From eec8f5c516a82a65b7fb588423df8aafa575bbee Mon Sep 17 00:00:00 2001 From: KATO Tomoyuki Date: Wed, 31 Aug 2016 10:39:42 +0900 Subject: [PATCH] [cli-ref] Update python-magnumclient to 2.3.0 Change-Id: I8378d0b2d59e93791d111b5be217bc2d52d29db8 --- doc/cli-reference/source/magnum.rst | 567 ++++++++++++++++++++++++---- 1 file changed, 504 insertions(+), 63 deletions(-) diff --git a/doc/cli-reference/source/magnum.rst b/doc/cli-reference/source/magnum.rst index 702b46551d..97defba4a0 100644 --- a/doc/cli-reference/source/magnum.rst +++ b/doc/cli-reference/source/magnum.rst @@ -9,7 +9,7 @@ Container Infrastructure Management service command-line client The magnum client is the command-line interface (CLI) for 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: @@ -25,20 +25,21 @@ magnum usage .. code-block:: console usage: magnum [--version] [--debug] [--os-cache] - [--os-region-name ] [--service-type ] - [--endpoint-type ] + [--os-region-name ] [--os-auth-url ] + [--os-user-id ] [--os-username ] + [--os-user-domain-id ] + [--os-user-domain-name ] + [--os-project-id ] + [--os-project-name ] + [--os-project-domain-id ] + [--os-project-domain-name ] + [--os-token ] [--os-password ] + [--service-type ] + [--os-endpoint-type ] + [--os-cloud ] [--magnum-api-version ] - [--os-cacert ] [--bypass-url ] - [--insecure] [--os-auth-system ] - [--os-username ] [--os-password ] - [--os-tenant-id ] [--os-tenant-name ] - [--os-project-id ] - [--os-project-name ] - [--os-user-domain-id ] - [--os-user-domain-name ] - [--os-project-domain-id ] - [--os-project-domain-name ] - [--os-token ] [--os-auth-url ] + [--os-cacert ] + [--os-endpoint-override ] [--insecure] ... **Subcommands:** @@ -58,6 +59,12 @@ magnum usage ``baymodel-update`` 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-create`` Create a bay. @@ -74,10 +81,48 @@ magnum usage Update information about the given bay. ``ca-show`` - Show details about the CA certificate for a bay. + Show details about the CA certificate for a bay or + cluster. ``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-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. @@ -110,11 +155,47 @@ magnum optional arguments ``--os-region-name `` Region name. Default= ``env[OS_REGION_NAME]``. -``--service-type `` - Defaults to container for all actions. +``--os-auth-url `` + Defaults to ``env[OS_AUTH_URL]``. -``--endpoint-type `` - Defaults to ``env[OS_ENDPOINT_TYPE]`` or publicURL. +``--os-user-id `` + Defaults to ``env[OS_USER_ID]``. + +``--os-username `` + Defaults to ``env[OS_USERNAME]``. + +``--os-user-domain-id `` + Defaults to ``env[OS_USER_DOMAIN_ID]``. + +``--os-user-domain-name `` + Defaults to ``env[OS_USER_DOMAIN_NAME]``. + +``--os-project-id `` + Defaults to ``env[OS_PROJECT_ID]``. + +``--os-project-name `` + Defaults to ``env[OS_PROJECT_NAME]``. + +``--os-project-domain-id `` + Defaults to ``env[OS_PROJECT_DOMAIN_ID]``. + +``--os-project-domain-name `` + Defaults to ``env[OS_PROJECT_DOMAIN_NAME]``. + +``--os-token `` + Defaults to ``env[OS_TOKEN]``. + +``--os-password `` + Defaults to ``env[OS_PASSWORD]``. + +``--service-type `` + Defaults to container-infra for all actions. + +``--os-endpoint-type `` + Defaults to ``env[OS_ENDPOINT_TYPE]`` + +``--os-cloud `` + Defaults to ``env[OS_CLOUD]``. ``--magnum-api-version `` Accepts "api", defaults to ``env[MAGNUM_API_VERSION]``. @@ -124,56 +205,37 @@ magnum optional arguments (https) server certificate. Defaults to ``env[OS_CACERT]``. -``--bypass-url `` +``--os-endpoint-override `` Use this API endpoint instead of the Service Catalog. ``--insecure`` 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 `` - Defaults to ``env[OS_AUTH_SYSTEM]``. + usage: magnum bay-config [--dir ] [--force] -``--os-username `` - Defaults to ``env[OS_USERNAME]``. +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 ). -``--os-password `` - Defaults to ``env[OS_PASSWORD]``. +**Positional arguments:** -``--os-tenant-id `` - Defaults to ``env[OS_TENANT_ID]``. +```` + ID or name of the bay to retrieve config. -``--os-tenant-name `` - Defaults to ``env[OS_TENANT_NAME]``. +**Optional arguments:** -``--os-project-id `` - Defaults to ``env[OS_PROJECT_ID]``. +``--dir `` + Directory to save the certificate and config files. -``--os-project-name `` - Defaults to ``env[OS_PROJECT_NAME]``. - -``--os-user-domain-id `` - Defaults to ``env[OS_USER_DOMAIN_ID]``. - -``--os-user-domain-name `` - Defaults to ``env[OS_USER_DOMAIN_NAME]``. - -``--os-project-domain-id `` - Defaults to ``env[OS_PROJECT_DOMAIN_ID]``. - -``--os-project-domain-name `` - Defaults to ``env[OS_PROJECT_DOMAIN_NAME]``. - -``--os-token `` - Defaults to ``env[OS_TOKEN]``. - -``--os-auth-url `` - Defaults to ``env[OS_AUTH_URL]``. +``--force`` + Overwrite files if existing. .. _magnum_bay-create: @@ -267,7 +329,7 @@ magnum bay-show .. code-block:: console - usage: magnum bay-show + usage: magnum bay-show [--long] Show details about the given bay. @@ -276,6 +338,11 @@ Show details about the given bay. ```` ID or name of the bay to show. +**Optional arguments:** + +``--long`` + Display extra associated Baymodel info. + .. _magnum_bay-update: magnum bay-update @@ -324,7 +391,7 @@ magnum baymodel-create [--labels ] [--tls-disabled] [--public] [--registry-enabled] [--server-type ] - [--master-lb-enabled] + [--master-lb-enabled] [--floating-ip-enabled] Create a baymodel. @@ -411,6 +478,10 @@ Create a baymodel. 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_baymodel-delete: magnum baymodel-delete @@ -502,15 +573,18 @@ magnum ca-show .. code-block:: console - usage: magnum ca-show --bay + usage: magnum ca-show [--bay ] [--cluster ] -Show details about the CA certificate for a bay. +Show details about the CA certificate for a bay or cluster. **Optional arguments:** ``--bay `` ID or name of the bay. +``--cluster `` + ID or name of the cluster. + .. _magnum_ca-sign: magnum ca-sign @@ -518,18 +592,385 @@ magnum ca-sign .. code-block:: console - usage: magnum ca-sign [--csr ] --bay + usage: magnum ca-sign [--csr ] [--bay ] [--cluster ] -Generate the CA certificate for a bay. +Generate the CA certificate for a bay or cluster. **Optional arguments:** ``--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 `` ID or name of the bay. +``--cluster `` + ID or name of the cluster. + +.. _magnum_cluster-config: + +magnum cluster-config +--------------------- + +.. code-block:: console + + usage: magnum cluster-config [--dir ] [--force] + +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 ). + +**Positional arguments:** + +```` + ID or name of the cluster to retrieve config. + +**Optional arguments:** + +``--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 ] --cluster-template + [--node-count ] + [--master-count ] + [--discovery-url ] + [--timeout ] + +Create a cluster. + +**Optional arguments:** + +``--name `` + Name of the cluster to create. + +``--cluster-template `` + ID or name of the cluster template. + +``--node-count `` + The cluster node count. + +``--master-count `` + The number of master nodes for the cluster. + +``--discovery-url `` + Specifies custom discovery url for node discovery. + +``--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 [ ...] + +Delete specified cluster. + +**Positional arguments:** + +```` + ID or name of the (cluster)s to delete. + +.. _magnum_cluster-list: + +magnum cluster-list +------------------- + +.. code-block:: console + + usage: magnum cluster-list [--marker ] [--limit ] + [--sort-key ] [--sort-dir ] + [--fields ] + +Print a list of available clusters. + +**Optional arguments:** + +``--marker `` + The last cluster UUID of the previous page; displays + list of clusters after "marker". + +``--limit `` + Maximum number of clusters to return. + +``--sort-key `` + Column to sort results by. + +``--sort-dir `` + Direction to sort. "asc" or "desc". + +``--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] + +Show details about the given cluster. + +**Positional arguments:** + +```` + 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 ] --image-id + --keypair-id + --external-network-id + --coe + [--fixed-network ] + [--fixed-subnet ] + [--network-driver ] + [--volume-driver ] + [--dns-nameserver ] + [--flavor-id ] + [--master-flavor-id ] + [--docker-volume-size ] + [--docker-storage-driver ] + [--http-proxy ] + [--https-proxy ] + [--no-proxy ] + [--labels ] + [--tls-disabled] [--public] + [--registry-enabled] + [--server-type ] + [--master-lb-enabled] + [--floating-ip-enabled] + +Create a cluster template. + +**Optional arguments:** + +``--name `` + Name of the cluster template to create. + +``--image-id `` + The name or UUID of the base image to customize for + the bay. + +``--keypair-id `` + The name or UUID of the SSH keypair to load into the + Bay nodes. + +``--external-network-id `` + The external Neutron network ID to connect to this bay + model. + +``--coe `` + Specify the Container Orchestration Engine to use. + +``--fixed-network `` + The private Neutron network name to connect to this + bay model. + +``--fixed-subnet `` + The private Neutron subnet name to connect to bay. + +``--network-driver `` + The network driver name for instantiating container + networks. + +``--volume-driver `` + The volume driver name for instantiating container + volume. + +``--dns-nameserver `` + The DNS nameserver to use for this cluster template. + +``--flavor-id `` + The nova flavor id to use when launching the bay. + +``--master-flavor-id `` + The nova flavor id to use when launching the master + node of the bay. + +``--docker-volume-size `` + Specify the number of size in GB for the docker volume + to use. + +``--docker-storage-driver `` + Select a docker storage driver. Supported: + devicemapper, overlay. Default: devicemapper + +``--http-proxy `` + The http_proxy address to use for nodes in bay. + +``--https-proxy `` + The https_proxy address to use for nodes in bay. + +``--no-proxy `` + The no_proxy address to use for nodes in bay. + +``--labels `` + 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 `` + 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 + [ ...] + +Delete specified cluster template. + +**Positional arguments:** + +```` + 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 ] [--sort-key ] + [--sort-dir ] + [--fields ] + +Print a list of cluster templates. + +**Optional arguments:** + +``--limit `` + Maximum number of cluster templates to return + +``--sort-key `` + Column to sort results by + +``--sort-dir `` + Direction to sort. "asc" or "desc". + +``--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 + +Show details about the given cluster template. + +**Positional arguments:** + +```` + 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 + [ ...] + +Updates one or more cluster template attributes. + +**Positional arguments:** + +```` + UUID or name of cluster template + +```` + Operations: 'add', 'replace' or 'remove' + +```` + 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 [ ...] + +Update information about the given cluster. + +**Positional arguments:** + +```` + UUID or name of cluster + +```` + Operations: 'add', 'replace' or 'remove' + +```` + Attributes to add/replace or remove (only PATH is necessary on + remove) + .. _magnum_service-list: magnum service-list