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

<h1>How to use KUDO CLI Commands</h1> <p>KUDO 및 Package 관리를 위한 KUDO CLI를 정리한다.</p> <h2>Global Flags</h2> <ul> <li><p><strong>Global Flags</strong> : 전체 명령들에 사용할 수 있는 전역 옵션들</p> <ul> <li><code>--home <path></code> : Kudo 설정이 있는 Home Directory 지정 (Default: "~/.kudo")</li> <li><code>--kubeconfig <path></code> : Kubernetes 설정이 있는 Home Directory 지정 (Default: "~/.kube/config")</li> <li><code>-n, --namespace <namespace></code> : 객체를 처리할 대상 Namespace (Default: "Default")</li> <li><code>--request-timeout <seconds></code> : 요청 시간 제한을 초단위로 지정 (Default: 0 - 무제한)</li> <li><code>-v <line count>, --v</code> : 상세 로그 수준을 라인단위로 지정</li> <li><code>--validate-install</code> : 명령을 실행하기 전에 KUDO 설치 여부 검증 (Default: true)</li> </ul> </li> <li><p><strong>Semi-Global Flags</strong> : 전체 명령들은 아니지만 많은 명령들에 사용할 수 있는 옵션들</p> <ul> <li><code>--help</code> : 모든 명령에 지정 가능하며, 해당 명령의 상세 정보 출력</li> <li><code>-o, --output</code> : 많은 명령들이 지원하며, "Yaml" 또는 "Json" 방식으로 출력 가능</li> <li><code>--dry-run</code> : 실제 실행하지는 않고, 점검과 준비만 처리하며, <code>--output</code> 옵션으로 대상 리소스에 대한 출력물 생성</li> </ul> </li> </ul> <h2>init</h2> <p>KUDO Server와 Client 컴포넌트의 초기화 및 업그레이드 처리</p> <pre><code class="language-bash">kubectl kudo init [options]</code></pre> <p>옵션들은 설치 및 업그레이드에 대한 변경을 위한 것으로 주로 Server를 대상으로 하며 저장되지 않기 때문에 매번 제공해야 한다.</p> <blockquote> <h2><strong>주의</strong></h2> <p>설치에 사용한 옵션들은 update / upgrade 등에도 동일하게 지정되어야 한다.</p> </blockquote> <ul> <li><p>초기화 관련 옵션</p> <ul> <li><p><code>n, --namespace <namespace></code> : KUDO 초기화를 위한 것으로 Default: "kudo-system" 이며, 특정한 값을 지정하면 KUDO Controller가 해당 네임스페이스로 설치된다. <code>지정한 사용자 정의 네임스페이스는 생성되는 것이 아니기 때문에 미리 생성</code>되어 있어야 한다.</p> </li> <li><p><code>-i, --kudo-image <image and/or version></code> : KUDO Controller image and/or Version을 지정한다.</p> </li> <li><p><code>--version <version></code> : KUDO Image의 버전을 지정한다.</p> </li> <li><p><code>--kudo-image-pull-policy <policy></code> : KUDO Controller Image pull 정책을 지정한다. (Default: "Always")</p> </li> <li><p><code>--service-account <account></code> : 기본 서비스 계정을 지정한다. 기본적으로 "kudo-manager" 계정이 cluster-admin 권한으로 생성된다. 따라서 <code>지정한 사용자 지정 계정도 이미 생성되어 있어야 하며, cluster-admin 권한을 가지고 있어야</code> 한다.</p> </li> <li><p><code>--unsafe-self-signed-webhook-ca</code> : Webhook에 대한 테스트 목적의 자체 서명 번들을 사용하도록 지정한다. 기본적으로 KUDO는 <a href="https://cert-manager.io/">cert-manager</a>가 존재하는 것으로 진행하며 설치되면 여러 버전을 지원한다.</p> </li> </ul> </li> <li><p>다른 작업 옵션 </p> <ul> <li><p><code>--upgrade</code> : 설치된 KUDO를 업그레이드 한다.</p> </li> <li><p><code>--verify</code> : 설치된 KUDO를 검증한다.</p> </li> <li><p><code>--client-only</code> : ~/.kudo 디렉터리와 Repository 설정을 초기화하며, Server 관련 어떤 리소스도 처리하지 않는다.</p> </li> <li><p><code>-w --wait</code> : KUDO Manager가 실행되고 요청을 받을 수 있는 상태일 때까지 대기한다.</p> </li> <li><p><code>--wait-timeout int</code> : --wait 옵션과 같이 사용하며 지정한 시간 (Default: 300초) 동안 대기한다.</p> </li> </ul> </li> </ul> <h2>get</h2> <p>설치된 사용자 Instances, Operators, OperatorVersions 객체를 조회한다.</p> <pre><code class="language-bash">kubectl kudo get [flags]</code></pre> <ul> <li><code>instances</code> : 설치된 모든 사용자 Instance 정보</li> <li><code>operators</code> : 설치된 모든 사용자 Operators 정보</li> <li><code>operatorversions</code> : 설치된 모든 사용자 OperatorVersions 정보</li> <li><code>all</code> : 설치된 모든 사용자 KUDO 객체들 정도 (Instances + Operators + OperatorVersions)</li> </ul> <p><code>--output yarml</code> 옵션을 사용해서 출력을 저장할 수 있다.</p> <h2>search</h2> <p>Repository에서 지정한 검색어를 포함하는 항목을 검색한다. 기본적으로 설치된 Operator의 최신 버전만 나타나며 <code>--all-versions</code>를 지정하면 설치된 모든 버전이 나타난다.</p> <pre><code class="language-bash">kubectl kudo search <검색어> [options]</code></pre> <ul> <li><code>--repo <repo name></code> : 지정한 Repository를 기준으로 검색을 수행한다. 기본 값은 KUDO Context 상의 기본 Respository (community)를 사용한다.</li> <li><code>-a, --all-versions</code> : 지정한 검색어를 포함하는 모든 버전의 Operator들을 보여준다.</li> </ul> <h2>install</h2> <p>로컬 디렉터리, 공식 Repository 또는 클러스터 내의 리소스에서 KUDO Package를 설치한다.<br>Package name은 반드시 Repository 내의 Package 이름이거나 *.tgz 포맷의 Package를 나타내는 URL 또는 Path 이거나 <code>--in-cluster 옵션</code>을 통해 이미 설치된 Operator의 이름 또는 압축 해제된 패키지 디렉터리를 지정해야 한다.<br><code>로컬 경로의 Operator를 설치할 경우는 "./", "../", "/" 를 사용</code>해야 한다. 그외는 모두 원격 Repository의 Operator name을 지정한 것으로 간주한다.</p> <pre><code class="language-bash">kubectl kudo install <operator name> [options]</code></pre> <ul> <li><p><code>--app-version <app version></code> : App 버전을 지정한다. (Default: Official Github repo기준 최신 값)</p> </li> <li><p><code>--operator-version <operator version></code> : Operator 버전을 지정한다. (Default: Official Github repo기준 최신 값)</p> </li> <li><p><code>--repo <repo name></code> : 사용할 Repository를 지정한다. (Default: Context)</p> </li> <li><p><code>--instance string</code> : 설치할 Instance 이름을 지정한다. (Default: Operator name + "-instance", ex. first-operator => first-operator-instance)</p> </li> <li><p><code>--skip-instance</code> : Instance를 제외하고 Operator와 OperatorVersion만 설치 (Default: false)</p> </li> <li><p><code>--create-namespace</code> : Namespace를 생성한다. 만일 이미 존재하는 경우라면 실패처리 된다. (Default: false)</p> </li> <li><p><code>-p, --parameter <parameter-name=parameter-value></code> : 파라미터의 이름과 값을 "="를 이용해서 지정한다. ex. -p NODE_COUNT=3, ... 또한 배열이나 Map 형식의 경우는 YAML 포맷으로 지정이 가능하다. ex. 배열은 -p PORT="[80, 443]" 으로 Map은 -p CUSTOM_LABELS="{team: dev, owner: foo}"</p> </li> <li><p><code>-P, --parameter-file <parameter yaml format file path></code> : 파라미터를 지정한 YAML 포맷 파일 경로를 지정한다. 이 파일의 최상위 요소는 반드시 매핑 형식이어야 한다. 키는 파라미터 이름이고 값은 파라미터 값이다. 이 기능은 Instance의 파라미터 값을 버전 제어로 유지하려는 경우나 Command line에 지정하기 힘들게 긴 값이나 복잡한 값을 처리할 때 유용하다. 파라미터는 --paramter-file/-P 로 지정된 파일을 먼저 읽고 --parameter/-p 로 지정된 값을 읽어서 갱신하게 된다. 즉, 파라미터 파일에 정의된 파라미터 값을 지정한 파라미터 값으로 재 정의하는 경우에 유용하게 사용할 수 있다.</p> </li> <li><p><code>--wait</code> : CLI가 설치가 완료될 때까지 대기해야 하는 경우 지정한다. (Default: false)</p> </li> <li><p><code>--wait-time <wait time seconds></code> : CLI가 최대 대기할 시간을 초 단위로 지정한다. (Default: 300초)</p> </li> <li><p><code>--in-cluster</code> : 지정되면 이미 클러스터에 설치된 Operator version에서 검색한다. 이미 설치된 Operation version은 <code>get</code> 명령을 통해서 확인할 수 있다.</p> </li> </ul> <h2>plan</h2> <h3>Status</h3> <p>지정한 Instance에 대한 Plan 상태를 나타낸다.</p> <pre><code class="language-bash">kubectl kudo plan status --instance=<instance name> [options]</code></pre> <ul> <li><code>--output yaml</code> : 결과를 YAML 포맷 파일로 출력</li> <li><code>--wait</code> : CLI가 모든 결과를 출력할 때까지 대기 (Default: false)</li> </ul> <h3>History</h3> <p>지정한 Instance에 대한 각 Plan의 History를 나타낸다.</p> <pre><code class="language-bash">kubectl kudo plan history --instance=<instance name> [options]</code></pre> <h3>tigger</h3> <p>지정한 Instance에 대해 지정한 Plan을 실행한다.</p> <pre><code class="language-bash">kubectl kudo plan trigger <plan name> --instance=<instance name> [options]</code></pre> <ul> <li><code>--wait</code> : CLI가 모든 결과를 출력할 때까지 대기 (Default: false)</li> <li><code>--wait-time <wait time second></code> : Trigger된 Plan이 완료될 때까지 대기할 최대 시간을 초 단위로 지정 (Default: 300s)</li> </ul> <h2>uninstall</h2> <p>설치된 KUDO Package의 Instance를 제거한다. 물론 연관된 Deployments, Pods 와 같은 리소스들을 제거한다. 단, OperatorVersion이나 Operator CRD는 제거하지 않는다.</p> <pre><code class="language-bash">kubectl kudo uninstall --instance=<instance name> [options]</code></pre> <blockquote> <h2><strong>주의</strong></h2> <p>이 명령은 Instance를 제거하는 것이기 때문에 데이터, 로그 파일 등의 손실이 발생하게 된다.</p> </blockquote> <h2>update</h2> <p>설치된 KUDO Operator Instance를 새로운 파라미터 값으로 갱신한다. 파라미터의 갱신은 파라미터 정의할 때 지정한 특정한 Plan을 실행시키게 된다.</p> <pre><code class="language-bash">kubectl kudo update --instance=<instance name> [options]</code></pre> <ul> <li><code>-p, --parameter <parameter-name=parameter-value></code> : 파라미터의 이름과 값을 "="를 이용해서 지정한다. ex. -p NODE_COUNT=3, ... <code>파라미터 옵션은 여러 번 중복 지정이 가능하다</code></li> <li><code>-P, --parameter-file <parameter yaml format file path></code> : 파라미터를 지정한 YAML 포맷 파일 경로를 지정한다. </li> <li><code>--wait</code> : CLI가 모든 결과를 출력할 때까지 대기 (Default: false)</li> <li><code>--wait-time <wait time second></code> : Trigger된 Plan이 완료될 때까지 대기할 최대 시간을 초 단위로 지정 (Default: 300s)</li> </ul> <h2>upgrade</h2> <p>현재 설치된 KUDO Operator Instance 버전을 새로운 버전으로 업그레이드 한다. 업그레이드하는 Operator의 이름은 Repository에 존재하는 패키지의 이름이거나 *.tgz 포맷의 경로 또는 URL 이거나 로컬의 압축 해제된 Opeartor 경로를 지정한다.</p> <p><code>로컬 경로의 Operator를 설치할 경우는 "./", "../", "/" 를 사용</code>해야 한다. 그외는 모두 원격 Repository의 Operator name을 지정한 것으로 간주한다.</p> <p>새로운 Operator 버전에 따라서 특정한 파라미터를 지정해야 할 수도 있다.</p> <pre><code class="language-bash">kubectl kudo upgrade <opeator name | path | url> --instance=<instance name> [options]</code></pre> <ul> <li><code>--app-version <app version></code> : App 버전을 지정한다. (Default: Official Github repo기준 최신 값)</li> <li><code>--operator-version <operator version></code> : Operator 버전을 지정한다. (Default: Official Github repo기준 최신 값)</li> <li><code>--repo <repo name></code> : 사용할 Repository를 지정한다. (Default: Context)</li> <li><code>-p, --parameter <parameter-name=parameter-value></code> : 파라미터의 이름과 값을 "="를 이용해서 지정한다. ex. -p NODE_COUNT=3, ... <code>파라미터 옵션은 여러 번 중복 지정이 가능하다</code></li> <li><code>-P, --parameter-file <parameter yaml format file path></code> : 파라미터를 지정한 YAML 포맷 파일 경로를 지정한다. </li> </ul> <h2>diagnostics</h2> <p>진단 기능은 진단 데이터를 수집하고 분석하는 기능을 제공한다.</p> <pre><code class="language-bash">kubectl kudo diagnostics collect --instance=<instance name> [options]</code></pre> <ul> <li><code>--log-since <timeDuration></code> : 현재 시점을 기준으로 지정한 5s, 2m, 3h 등과 같이 지정한 구간까지의 로그들을 대상으로 한다. (Default: all logs)</li> <li><code>-O, --output-directory <path></code> : 수집된 리소스들을 저장할 디렉터리 경로 지정 (Default: "diag")</li> </ul> <h2>Development Commands</h2> <p>Operator 개발자들에 유용한 명령들이다.</p> <h3>Package</h3> <p>KUDO Package와 상호 작용하는 여러 개의 서브 명령들로 구성된다.</p> <p>Operator를 패키징하거나 검증하고 파라미터들을 나열하는데 사용한다. 파라미터들과 같이 작업할 때는 지정한 URL이나 이름과 버전등으로 원격 Repository의 파라미터 변수 목록을 제공할 수 있다.</p> <ul> <li><code>add</code> : Operator Package 파일들에 새로운 컨텐츠를 추가한다.</li> <li><code>create</code> : 로컬에 구성한 KUDO Operator를 tarball 형식의 패키지로 생성한다.</li> <li><code>list</code> : Operator Package로 부터 Parameters, Plans, Tasks 왁 같은 정보들을 출력한다.</li> <li><code>new</code> : 상호 작용을 통해서 새로운 Operator를 생성한다.</li> <li><code>verify</code> : Operator Package를 검증한다.</li> </ul> <p>좀 더 자세한 사항은 해당 명령에 대한 <code>--help</code> 옵션을 지정해서 확인하면 된다.</p> <h3>Repository</h3> <p>KUDO Repositories와 상호 작용하는 여러 개의 서브 명령들로 구성된다.</p> <p>It can be used to add, remove, list, and index kudo repositories.</p> <ul> <li><code>add</code> : Operator Repository를 추가한다.</li> <li><code>context</code> : KUDO Context에 관리되는 Repository들 중에 하나를 기본 값으로 설정한다.</li> <li><code>index</code> : 지정한 KUDO Operator Package들이 존재하는 디렉터리에 색인 파일 (Index.yaml)을 생성한다.</li> <li><code>list</code> : KUDO Context에서 관리되는 Repository 리스트를 출력한다.</li> <li><code>remove</code> : Remove an operator repository</li> </ul> <p>좀 더 자세한 사항은 해당 명령에 대한 <code>--help</code> 옵션을 지정해서 확인하면 된다.</p> <h2>참고 자료</h2> <ul> <li><a href="https://kudo.dev/docs/cli/commands.html">KUDO CLI Commands</a></li> </ul>