# cubectl.toml

`cubectl.toml` 은 클러스터를 설치하고 업데이트기 위한 기본 설정 정보 파일입니다.

"cubectl config new" 명령으로 template 파일을 생성할 수 있습니다.

```
$ bin/cubectl config new

# cat config/cubectl.toml
```

## 구조

`cubectl.toml` 의 설정 구조는 아래와 같습니다.

```
cubectl.toml/
├── cubectl
│   ├── cluster-name
│   ├── cubectl.cert_validity_days
│   ├── install-dir
│   ├── closed-network
│   ├── local-repository-install
│   └── local-repository-url
├── kubernetes
│   ├── version
│   ├── kube-proxy-mode
│   ├── service-cidr
│   ├── pod-cidr
│   ├── node-port-range
│   ├── audit-log-enable
│   ├── api-sans
│   └── calico
│       └── vxlan-mode
├── node-pool
│   ├── data-dir
│   ├── ssh-port
│   ├── master
│   │   ├── ip
│   │   ├── private-ip
│   │   ├── haproxy-install
│   │   ├── lb-ip
│   │   └── lb-port
│   └── node
│       ├── ip
│       └── private-ip
├── private-registry
│   ├── install
│   ├── registry-ip
│   ├── private-ip
│   ├── registry-domain
│   ├── data-dir
│   ├── public-cert
│   └── cert-file
│       ├── ssl-certificate
│       └── ssl-certificate-key
└── shared-storage
    ├── install
    ├── storage-ip
    ├── private-ip
    └── volume-dir
```

## 목차

* [cubectl](cubectl-toml/cubectl) : `cubectl` 실행 환경을 정의합니다.
* [kubernetes](cubectl-toml/kubernetes) : 쿠버네티스 관련 속성을 정의합니다.
* [node-pool](cubectl-toml/node-pool) : 노드 IP와 같은 노드관련 속성을 정의합니다.
* [local-repository](cubectl-toml/local-repository) : local repository 설치 여부 및 관련 속성을 정의합니다.
* [private-registry](https://github.com/kore3lab/cubectl/blob/prod/docs/user/cubectl-toml/private-regisrty.md) : 사설 저장소 설치 여부 및 관련 속성을 정의합니다.
* [shared-storage](cubectl-toml/shared-storage) : 스토리지 서버(Network File System) 설치 여부 및 관련 속성을 정의합니다.
