[Kubernetes - Operator] KUDO CLI 명령어 정리

How to use KUDO CLI Commands

KUDO 및 Package 관리를 위한 KUDO CLI를 정리한다.

Global Flags

• Global Flags : 전체 명령들에 사용할 수 있는 전역 옵션들

  • --home <path> : Kudo 설정이 있는 Home Directory 지정 (Default: "~/.kudo")
  • --kubeconfig <path> : Kubernetes 설정이 있는 Home Directory 지정 (Default: "~/.kube/config")
  • -n, --namespace <namespace> : 객체를 처리할 대상 Namespace (Default: "Default")
  • --request-timeout <seconds> : 요청 시간 제한을 초단위로 지정 (Default: 0 - 무제한)
  • -v <line count>, --v : 상세 로그 수준을 라인단위로 지정
  • --validate-install : 명령을 실행하기 전에 KUDO 설치 여부 검증 (Default: true)

• Semi-Global Flags : 전체 명령들은 아니지만 많은 명령들에 사용할 수 있는 옵션들

  • --help : 모든 명령에 지정 가능하며, 해당 명령의 상세 정보 출력
  • -o, --output : 많은 명령들이 지원하며, "Yaml" 또는 "Json" 방식으로 출력 가능
  • --dry-run : 실제 실행하지는 않고, 점검과 준비만 처리하며, --output 옵션으로 대상 리소스에 대한 출력물 생성

init

KUDO Server와 Client 컴포넌트의 초기화 및 업그레이드 처리

kubectl kudo init [options]

옵션들은 설치 및 업그레이드에 대한 변경을 위한 것으로 주로 Server를 대상으로 하며 저장되지 않기 때문에 매번 제공해야 한다.

주의

설치에 사용한 옵션들은 update / upgrade 등에도 동일하게 지정되어야 한다.

• 초기화 관련 옵션

  • n, --namespace <namespace> : KUDO 초기화를 위한 것으로 Default: "kudo-system" 이며, 특정한 값을 지정하면 KUDO Controller가 해당 네임스페이스로 설치된다. 지정한 사용자 정의 네임스페이스는 생성되는 것이 아니기 때문에 미리 생성되어 있어야 한다.

  • -i, --kudo-image <image and/or version> : KUDO Controller image and/or Version을 지정한다.

  • --version <version> : KUDO Image의 버전을 지정한다.

  • --kudo-image-pull-policy <policy> : KUDO Controller Image pull 정책을 지정한다. (Default: "Always")

  • --service-account <account> : 기본 서비스 계정을 지정한다. 기본적으로 "kudo-manager" 계정이 cluster-admin 권한으로 생성된다. 따라서 지정한 사용자 지정 계정도 이미 생성되어 있어야 하며, cluster-admin 권한을 가지고 있어야 한다.

  • --unsafe-self-signed-webhook-ca : Webhook에 대한 테스트 목적의 자체 서명 번들을 사용하도록 지정한다. 기본적으로 KUDO는 cert-manager가 존재하는 것으로 진행하며 설치되면 여러 버전을 지원한다.

• 다른 작업 옵션

  • --upgrade : 설치된 KUDO를 업그레이드 한다.

  • --verify : 설치된 KUDO를 검증한다.

  • --client-only : ~/.kudo 디렉터리와 Repository 설정을 초기화하며, Server 관련 어떤 리소스도 처리하지 않는다.

  • -w --wait : KUDO Manager가 실행되고 요청을 받을 수 있는 상태일 때까지 대기한다.

  • --wait-timeout int : --wait 옵션과 같이 사용하며 지정한 시간 (Default: 300초) 동안 대기한다.

get

설치된 사용자 Instances, Operators, OperatorVersions 객체를 조회한다.

kubectl kudo get [flags]

• instances : 설치된 모든 사용자 Instance 정보
• operators : 설치된 모든 사용자 Operators 정보
• operatorversions : 설치된 모든 사용자 OperatorVersions 정보
• all : 설치된 모든 사용자 KUDO 객체들 정도 (Instances + Operators + OperatorVersions)

--output yarml 옵션을 사용해서 출력을 저장할 수 있다.

search

Repository에서 지정한 검색어를 포함하는 항목을 검색한다. 기본적으로 설치된 Operator의 최신 버전만 나타나며 --all-versions를 지정하면 설치된 모든 버전이 나타난다.

kubectl kudo search <검색어> [options]

• --repo <repo name> : 지정한 Repository를 기준으로 검색을 수행한다. 기본 값은 KUDO Context 상의 기본 Respository (community)를 사용한다.
• -a, --all-versions : 지정한 검색어를 포함하는 모든 버전의 Operator들을 보여준다.

install

로컬 디렉터리, 공식 Repository 또는 클러스터 내의 리소스에서 KUDO Package를 설치한다.
Package name은 반드시 Repository 내의 Package 이름이거나 *.tgz 포맷의 Package를 나타내는 URL 또는 Path 이거나 --in-cluster 옵션을 통해 이미 설치된 Operator의 이름 또는 압축 해제된 패키지 디렉터리를 지정해야 한다.
로컬 경로의 Operator를 설치할 경우는 "./", "../", "/" 를 사용해야 한다. 그외는 모두 원격 Repository의 Operator name을 지정한 것으로 간주한다.

kubectl kudo install <operator name> [options]

• --app-version <app version> : App 버전을 지정한다. (Default: Official Github repo기준 최신 값)

• --operator-version <operator version> : Operator 버전을 지정한다. (Default: Official Github repo기준 최신 값)

• --repo <repo name> : 사용할 Repository를 지정한다. (Default: Context)

• --instance string : 설치할 Instance 이름을 지정한다. (Default: Operator name + "-instance", ex. first-operator => first-operator-instance)

• --skip-instance : Instance를 제외하고 Operator와 OperatorVersion만 설치 (Default: false)

• --create-namespace : Namespace를 생성한다. 만일 이미 존재하는 경우라면 실패처리 된다. (Default: false)

• -p, --parameter <parameter-name=parameter-value> : 파라미터의 이름과 값을 "="를 이용해서 지정한다. ex. -p NODE_COUNT=3, ... 또한 배열이나 Map 형식의 경우는 YAML 포맷으로 지정이 가능하다. ex. 배열은 -p PORT="[80, 443]" 으로 Map은 -p CUSTOM_LABELS="{team: dev, owner: foo}"

• -P, --parameter-file <parameter yaml format file path> : 파라미터를 지정한 YAML 포맷 파일 경로를 지정한다. 이 파일의 최상위 요소는 반드시 매핑 형식이어야 한다. 키는 파라미터 이름이고 값은 파라미터 값이다. 이 기능은 Instance의 파라미터 값을 버전 제어로 유지하려는 경우나 Command line에 지정하기 힘들게 긴 값이나 복잡한 값을 처리할 때 유용하다. 파라미터는 --paramter-file/-P 로 지정된 파일을 먼저 읽고 --parameter/-p 로 지정된 값을 읽어서 갱신하게 된다. 즉, 파라미터 파일에 정의된 파라미터 값을 지정한 파라미터 값으로 재 정의하는 경우에 유용하게 사용할 수 있다.

• --wait : CLI가 설치가 완료될 때까지 대기해야 하는 경우 지정한다. (Default: false)

• --wait-time <wait time seconds> : CLI가 최대 대기할 시간을 초 단위로 지정한다. (Default: 300초)

• --in-cluster : 지정되면 이미 클러스터에 설치된 Operator version에서 검색한다. 이미 설치된 Operation version은 get 명령을 통해서 확인할 수 있다.

plan

Status

지정한 Instance에 대한 Plan 상태를 나타낸다.

kubectl kudo plan status --instance=<instance name> [options]

• --output yaml : 결과를 YAML 포맷 파일로 출력
• --wait : CLI가 모든 결과를 출력할 때까지 대기 (Default: false)

History

지정한 Instance에 대한 각 Plan의 History를 나타낸다.

kubectl kudo plan history --instance=<instance name> [options]

tigger

지정한 Instance에 대해 지정한 Plan을 실행한다.

kubectl kudo plan trigger <plan name> --instance=<instance name> [options]

• --wait : CLI가 모든 결과를 출력할 때까지 대기 (Default: false)
• --wait-time <wait time second> : Trigger된 Plan이 완료될 때까지 대기할 최대 시간을 초 단위로 지정 (Default: 300s)

uninstall

설치된 KUDO Package의 Instance를 제거한다. 물론 연관된 Deployments, Pods 와 같은 리소스들을 제거한다. 단, OperatorVersion이나 Operator CRD는 제거하지 않는다.

kubectl kudo uninstall --instance=<instance name> [options]

주의

이 명령은 Instance를 제거하는 것이기 때문에 데이터, 로그 파일 등의 손실이 발생하게 된다.

update

설치된 KUDO Operator Instance를 새로운 파라미터 값으로 갱신한다. 파라미터의 갱신은 파라미터 정의할 때 지정한 특정한 Plan을 실행시키게 된다.

kubectl kudo update --instance=<instance name> [options]

• -p, --parameter <parameter-name=parameter-value> : 파라미터의 이름과 값을 "="를 이용해서 지정한다. ex. -p NODE_COUNT=3, ... 파라미터 옵션은 여러 번 중복 지정이 가능하다
• -P, --parameter-file <parameter yaml format file path> : 파라미터를 지정한 YAML 포맷 파일 경로를 지정한다.
• --wait : CLI가 모든 결과를 출력할 때까지 대기 (Default: false)
• --wait-time <wait time second> : Trigger된 Plan이 완료될 때까지 대기할 최대 시간을 초 단위로 지정 (Default: 300s)

upgrade

현재 설치된 KUDO Operator Instance 버전을 새로운 버전으로 업그레이드 한다. 업그레이드하는 Operator의 이름은 Repository에 존재하는 패키지의 이름이거나 *.tgz 포맷의 경로 또는 URL 이거나 로컬의 압축 해제된 Opeartor 경로를 지정한다.

로컬 경로의 Operator를 설치할 경우는 "./", "../", "/" 를 사용해야 한다. 그외는 모두 원격 Repository의 Operator name을 지정한 것으로 간주한다.

새로운 Operator 버전에 따라서 특정한 파라미터를 지정해야 할 수도 있다.

kubectl kudo upgrade <opeator name | path | url> --instance=<instance name> [options]

• --app-version <app version> : App 버전을 지정한다. (Default: Official Github repo기준 최신 값)
• --operator-version <operator version> : Operator 버전을 지정한다. (Default: Official Github repo기준 최신 값)
• --repo <repo name> : 사용할 Repository를 지정한다. (Default: Context)
• -p, --parameter <parameter-name=parameter-value> : 파라미터의 이름과 값을 "="를 이용해서 지정한다. ex. -p NODE_COUNT=3, ... 파라미터 옵션은 여러 번 중복 지정이 가능하다
• -P, --parameter-file <parameter yaml format file path> : 파라미터를 지정한 YAML 포맷 파일 경로를 지정한다.

diagnostics

진단 기능은 진단 데이터를 수집하고 분석하는 기능을 제공한다.

kubectl kudo diagnostics collect --instance=<instance name> [options]

• --log-since <timeDuration> : 현재 시점을 기준으로 지정한 5s, 2m, 3h 등과 같이 지정한 구간까지의 로그들을 대상으로 한다. (Default: all logs)
• -O, --output-directory <path> : 수집된 리소스들을 저장할 디렉터리 경로 지정 (Default: "diag")

Development Commands

Operator 개발자들에 유용한 명령들이다.

Package

KUDO Package와 상호 작용하는 여러 개의 서브 명령들로 구성된다.

Operator를 패키징하거나 검증하고 파라미터들을 나열하는데 사용한다. 파라미터들과 같이 작업할 때는 지정한 URL이나 이름과 버전등으로 원격 Repository의 파라미터 변수 목록을 제공할 수 있다.

• add : Operator Package 파일들에 새로운 컨텐츠를 추가한다.
• create : 로컬에 구성한 KUDO Operator를 tarball 형식의 패키지로 생성한다.
• list : Operator Package로 부터 Parameters, Plans, Tasks 왁 같은 정보들을 출력한다.
• new : 상호 작용을 통해서 새로운 Operator를 생성한다.
• verify : Operator Package를 검증한다.

좀 더 자세한 사항은 해당 명령에 대한 --help 옵션을 지정해서 확인하면 된다.

Repository

KUDO Repositories와 상호 작용하는 여러 개의 서브 명령들로 구성된다.

It can be used to add, remove, list, and index kudo repositories.

• add : Operator Repository를 추가한다.
• context : KUDO Context에 관리되는 Repository들 중에 하나를 기본 값으로 설정한다.
• index : 지정한 KUDO Operator Package들이 존재하는 디렉터리에 색인 파일 (Index.yaml)을 생성한다.
• list : KUDO Context에서 관리되는 Repository 리스트를 출력한다.
• remove : Remove an operator repository

좀 더 자세한 사항은 해당 명령에 대한 --help 옵션을 지정해서 확인하면 된다.

참고 자료

• KUDO CLI Commands