Chapter 14. coe

<cluster>

Id or name of the cluster

-h, --help

Show this help message and exit

<cluster>

Id or name of the cluster

-h, --help

Show this help message and exit

<cluster>

Id or name of the cluster

<csr>

File path of csr file to send to magnum to get signed.

-h, --help

Show this help message and exit

<cluster>

The name or uuid of cluster to update

-h, --help

Show this help message and exit

--dir <dir>

Directory to save the certificate and config files.

--force

Overwrite files if existing.

--output-certs

Output certificates in separate files.

--use-certificate

Use certificate in config files.

--use-keystone

Use keystone token in config files.

<name>

Name of the cluster to create.

-h, --help

Show this help message and exit

--cluster-template <cluster-template>

Id or name of the cluster template.

--discovery-url <discovery-url>

Specifies custom delivery url for node discovery.

--docker-volume-size <docker-volume-size>

The size in gb for the docker volume to use.

--labels <KEY1=VALUE1,KEY2=VALUE2;KEY3=VALUE3…​>

Arbitrary labels in the form of key=valuepairs to associate with a cluster template. May be used multiple times.

--keypair <keypair>

Uuid or name of the keypair to use.

--master-count <master-count>

The number of master nodes for the cluster.

--node-count <node-count>

The cluster node count.

--timeout <timeout>

The timeout for cluster creation time. the default is 60 minutes.

--master-flavor <master-flavor>

The nova flavor name or uuid to use when launching the master node of the Cluster.

--flavor <flavor>

The nova flavor name or uuid to use when launching the Cluster.

--fixed-network <fixed-network>

The private neutron network name to connect to this Cluster template.

--fixed-subnet <fixed-subnet>

The private neutron subnet name to connect to cluster.

--floating-ip-enabled

Indicates whether created clusters should have a floating ip.

--floating-ip-disabled

Disables floating ip creation on the new cluster

<cluster>

Id or name of the cluster(s) to delete.

-h, --help

Show this help message and exit

-h, --help

Show this help message and exit

--limit <limit>

Maximum number of clusters to return

--sort-key <sort-key>

Column to sort results by

--sort-dir <sort-dir>

Direction to sort. "asc" or "desc".

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

--noindent

Whether to disable indenting the json

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

<cluster>

The name or uuid of cluster to update

node_count

Desired node count of the cluser.

-h, --help

Show this help message and exit

--nodes-to-remove <Server UUID>

Server id of the nodes to be removed. repeat to addmore server ID

--nodegroup <nodegroup>

The name or uuid of the nodegroup of current cluster.

<cluster>

Id or name of the cluster to show.

-h, --help

Show this help message and exit

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

<name>

Name of the cluster template to create.

-h, --help

Show this help message and exit

--coe <coe>

Specify the container orchestration engine to use.

--image <image>

The name or uuid of the base image to customize for the Cluster.

--external-network <external-network>

The external neutron network name or uuid to connect to this Cluster Template.

--keypair <keypair>

The name or uuid of the ssh keypair to load into the Cluster nodes.

--fixed-network <fixed-network>

The private neutron network name to connect to this Cluster model.

--fixed-subnet <fixed-subnet>

The private neutron subnet name to connect to cluster.

--network-driver <network-driver>

The network driver name for instantiating container networks.

--volume-driver <volume-driver>

The volume driver name for instantiating container volume.

--dns-nameserver <dns-nameserver>

The dns nameserver to use for this cluster template.

--flavor <flavor>

The nova flavor name or uuid to use when launching the Cluster.

--master-flavor <master-flavor>

The nova flavor name or uuid to use when launching the master node of the Cluster.

--docker-volume-size <docker-volume-size>

Specify the number of size in gb for the docker volume to use.

--docker-storage-driver <docker-storage-driver>

Select a docker storage driver. supported: devicemapper, overlay. Default: devicemapper

--http-proxy <http-proxy>

The http_proxy address to use for nodes in cluster.

--https-proxy <https-proxy>

The https_proxy address to use for nodes in cluster.

--no-proxy <no-proxy>

The no_proxy address to use for nodes in cluster.

--labels <KEY1=VALUE1,KEY2=VALUE2;KEY3=VALUE3…​>

Arbitrary labels in the form of key=value pairs to associate with a cluster template. May be used multiple times.

--tls-disabled

Disable tls in the cluster.

--public

Make cluster template public.

--registry-enabled

Enable docker registry in the cluster

--server-type <server-type>

Specify the server type to be used for example vm. for this release default server type will be vm.

--master-lb-enabled

Indicates whether created clusters should have a load balancer for master nodes or not.

--floating-ip-enabled

Indicates whether created clusters should have a floating ip.

--floating-ip-disabled

Disables floating ip creation on the new cluster

--hidden

Indicates the cluster template should be hidden.

--visible

Indicates the cluster template should be visible.

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

<cluster-templates>

Id or name of the (cluster template)s to delete.

-h, --help

Show this help message and exit

-h, --help

Show this help message and exit

--limit <limit>

Maximum number of cluster templates to return

--sort-key <sort-key>

Column to sort results by

--sort-dir <sort-dir>

Direction to sort. "asc" or "desc".

--fields <fields>

Comma-separated list of fields to display. available fields: uuid, name, coe, image_id, public, link, apiserver_port, server_type, tls_disabled, registry_enabled

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

--noindent

Whether to disable indenting the json

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

<cluster-template>

Id or name of the cluster template to show.

-h, --help

Show this help message and exit

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

<cluster-template>

The name or uuid of cluster template to update

<op>

Operations: one of add, replace or remove

<path=value>

Attributes to add/replace or remove (only path is necessary on remove)

-h, --help

Show this help message and exit

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

<cluster>

The name or uuid of cluster to update

<op>

Operations: one of add, replace or remove

<path=value>

Attributes to add/replace or remove (only path is necessary on remove)

-h, --help

Show this help message and exit

--rollback

Rollback cluster on update failure.

<cluster>

The name or uuid of cluster to update

cluster_template

The new cluster template id will be upgraded to.

-h, --help

Show this help message and exit

--max-batch-size <max_batch_size>

The max batch size for upgrading each time.

--nodegroup <nodegroup>

The name or uuid of the nodegroup of current cluster.

<cluster>

Name of the nodegroup to create.

<name>

Name of the nodegroup to create.

-h, --help

Show this help message and exit

--docker-volume-size <docker-volume-size>

The size in gb for the docker volume to use.

--labels <KEY1=VALUE1,KEY2=VALUE2;KEY3=VALUE3…​>

Arbitrary labels in the form of key=valuepairs to associate with a nodegroup. May be used multiple times.

--node-count <node-count>

The nodegroup node count.

--min-nodes <min-nodes>

The nodegroup minimum node count.

--max-nodes <max-nodes>

The nodegroup maximum node count.

--role <role>

The role of the nodegroup

--image <image>

The name or uuid of the base image to customize for the NodeGroup.

--flavor <flavor>

The nova flavor name or uuid to use when launching the nodes in this NodeGroup.

<cluster>

Id or name of the cluster where the nodegroup(s) belong(s).

<nodegroup>

Id or name of the nodegroup(s) to delete.

-h, --help

Show this help message and exit

<cluster>

Id or name of the cluster where the nodegroup belongs.

-h, --help

Show this help message and exit

--limit <limit>

Maximum number of nodegroups to return

--sort-key <sort-key>

Column to sort results by

--sort-dir <sort-dir>

Direction to sort. "asc" or "desc".

--role <role>

List the nodegroups in the cluster with this role

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

--noindent

Whether to disable indenting the json

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

<cluster>

Id or name of the cluster where the nodegroup belongs.

<nodegroup>

Id or name of the nodegroup to show.

-h, --help

Show this help message and exit

-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--noindent

Whether to disable indenting the json

--prefix PREFIX

Add a prefix to all variable names

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

<cluster>

Id or name of the cluster where the nodegroup belongs.

<nodegroup>

The name or uuid of cluster to update

<op>

Operations: one of add, replace or remove

<path=value>

Attributes to add/replace or remove (only path is necessary on remove)

-h, --help

Show this help message and exit

-h, --help

Show this help message and exit

--project-id <project-id>

Project id

--resource <resource>

Resource name.

--hard-limit <hard-limit>

Max resource limit (default: hard-limit=1)

-h, --help

Show this help message and exit

--project-id <project-id>

Project id

--resource <resource>

Resource name.

-h, --help

Show this help message and exit

--marker <marker>

The last quota uuid of the previous page; displays list of quotas after "marker".

--limit <limit>

Maximum number of quotas to return.

--sort-key <sort-key>

Column to sort results by.

--sort-dir <sort-dir>

Direction to sort. "asc" or "desc".

--all-tenants

Flag to indicate list all tenant quotas.

-h, --help

Show this help message and exit

--project-id <project-id>

Project id

--resource <resource>

Resource name.

-h, --help

Show this help message and exit

--project-id <project-id>

Project id

--resource <resource>

Resource name.

--hard-limit <hard-limit>

Max resource limit (default: hard-limit=1)

-h, --help

Show this help message and exit

-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}

The output format, defaults to table

-c COLUMN, --column COLUMN

Specify the column(s) to include, can be repeated

--sort-column SORT_COLUMN

Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

--noindent

Whether to disable indenting the json

--max-width <integer>

Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.

--fit-width

Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable

--print-empty

Print empty table if there is no data to show.

<project>

Project id

-h, --help

Show this help message and exit