Chapter 16. coe
This chapter describes the commands under the coe
command.
16.1. coe ca rotate Copy linkLink copied to clipboard!
Rotate the CA certificate for cluster to revoke access.
Usage:
openstack coe ca rotate [-h] <cluster>
openstack coe ca rotate [-h] <cluster>
Value | Summary |
---|---|
<cluster> | Id or name of the cluster |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
16.2. coe ca show Copy linkLink copied to clipboard!
Show details about the CA certificate for a cluster.
Usage:
openstack coe ca show [-h] <cluster>
openstack coe ca show [-h] <cluster>
Value | Summary |
---|---|
<cluster> | Id or name of the cluster |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
16.3. coe ca sign Copy linkLink copied to clipboard!
Generate the CA certificate for a cluster.
Usage:
openstack coe ca sign [-h] <cluster> <csr>
openstack coe ca sign [-h] <cluster> <csr>
Value | Summary |
---|---|
<cluster> | Id or name of the cluster |
<csr> | File path of csr file to send to magnum to get signed. |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
16.4. coe cluster config Copy linkLink copied to clipboard!
Get Configuration for a Cluster
Usage:
openstack coe cluster config [-h] [--dir <dir>] [--force] [--output-certs] [--use-certificate] [--use-keystone] <cluster>
openstack coe cluster config [-h] [--dir <dir>] [--force]
[--output-certs] [--use-certificate]
[--use-keystone]
<cluster>
Value | Summary |
---|---|
<cluster> | The name or uuid of cluster to update |
Value | Summary |
---|---|
-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. |
16.5. coe cluster create Copy linkLink copied to clipboard!
Create a cluster
Usage:
Value | Summary |
---|---|
<name> | Name of the cluster to create. |
Value | Summary |
---|---|
-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. |
16.6. coe cluster delete Copy linkLink copied to clipboard!
Delete a cluster
Usage:
openstack coe cluster delete [-h] <cluster> [<cluster> ...]
openstack coe cluster delete [-h] <cluster> [<cluster> ...]
Value | Summary |
---|---|
<cluster> | Id or name of the cluster(s) to delete. |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
16.7. coe cluster list Copy linkLink copied to clipboard!
List clusters
Usage:
Value | Summary |
---|---|
-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". |
Value | Summary |
---|---|
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 |
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--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. |
16.8. coe cluster show Copy linkLink copied to clipboard!
Show a Cluster
Usage:
openstack coe cluster show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <cluster>
openstack coe cluster show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--noindent] [--prefix PREFIX]
[--max-width <integer>] [--fit-width]
[--print-empty]
<cluster>
Value | Summary |
---|---|
<cluster> | Id or name of the cluster to show. |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Value | Summary |
---|---|
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 |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
a format a UNIX shell can parse (variable="value")--prefix PREFIX | Add a prefix to all variable names |
Value | Summary |
---|---|
--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. |
16.9. coe cluster template create Copy linkLink copied to clipboard!
Create a Cluster Template.
Usage:
Value | Summary |
---|---|
<name> | Name of the cluster template to create. |
Value | Summary |
---|---|
-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 |
Value | Summary |
---|---|
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 |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
a format a UNIX shell can parse (variable="value")--prefix PREFIX | Add a prefix to all variable names |
Value | Summary |
---|---|
--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. |
16.10. coe cluster template delete Copy linkLink copied to clipboard!
Delete a Cluster Template.
Usage:
openstack coe cluster template delete [-h] <cluster-templates> [<cluster-templates> ...]
openstack coe cluster template delete [-h]
<cluster-templates>
[<cluster-templates> ...]
Value | Summary |
---|---|
<cluster-templates> | Id or name of the (cluster template)s to delete. |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
16.11. coe cluster template list Copy linkLink copied to clipboard!
List Cluster Templates.
Usage:
Value | Summary |
---|---|
-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 |
Value | Summary |
---|---|
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 |
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--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. |
16.12. coe cluster template show Copy linkLink copied to clipboard!
Show a Cluster Template.
Usage:
Value | Summary |
---|---|
<cluster-template> | Id or name of the cluster template to show. |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Value | Summary |
---|---|
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 |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
a format a UNIX shell can parse (variable="value")--prefix PREFIX | Add a prefix to all variable names |
Value | Summary |
---|---|
--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. |
16.13. coe cluster template update Copy linkLink copied to clipboard!
Update a Cluster Template.
Usage:
Value | Summary |
---|---|
<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) |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Value | Summary |
---|---|
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 |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
a format a UNIX shell can parse (variable="value")--prefix PREFIX | Add a prefix to all variable names |
Value | Summary |
---|---|
--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. |
16.14. coe cluster update Copy linkLink copied to clipboard!
Update a Cluster
Usage:
openstack coe cluster update [-h] [--rollback] <cluster> <op> <path=value> [<path=value> ...]
openstack coe cluster update [-h] [--rollback]
<cluster> <op> <path=value>
[<path=value> ...]
Value | Summary |
---|---|
<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) |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--rollback | Rollback cluster on update failure. |
16.15. coe quotas create Copy linkLink copied to clipboard!
Create a quota.
Usage:
openstack coe quotas create [-h] --project-id <project-id> --resource <resource> [--hard-limit <hard-limit>]
openstack coe quotas create [-h] --project-id <project-id> --resource
<resource> [--hard-limit <hard-limit>]
Value | Summary |
---|---|
-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) |
16.16. coe quotas delete Copy linkLink copied to clipboard!
Delete specified resource quota.
Usage:
openstack coe quotas delete [-h] --project-id <project-id> --resource <resource>
openstack coe quotas delete [-h] --project-id <project-id> --resource
<resource>
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--project-id <project-id> | Project id |
--resource <resource> | Resource name. |
16.17. coe quotas list Copy linkLink copied to clipboard!
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]
openstack coe quotas list [-h] [--marker <marker>] [--limit <limit>]
[--sort-key <sort-key>]
[--sort-dir <sort-dir>] [--all-tenants]
Value | Summary |
---|---|
-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. |
16.18. coe quotas show Copy linkLink copied to clipboard!
Show details about the given project resource quota.
Usage:
openstack coe quotas show [-h] --project-id <project-id> --resource <resource>
openstack coe quotas show [-h] --project-id <project-id> --resource
<resource>
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--project-id <project-id> | Project id |
--resource <resource> | Resource name. |
16.19. coe quotas update Copy linkLink copied to clipboard!
Update information about the given project resource quota.
Usage:
openstack coe quotas update [-h] --project-id <project-id> --resource <resource> [--hard-limit <hard-limit>]
openstack coe quotas update [-h] --project-id <project-id> --resource
<resource> [--hard-limit <hard-limit>]
Value | Summary |
---|---|
-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) |
16.20. coe service list Copy linkLink copied to clipboard!
Print a list of Magnum services.
Usage:
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Value | Summary |
---|---|
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 |
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--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. |
16.21. coe stats list Copy linkLink copied to clipboard!
Show stats for the given project_id
Usage:
openstack coe stats list [-h] <project>
openstack coe stats list [-h] <project>
Value | Summary |
---|---|
<project> | Project id |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |