openstack-manuals/doc/cli-reference/source/magnum.rst

Container Infrastructure Management service (magnum) command-line client

The magnum client is the command-line interface (CLI) for the Container Infrastructure Management service (magnum) API and its extensions.

This chapter documents magnum version 2.5.0.

For help on a specific magnum command, enter:

$ magnum help COMMAND

magnum usage

usage: magnum [--version] [--debug] [--os-cache]
              [--os-region-name <region-name>] [--os-auth-url <auth-auth-url>]
              [--os-user-id <auth-user-id>] [--os-username <auth-username>]
              [--os-user-domain-id <auth-user-domain-id>]
              [--os-user-domain-name <auth-user-domain-name>]
              [--os-project-id <auth-project-id>]
              [--os-project-name <auth-project-name>]
              [--os-project-domain-id <auth-project-domain-id>]
              [--os-project-domain-name <auth-project-domain-name>]
              [--os-token <auth-token>] [--os-password <auth-password>]
              [--service-type <service-type>]
              [--os-endpoint-type <os-endpoint-type>]
              [--os-cloud <auth-cloud>]
              [--magnum-api-version <magnum-api-ver>]
              [--os-cacert <ca-certificate>]
              [--os-endpoint-override <endpoint-override>] [--insecure]
              [--profile HMAC_KEY]
              <subcommand> ...

Subcommands:

baymodel-create

Create a baymodel. (Deprecated in favor of cluster-template-create.)

baymodel-delete

Delete specified baymodel. (Deprecated in favor of cluster-template-delete.)

baymodel-list

Print a list of baymodels. (Deprecated in favor of cluster-template-list.)

baymodel-show

Show details about the given baymodel. (Deprecated in favor of cluster-template-show.)

baymodel-update

Updates one or more baymodel attributes. (Deprecated in favor of cluster-template-update.)

bay-config

Configure native client to access bay. You can source the output of this command to get the native client of the corresponding COE configured to access the bay. Example: eval $(magnum bay-config <bay-name>). (Deprecated in favor of cluster-config.)

bay-create

Create a bay. (Deprecated in favor of cluster-create.)

bay-delete

Delete specified bay. (Deprecated in favor of cluster-delete.)

bay-list

Print a list of available bays. (Deprecated in favor of cluster-list.)

bay-show

Show details about the given bay. (Deprecated in favor of cluster-show.)

bay-update

Update information about the given bay. (Deprecated in favor of cluster-update.)

ca-show

Show details about the CA certificate for a bay or cluster.

ca-sign

Generate the CA certificate for a bay or cluster.

cluster-config

Configure native client to access cluster. You can source the output of this command to get the native client of the corresponding COE configured to access the cluster. Example: eval $(magnum cluster-config <cluster-name>).

cluster-create

Create a cluster.

cluster-delete

Delete specified cluster.

cluster-list

Print a list of available clusters.

cluster-show

Show details about the given cluster.

cluster-update

Update information about the given cluster.

cluster-template-create

Create a cluster template.

cluster-template-delete

Delete specified cluster template.

cluster-template-list

Print a list of cluster templates.

cluster-template-show

Show details about the given cluster template.

cluster-template-update

Updates one or more cluster template attributes.

service-list

Print a list of magnum services.

stats-list

Show stats for the given project_id

bash-completion

Prints arguments for bash-completion. Prints all of the commands and options to stdout so that the magnum.bash_completion script doesn't have to hard code them.

help

Display help about this program or one of its subcommands.

magnum optional arguments

--version

show program's version number and exit

--debug

Print debugging output.

--os-cache

Use the auth token cache. Defaults to False if env[OS_CACHE] is not set.

--os-region-name <region-name>

Region name. Default= env[OS_REGION_NAME].

--os-auth-url <auth-auth-url>

Defaults to env[OS_AUTH_URL].

--os-user-id <auth-user-id>

Defaults to env[OS_USER_ID].

--os-username <auth-username>

Defaults to env[OS_USERNAME].

--os-user-domain-id <auth-user-domain-id>

Defaults to env[OS_USER_DOMAIN_ID].

--os-user-domain-name <auth-user-domain-name>

Defaults to env[OS_USER_DOMAIN_NAME].

--os-project-id <auth-project-id>

Defaults to env[OS_PROJECT_ID].

--os-project-name <auth-project-name>

Defaults to env[OS_PROJECT_NAME].

--os-project-domain-id <auth-project-domain-id>

Defaults to env[OS_PROJECT_DOMAIN_ID].

--os-project-domain-name <auth-project-domain-name>

Defaults to env[OS_PROJECT_DOMAIN_NAME].

--os-token <auth-token>

Defaults to env[OS_TOKEN].

--os-password <auth-password>

Defaults to env[OS_PASSWORD].

--service-type <service-type>

Defaults to container-infra for all actions.

--os-endpoint-type <os-endpoint-type>

Defaults to env[OS_ENDPOINT_TYPE]

--os-cloud <auth-cloud>

Defaults to env[OS_CLOUD].

--magnum-api-version <magnum-api-ver>

Accepts "api", defaults to env[MAGNUM_API_VERSION].

--os-cacert <ca-certificate>

Specify a CA bundle file to use in verifying a TLS (https) server certificate. Defaults to env[OS_CACERT].

--os-endpoint-override <endpoint-override>

Use this API endpoint instead of the Service Catalog.

--insecure

Do not verify https connections

--profile HMAC_KEY

HMAC key to use for encrypting context data for performance profiling of operation. This key should be the value of the HMAC key configured for the OSprofiler middleware in nova; it is specified in the Nova configuration file at "/etc/nova/nova.conf". Without the key, profiling will not be triggered even if OSprofiler is enabled on the server side.

magnum ca-show

usage: magnum ca-show [--bay <bay>] [--cluster <cluster>]

Show details about the CA certificate for a bay or cluster.

Optional arguments:

--bay <bay>

ID or name of the bay.

--cluster <cluster>

ID or name of the cluster.

magnum ca-sign

usage: magnum ca-sign [--csr <csr>] [--bay <bay>] [--cluster <cluster>]

Generate the CA certificate for a bay or cluster.

Optional arguments:

--csr <csr>

File path of the csr file to send to Magnum to get signed.

--bay <bay>

ID or name of the bay.

--cluster <cluster>

ID or name of the cluster.

magnum cluster-config

usage: magnum cluster-config [--dir <dir>] [--force] <cluster>

Configure native client to access cluster. You can source the output of this command to get the native client of the corresponding COE configured to access the cluster. Example: eval $(magnum cluster-config <cluster-name>).

Positional arguments:

<cluster>

ID or name of the cluster to retrieve config.

Optional arguments:

--dir <dir>

Directory to save the certificate and config files.

--force

Overwrite files if existing.

magnum cluster-create

usage: magnum cluster-create [--keypair-id <keypair> | --keypair <keypair>]
                             [--name <name>] --cluster-template
                             <cluster_template> [--node-count <node-count>]
                             [--master-count <master-count>]
                             [--discovery-url <discovery-url>]
                             [--timeout <timeout>]

Create a cluster.

Optional arguments:

--keypair-id <keypair>

UUID or name of the keypair to use for this cluster. This parameter is deprecated and will be removed in a future release. Use --keypair instead.

--keypair <keypair>

UUID or name of the keypair to use for this cluster.

--name <name>

Name of the cluster to create.

--cluster-template <cluster_template>

ID or name of the cluster template.

--node-count <node-count>

The cluster node count.

--master-count <master-count>

The number of master nodes for the cluster.

--discovery-url <discovery-url>

Specifies custom discovery url for node discovery.

--timeout <timeout>

The timeout for cluster creation in minutes. The default is 60 minutes.

magnum cluster-delete

usage: magnum cluster-delete <cluster> [<cluster> ...]

Delete specified cluster.

Positional arguments:

<cluster>

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

magnum cluster-list

usage: magnum cluster-list [--marker <marker>] [--limit <limit>]
                           [--sort-key <sort-key>] [--sort-dir <sort-dir>]
                           [--fields <fields>]

Print a list of available clusters.

Optional arguments:

--marker <marker>

The last cluster UUID of the previous page; displays list of clusters after "marker".

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

--fields <fields>

Comma-separated list of fields to display. Available fields: uuid, name, cluster_template_id, stack_id, status, master_count, node_count, links, create_timeout

magnum cluster-show

usage: magnum cluster-show [--long] <cluster>

Show details about the given cluster.

Positional arguments:

<cluster>

ID or name of the cluster to show.

Optional arguments:

--long

Display extra associated cluster template info.

magnum cluster-template-create

usage: magnum cluster-template-create
                                      [--keypair-id <keypair> | --keypair <keypair>]
                                      (--external-network-id <external-network> | --external-network <external-network>)
                                      [--master-flavor-id <master-flavor> | --master-flavor <master-flavor>]
                                      [--flavor-id <flavor> | --flavor <flavor>]
                                      (--image-id <image> | --image <image>)
                                      [--name <name>] --coe <coe>
                                      [--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>]
                                      [--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]

Create a cluster template.

Optional arguments:

--keypair-id <keypair>

The name or UUID of the SSH keypair to load into the Cluster nodes. This parameter is deprecated and will be removed in a future release. Use --keypair instead.

--keypair <keypair>

The name or UUID of the SSH keypair to load into the Cluster nodes.

--external-network-id <external-network>

The external Neutron network name or UUID to connect to this Cluster Template. This parameter is deprecated and will be removed in a future release. Use --external-network instead.

--external-network <external-network>

The external Neutron network name or UUID to connect to this Cluster Template.

--master-flavor-id <master-flavor>

The nova flavor name or UUID to use when launching the master node of the Cluster. This parameter is deprecated and will be removed in a future release. Use --master-flavor instead.

--master-flavor <master-flavor>

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

--flavor-id <flavor>

The nova flavor name or UUID to use when launching the Cluster. This parameter is deprecated and will be removed in a future release. Use --flavor instead.

--flavor <flavor>

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

--image-id <image>

The name or UUID of the base image to customize for the Cluster. This parameter is deprecated and will be removed in a future release. Use --image instead.

--image <image>

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

--name <name>

Name of the cluster template to create.

--coe <coe>

Specify the Container Orchestration Engine to use.

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

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

magnum cluster-template-delete

usage: magnum cluster-template-delete <cluster_templates>
                                      [<cluster_templates> ...]

Delete specified cluster template.

Positional arguments:

<cluster_templates>

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

magnum cluster-template-list

usage: magnum cluster-template-list [--limit <limit>] [--sort-key <sort-key>]
                                    [--sort-dir <sort-dir>]
                                    [--fields <fields>]

Print a list of cluster templates.

Optional arguments:

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

magnum cluster-template-show

usage: magnum cluster-template-show <cluster_template>

Show details about the given cluster template.

Positional arguments:

<cluster_template>

ID or name of the cluster template to show.

magnum cluster-template-update

usage: magnum cluster-template-update <cluster_template> <op> <path=value>
                                      [<path=value> ...]

Updates one or more cluster template attributes.

Positional arguments:

<cluster_template>

UUID or name of cluster template

<op>

Operations: 'add', 'replace' or 'remove'

<path=value>

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

magnum cluster-update

usage: magnum cluster-update [--rollback]
                             <cluster> <op> <path=value> [<path=value> ...]

Update information about the given cluster.

Positional arguments:

<cluster>

UUID or name of cluster

<op>

Operations: 'add', 'replace' or 'remove'

<path=value>

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

Optional arguments:

--rollback

Rollback cluster on update failure.

magnum service-list

usage: magnum service-list

Print a list of magnum services.

magnum stats-list

usage: magnum stats-list [--project-id <project-id>]

Show stats for the given project_id

Optional arguments:

--project-id <project-id>

Project ID