From fb8dcaf9b60f4801c98c6be16831306f613c8a9a Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E1=84=8C=E1=85=A1=E1=86=BC=E1=84=89=E1=85=A5=E1=86=AB?=
 =?UTF-8?q?=E1=84=8B=E1=85=A2?= <sa.jang@sdt.inc>
Date: Wed, 13 Sep 2023 16:10:23 +0900
Subject: [PATCH] =?UTF-8?q?README.md=20=EC=9E=91=EC=84=B1?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md | 119 ++++++++++++++++++++++++++++++++++++++++++++----------
 1 file changed, 97 insertions(+), 22 deletions(-)

diff --git a/README.md b/README.md
index 39af52c..2f722f6 100644
--- a/README.md
+++ b/README.md
@@ -1,29 +1,104 @@
-# README #
+# AXR X-Ray Tube 제어/조회 서비스 #
 
-This README would normally document whatever steps are necessary to get your application up and running.
+## 기능 ##
+* Tube on/off 제어
+* Tube 전류, 전압 offset 설정
+* 전체 챔버 통계 조회
+* 챔버 개별 튜브별 통계 조회
 
-### What is this repository for? ###
+## 기술 ##
+* Spring Boot 3.1.3
+* Spring web
+* Spring AMQP
+* Spring Data MongoDB
+* Gradle
 
-* Quick summary
-* Version
-* [Learn Markdown](https://bitbucket.org/tutorials/markdowndemo)
+## 배포 ##
+## build ##
+```
+$ ./gradlew clean build -x test
+```
 
-### How do I get set up? ###
+## dockerize ##
+```
+$ docker build --platform linux/amd64 -t control-center-management .
+```
 
-* Summary of set up
-* Configuration
-* Dependencies
-* Database configuration
-* How to run tests
-* Deployment instructions
+## K8s Envs ##
+### Office Desktop ###
+```
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: control-center-management
+  namespace: sdt-cloud
+  labels:
+    name: control-center-management
+spec:
+  selector:
+    matchLabels:
+      name: control-center-management
+  replicas: 1
+  template:
+    metadata:
+      labels:
+        name: control-center-management
+    spec:
+      imagePullSecrets:
+        - name: regcred
+      containers:
+        - name: control-center-management
+          image: 003960268191.dkr.ecr.ap-northeast-2.amazonaws.com/sdt-cloud/control-center-management:0.0.3
+          imagePullPolicy: Always
+          ports:
+            - containerPort: 8087
+          env:
+            - name: SPRING_PROFILES_ACTIVE
+              value: "k8s"
+            - name: SERVER_PORT
+              value: "8087"
+            - name: MONGODB_URL
+              value: "mongodb://sdt:251327@mongo-db.database.svc.cluster.local/awexomeray?authSource=admin"
+            - name: DEPLOYER_ENDPOINT
+              value: "http://device-deployer.sdt-cloud.svc.cluster.local:8085"
+            - name: IAM_AMQP_HOST
+              value: "rabbitmq.sdt-cloud.svc.cluster.local"
+            - name: IAM_AMQP_PORT
+              value: "5672"
+            - name: IAM_AMQP_CREDENTIALS_USERNAME
+              value: "sdt"
+            - name: IAM_AMQP_CREDENTIALS_PASSWORD
+              value: "251327"
+            - name: DATA_FALL_ENDPOINT
+              value: "http://data-fall.sdt-cloud.svc.cluster.local:8083"
+---
+apiVersion: v1
+kind: Service
+metadata:
+  name: control-center-management
+  namespace: sdt-cloud
+spec:
+  ports:
+    - port: 8087
+      targetPort: 8087
+      protocol: TCP
+      name: control-center-management
+      nodePort: 30870
+  type: NodePort
+  selector:
+    name: control-center-management
+```
 
-### Contribution guidelines ###
 
-* Writing tests
-* Code review
-* Other guidelines
-
-### Who do I talk to? ###
-
-* Repo owner or admin
-* Other community or team contact
\ No newline at end of file
+## Container Option ##
+|          옵션명           |                설명                |                                        Sample                                        |
+|:----------------------:|:--------------------------------:|:------------------------------------------------------------------------------------:|
+| SPRING_PROFILES_ACTIVE |           스프링 부트 프로파일            |                                         k8s                                          |
+| SERVER_PORT                       |              서버 포트               |                                         8087                                         |
+| MONGODB_URL                       |           MongoDB URL            | mongodb://sdt:251327@mongo-db.database.svc.cluster.local/awexomeray?authSource=admin |
+| DEPLOYER_ENDPOINT                       | device deployer service endpoint |                   http://device-deployer.sdt-cloud.svc.cluster.local:8085                   |
+| IAM_AMQP_HOST                       |           RabbitMQ URL           |                         rabbitmq.sdt-cloud.svc.cluster.local                         |
+| IAM_AMQP_PORT                       |          RabbitMQ port           |                                         5672                                         |
+| IAM_AMQP_CREDENTIALS_USERNAME                       |       RabbitMQ 접속 username       |                         sdt                                                             |
+| IAM_AMQP_CREDENTIALS_PASSWORD                       |       RabbitMQ 접속 password       |                        2xxxx7                                                              |
+| DATA_FALL_ENDPOINT                       |    data fall service endpoint    |                                    http://data-fall.sdt-cloud.svc.cluster.local:8083                                                  |