Menu Close

Chapter 14. coe

This chapter describes the commands under the coe command.

14.1. coe ca rotate

Rotate the CA certificate for cluster to revoke access.

Usage:

openstack coe ca rotate [-h] <cluster>

Table 14.1. Positional Arguments

ValueSummary

<cluster>

Id or name of the cluster

Table 14.2. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

14.2. coe ca show

Show details about the CA certificate for a cluster.

Usage:

openstack coe ca show [-h] <cluster>

Table 14.3. Positional Arguments

ValueSummary

<cluster>

Id or name of the cluster

Table 14.4. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

14.3. coe ca sign

Generate the CA certificate for a cluster.

Usage:

openstack coe ca sign [-h] <cluster> <csr>

Table 14.5. Positional Arguments

ValueSummary

<cluster>

Id or name of the cluster

<csr>

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

Table 14.6. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

14.4. coe cluster config

Get Configuration for a Cluster

Usage:

openstack coe cluster config [-h] [--dir <dir>] [--force] <cluster>

Table 14.7. Positional Arguments

ValueSummary

<cluster>

The name or uuid of cluster to update

Table 14.8. Optional Arguments

ValueSummary

--force

Overwrite files if existing.

-h, --help

Show this help message and exit

--dir <dir>

Directory to save the certificate and config files.

14.5. coe cluster create

Create a cluster

Usage:

openstack coe cluster create [-h] --cluster-template <cluster-template>
                                    [--discovery-url <discovery-url>]
                                    [--docker-volume-size <docker-volume-size>]
                                    [--labels <KEY1=VALUE1,KEY2=VALUE2;KEY3=VALUE3...>]
                                    [--keypair <keypair>]
                                    [--master-count <master-count>]
                                    [--node-count <node-count>]
                                    [--timeout <timeout>]
                                    [--master-flavor <master-flavor>]
                                    [--flavor <flavor>]
                                    <name>

Table 14.9. Positional Arguments

ValueSummary

<name>

Name of the cluster to create.

Table 14.10. Optional Arguments

ValueSummary

--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.

--discovery-url <discovery-url>

Specifies custom delivery url for node discovery.

--cluster-template <cluster-template>

Id or name of the cluster template.

--master-flavor <master-flavor>

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

--timeout <timeout>

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

--flavor <flavor>

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

--master-count <master-count>

The number of master nodes for the cluster.

--keypair <keypair>

Uuid or name of the keypair to use.

-h, --help

Show this help message and exit

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

The size in gb for the docker volume to use.

--node-count <node-count>

The cluster node count.

14.6. coe cluster delete

Delete a cluster

Usage:

openstack coe cluster delete [-h] <cluster> [<cluster> ...]

Table 14.11. Positional Arguments

ValueSummary

<cluster>

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

Table 14.12. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

14.7. coe cluster list

List clusters

Usage:

openstack coe cluster list [-h] [-f {csv,json,table,value,yaml}]
                                  [-c COLUMN] [--max-width <integer>]
                                  [--fit-width] [--print-empty] [--noindent]
                                  [--quote {all,minimal,none,nonnumeric}]
                                  [--sort-column SORT_COLUMN]
                                  [--limit <limit>] [--sort-key <sort-key>]
                                  [--sort-dir <sort-dir>]

Table 14.13. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--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

Table 14.14. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 14.15. Output Formatters

ValueSummary

output formatter options-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

Table 14.16. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 14.17. Optional Arguments

ValueSummary

--limit <limit>

Maximum number of clusters to return

-h, --help

Show this help message and exit

--sort-key <sort-key>

Column to sort results by

--sort-dir <sort-dir>

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

14.8. coe cluster show

Show a Cluster

Usage:

openstack coe cluster show [-h] [-f {json,shell,table,value,yaml}]
                                  [-c COLUMN] [--max-width <integer>]
                                  [--fit-width] [--print-empty] [--noindent]
                                  [--prefix PREFIX]
                                  <cluster>

Table 14.18. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--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

Table 14.19. Positional Arguments

ValueSummary

<cluster>

Id or name of the cluster to show.

Table 14.20. Output Formatters

ValueSummary

output formatter options-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

Table 14.21. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 14.22. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 14.23. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

14.9. coe cluster template create

Create a Cluster Template.

Usage:

openstack coe cluster template create [-h]
                                             [-f {json,shell,table,value,yaml}]
                                             [-c COLUMN]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             [--noindent] [--prefix PREFIX]
                                             --coe <coe> --image <image>
                                             --external-network
                                             <external-network>
                                             [--keypair <keypair>]
                                             [--fixed-network <fixed-network>]
                                             [--fixed-subnet <fixed-subnet>]
                                             [--network-driver <network-driver>]
                                             [--volume-driver <volume-driver>]
                                             [--dns-nameserver <dns-nameserver>]
                                             [--flavor <flavor>]
                                             [--master-flavor <master-flavor>]
                                             [--docker-volume-size <docker-volume-size>]
                                             [--docker-storage-driver <docker-storage-driver>]
                                             [--http-proxy <http-proxy>]
                                             [--https-proxy <https-proxy>]
                                             [--no-proxy <no-proxy>]
                                             [--labels <KEY1=VALUE1,KEY2=VALUE2;KEY3=VALUE3...>]
                                             [--tls-disabled] [--public]
                                             [--registry-enabled]
                                             [--server-type <server-type>]
                                             [--master-lb-enabled]
                                             [--floating-ip-enabled]
                                             [--floating-ip-disabled]
                                             <name>

Table 14.24. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--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

Table 14.25. Positional Arguments

ValueSummary

<name>

Name of the cluster template to create.

Table 14.26. Output Formatters

ValueSummary

output formatter options-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

Table 14.27. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 14.28. Optional Arguments

ValueSummary

--master-lb-enabled

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

--fixed-subnet <fixed-subnet>

The private neutron subnet name to connect to cluster.

--fixed-network <fixed-network>

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

--https-proxy <https-proxy>

The https_proxy address to use for nodes in cluster.

--registry-enabled

Enable docker registry in the cluster

--volume-driver <volume-driver>

The volume driver name for instantiating container volume.

--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.

--network-driver <network-driver>

The network driver name for instantiating container networks.

--tls-disabled

Disable tls in the cluster.

--master-flavor <master-flavor>

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

--floating-ip-enabled

Indicates whether created clusters should have a floating ip.

-h, --help

Show this help message and exit

--flavor <flavor>

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

--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.

--coe <coe>

Specify the container orchestration engine to use.

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

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

--keypair <keypair>

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

--public

Make cluster template public.

--server-type <server-type>

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

--http-proxy <http-proxy>

The http_proxy address to use for nodes in cluster.

--no-proxy <no-proxy>

The no_proxy address to use for nodes in cluster.

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

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

--dns-nameserver <dns-nameserver>

The dns nameserver to use for this cluster template.

--floating-ip-disabled

Disables floating ip creation on the new cluster

Table 14.29. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

14.10. coe cluster template delete

Delete a Cluster Template.

Usage:

openstack coe cluster template delete [-h]
                                             <cluster-templates>
                                             [<cluster-templates> ...]

Table 14.30. Positional Arguments

ValueSummary

<cluster-templates>

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

Table 14.31. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

14.11. coe cluster template list

List Cluster Templates.

Usage:

openstack coe cluster template list [-h]
                                           [-f {csv,json,table,value,yaml}]
                                           [-c COLUMN] [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--noindent]
                                           [--quote {all,minimal,none,nonnumeric}]
                                           [--sort-column SORT_COLUMN]
                                           [--limit <limit>]
                                           [--sort-key <sort-key>]
                                           [--sort-dir <sort-dir>]
                                           [--fields <fields>]

Table 14.32. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--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

Table 14.33. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 14.34. Output Formatters

ValueSummary

output formatter options-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

Table 14.35. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 14.36. Optional Arguments

ValueSummary

--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

--limit <limit>

Maximum number of cluster templates to return

-h, --help

Show this help message and exit

--sort-key <sort-key>

Column to sort results by

--sort-dir <sort-dir>

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

14.12. coe cluster template show

Show a Cluster Template.

Usage:

openstack coe cluster template show [-h]
                                           [-f {json,shell,table,value,yaml}]
                                           [-c COLUMN] [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--noindent] [--prefix PREFIX]
                                           <cluster-template>

Table 14.37. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--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

Table 14.38. Positional Arguments

ValueSummary

<cluster-template>

Id or name of the cluster template to show.

Table 14.39. Output Formatters

ValueSummary

output formatter options-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

Table 14.40. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 14.41. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 14.42. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

14.13. coe cluster template update

Update a Cluster Template.

Usage:

openstack coe cluster template update [-h]
                                             [-f {json,shell,table,value,yaml}]
                                             [-c COLUMN]
                                             [--max-width <integer>]
                                             [--fit-width] [--print-empty]
                                             [--noindent] [--prefix PREFIX]
                                             <cluster-template> <op>
                                             <path=value> [<path=value> ...]

Table 14.43. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--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

Table 14.44. Positional Arguments

ValueSummary

<op>

Operations: one of add, replace or remove

<cluster-template>

The name or uuid of cluster template to update

<path=value>

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

Table 14.45. Output Formatters

ValueSummary

output formatter options-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

Table 14.46. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 14.47. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 14.48. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

14.14. coe cluster update

Update a Cluster

Usage:

openstack coe cluster update [-h] [--rollback]
                                    <cluster> <op> <path=value>
                                    [<path=value> ...]

Table 14.49. Positional Arguments

ValueSummary

<cluster>

The name or uuid of cluster to update

<path=value>

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

<op>

Operations: one of add, replace or remove

Table 14.50. Optional Arguments

ValueSummary

--rollback

Rollback cluster on update failure.

-h, --help

Show this help message and exit

14.15. coe quotas create

Create a quota.

Usage:

openstack coe quotas create [-h] --project-id <project-id> --resource
                                   <resource> [--hard-limit <hard-limit>]

Table 14.51. Optional Arguments

ValueSummary

--project-id <project-id>

Project id

-h, --help

Show this help message and exit

--hard-limit <hard-limit>

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

--resource <resource>

Resource name.

14.16. coe quotas delete

Delete specified resource quota.

Usage:

openstack coe quotas delete [-h] --project-id <project-id> --resource
                                   <resource>

Table 14.52. Optional Arguments

ValueSummary

--project-id <project-id>

Project id

-h, --help

Show this help message and exit

--resource <resource>

Resource name.

14.17. coe quotas list

Print a list of available quotas.

Usage:

openstack coe quotas list [-h] [--marker <marker>] [--limit <limit>]
                                 [--sort-key <sort-key>]
                                 [--sort-dir <sort-dir>] [--all-tenants]

Table 14.53. Optional Arguments

ValueSummary

--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.

--limit <limit>

Maximum number of quotas to return.

-h, --help

Show this help message and exit

--marker <marker>

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

14.18. coe quotas show

Show details about the given project resource quota.

Usage:

openstack coe quotas show [-h] --project-id <project-id> --resource
                                 <resource>

Table 14.54. Optional Arguments

ValueSummary

--project-id <project-id>

Project id

-h, --help

Show this help message and exit

--resource <resource>

Resource name.

14.19. coe quotas update

Update information about the given project resource quota.

Usage:

openstack coe quotas update [-h] --project-id <project-id> --resource
                                   <resource> [--hard-limit <hard-limit>]

Table 14.55. Optional Arguments

ValueSummary

--project-id <project-id>

Project id

-h, --help

Show this help message and exit

--hard-limit <hard-limit>

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

--resource <resource>

Resource name.

14.20. coe service list

Print a list of Magnum services.

Usage:

openstack coe service list [-h] [-f {csv,json,table,value,yaml}]
                                  [-c COLUMN] [--max-width <integer>]
                                  [--fit-width] [--print-empty] [--noindent]
                                  [--quote {all,minimal,none,nonnumeric}]
                                  [--sort-column SORT_COLUMN]

Table 14.56. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--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

Table 14.57. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 14.58. Output Formatters

ValueSummary

output formatter options-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

Table 14.59. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 14.60. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

14.21. coe stats list

Show stats for the given project_id

Usage:

openstack coe stats list [-h] <project>

Table 14.61. Positional Arguments

ValueSummary

<project>

Project id

Table 14.62. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit