BOSH CLI

Table Contents

문서 개요

문서 목적

본 문서는 BOSH에 대한 설치 및 운영 관리를 위한 도구인 BOSH CLI v2에 대해 기본 사용법 및 사용 예시를 통해 BOSH를 이해하는데 목적이 있다.

문서 범위

본 문서에서는 BOSH CLI V2 사용법에 대해서 작성하였다.

참고 자료

본 문서는 Cloud Foundry의 BOSH Document(http://bosh.io)를 참고로 작성하였다.

BOSH CLI 기본 사용법

CLI는 BOSH 배포와 Release를 관리하기 위해 도움을 주는 커맨드 라인 명령어로 아래와 같이 구분된다.

  • bosh-cli: BOSH를 관리하기 위한 CLI

  • 기본 Syntax

    bosh 명령어에 대괄호로 묶인 인자인 과 는 명령어에 따라 선택적으로 사용되고, 인자는 필수 인자이다.

  • Options

    번호

    옵션

    설명

    1

    -c, --config

    BOSH configuration file 지정

    2

    --ca-cert

    Director 및 UAA 연결에 사용 되는 CA 인증서 지정

    3

    --client

    사용자 이름 또는 UAA 클라이언트 재정의

    4

    -n

    입력 사용이 필요한 확인

    5

    --json

    출력 형식을 JSON으로 변경

    6

    --tty

    명령이 리디렉션되지 않을 때 일반적으로 표시되는 모든 텍스트를 출력에 포함

    7

    --no-color

    색상을 비활성화

    8

    --deployment, -d

    Deploy 명령을 위한 배치 지정

    9

    -h, --help

    Help 메시지 보기

    10

    --column=

    지정된 열만 표시하도록 필터링

    11

    -e, --enviroment

    SHA256 체크섬 사용

    12

    --sha2

    BOSH 배포파일 지정

    13

    --parallel=

    병렬 작업의 최대 수

    14

    --client-secret=

    암호 또는 UAA 클라이언트 암호 재정의

BOSH CLI - Environments

bosh environments

  • 기본 Syntax

  • 설명

  • 파라미터

  • 사용 예시

bosh create-env

  • 기본 Syntax

  • 설명

    BOSH CLI를 통해 Manifest File을 기반으로 단일 VM을 생성. 일반적으로 Director 환경을 만드는 데 사용

  • 파라미터

    파라미터 명

    설명

    필수**(O/X)**

    deploymentFile

    설치 Manfiest 파일

    O

    --state path

    Deployment state 파일 경로

    X

    -v

    Manifest Replace 변수 ex) internal_ip, deployment_name

    X

    -o

    option Manifest File ex) jumpbox-user.yml, uaa.yml...

    X

    --vars -store path

    creds.yml 파일, 인증 키 및 Job Password yml 파일 경로

    X

  • 사용 예시

bosh alias-env

  • 기본 Syntax

  • 설명

    BOSH CLI를 통해 엑세스 할 디렉터의 별명이 지정

  • 파라미터

파라미터 명

설명

필수**(O/X)**

name

환경 이름 지정

O

location

디렉터 위치 지정

O

--ca-cert=path

CA 인증서를 지정

X

bosh environment

  • 기본 Syntax

  • 설명

    해당 Director 정보를 출력

  • 파라미터

    파라미터 명

    설명

    필수**(O/X)**

    my-env

    지정 한 Director 환경 이름 명칭

    O

  • 사용 예시

bosh delete-env

  • 기본 Syntax

  • 설명

    매니페스트를 기반으로 이전에 만든 VM을 삭제, create-env 명령에 제공된 것과 동일한 플래그를 delete-env 명령에 제공해야한다.

  • 파라미터

    파라미터 명

    설명

    필수**(O/X)**

    deploymentFile

    설치 한 Manfiest 파일

    O

    --state path

    Deployment state 파일 경로

    O

    -v

    Manifest Replace 변수 ex) internal_ip, deployment_name

    X

    -o

    option Manifest File ex) jumpbox-user.yml, uaa.yml…

    X

    --vars -store path

    creds.yml 파일, 인증 키 및 Job Password yml 파일 경로

    X

  • 사용 예시

BOSH CLI - Session

bosh log-in

  • 기본 Syntax

  • 설명

    주어진 사용자를 Director에 로그인합니다.

  • 파라미터

    파라미터 명

    설명

    필수**(O/X)**

    my-env

    BOSH 지정 한 Director 환경 이름 명칭

    O

  • 사용 예시

bosh log-out

  • 기본 Syntax

  • 설명

    현재 접속 한 디렉터 로그아웃

  • 파라미터

    파라미터 명

    설명

    필수**(O/X)**

    my-env

    BOSH 지정 한 Director 환경 이름 명칭

    O

  • 사용 예시

BOSH CLI - Stemcells

bosh Stemcells

  • 기본 Syntax

  • 설명

    업로드 한 릴리즈 조회

  • 파라미터

    파라미터 명

    설명

    필수**(O/X)**

    my-env

    지정 한 Director 환경 이름 명칭

    O

  • 사용 예시

bosh upload-stemcell

  • 기본 Syntax

  • 설명

    스템셀 업로드

  • 파라미터

    파라미터 명

    설명

    필수**(O/X)**

    my-env

    지정 한 Director 환경 이름 명칭

    O

    location

    스템셀 파일 위치 및 URL 지정

    X

    --sha1

    스템셀 파일 sha1um 값 확인

    X

    --fix

    이전에 업로드 한 스템 셀을 동일한 이름과 버전으로 교체

    X

  • 사용 예시

bosh delete-stemcell

  • 기본 Syntax

  • 설명

    업로드 한 스템셀 삭제

  • 파라미터

    파라미터 명

    설명

    필수**(O/X)**

    my-env

    지정 한 Director 환경 이름 명칭

    O

    name

    삭제 할 스템셀 명

    O

    version

    삭제 할 스템셀 버전

    O

  • 사용 예시

bosh repack-stemcell

  • 기본 Syntax

  • 설명

    기존 스템셀의 이름, 버전 및 클라우드 등록 정보와 같은 업데이트 된 등록 정보로 새로운 스템셀 타르볼을 생성 참조 URL: https://bosh.io/docs/repack-stemcell.html

  • 파라미터

    파라미터 명

    설명

    필수**(O/X)**

    name

    업데이트 등록 스템셀 명

    O

    version

    업데이트 등록 스템셀 버전

    X

    cloud-properties

    업데이트 등록 스템셀 cloud-properties, Json 형식

    X

  • 사용 예시

BOSH CLI - Release creation

bosh init-release

  • 기본 Syntax

  • 설명

    dir에 릴리즈에 관련한 구성 파일을 생성 dir을 사용 않할 경우는 현재 디렉토리

  • 파라미터

    파라미터 명

    설명

    필수**(O/X)**

    --git

    BOSH 릴리즈 Git repository에 적절한 .gitignore 파일을 생성

    X

    --dir

    디렉토리에 대한 빈 릴리스 구성 파일 생성

    X

  • 파라미터

bosh generate-job

  • 기본 Syntax

  • 설명

    dir에 릴리즈에 대한 Job에 관련 한 빈 파일 생성

  • 파라미터

    파라미터 명

    설명

    필수**(O/X)**

    name

    릴리즈 Job 명칭

    O

    --dir

    디렉토리에 대한 Job 관련 빈 릴리스 구성 파일 생성

    X

  • 사용 예시

bosh generate-package

  • 기본 Syntax

  • 설명

    dir에 릴리즈에 대한 pakage에 관련 한 빈 파일 생성

  • 파라미터

    파라미터 명

    설명

    필수**(O/X)**

    name

    릴리즈 pakage 명칭

    O

    --dir

    디렉토리에 pakage Job 관련 빈 릴리스 구성 파일 생성

    X

  • 사용 예시

bosh vendor-package

  • 기본 Syntax

  • 설명

    다른 릴리스의 패키지를 dir의 릴리스로 제공, 릴리즈를 만들 때 CLI가 특정 패키리를 참조 하도록 디렉토리에 spec.lock을 포함 설명 참조 https://bosh.io/docs/package-vendoring.html

  • 파라미터

    파라미터 명

    설명

    필수**(O/X)**

    name

    릴리즈 pakage명칭

    O

    --dir

    디렉토리에 대한 package 관련 빈 릴리스 구성 파일 생성

    X

  • 사용 예시

bosh create-release

  • 기본 Syntax

  • 설명

    dir에 저장된 릴리스의 새 버전을 생성

  • 파라미터

    파라미터 명

    설명

    필수**(O/X)**

    --force

    릴리스 디렉토리에서 커밋되지 않은 변경 사항을 무시하도록 지정

    X

    --version

    사용자 정의 릴리스 버전을 제공

    X

    --version

    사용자 정의 릴리스 버전을 제공

    X

    --timestamp-version

    타임 스탬프 기반의 dev 릴리즈 버전을 생성

    X

    --tarball

    릴리스 타르볼의 대상을 지정

    X

    --sha2

    SHA256 체크섬 사용 지정

    X

  • 사용 예시

bosh finalize-release

  • 기본 Syntax

  • 설명

    선택적으로 주어진 버전으로 최종 릴리스로 릴리스 타볼의 내용을 기록

  • 파라미터

    파라미터 명

    설명

    필수**(O/X)**

    path

    릴리즈 tarball 지정

    O

    --force

    릴리스 디렉토리에서 커밋되지 않은 변경 사항을 무시하도록 지정

    X

    --version

    사용자 정의 릴리스 버전을 제공

    X

    --dir

    디렉토리 위치 지정

    X

  • 사용 예시

bosh reset-release

  • 기본 Syntax

  • 설명

    릴리스 디렉토리에 보관 된 dev 릴리스, blob 등의 임시 아티팩트를 제거

  • 파라미터

    파라미터 명

    설명

    필수**(O/X)**

    --dir

    디렉토리 위치 지정

    O

  • 사용 예시

BOSH CLI - Release blobs

bosh blob

  • 기본 Syntax

  • 설명

    릴리즈 Blobstore에 등록 한 blob 출력

  • 사용 예시

bosh add-blob

  • 기본 Syntax

  • 설명

    릴리즈 Blobstore에 로컬 blob 추가

  • 파라미터

    파라미터 명

    설명

    필수**(O/X)**

    src-path

    로컬 Blob 디렉토리

    O

    dst-path

    릴리즈 내 blob 디렉토리

    X

  • 사용 예시

bosh reomove-blob

  • 기본 Syntax

  • 설명

    릴리즈 Blobstore에 존재 하는 Blob 삭제

  • 파라미터

    파라미터 명

    설명

    필수**(O/X)**

    blob-path

    릴리즈 내 blob 디렉토리

    O

  • 사용 예시

bosh sync-blob

  • 기본 Syntax

  • 설명

    릴리즈 내 blobstore의 blob 동기화

  • 사용 예시

BOSH CLI - Releases

bosh releases

  • 기본 Syntax

  • 설명

    업로드 한 릴리즈 조회

  • 파라미터

    파라미터 명

    설명

    필수**(O/X)**

    my-env

    지정 한 Director 환경 이름 명칭

    O

  • 사용 예시

bosh upload-release

  • 기본 Syntax

  • 설명

    릴리즈 업로드

  • 파라미터

    파라미터 명

    설명

    필수**(O/X)**

    my-env

    지정 한 Director 환경 이름 명칭

    O

    location

    릴리즈 파일 위치 및 URL 지정

    O

    --sha1

    릴리즈 파일 sha1um 값 확인

    X

    --fix

    이전에 업로드 한 릴리즈를 동일한 이름과 버전으로 교체

    X

  • 사용 예시

bosh delete-release

  • 기본 Syntax

  • 설명

    업로드 한 릴리즈 삭제

  • 파라미터

    파라미터 명

    설명

    필수**(O/X)**

    my-env

    지정 한 Director 환경 이름 명칭

    O

    name

    삭제 할 릴리즈 명

    O

    version

    삭제 할 릴리즈 버전

    O

  • 사용 예시

bosh export-release

  • 기본 Syntax

  • 설명

    특정 스템셀에 대한 릴리즈를 컴파일 하고 내보낸다

  • 파라미터

    파라미터 명

    설명

    필수**(O/X)**

    my-env

    지정 한 Director 환경 이름 명칭

    O

    name

    릴리즈 명

    O

    version

    릴리즈 버전

    O

    os

    스템셀 os 명

    O

    version

    스템셀 os 버전

    O

    dir

    내보내기 디렉토리

    X

  • 사용 예시

bosh inspect-release

  • 기본 Syntax

  • 설명

    모든 Job, Job의 메타데이터 패키지 및 릴리즈 버전과 관련 된 패키지를 출력

  • 파라미터

    파라미터 명

    설명

    필수**(O/X)**

    my-env

    지정 한 Director 환경 이름 명칭

    O

    name

    릴리즈 명

    O

    version

    릴리즈 버전

    O

  • 사용 예시

BOSH CLI - Configs

bosh configs

  • 기본 Syntax

  • 설명

    Director의 모든 구성을 출력

  • 파라미터

    파라미터 명

    설명

    필수**(O/X)**

    my-env

    지정 한 Director 환경 이름 명칭

    O

    --name

    config 명 기본 Default

    X

    --type

    config type 명

    X

  • 사용 예시

bosh update-config

  • 기본 Syntax

  • 설명

    Director에서 구성을 추가하거나 업데이트

  • 파라미터

    파라미터 명

    설명

    필수**(O/X)**

    my-env

    지정 한 Director 환경 이름 명칭

    O

    my-typ

    config type 명

    O

    config.yml

    config type의 property Manifest 파일

    O

    --name

    config 명 기본 Default

    X

  • 사용 예시

bosh delete-config

  • 기본 Syntax

  • 설명

    Director의 my-type 구성을 삭제

  • 파라미터

    파라미터 명

    설명

    필수**(O/X)**

    my-env

    지정 한 Director 환경 이름 명칭

    O

    my-type

    config type 명

    O

    --name

    config 명 기본 Default

    X

  • 사용 예시

BOSH CLI - Cloud config

bosh cloud-configs

  • 기본 Syntax

  • 설명

    Deployment Property 설정

  • 파라미터

    파라미터 명

    설명

    필수**(O/X)**

    my-env

    지정 한 Director 환경 이름 명칭

    O

  • 사용 예시

bosh update-cloud-config

  • 기본 Syntax

  • 설명

    Director의 cloud-conifg 구성 요소를 추가 하거나 수정

  • 파라미터

    파라미터 명

    설명

    필수**(O/X)**

    my-env

    지정 한 Director 환경 이름 명칭

    O

    config.yml

    property Manifest 파일

    O

    -v

    Manifest Replace 변수 ex) internal_ip, deployment_name

    X

    -o

    option Manifest File ex) jumpbox-user.yml, uaa.yml…

    X

  • 사용 예시

BOSH CLI - Runtime config

bosh runtime-configs

  • 기본 Syntax

  • 설명

    Director의 runtime-conifg 구성 요소를 출력

  • 파라미터

    파라미터 명

    설명

    필수**(O/X)**

    my-env

    지정 한 Director 환경 이름 명칭

    O

  • 사용 예시

bosh update-runtime-config

  • 기본 Syntax

  • 설명

    Director의 cloud-conifg 구성 요소를 추가 하거나 수정

  • 파라미터

    파라미터 명

    설명

    필수**(O/X)**

    my-env

    지정 한 Director 환경 이름 명칭

    O

    config.yml

    property Manifest 파일

    O

    -v

    Manifest Replace 변수 ex) internal_ip, deployment_name

    X

    -o

    option Manifest File ex) jumpbox-user.yml, uaa.yml…

    X

  • 사용 예시

BOSH CLI - CPI config

bosh cpi-configs

  • 기본 Syntax

  • 설명

    Director의 cpi-conifg 구성 요소를 출력

  • 파라미터

    파라미터 명

    설명

    필수**(O/X)**

    my-env

    지정 한 Director 환경 이름 명칭

    O

  • 사용 예시

bosh update-cpi-config

  • 기본 Syntax

  • 설명

    Director의 cpi-conifg 구성 요소를 추가 하거나 수정

  • 파라미터

    파라미터 명

    설명

    필수**(O/X)**

    my-env

    지정 한 Director 환경 이름 명칭

    O

    config.yml

    property Manifest 파일

    O

    -v

    Manifest Replace 변수 ex) internal_ip, deployment_name

    X

    -o

    option Manifest File ex) jumpbox-user.yml, uaa.yml…

    X

  • 사용 예시

BOSH CLI – Deployments

bosh deployments

  • 기본 Syntax

  • 설명

    디렉터가 설치 한 전체 배포 목록을 출력.

  • 파라미터

    파라미터 명

    설명

    필수**(O/X)**

    my-env

    지정 한 Director 환경 이름 명칭

    O

  • 파라미터

bosh deployment

  • 기본 Syntax

  • 설명

    디렉터가 지정한 이름의 배포 목록 조회

  • 파라미터

    파라미터 명

    설명

    필수**(O/X)**

    my-env

    지정 한 Director 환경 이름 명칭

    O

    my-dep

    배포 명 지정

    O

  • 사용 예시

bosh deploy

  • 기본 Syntax

  • 설명

    디렉터가 지정 한 배포명의 Manifest 파일를 통한 VM 설치

  • 파라미터

    파라미터 명

    설명

    필수**(O/X)**

    my-env

    지정 한 Director 환경 이름 명칭

    O

    my-dep

    배포 명

    O

    -v

    Manifest Replace 변수 ex) internal_ip, deployment_name

    X

    -o

    option Manifest File ex) jumpbox-user.yml, uaa.yml…

    X

    manifest.yml

    배포 Manifest 파일

    O

  • 사용 예시

bosh delete-deployment

  • 기본 Syntax

  • 설명

    디렉터가 지정 한 배포명의 VM을 삭제 한다.

  • 파라미터

    파라미터 명

    설명

    필수**(O/X)**

    my-env

    지정 한 Director 환경 이름 명칭

    O

    my-dep

    배포 명

    O

    --force

    다양한 오류 (IaaS, blobstore, database)를 무시 지정

    X

  • 사용 예시

bosh manifest

  • 기본 Syntax

  • 설명

    디렉터가 지정 한 배포명의 Manifest 파일을 출력 한다.

  • 파라미터

    파라미터 명

    설명

    필수**(O/X)**

    my-env

    지정 한 Director 환경 이름 명칭

    O

    my-dep

    배포 명

    O

  • 사용 예시

bosh recreate

  • 기본 Syntax

  • 설명

    디렉터가 지정한 배포의 인스턴스에 대한 VM을 재생성 한다.

  • 파라미터

    파라미터 명

    설명

    필수**(O/X)**

    my-env

    지정 한 Director 환경 이름 명칭

    O

    my-dep

    배포 명 지정

    O

    group[/instance-id]

    그룹 또는 그룹과 인스턴스 아이디

    X

    --fix

    응답 하지 않는 VM을 대체

    X

    --skip-drain

    drain scripts를 건너 뛴다.

    X

    --canaries=

    배포 명 지정

    X

    --max-in-flight=

    Manifest의 max-in-flight 값을 덮어 쓴다.

    X

    --dry-run

    배포를 변경 하지 않고 작업을 실행 한다.

    X

  • 사용 예시

bosh restart

  • 기본 Syntax

  • 설명

    디렉터가 지정한 배포의 인스턴스에 대한 VM을 재시작 한다.

  • 파라미터

    파라미터 명

    설명

    필수**(O/X)**

    my-env

    지정 한 Director 환경 이름 명칭

    O

    my-dep

    배포 명 지정

    O

    group[/instance-id]

    그룹 또는 그룹과 인스턴스 아이디

    X

    --skip-drain

    drain scripts를 건너 뛴다.

    X

    --canaries=

    배포 명 지정

    X

    --max-in-flight=

    Manifest의 max-in-flight 값을 덮어 쓴다.

    X

  • 사용 예시

bosh start

  • 기본 Syntax

  • 설명

    디렉터가 지정한 배포의 인스턴스에 대한 VM을 시작 한다.

  • 파라미터

    파라미터 명

    설명

    필수**(O/X)**

    my-env

    지정 한 Director 환경 이름 명칭

    O

    my-dep

    배포 명 지정

    O

    group[/instance-id]

    그룹 또는 그룹과 인스턴스 아이디

    X

    --canaries=

    배포 명 지정

    X

    --max-in-flight=

    Manifest의 max-in-flight 값을 덮어 쓴다.

    X

  • 사용 예시

bosh stop

  • 기본 Syntax

  • 설명

    디렉터가 지정한 배포의 인스턴스에 대한 VM을 시작 한다.

  • 파라미터

    파라미터 명

    설명

    필수**(O/X)**

    my-env

    지정 한 Director 환경 이름 명칭

    O

    my-dep

    배포 명 지정

    O

    group[/instance-id]

    그룹 또는 그룹과 인스턴스 아이디

    X

    --canaries=

    배포 명 지정

    X

    --max-in-flight=

    Manifest의 max-in-flight 값을 덮어 쓴다.

    X

    --skip-drain

    drain scripts를 건너 뛴다.

    X

    hard

    강제로 VM 삭제, 영구 디스크는 유지

    X

  • 사용 예시

bosh ignore

  • 기본 Syntax

  • 설명

    bosh deploy와 같은 다른 명령의 영향을 받지 않도록 인스턴스를 무시

  • 파라미터

    파라미터 명

    설명

    필수**(O/X)**

    my-env

    지정 한 Director 환경 이름 명칭

    O

    my-dep

    배포 명 지정

    O

    group[/instance-id]

    그룹 또는 그룹과 인스턴스 아이디

    X

  • 사용 예시

bosh unignore

  • 기본 Syntax

  • 설명

    bosh deploy와 같은 다른 명령의 영향을받지 않도록 인스턴스를 무시하지 않는다

  • 파라미터

    파라미터 명

    설명

    필수**(O/X)**

    my-env

    지정 한 Director 환경 이름 명칭

    O

    my-dep

    배포 명 지정

    O

    group[/instance-id]

    그룹 또는 그룹과 인스턴스 아이디

    X

  • 사용 예시

bosh logs

  • 기본 Syntax

  • 설명

    하나 이상의 인스턴스에서 로그를 다운로드

  • 파라미터

    파라미터 명

    설명

    필수**(O/X)**

    my-env

    지정 한 Director 환경 이름 명칭

    O

    my-dep

    배포 명 지정

    O

    group[/instance-id]

    그룹 또는 그룹과 인스턴스 아이디

    X

    --dir

    로그의 디렉토리 지정

    X

    --job

    특정 Job의 로그 설정

    X

    --only

    로그 필터링

    X

    --agent

    bosh agent 로그만 포함

    X

    --follow

    Additional flags for following logs via SSH 로그를 실행

    X

    --num

    Additional flags for following logs via SSH 마지막 행 수를 출력

    X

    --gw

    Additional flags for following logs via SSH ssh 게이트웨이 구성

    X

    --quiet

    Additional flags for following logs via SSH 헤더 출력 생략

    X

  • 사용 예시

BOSH CLI - VMs

bosh vms

  • 기본 Syntax

  • 설명

    Director 가 관리하는 또는 deployment 의 모든 vm 조회

  • 파라미터

    파라미터 명

    설명

    필수**(O/X)**

    my-env

    지정 한 Director 환경 이름 명칭

    O

    my-dep

    배포 명 지정

    O

    --vitals

    RAM CPU disk 와 같은 vm의 기본 정보 조회

    X

  • 사용 예시

bosh delete-vms

  • 기본 Syntax

  • 설명

    인스턴스의 Lifecycle을 거치지 않고 VM을 삭제

  • 파라미터

    파라미터 명

    설명

    필수**(O/X)**

    my-env

    지정 한 Director 환경 이름 명칭

    O

    my-dep

    배포 명 지정

    O

    cid

    인스턴스 아이디 지정

    X

  • 사용 예시

BOSH CLI - Disks

bosh disks

  • 기본 Syntax

  • 설명

    Director가 관리하는 또는 deployment의 모든 disk 조회

  • 파라미터

    파라미터 명

    설명

    필수**(O/X)**

    my-env

    지정 한 Director 환경 이름 명칭

    O

    my-dep

    배포 명 지정

    O

    --orphaned

    사용하지 않는 DISK를 나열

    X

  • 사용 예시

bosh attach-disk

  • 기본 Syntax

  • 설명

    인스턴스에 disk attach. 만약 attach된 disk 가 있다면 가장 최근 attach 된 disk를 replace한다.

  • 파라미터

    파라미터 명

    설명

    필수**(O/X)**

    my-env

    지정 한 Director 환경 이름 명칭

    O

    my-dep

    배포 명 지정

    O

    --orphaned

    사용하지 않는 DISK를 나열

    X

    group/instance-id

    그룹 또는 그룹과 인스턴스 아이디

    X

  • 사용 예시

bosh delete-disk

  • 기본 Syntax

  • 설명

    사용하지 않는 disk 삭제

  • 파라미터

    파라미터 명

    설명

    필수**(O/X)**

    my-env

    지정 한 Director 환경 이름 명칭

    O

    my-dep

    배포 명 지정

    O

    --cid

    삭제 할 DISK 아이디 지정

    X

  • 사용 예시

BOSH CLI - SSH

bosh ssh

  • 기본 Syntax

  • 설명

    인스턴스 한개 또는 여러 개에 SSH설정

  • 파라미터

    파라미터 명

    설명

    필수**(O/X)**

    my-env

    지정 한 Director 환경 이름 명칭

    O

    my-dep

    배포 명 지정

    O

    -c

    커맨드 라인 설정

    X

    destination

    SSH 목적지 지정 그룹 또는 그룹과 인스턴스 아이디

    X

    --opts

    ssh에 옵션을 전달 ex) 포트 포워딩

    X

    --gw-*

    SSH 게이트웨이를 구성

    X

    -r, --recursive

    directory의 반복 복사 허용

    X

  • 사용 예시

bosh scp

  • 기본 Syntax

  • 설명

    인스턴스로 또는 인스턴스로 부터 SCP (to/from)설정

  • 파라미터

    파라미터 명

    설명

    필수**(O/X)**

    my-env

    지정 한 Director 환경 이름 명칭

    O

    my-dep

    배포 명 지정

    O

    src/dst:

    복사 받을 script.sh file 경로

    O

    src/dst:

    복사 될 script.sh file 경로

    O

    -r, --recursive

    directory의 반복 복사 허용

    X

    --gw-*

    SCP gateway설정

    X

  • 사용 예시

BOSH CLI - Errands

bosh errands

  • 기본 Syntax

  • 설명

    deployment로 정의 된 모든 errand 목록 조회

  • 파라미터

    파라미터 명

    설명

    필수**(O/X)**

    my-env

    지정 한 Director 환경 이름 명칭

    O

    my-dep

    배포 명 지정

    O

  • 사용 예시

bosh run-errand

  • 기본 Syntax

  • 설명

    errand job 을 name 단위로 실행

  • 파라미터

    파라미터 명

    설명

    필수**(O/X)**

    my-env

    지정 한 Director 환경 이름 명칭

    O

    my-dep

    배포 명 지정

    O

    name

    실행 할 errand 이름

    O

    --keep-alive

    errand가 실행 되는 곳에서 VM 유지

    X

    --when-changed

    errand가 skip 설정: 이전에 이미 실행하였고 (성공적으로 마침) errand job 설정값이 바뀌지 않았을 경우

    X

    --download-logs

    errand log를 통채로 --logs-dir에 명시된 경로에 저장

    X

    --logs-dir=

    errand log를 저장 할 파일 경로

    X

    instance=<instance-group/instance-id> (v2.0.31+)

    errand를 실행하기위해 어떤 인스턴스를 사용할지 결정

    X

  • 사용 예시

BOSH CLI - Tasks

bosh tasks

  • 기본 Syntax

  • 설명

    활성 및 이전에 실행 한 작업에 대한 task를 출력

  • 파라미터

    파라미터 명

    설명

    필수**(O/X)**

    my-env

    지정 한 Director 환경 이름 명칭

    O

    --recent

    최근 순 4개 task 조회

    X

    num

    최근 순 조회하고 싶은 task 숫자

    X

    --all

    active tasks 모두 조회

    X

    -d, -deployment

    deployment 단위로 필터링 해서 조회

    X

  • 사용 예시

bosh task

  • 기본 Syntax

  • 설명

    task 아이디를 기준으로 상세 조회.

  • 파라미터

    파라미터 명

    설명

    필수**(O/X)**

    my-env

    지정 한 Director 환경 이름 명칭

    O

    id

    task 아이디

    O

    --debug

    Debug 로그 출력

    X

    --result

    Result 로그 출력

    X

    --event

    Event 로그 출력

    X

    --cpi

    CPI 로그 출력

    X

  • 사용 예시

bosh cancle-task

  • 기본 Syntax

  • 설명

    task 취소. 다음 checkpoint 에서 task를 취소 한다. task가 취소될 때까지 대기하지 않는다

  • 파라미터

    파라미터 명

    설명

    필수**(O/X)**

    my-env

    지정 한 Director 환경 이름 명칭

    O

    id

    task 아이디

    O

BOSH CLI - Snapshot

bosh snapshots

  • 기본 Syntax

  • 설명

    deployment의 스냅샷 목록을 출력 한다.

  • 파라미터

    파라미터 명

    설명

    필수**(O/X)**

    my-env

    지정 한 Director 환경 이름 명칭

    O

    my-dep

    배포 명 지정

    O

  • 사용 예시

bosh take-snapshot

  • 기본 Syntax

  • 설명

    특정 인스턴스 또는 deployment에 대한 스냅샷을 생성 한다.

  • 파라미터

    파라미터 명

    설명

    필수**(O/X)**

    my-env

    지정 한 Director 환경 이름 명칭

    O

    my-dep

    배포 명 지정

    O

    group/instance-id

    그룹 또는 그룹과 인스턴스 아이디

    X

  • 사용 예시

bosh delete-snapshot

  • 기본 Syntax

  • 설명

    특정 스냅샷을 삭제 한다.

  • 파라미터

    파라미터 명

    설명

    필수**(O/X)**

    my-env

    지정 한 Director 환경 이름 명칭

    O

    my-dep

    배포 명 지정

    O

    cid

    스냅샷 아이디 지정

    O

  • 사용 예시

bosh delete-snapshots

  • 기본 Syntax

  • 설명

    스냅샷을 전체 삭제 한다.

  • 파라미터

    파라미터 명

    설명

    필수**(O/X)**

    my-env

    지정 한 Director 환경 이름 명칭

    O

    my-dep

    배포 명 지정

    O

  • 사용 예시

BOSH CLI - Deployment recovery

bosh update-resurrection

  • 기본 Syntax

  • 설명

    디렉터가 지정한 환경에 대해 recovery를 활성/비활성화

  • 파라미터

    파라미터 명

    설명

    필수**(O/X)**

    my-env

    지정 한 Director 환경 이름 명칭

    O

    on/off

    활성/비활성화

    O

  • 사용 예시

bosh cloud-check

  • 기본 Syntax

  • 설명

    리소스에 대해 일관적인 검사를 하고 대화 형 복구를 허용 한다.

  • 파라미터

    파라미터 명

    설명

    필수**(O/X)**

    my-env

    지정 한 Director 환경 이름 명칭

    O

    my-dep

    배포 명 지정

    O

    --report

    Report 생성

    X

    --auto

    자동으로 Problem해결

    X

  • 사용 예시

bosh locks

  • 기본 Syntax

  • 설명

    최근 lock 목록 조회

  • 파라미터

    파라미터 명

    설명

    필수**(O/X)**

    my-env

    지정 한 Director 환경 이름 명칭

    O

  • 사용 예시

BOSH CLI - Misc

bosh clean-up

  • 기본 Syntax

  • 설명

    releases, stemcells, orphaned disks 그리고 사용되지 않는 다른 리소스를 clean up 한다

  • 파라미터

    파라미터 명

    설명

    필수**(O/X)**

    my-env

    지정 한 Director 환경 이름 명칭

    O

    --all

    orphaned disks에 강제 clean up적용

    X

  • 사용 예시

bosh help

  • 기본 Syntax

  • 설명

    사용 가능한 모든 명령어와 global option 목록 조회 각각의 command에 대해서는 -h 사용

  • 파라미터

  • 사용 예시

bosh interpolate

  • 기본 Syntax

  • 설명

    결과 값 이 sudout로 넘겨지는 Manifest.yml에 추가적으로 merge할 yml 파일이나 설정 값을 입력

  • 파라미터

    파라미터 명

    설명

    필수**(O/X)**

    -v

    수정/입력 하는 variable list

    X

    -o

    수정/입력 하는 operation file list

    X

    --vars-store path

    디렉터 접근 아이디 Key 및 각 JOB 패스워드 등이 존재하는 설정 파일 생성 위치

    X

    --path op-path

    Manifest의 해당 값 출력

    X

  • 사용 예시

Last updated

Was this helpful?