[cli-ref] Update python-magnumclient to 2.3.0
Change-Id: I8378d0b2d59e93791d111b5be217bc2d52d29db8
This commit is contained in:
KATO Tomoyuki
parent
112da47d2f
commit
eec8f5c516
@ -9,7 +9,7 @@ Container Infrastructure Management service command-line client
|
|||||||
The magnum client is the command-line interface (CLI) for
|
The magnum client is the command-line interface (CLI) for
|
||||||
the Container Infrastructure Management service API and its extensions.
|
the Container Infrastructure Management service API and its extensions.
|
||||||
|
|
||||||
This chapter documents :command:`magnum` version ``2.2.0``.
|
This chapter documents :command:`magnum` version ``2.3.0``.
|
||||||
|
|
||||||
For help on a specific :command:`magnum` command, enter:
|
For help on a specific :command:`magnum` command, enter:
|
||||||
|
|
||||||
@ -25,20 +25,21 @@ magnum usage
|
|||||||
.. code-block:: console
|
.. code-block:: console
|
||||||
|
|
||||||
usage: magnum [--version] [--debug] [--os-cache]
|
usage: magnum [--version] [--debug] [--os-cache]
|
||||||
[--os-region-name <region-name>] [--service-type <service-type>]
|
[--os-region-name <region-name>] [--os-auth-url <auth-auth-url>]
|
||||||
[--endpoint-type <endpoint-type>]
|
[--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>]
|
[--magnum-api-version <magnum-api-ver>]
|
||||||
[--os-cacert <ca-certificate>] [--bypass-url <bypass-url>]
|
[--os-cacert <ca-certificate>]
|
||||||
[--insecure] [--os-auth-system <auth-system>]
|
[--os-endpoint-override <endpoint-override>] [--insecure]
|
||||||
[--os-username <username>] [--os-password <password>]
|
|
||||||
[--os-tenant-id <tenant-id>] [--os-tenant-name <tenant-name>]
|
|
||||||
[--os-project-id <project-id>]
|
|
||||||
[--os-project-name <project-name>]
|
|
||||||
[--os-user-domain-id <user-domain-id>]
|
|
||||||
[--os-user-domain-name <user-domain-name>]
|
|
||||||
[--os-project-domain-id <project-domain-id>]
|
|
||||||
[--os-project-domain-name <project-domain-name>]
|
|
||||||
[--os-token <token>] [--os-auth-url <auth-url>]
|
|
||||||
<subcommand> ...
|
<subcommand> ...
|
||||||
|
|
||||||
**Subcommands:**
|
**Subcommands:**
|
||||||
@ -58,6 +59,12 @@ magnum usage
|
|||||||
``baymodel-update``
|
``baymodel-update``
|
||||||
Updates one or more baymodel attributes.
|
Updates one or more baymodel attributes.
|
||||||
|
|
||||||
|
``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>).
|
||||||
|
|
||||||
``bay-create``
|
``bay-create``
|
||||||
Create a bay.
|
Create a bay.
|
||||||
|
|
||||||
@ -74,10 +81,48 @@ magnum usage
|
|||||||
Update information about the given bay.
|
Update information about the given bay.
|
||||||
|
|
||||||
``ca-show``
|
``ca-show``
|
||||||
Show details about the CA certificate for a bay.
|
Show details about the CA certificate for a bay or
|
||||||
|
cluster.
|
||||||
|
|
||||||
``ca-sign``
|
``ca-sign``
|
||||||
Generate the CA certificate for a bay.
|
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``
|
``service-list``
|
||||||
Print a list of magnum services.
|
Print a list of magnum services.
|
||||||
@ -110,11 +155,47 @@ magnum optional arguments
|
|||||||
``--os-region-name <region-name>``
|
``--os-region-name <region-name>``
|
||||||
Region name. Default= ``env[OS_REGION_NAME]``.
|
Region name. Default= ``env[OS_REGION_NAME]``.
|
||||||
|
|
||||||
``--service-type <service-type>``
|
``--os-auth-url <auth-auth-url>``
|
||||||
Defaults to container for all actions.
|
Defaults to ``env[OS_AUTH_URL]``.
|
||||||
|
|
||||||
``--endpoint-type <endpoint-type>``
|
``--os-user-id <auth-user-id>``
|
||||||
Defaults to ``env[OS_ENDPOINT_TYPE]`` or publicURL.
|
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>``
|
``--magnum-api-version <magnum-api-ver>``
|
||||||
Accepts "api", defaults to ``env[MAGNUM_API_VERSION]``.
|
Accepts "api", defaults to ``env[MAGNUM_API_VERSION]``.
|
||||||
@ -124,56 +205,37 @@ magnum optional arguments
|
|||||||
(https) server certificate. Defaults to
|
(https) server certificate. Defaults to
|
||||||
``env[OS_CACERT]``.
|
``env[OS_CACERT]``.
|
||||||
|
|
||||||
``--bypass-url <bypass-url>``
|
``--os-endpoint-override <endpoint-override>``
|
||||||
Use this API endpoint instead of the Service Catalog.
|
Use this API endpoint instead of the Service Catalog.
|
||||||
|
|
||||||
``--insecure``
|
``--insecure``
|
||||||
Do not verify https connections
|
Do not verify https connections
|
||||||
|
|
||||||
|
.. _magnum_bay-config:
|
||||||
|
|
||||||
magnum.. _magnum_common_auth:
|
magnum bay-config
|
||||||
|
-----------------
|
||||||
|
|
||||||
magnum common authentication arguments
|
.. code-block:: console
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
||||||
|
|
||||||
``--os-auth-system <auth-system>``
|
usage: magnum bay-config [--dir <dir>] [--force] <bay>
|
||||||
Defaults to ``env[OS_AUTH_SYSTEM]``.
|
|
||||||
|
|
||||||
``--os-username <username>``
|
Configure native client to access bay. You can source the output of this
|
||||||
Defaults to ``env[OS_USERNAME]``.
|
command to get the native client of the corresponding COE configured to access
|
||||||
|
the bay. Example: eval $(magnum bay-config <bay-name>).
|
||||||
|
|
||||||
``--os-password <password>``
|
**Positional arguments:**
|
||||||
Defaults to ``env[OS_PASSWORD]``.
|
|
||||||
|
|
||||||
``--os-tenant-id <tenant-id>``
|
``<bay>``
|
||||||
Defaults to ``env[OS_TENANT_ID]``.
|
ID or name of the bay to retrieve config.
|
||||||
|
|
||||||
``--os-tenant-name <tenant-name>``
|
**Optional arguments:**
|
||||||
Defaults to ``env[OS_TENANT_NAME]``.
|
|
||||||
|
|
||||||
``--os-project-id <project-id>``
|
``--dir <dir>``
|
||||||
Defaults to ``env[OS_PROJECT_ID]``.
|
Directory to save the certificate and config files.
|
||||||
|
|
||||||
``--os-project-name <project-name>``
|
``--force``
|
||||||
Defaults to ``env[OS_PROJECT_NAME]``.
|
Overwrite files if existing.
|
||||||
|
|
||||||
``--os-user-domain-id <user-domain-id>``
|
|
||||||
Defaults to ``env[OS_USER_DOMAIN_ID]``.
|
|
||||||
|
|
||||||
``--os-user-domain-name <user-domain-name>``
|
|
||||||
Defaults to ``env[OS_USER_DOMAIN_NAME]``.
|
|
||||||
|
|
||||||
``--os-project-domain-id <project-domain-id>``
|
|
||||||
Defaults to ``env[OS_PROJECT_DOMAIN_ID]``.
|
|
||||||
|
|
||||||
``--os-project-domain-name <project-domain-name>``
|
|
||||||
Defaults to ``env[OS_PROJECT_DOMAIN_NAME]``.
|
|
||||||
|
|
||||||
``--os-token <token>``
|
|
||||||
Defaults to ``env[OS_TOKEN]``.
|
|
||||||
|
|
||||||
``--os-auth-url <auth-url>``
|
|
||||||
Defaults to ``env[OS_AUTH_URL]``.
|
|
||||||
|
|
||||||
.. _magnum_bay-create:
|
.. _magnum_bay-create:
|
||||||
|
|
||||||
@ -267,7 +329,7 @@ magnum bay-show
|
|||||||
|
|
||||||
.. code-block:: console
|
.. code-block:: console
|
||||||
|
|
||||||
usage: magnum bay-show <bay>
|
usage: magnum bay-show [--long] <bay>
|
||||||
|
|
||||||
Show details about the given bay.
|
Show details about the given bay.
|
||||||
|
|
||||||
@ -276,6 +338,11 @@ Show details about the given bay.
|
|||||||
``<bay>``
|
``<bay>``
|
||||||
ID or name of the bay to show.
|
ID or name of the bay to show.
|
||||||
|
|
||||||
|
**Optional arguments:**
|
||||||
|
|
||||||
|
``--long``
|
||||||
|
Display extra associated Baymodel info.
|
||||||
|
|
||||||
.. _magnum_bay-update:
|
.. _magnum_bay-update:
|
||||||
|
|
||||||
magnum bay-update
|
magnum bay-update
|
||||||
@ -324,7 +391,7 @@ magnum baymodel-create
|
|||||||
[--labels <KEY1=VALUE1,KEY2=VALUE2;KEY3=VALUE3...>]
|
[--labels <KEY1=VALUE1,KEY2=VALUE2;KEY3=VALUE3...>]
|
||||||
[--tls-disabled] [--public] [--registry-enabled]
|
[--tls-disabled] [--public] [--registry-enabled]
|
||||||
[--server-type <server-type>]
|
[--server-type <server-type>]
|
||||||
[--master-lb-enabled]
|
[--master-lb-enabled] [--floating-ip-enabled]
|
||||||
|
|
||||||
Create a baymodel.
|
Create a baymodel.
|
||||||
|
|
||||||
@ -411,6 +478,10 @@ Create a baymodel.
|
|||||||
Indicates whether created bays should have a load
|
Indicates whether created bays should have a load
|
||||||
balancer for master nodes or not.
|
balancer for master nodes or not.
|
||||||
|
|
||||||
|
``--floating-ip-enabled``
|
||||||
|
Indicates whether created bays should have a floating
|
||||||
|
ipor not.
|
||||||
|
|
||||||
.. _magnum_baymodel-delete:
|
.. _magnum_baymodel-delete:
|
||||||
|
|
||||||
magnum baymodel-delete
|
magnum baymodel-delete
|
||||||
@ -502,15 +573,18 @@ magnum ca-show
|
|||||||
|
|
||||||
.. code-block:: console
|
.. code-block:: console
|
||||||
|
|
||||||
usage: magnum ca-show --bay <bay>
|
usage: magnum ca-show [--bay <bay>] [--cluster <cluster>]
|
||||||
|
|
||||||
Show details about the CA certificate for a bay.
|
Show details about the CA certificate for a bay or cluster.
|
||||||
|
|
||||||
**Optional arguments:**
|
**Optional arguments:**
|
||||||
|
|
||||||
``--bay <bay>``
|
``--bay <bay>``
|
||||||
ID or name of the bay.
|
ID or name of the bay.
|
||||||
|
|
||||||
|
``--cluster <cluster>``
|
||||||
|
ID or name of the cluster.
|
||||||
|
|
||||||
.. _magnum_ca-sign:
|
.. _magnum_ca-sign:
|
||||||
|
|
||||||
magnum ca-sign
|
magnum ca-sign
|
||||||
@ -518,18 +592,385 @@ magnum ca-sign
|
|||||||
|
|
||||||
.. code-block:: console
|
.. code-block:: console
|
||||||
|
|
||||||
usage: magnum ca-sign [--csr <csr>] --bay <bay>
|
usage: magnum ca-sign [--csr <csr>] [--bay <bay>] [--cluster <cluster>]
|
||||||
|
|
||||||
Generate the CA certificate for a bay.
|
Generate the CA certificate for a bay or cluster.
|
||||||
|
|
||||||
**Optional arguments:**
|
**Optional arguments:**
|
||||||
|
|
||||||
``--csr <csr>``
|
``--csr <csr>``
|
||||||
File path of the csr file to send to Magnum to get signed.
|
File path of the csr file to send to Magnum to get
|
||||||
|
signed.
|
||||||
|
|
||||||
``--bay <bay>``
|
``--bay <bay>``
|
||||||
ID or name of the bay.
|
ID or name of the bay.
|
||||||
|
|
||||||
|
``--cluster <cluster>``
|
||||||
|
ID or name of the cluster.
|
||||||
|
|
||||||
|
.. _magnum_cluster-config:
|
||||||
|
|
||||||
|
magnum cluster-config
|
||||||
|
---------------------
|
||||||
|
|
||||||
|
.. code-block:: console
|
||||||
|
|
||||||
|
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:
|
||||||
|
|
||||||
|
magnum cluster-create
|
||||||
|
---------------------
|
||||||
|
|
||||||
|
.. code-block:: console
|
||||||
|
|
||||||
|
usage: magnum cluster-create [--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:**
|
||||||
|
|
||||||
|
``--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:
|
||||||
|
|
||||||
|
magnum cluster-delete
|
||||||
|
---------------------
|
||||||
|
|
||||||
|
.. code-block:: console
|
||||||
|
|
||||||
|
usage: magnum cluster-delete <cluster> [<cluster> ...]
|
||||||
|
|
||||||
|
Delete specified cluster.
|
||||||
|
|
||||||
|
**Positional arguments:**
|
||||||
|
|
||||||
|
``<cluster>``
|
||||||
|
ID or name of the (cluster)s to delete.
|
||||||
|
|
||||||
|
.. _magnum_cluster-list:
|
||||||
|
|
||||||
|
magnum cluster-list
|
||||||
|
-------------------
|
||||||
|
|
||||||
|
.. code-block:: console
|
||||||
|
|
||||||
|
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, baymodel_id, stack_id, status,
|
||||||
|
master_count, node_count, links,
|
||||||
|
cluster_create_timeout
|
||||||
|
|
||||||
|
.. _magnum_cluster-show:
|
||||||
|
|
||||||
|
magnum cluster-show
|
||||||
|
-------------------
|
||||||
|
|
||||||
|
.. code-block:: console
|
||||||
|
|
||||||
|
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:
|
||||||
|
|
||||||
|
magnum cluster-template-create
|
||||||
|
------------------------------
|
||||||
|
|
||||||
|
.. code-block:: console
|
||||||
|
|
||||||
|
usage: magnum cluster-template-create [--name <name>] --image-id <image-id>
|
||||||
|
--keypair-id <keypair-id>
|
||||||
|
--external-network-id
|
||||||
|
<external-network-id> --coe <coe>
|
||||||
|
[--fixed-network <fixed-network>]
|
||||||
|
[--fixed-subnet <fixed-subnet>]
|
||||||
|
[--network-driver <network-driver>]
|
||||||
|
[--volume-driver <volume-driver>]
|
||||||
|
[--dns-nameserver <dns-nameserver>]
|
||||||
|
[--flavor-id <flavor-id>]
|
||||||
|
[--master-flavor-id <master-flavor-id>]
|
||||||
|
[--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:**
|
||||||
|
|
||||||
|
``--name <name>``
|
||||||
|
Name of the cluster template to create.
|
||||||
|
|
||||||
|
``--image-id <image-id>``
|
||||||
|
The name or UUID of the base image to customize for
|
||||||
|
the bay.
|
||||||
|
|
||||||
|
``--keypair-id <keypair-id>``
|
||||||
|
The name or UUID of the SSH keypair to load into the
|
||||||
|
Bay nodes.
|
||||||
|
|
||||||
|
``--external-network-id <external-network-id>``
|
||||||
|
The external Neutron network ID to connect to this bay
|
||||||
|
model.
|
||||||
|
|
||||||
|
``--coe <coe>``
|
||||||
|
Specify the Container Orchestration Engine to use.
|
||||||
|
|
||||||
|
``--fixed-network <fixed-network>``
|
||||||
|
The private Neutron network name to connect to this
|
||||||
|
bay model.
|
||||||
|
|
||||||
|
``--fixed-subnet <fixed-subnet>``
|
||||||
|
The private Neutron subnet name to connect to bay.
|
||||||
|
|
||||||
|
``--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-id <flavor-id>``
|
||||||
|
The nova flavor id to use when launching the bay.
|
||||||
|
|
||||||
|
``--master-flavor-id <master-flavor-id>``
|
||||||
|
The nova flavor id to use when launching the master
|
||||||
|
node of the bay.
|
||||||
|
|
||||||
|
``--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 bay.
|
||||||
|
|
||||||
|
``--https-proxy <https-proxy>``
|
||||||
|
The https_proxy address to use for nodes in bay.
|
||||||
|
|
||||||
|
``--no-proxy <no-proxy>``
|
||||||
|
The no_proxy address to use for nodes in bay.
|
||||||
|
|
||||||
|
``--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 Bay.
|
||||||
|
|
||||||
|
``--public``
|
||||||
|
Make cluster template public.
|
||||||
|
|
||||||
|
``--registry-enabled``
|
||||||
|
Enable docker registry in the Bay
|
||||||
|
|
||||||
|
``--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 bays should have a load
|
||||||
|
balancer for master nodes or not.
|
||||||
|
|
||||||
|
``--floating-ip-enabled``
|
||||||
|
Indicates whether created bays should have a floating
|
||||||
|
ipor not.
|
||||||
|
|
||||||
|
.. _magnum_cluster-template-delete:
|
||||||
|
|
||||||
|
magnum cluster-template-delete
|
||||||
|
------------------------------
|
||||||
|
|
||||||
|
.. code-block:: console
|
||||||
|
|
||||||
|
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:
|
||||||
|
|
||||||
|
magnum cluster-template-list
|
||||||
|
----------------------------
|
||||||
|
|
||||||
|
.. code-block:: console
|
||||||
|
|
||||||
|
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:
|
||||||
|
|
||||||
|
magnum cluster-template-show
|
||||||
|
----------------------------
|
||||||
|
|
||||||
|
.. code-block:: console
|
||||||
|
|
||||||
|
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:
|
||||||
|
|
||||||
|
magnum cluster-template-update
|
||||||
|
------------------------------
|
||||||
|
|
||||||
|
.. code-block:: console
|
||||||
|
|
||||||
|
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:
|
||||||
|
|
||||||
|
magnum cluster-update
|
||||||
|
---------------------
|
||||||
|
|
||||||
|
.. code-block:: console
|
||||||
|
|
||||||
|
usage: magnum cluster-update <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)
|
||||||
|
|
||||||
.. _magnum_service-list:
|
.. _magnum_service-list:
|
||||||
|
|
||||||
magnum service-list
|
magnum service-list
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user