Skip to content

Kubernetes service CLI Reference

See https://docs.openstack.org/magnum/latest/cli/index.html for more information about commands and details for each command.

These commands allow you to create, list, show details of, update, and delete cluster templates and clusters in your project, as well as manage cluster certificates. The <template_id_or_name>, <cluster_id_or_name>, <image_id_or_name>, <keypair_name>, <network_id_or_name>, and <flavor_id_or_name> in the commands are placeholders that should be replaced with the actual IDs or names of the resources.

List cluster templates

Bash
openstack coe cluster template list

Show cluster template details

Bash
openstack coe cluster template show <template_id_or_name>

Create a cluster template

Bash
openstack coe cluster template create <template_name> --image <image_id_or_name> --keypair <keypair_name> --external-network <network_id_or_name> --flavor <flavor_id_or_name> --coe <orchestration_engine>
- <orchestration_engine>: The container orchestration engine to use (e.g., kubernetes, swarm, mesos).

Delete a cluster template

Bash
openstack coe cluster template delete <template_id_or_name>

List clusters

Bash
openstack coe cluster list

Show cluster details

Bash
openstack coe cluster show <cluster_id_or_name>

Create a cluster

Bash
openstack coe cluster create <cluster_name> --cluster-template <template_id_or_name> --master-count <master_node_count> --node-count <worker_node_count>

Delete a cluster

Bash
openstack coe cluster delete <cluster_id_or_name>

Update a cluster

Bash
openstack coe cluster update <cluster_id_or_name> --rollback <True_or_False> --node-count <new_worker_node_count>

List cluster certificates

Bash
openstack coe cluster certificate list <cluster_id_or_name>

Show cluster certificate

bash openstack coe cluster certificate show <cluster_id_or_name>

Rotate cluster certificates

Bash
openstack coe cluster certificate rotate <cluster_id_or_name>