sunae
/
control-center-management
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

README.md 작성

This commit is contained in:
장선애 2023-09-13 16:10:23 +09:00
parent 4c553d2938
commit fb8dcaf9b6
1 changed files with 97 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

119
README.md
View File

@ -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 ## build ##
* [Learn Markdown](https://bitbucket.org/tutorials/markdowndemo) ```
$ ./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 ## K8s Envs ##
* Configuration ### Office Desktop ###
* Dependencies ```
* Database configuration apiVersion: apps/v1
* How to run tests kind: Deployment
* Deployment instructions 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 ## Container Option ##
* Code review | 옵션명 | 설명 | Sample |
* Other guidelines |:----------------------:|:--------------------------------:|:------------------------------------------------------------------------------------:|
| SPRING_PROFILES_ACTIVE | 스프링 부트 프로파일 | k8s |
### Who do I talk to? ### | SERVER_PORT | 서버 포트 | 8087 |
| MONGODB_URL | MongoDB URL | mongodb://sdt:251327@mongo-db.database.svc.cluster.local/awexomeray?authSource=admin |
* Repo owner or admin | DEPLOYER_ENDPOINT | device deployer service endpoint | http://device-deployer.sdt-cloud.svc.cluster.local:8085 |
* Other community or team contact | 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 |