magnum cluster-template-create help does not tell mandatory arguments completely

Bug #1696387 reported by NidhiMittalHada
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
python-magnumclient
New
Undecided
NidhiMittalHada

Bug Description

stack@kernel:~/devstack$ magnum help 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]
                                      [--insecure-registry <insecure-registry>]
                                      [<name>]

Create a cluster template.

Positional arguments:
  <name> Name of the cluster template to create.

Optional arguments:
  --keypair-id <keypair>
                        The name 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 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. The --name
                        parameter is deprecated and will be removed in a
                        future release. Use the <name> positional parameter
                        instead.
  --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.
  --insecure-registry <insecure-registry>
                        url of docker registry
stack@kernel:~/devstack$ magnum cluster-template-create first_template
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]
                                      [--insecure-registry <insecure-registry>]
                                      [<name>]
error: argument --coe is required >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>.
Try 'magnum help cluster-template-create' for more information.
stack@kernel:~/devstack$

Help text says that coe argument is optional but actually its not.
Hence needs correction help text at present is misguiding.

Changed in python-magnumclient:
assignee: nobody → NidhiMittalHada (nidhimittal19)
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.