> For the complete documentation index, see [llms.txt](https://cocktailcloud.gitbook.io/cube/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://cocktailcloud.gitbook.io/cube/reference/apis.md).

# cubectl

## 개요

`cubectl` 은 `cubectl.toml` 에 지정된 설정 값을 기반으로 쿠버네티스 클러스터를 프로비저닝하고 관련 툴을 설치하는 Command Line Interface 입니다.

### 구조

`cubectl` command 구조는 다음과 같습니다.

```
cubectl/
├── create
├── destroy
│   ├── cluster
│   ├── registry
│   ├── localrepo
│   └── storage
├── update
├── update-kubeconfig
├── upgrade
├── config
│   ├── view
│   ├── new
│   └── sync
│── addon
│   ├── list
│   ├── enable
│   └── disable
│── push
│   ├── registry
│   └── localrepo
│── preflight
│   └── auto
├── version
└── help
```

## 목차

* [create](/cube/reference/apis/create.md) : 쿠버네티스 클러스터를 프로비저닝하고 사설 저장소(harbor), 스토리지 서버(NFS) 툴 설치합니다.
* [destroy](/cube/reference/apis/destroy.md) : 프로비저닝된 쿠버네티스 클러스터, 사설 저장소(harbor), 스토리지 서버(NFS) 툴 제거합니다.
* [update](/cube/reference/apis/update.md) : 쿠버네티스 노드를 추가,삭제 합니다.
* [update-kubeconfig](/cube/reference/apis/update-kubeconfig.md) : 쿠버네티스 클러스터의 KUBECONFIG 파일을 저장합니다.
* [upgrade](/cube/reference/apis/upgrade.md) : 쿠버네티스 클러스터 버전을 업그레이드 합니다.
* [config](/cube/reference/apis/config.md) : 설정 정보 파일인 `cubectl.toml` 생성/조회하거나 프로비저닝된 쿠버네티스 클러스터와 `cubectl.toml` 파일을 동기화 합니다.
* [addon](/cube/reference/apis/addon.md) : 애드온 어플리케이션을 배포합니다.
* [push](https://github.com/kore3lab/cubectl/blob/prod/docs/user/apis/push.md) : 컨테이너 이미지를 레지스트리에 push 합니다, OS 패키지를 local repository에 push하고 재구성합니다.
* [preflight](/cube/reference/apis/preflight.md) : 네트워크 환경을 확인합니다.(port scan)
* [version](https://github.com/kore3lab/cubectl/blob/prod/docs/user/apis/version.md) : CLI 버전 정보를 조회합니다.
* [help](https://github.com/kore3lab/cubectl/blob/prod/docs/user/apis/help.md) : 애플리케이션 내의 모든 명령어에 대한 도움말을 제공합니다.