CB‐Spider Server Configuration(KR) - cloud-barista/cb-spider GitHub Wiki

CB-Spider 서버 설정

Language: English | 한국어

CB-Spider 서버 설정 방법

• CB-Spider 서버의 접근 방식 및 비밀번호 등을 설정합니다.
• 보통 비밀번호(SPIDER_PASSWORD)만 설정하면 로컬 운영 가능합니다.

  • 설정 정보

    환경 변수 설명 기본값
    CBSPIDER_ROOT 설치된 CB-Spider 패키지의 루트 경로 설정 setup.env 파일 위치로 자동 설정
    SERVER_ADDRESS 서버 가동 주소 및 포트 설정. 참고) CB-Spider Service Address Configuration 미설정(localhost 사용, 외부 접근 불가)
    SERVICE_ADDRESS 서비스 접근 주소 및 포트 설정(2중 네트워크 환경 등 필요시만 설정). 참고) CB-Spider Service Address Configuration 미설정(localhost 사용, 외부 접근 불가)
    PLUGIN_SW 클라우드 인프라 드라이버를 동적으로 추가 및 연결하는 옵션. ON으로 설정하면 공유 라이브러리로 빌드된 드라이버를 동적으로 등록하고 관리합니다. PLUGIN_SW=OFF
    ID_TRANSFORM_MODE 리소스 생성 시 ID 변환 수행 여부를 설정하는 옵션. OFF로 설정하면 사용자가 입력한 ID를 UUID 형식으로 변환하지 않고 CSP에 요청합니다(OFF로 설정 시 사용자는 CSP별 명명 제약사항을 고려해야 합니다). 참고) ID Transform ON/OFF Guide ID_TRANSFORM_MODE=ON
    CBLOG_ROOT 로그 출력을 위한 cb-log의 루트 경로 설정; cb-log가 설정 파일 등을 찾는 데 사용됩니다. CBSTORE_ROOT=$CBSPIDER_ROOT
    ADMINWEB AdminWeb UI 및 Swagger UI 활성화/비활성화 옵션. OFF로 설정하면 AdminWeb과 Swagger UI가 모두 비활성화됩니다. 참고) [AdminWeb ON/OFF Guide] ADMINWEB=ON
    MC_INSIGHT_API_TOKEN 멀티클라우드 메타데이터 검색을 위한 MC-Insight API 토큰 설정. MC-Insight 서비스 관리자로부터 토큰을 발급받아 설정합니다. 비어있으면 MC-Insight 기능이 비활성화됩니다. MC_INSIGHT_API_TOKEN=c72df1af9b1f0c29
    SPIDER_METADB_URL PostgreSQL URL 모드용 Meta DB 연결 URL. URL 모드(SPIDER_METADB_URL) 또는 key-value 모드(SPIDER_METADB_USER, SPIDER_METADB_PASSWORD, SPIDER_METADB_ENDPOINT, SPIDER_METADB_DATABASE) 중 하나만 사용해야 합니다. PostgreSQL 모드 사용 시 Spider는 MetaDB를 사용자 관리형으로 간주하며 백업 스케줄러가 자동 비활성화됩니다. 미설정(내장 SQLite 모드)
    SPIDER_METADB_USER Meta DB key-value 모드용 PostgreSQL 사용자명. 미설정
    SPIDER_METADB_PASSWORD Meta DB key-value 모드용 PostgreSQL 비밀번호. 미설정
    SPIDER_METADB_ENDPOINT Meta DB key-value 모드용 PostgreSQL 엔드포인트 (예: localhost:5432). 미설정
    SPIDER_METADB_DATABASE Meta DB key-value 모드용 PostgreSQL 데이터베이스 이름. 미설정
    SPIDER_METADB_SSLMODE Meta DB key-value 모드용 선택 SSL 모드 (예: disable). 미설정
    SPIDER_METADB_CONNECT_TIMEOUT Meta DB key-value 모드용 선택 연결 타임아웃(초) (예: 10). 미설정
    SPIDER_BACKUP_ENABLED 메타 DB 자동 백업 활성화 여부 설정. 참고) Meta DB Backup Guide true
    SPIDER_BACKUP_INTERVAL 백업 주기 설정 (Go duration 형식, 예: 6h, 1h, 30m). 6h
    SPIDER_BACKUP_DIR 백업 파일이 저장되는 디렉터리 경로. $CBSPIDER_ROOT/meta_db/backups
    SPIDER_BACKUP_MAX_COUNT 보관할 최대 백업 파일 수. 10
    SPIDER_USERNAME / SPIDER_PASSWORD REST API 인증(Basic Auth)을 위한 ID/PW 설정. ⚠️ 중요: 두 값 모두 반드시 설정해야 합니다. 둘 중 하나라도 비어있으면 서버가 시작되지 않습니다. 참고) 인증 가이드 SPIDER_USERNAME=admin SPIDER_PASSWORD=

  • 설정 파일: ./setup.env

     #!/bin/bash

 # root path of cb-spider
 SCRIPT_DIR=`dirname ${BASH_SOURCE[0]-$0}`
 export CBSPIDER_ROOT=`cd $SCRIPT_DIR && pwd`

 ### Set Spider server Address of Service Address
 # cf) https://github.com/cloud-barista/cb-spider/wiki/CB-Spider-Service-Address-Configuration
 # default: unset SERVER_ADDRESS and unset SERVICE_ADDRESS
 # examples for other service port
 #export SERVER_ADDRESS=":3000"

 # examples for K8S env
 #export SERVER_ADDRESS=":1024"
 #export SERVICE_ADDRESS="1.2.3.4:31024"

 ### Set the library type of Cloud Driver pkg.
 # ON is a shared library type.
 # default: OFF (will be deprecated)
 export PLUGIN_SW=OFF

 ## If the value is OFF, Spider does not perform ID transformation.
 # default: ON
 export ID_TRANSFORM_MODE=ON

 # root path of cb-log
 export CBLOG_ROOT=$CBSPIDER_ROOT

 # AdminWeb ON/OFF setting
 # ON: Enable AdminWeb, OFF: Disable AdminWeb
 # default: ON
 export ADMINWEB=ON

 # MC-Insight API Token for multi-cloud metadata search
 # Get token from MC-Insight service administrator
 # If empty, MC-Insight features will be disabled
 export MC_INSIGHT_API_TOKEN=c72df1af9b1f0c29

 # Meta DB Configuration (Choose one mode only)
 # Default: if neither mode is set, Spider uses embedded SQLite.
 # SQLite(default) file: $CBSPIDER_ROOT/meta_db/cb-spider.db
 #
 # Option A) URL mode
 #export SPIDER_METADB_URL="postgresql://postgres:password123@localhost:5432/cb_spider"
 #export SPIDER_METADB_URL="postgresql://postgres:password123@localhost:5432/cb_spider?sslmode=disable&connect_timeout=10"
 #
 # Option B) Key-value mode
 #export SPIDER_METADB_USER=postgres
 #export SPIDER_METADB_PASSWORD=password123
 #export SPIDER_METADB_ENDPOINT=localhost:5432
 #export SPIDER_METADB_DATABASE=cb_spider
 # Optional for key-value mode
 #export SPIDER_METADB_SSLMODE=disable
 #export SPIDER_METADB_CONNECT_TIMEOUT=10
 #
 # NOTE:
 # - Use only one mode (URL or key-value), not both.
 # - If PostgreSQL mode is used, Spider treats MetaDB as user-managed.
 # - In PostgreSQL mode, Spider MetaDB backup scheduler is automatically disabled.

 # Meta DB Backup Configuration
 # All settings are optional. If not set, defaults are used without errors.
 # SPIDER_BACKUP_ENABLED: true/false (default: true)
 # SPIDER_BACKUP_INTERVAL: Go duration format, e.g., 6h, 1h, 30m (default: 6h)
 # SPIDER_BACKUP_DIR: Backup directory path (default: $CBSPIDER_ROOT/meta_db/backups)
 # SPIDER_BACKUP_MAX_COUNT: Max number of backup files to keep (default: 10)
 #export SPIDER_BACKUP_ENABLED=true
 #export SPIDER_BACKUP_INTERVAL=6h
 #export SPIDER_BACKUP_DIR=$CBSPIDER_ROOT/meta_db/backups
 #export SPIDER_BACKUP_MAX_COUNT=10
 # Note: SPIDER_BACKUP_* settings are applied only in embedded SQLite MetaDB mode.

 # REST API Authentication (Basic Auth) - REQUIRED
 # - Both SPIDER_USERNAME and SPIDER_PASSWORD must be set. Server will not start without them.
 export SPIDER_USERNAME=admin
 export SPIDER_PASSWORD=

⚠️ 인증 필수: 서버를 시작하려면 SPIDER_USERNAME과 SPIDER_PASSWORD를 모두 설정해야 합니다.
둘 중 하나라도 누락되면 서버가 log.Fatal로 종료됩니다.
CLI(spctl)의 경우 환경변수 또는 -u/-p 플래그를 통해 인증 정보를 제공할 수 있습니다.
자세한 내용은 인증 가이드 및 CLI Install Guide를 참조하세요.

  • setup.env 파일을 수정한 경우, 변경사항을 적용하려면 서버를 재시작해야 합니다.