Kubernetes service CLI reference
The Kubernetes CLI reference lists commands with Quake AI-specific context.
OpenStack Magnum backs Quake AI Kubernetes. Manage clusters with the openstack coe command group. The OpenStack Magnum CLI reference documents additional subcommands and per-command options.
The commands below create, list, show, update, and delete cluster templates and clusters. They also manage node groups and cluster certificates and retrieve kubeconfig files. Replace the SCREAMING_SNAKE placeholders (CLUSTER, TEMPLATE, IMAGE, KEYPAIR, NETWORK, FLAVOR, and the others below) with your resource IDs or names.
Cluster templates#
List cluster templates#
openstack coe cluster template listShow cluster template details#
openstack coe cluster template show TEMPLATECreate a cluster template#
Provide values for --coe, --image, and --external-network. The other options are optional:
openstack coe cluster template create TEMPLATE_NAME \
--coe kubernetes \
--image IMAGE \
--external-network NETWORK \
[--keypair KEYPAIR] \
[--flavor FLAVOR] \
[--master-flavor MASTER_FLAVOR] \
[--fixed-network FIXED_NETWORK] \
[--fixed-subnet FIXED_SUBNET] \
[--network-driver NETWORK_DRIVER] \
[--volume-driver VOLUME_DRIVER] \
[--dns-nameserver DNS_NAMESERVER] \
[--docker-volume-size DOCKER_VOLUME_SIZE] \
[--docker-storage-driver DOCKER_STORAGE_DRIVER] \
[--labels KEY1=VALUE1,KEY2=VALUE2] \
[--server-type SERVER_TYPE] \
[--registry-enabled] \
[--insecure-registry INSECURE_REGISTRY] \
[--tls-disabled] \
[--public] \
[--hidden | --visible] \
[--master-lb-enabled] \
[--floating-ip-enabled | --floating-ip-disabled] \
[--tags TAGS]--tls-disabled, --public, --hidden, --visible, --registry-enabled, --master-lb-enabled, --floating-ip-enabled, and --floating-ip-disabled are boolean flags that take no value.
Update a cluster template#
Apply one or more JSON-patch attribute changes. OPERATION is one of add, replace, or remove, and each change is a path=value pair:
openstack coe cluster template update TEMPLATE OPERATION PATH=VALUE [PATH=VALUE ...]For example, to replace a label on the template:
openstack coe cluster template update mytemplate replace labels/kube_tag=v1.28.9Delete a cluster template#
openstack coe cluster template delete TEMPLATEQuake AI cluster template labels#
Quake AI's public cluster templates carry labels that govern node and load balancer behavior. Set them through --labels at create time, or change them later with cluster template update:
| Label | Purpose |
|---|---|
kube_tag | Kubernetes version tag for the cluster |
container_runtime | Container runtime for cluster nodes |
boot_volume_size | Boot volume size, in GB, for cluster nodes |
master_lb_floating_ip_enabled | Whether the control plane load balancer receives a floating IP |
Clusters#
List clusters#
openstack coe cluster listShow cluster details#
openstack coe cluster show CLUSTERCreate a cluster#
Provide a value for --cluster-template. The other options are optional:
openstack coe cluster create CLUSTER_NAME \
--cluster-template TEMPLATE \
[--master-count MASTER_COUNT] \
[--node-count WORKER_COUNT] \
[--keypair KEYPAIR] \
[--flavor FLAVOR] \
[--master-flavor MASTER_FLAVOR] \
[--docker-volume-size DOCKER_VOLUME_SIZE] \
[--labels KEY1=VALUE1,KEY2=VALUE2] \
[--merge-labels] \
[--fixed-network FIXED_NETWORK] \
[--fixed-subnet FIXED_SUBNET] \
[--floating-ip-enabled | --floating-ip-disabled] \
[--master-lb-enabled | --master-lb-disabled] \
[--timeout TIMEOUT] \
[--discovery-url DISCOVERY_URL]--merge-labels merges the labels you pass with the labels already set on the cluster template, instead of replacing them.
Delete a cluster#
openstack coe cluster delete CLUSTERUpdate a cluster#
Apply one or more JSON-patch attribute changes. OPERATION is one of add, replace, or remove, and each change is a path=value pair:
openstack coe cluster update [--rollback] CLUSTER OPERATION PATH=VALUE [PATH=VALUE ...]For example, to replace a label:
openstack coe cluster update mycluster replace labels=foo=bar--rollback is a boolean flag and takes no value. Pass it to have Magnum roll the cluster back if the update fails. Use openstack coe cluster resize to change the worker node count.
Resize a cluster#
Scale the number of worker nodes without changing other cluster properties:
openstack coe cluster resize [--nodegroup NODEGROUP] [--nodes-to-remove SERVER_UUID] CLUSTER NODE_COUNTPass --nodegroup to resize a specific node group. Repeat --nodes-to-remove to name the servers to drop when scaling down.
Get cluster kubeconfig#
Retrieve the kubeconfig file for kubectl access:
openstack coe cluster config CLUSTERThis writes a config file to the current directory. Set KUBECONFIG or merge it with your existing config to use it:
export KUBECONFIG=$(pwd)/config
kubectl get nodesNode groups#
Node groups manage worker pools within a cluster. The default worker pool is itself a node group.
List node groups#
openstack coe nodegroup list CLUSTERShow node group details#
openstack coe nodegroup show CLUSTER NODEGROUPCreate a node group#
openstack coe nodegroup create CLUSTER NODEGROUP_NAME \
--node-count NODE_COUNT \
--flavor FLAVORUpdate a node group#
Apply one or more JSON-patch attribute changes. OPERATION is one of add, replace, or remove:
openstack coe nodegroup update CLUSTER NODEGROUP OPERATION PATH=VALUE [PATH=VALUE ...]Delete a node group#
openstack coe nodegroup delete CLUSTER NODEGROUPCluster certificate authority operations#
Show the cluster certificate authority certificate#
openstack coe ca show CLUSTERSign a certificate signing request#
openstack coe ca sign CLUSTER CSR_FILECSR_FILE: Path to the certificate signing request file.
Rotate cluster certificate authority certificates#
openstack coe ca rotate CLUSTEROther commands#
Show cluster statistics#
Report cluster statistics for a project. Provide PROJECT to select the project:
openstack coe stats list PROJECTShow Magnum quotas#
openstack coe quotas listThis runs at admin scope. Project-scoped users receive an HTTP 403 response.
Output columns#
Select specific columns with --column COL1 --column COL2 or change the output format with -f json, -f csv, or -f table (default).
openstack coe cluster list#
| Column | Description |
|---|---|
| uuid | Cluster UUID |
| name | Cluster name |
| keypair | Associated SSH key pair |
| node_count | Number of worker nodes |
| master_count | Number of control plane nodes |
| status | Cluster state (CREATE_COMPLETE, CREATE_IN_PROGRESS, CREATE_FAILED) |
| health_status | Cluster health state |
openstack coe cluster template list#
| Column | Description |
|---|---|
| uuid | Template UUID |
| name | Template name |
| tags | User-defined tags |