6. 레퍼런스

BXCP ADM에는 다양한 설정이 있는데 본 장에서는 BXCP ADM을 관리 시 참조 레퍼런스 정보를 설명한다.

6.1 시스템 환경변수

6.1.1 bxcp.app.status.timeout

  • 단위 : 시간 - 초

  • 기본값 : 30

  • 애플리케이션 배포 행위에 대한 동시성 제어를 위해 사용하는 Lock Timeout 시간이다. 애플리케이션의 배포(롤아웃 교체, 배포, 롤백, 롤아웃 확정, 롤아웃 취소)가 이루어진 이후에는 해당 시간 동안 잠금 상태가 되어 배포에 관련된 처리를 할 수 없다.

6.1.2 bxcr.auto.harbor.project

  • 단위 : Y/N

  • 기본값 : Y

  • BXCP ADM의 Project 생성 시 연동되는 Harbor에서 project를 자동으로 생성할지 여부를 결정한다.

6.1.3 bxcr.auto.jenkins.folder

  • 단위 : Y/N

  • 기본값 : Y

  • BXCP ADM의 Project 생성 시 CI/CD 파이프라인 처리를 위한 Jenkin 서버에서 프로젝트에 관련한 폴더를 생성할지 여부를 결정한다.

6.1.4 bxcr.auto.jenkins.job

  • 단위 : Y/N

  • 기본값 : Y

  • BXCP ADM에서 애플리케이션을 생성 시 젠킨스 서버에 CI/CD 파이프라인 작업을 생성할지 여부를 결정한다.

6.1.5 bxcr.auto.jwt.expiration

  • 단위 : 기간 - 일수

  • 기본값 : 3650

  • 자동으로 웹훅을 위한 토큰 생성 시 적용할 기본 만료일을 설정하는 값이다.

6.1.6 bxcr.auto.jwt.user

  • 단위 : 문자열 - 사용자ID

  • 기본값 : webhook001

  • 자동으로 웹훅을 위한 토큰을 생성 시 사용할 사용자 ID 값이다.

6.1.7 bxcr.common.approve

  • 단위 : Y/N

  • 기본값 : Y

  • 애플리케이션 릴리즈 이관 처리 시 승인 처리를 진행해야 하는지 여부를 결정한다.

6.1.8 bxcr.common.dashboard.popup

  • 단위 : Y/N

  • 기본값 : Y

  • 관리자로 로그인 시 Administrator 대시보드에서 선택할 수 있는 메뉴를 팝업으로 열어줄지 여부를 결정한다.

6.1.9 bxcr.common.gateway

  • 단위 : 문자열 - istio 게이트웨이 명

  • 기본값 : istio-system/bxcp-gateway

  • 애플리케이션 등록에 사용되는 Istio 게이트웨이의 기본값으로 사용한다.

6.1.10 bxcr.common.gitlab.tag

  • 단위 : 문자열 - 정규표현식

  • 기본값 : RELEASE_*

  • Gitlab 서버에서 Tag Push event에서 사용할 태그 정규 표현식을 입력한다. 여기에 필터링 할 태그를 정규 표현식으로 설정해서 표현식에 맞는 태그만 웹훅이 트리거 처리된다.

6.1.11 bxcr.common.harbor.chartUrl

  • 단위 : 문자열 - URL

  • 기본값 : https://registry.bxcp.lab:5443/api/chartrepo/bxcp-system-common

  • 공통으로 사용할 Helm Chart Repository 정보를 설정한다.

6.1.12 bxcr.common.harbor.id

  • 단위 : 문자열 - Harbor ID

  • 기본값 : admin

  • BXCP ADM 환경에서 사용하는 컨테이너 이미지 레지스트리 Harbor를 연결 시 사용하는 관리자 ID 정보를 설정하며 클러스터에서는 재정의 할 수 있다.

6.1.13 bxcr.common.harbor.pw

  • 단위 : 문자열 - Harbor Password

  • 기본값 : bxcp!gen3

  • BXCP ADM 환경에서 사용하는 컨테이너 이미지 레지스트리 역할을 하는 Harbor에 연결 시 사용하는 관리자 비밀번호 정보를 설정하며 클러스터에서는 재정의 할 수 있다.

6.1.14 bxcr.common.harbor.svc

  • 단위 : 문자열 - Harbor 레지스트리 정보

  • 기본값 : registry.bxcp-system.svc

  • BXCP ADM 환경에서 진행되는 배포 프로세스에서 컨테이너 이미지를 Pull 할때 사용하는 Harbor 레지스트리 정보를 설정하며, 주로 쿠버네티스에 External Service Name 설정을 통해서 설정한다.

6.1.15 bxcr.common.harbor.svc.port

  • 단위 : 숫자 - Harbor 포트 번호

  • 기본값 : 5443

  • BXCP ADM 환경에서 진행되는 배포 프로세스에서 컨테이너 이미지를 Pull 할때 사용하는 Harbor 레지스트리 정보 중에서 포트 번호를 설정한다.

6.1.16 bxcr.common.harbor.url

  • 단위 : 문자열 - URL

  • 기본값 : https://registry.bxcp.lab:5443

  • BXCP ADM 환경에서 클러스터 정보에서 사용하는 기본 Harbor 레지스트리 URL 정보이다. 클러스터에서는 재정의 할 수 있다.

6.1.17 bxcr.common.hostCluster

  • 단위 : 문자열 - 호스트 클러스터 ID

  • 기본값 : host

  • BXCP ADM에서 관리하는 클러스터에서 호스트 역할을 하는 클러스터의 ID를 입력한다.

6.1.18 bxcr.common.jenkins.id

  • 단위 : 문자열 - Jenkins ID

  • 기본값 : bwg

  • BXCP ADM과 연동하는 젠킨스 서버의 관리자 ID를 설정한다.

6.1.19 bxcr.common.jenkins.pw

  • 단위 : 문자열 - Jenkins Password

  • 기본값 : bxcp!gen3

  • BXCP ADM과 연동하는 젠킨스 서버의 관리자 비밀번호를 설정한다.

6.1.20 bxcr.common.jenkins.url

  • 단위 : 문자열 - URL

  • 기본값 : https://{{infra_node_ip}}:8444

  • BXCP ADM과 연동하는 젠킨스 서버의 URL 정보를 설정한다.

6.1.21 bxcr.common.monitoring.popup

  • 단위 : Y/N

  • 기본값 : Y

  • 모니터링 메뉴에서 선택하는 모니터링 화면의 팝업 여부를 설정한다.

6.1.22 bxcr.common.terminal.allow

  • 단위 : Y/N

  • 기본값 : Y

  • BXCP ADM에서 [파드] > [상세] > [Terminal] 탭 화면을 모두에게 접근 허가 여부를 설정한다.

6.1.23 bxcr.docker.host

  • 단위 : 문자열 - docker0 네트워크 인터페이스 IP

  • 기본값 : unix:///var/run/docker.sock

  • BXCP ADM이 이미지 이관에 사용되는 도커 호스트 정보 - docker 호스트에 docker0 네트워크 인터페이스에 명시된 ip 사용

6.1.24 bxcr.system.auth.token

  • 단위 : 문자열 - JWT 토큰

  • 기본값 : eyJhbGciOiJIUzI1NiJ9.eyJqdGkiO ...

  • BXCP API 호출에 사용하는 인증 토큰이다.

6.1.25 bxcr.system.cache.daemon.delay.msec

  • 단위 : 시간 - 밀리초

  • 기본값 : 3000

  • BXCP ADM 환경에서는 다른 시스템의 부하를 최대한 줄이기 위해 일부 데이터를 캐시 형태로 제공한다. 이 캐시 데이터를 생성하는 데몬의 작업 지연 시간을 설정한다.

6.1.26 bxcr.system.isClassified

  • 단위 : Y/N

  • 기본값 : Y

  • 시스템 구분에 따라 화면에서의 기능 분기 처리 여부 - N인 경우 모두 Development로 처리

6.1.27 bxcr.system.isLegacy

  • 단위 : Y/N

  • 기본값 : N

  • Kubernetes Cluster 사용 여부를 설정한다. Kubernetes Cluster가 없으면 Y

6.1.28 bxcr.system.k8s.connection.timeout

  • 단위 : 시간 - 밀리초

  • 기본값 : 1000

  • BXCP ADM에서 쿠버네티스 연결에 사용하는 클라이언트의 연결 타임아웃 시간

6.1.29 bxcr.system.k8s.request.timeout

  • 단위 : 시간 - 밀리초

  • 기본값 : 30000

  • BXCP ADM에서 쿠버네티스 연결에 사용하는 클라이언트의 요청 타임아웃 시간

6.1.30 bxcr.system.k8s.websocket.timeout

  • 단위 : 시간 - 밀리초

  • 기본값 : 600000

  • BXCP ADM에서 파드의 로깅, 터미널 등의 기능을 이용 시 사용하는 클라이언트의 웹소켓 타임아웃 시간

6.1.31 bxcr.system.kubefed.delete.timeout

  • 단위 : 시간 - 초

  • 기본값 : 5

  • rewrite 활성화가 되었을 때, BXCP ADM에서 배포 처리 시 FederatedIngress 리소스가 이미 있으면 삭제 요청을 전송후 대기하는 타임아웃 시간이다.

6.1.32 bxcr.system.logging.audit.disable

  • 단위 : true/false

  • 기본값 : false

  • 감사 로깅을 비활성화 여부를 설정하며 true(로그를 저장하지 않음) 또는 false 값으로 설정한다.

6.1.33 bxcr.system.logging.error.disable

  • 단위 : true/false

  • 기본값 : false

  • 에러 로깅의 비활성화 여부를 설정하며 true(로그를 저장하지 않음) 또는 false 값으로 설정한다.

6.1.34 bxcr.system.p8s.disable

  • 단위 : Y/N

  • 기본값 : N

  • BXCP ADM 화면에서 사용하는 프로메테우스 사용 여부를 설정한다.

6.1.35 bxcr.system.service.dryrun.nodeport

  • 단위 : 숫자 - 노드포트번호

  • 기본값 : 33333

  • 서비스 리소스 검증을 위한 노드 포트번호 값이다.

6.1.36 bxcr.system.url

  • 단위 : 문자열 - URL

  • 기본값 : https://{{infra_node_ip}}:30130

  • 현재 기동하는 BXCP ADM URL

6.1.37 bxcr.workspaces.default.harbor.id

  • 단위 : 문자열 - Harbor ID

  • 기본값 : admin

  • 릴리즈에서 사용하는 Source Harbor 관리자 ID를 입력하며 이 정보는 워크스페이스에서 재정의 가능하다.

6.1.38 bxcr.workspaces.default.harbor.password

  • 단위 : 문자열 - Harbor Password

  • 기본값 : bxcp!gen3

  • 릴리즈에서 사용하는 Source Harbor 관리자 Password를 입력하며 이 정보는 워크스페이스에서 재정의 가능하다.

6.1.39 bxcr.workspaces.default.harbor.url

  • 단위 : 문자열 - URL

  • 기본값 : https://registry.bxcp.lab:5443

  • 릴리즈에서 사용하는 Source Harbor URL을 입력하며 이 정보는 워크스페이스에서 재정의 가능하다.

6.1.40 bxcr.workspaces.default.portal.token

  • 단위 : 문자열 - JWT 토큰

  • 기본값 : eyJhbGciOiJIUzI1NiJ9.eyJqdGkiO ...

  • 릴리즈에서 사용하는 Source BXCP Portal Token을 입력하며 이 정보는 워크스페이스에서 재정의 가능하다.

6.1.41 bxcr.workspaces.default.portal.url

  • 단위 : 문자열 - URL

  • 기본값 : https://{{infra_node_ip}}:30130

  • 릴리즈에서 사용하는 Source BXCP Portal URL을 입력하며 이 정보는 워크스페이스에서 재정의 가능하다.

6.1.42 jwt.token.access.expiration

  • 단위 : 시간 - 분

  • 기본값 : 30

  • BXCP ADM에서 인증에 사용하는 JWT Access 토큰을 생성할 때 설정하는 기본 만료 시간이다.

6.1.43 jwt.token.delete.data

  • 단위 : true/false

  • 기본값 : false

  • BXCP ADM에서 로그인 토큰을 발급 시 사용자 기준에 기존 토큰 정보가 있으면 삭제할지 여부를 설정하는 값이다.(true: 사용자 아이디를 기준으로 동시에 로그인 할 수 없음, 반드시 소문자로 지정)

6.1.44 jwt.token.job.interval

  • 단위 : 시간 - 분

  • 기본값 : 10

  • BXCP ADM 화면 내부에서 JWT 토큰을 검증하기 위해서 사용하는 반복시간을 설정하는 값이다.

6.1.45 jwt.token.refresh.expiration

  • 단위 : 시간 - 분

  • 기본값 : 10080 (7일)

  • BXCP ADM 화면 내부에서 JWT 새로고침 토큰의 만료 시간의 값이다.

6.1.46 jwt.token.secret

  • 단위 : 문자열

  • 기본값 : secret

  • BXCP ADM에서 JWT 토큰 생성과 검증을 위한 비밀키

6.1.47 mail.send.host

  • 단위 : 문자열 - SMTP 서버 호스트 명

  • 기본값 : smtp.gmail.com

  • SMTP 서버의 호스트 이름

6.1.48 mail.send.password

  • 단위 : 문자열 - SMTP 서버 비밀번호

  • 기본값 : xqchhlnqnjcsfslk

  • SMTP 서버의 메일 전송 시 사용하는 비밀번호

6.1.49 mail.send.port

  • 단위 : 숫자 - 포트 번호

  • 기본값 : 465

  • SMTP 서버의 연결 포트 번호

6.1.50 mail.send.username

  • 단위 : 문자열 - 메일 주소

  • 기본값 : bwg@gmail.com

  • SMTP 서버의 메일 전송 시 사용자 이름