openstack/magnum
Code Issues Proposed changes

Update docs to use positional name argument

Browse Source 
Using the optional --name argument will result in a deprecation
warning.

Change-Id: Id2be01f9ec40d53c2b7ddd0807e38ee550d7ab8a
Implements: blueprint positional-name
This commit is contained in:
Jason Dunsmore 2017-03-03 14:45:35 -06:00
parent 27c3efa202
commit caf811b974
4 changed files with 39 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
doc/source/dev/quickstart.rst
View File

@ -254,7 +254,7 @@ Atomic image so the clusters which use this ClusterTemplate will be based on
Fedora Atomic. The COE (Container Orchestration Engine) and keypair need to
be specified as well::
magnum cluster-template-create --name k8s-cluster-template \
magnum cluster-template-create k8s-cluster-template \
--image fedora-atomic-latest \
--keypair testkey \
--external-network public \
@ -268,7 +268,7 @@ Create a cluster. Use the ClusterTemplate name as a template for cluster
creation. This cluster will result in one master kubernetes node and one minion
node::
magnum cluster-create --name k8s-cluster \
magnum cluster-create k8s-cluster \
--cluster-template k8s-cluster-template \
--node-count 1
@ -350,7 +350,7 @@ Upload the image to glance::
Create a CoreOS Kubernetes ClusterTemplate, which is similar to the Atomic
Kubernetes ClusterTemplate, except for pointing to a different image::
magnum cluster-template-create --name k8s-cluster-template-coreos \
magnum cluster-template-create k8s-cluster-template-coreos \
--image CoreOS \
--keypair testkey \
--external-network public \
@ -362,7 +362,7 @@ Kubernetes ClusterTemplate, except for pointing to a different image::
Create a CoreOS Kubernetes cluster. Use the CoreOS ClusterTemplate as a
template for cluster creation::
magnum cluster-create --name k8s-cluster \
magnum cluster-create k8s-cluster \
--cluster-template k8s-cluster-template-coreos \
--node-count 2
@ -524,7 +524,7 @@ Create a ClusterTemplate. It is very similar to the Kubernetes ClusterTemplate,
except for the absence of some Kubernetes-specific arguments and the use of
'swarm' as the COE::
magnum cluster-template-create --name swarm-cluster-template \
magnum cluster-template-create swarm-cluster-template \
--image fedora-atomic-latest \
--keypair testkey \
--external-network public \
@ -540,7 +540,7 @@ Finally, create the cluster. Use the ClusterTemplate 'swarm-cluster-template'
as a template for cluster creation. This cluster will result in one swarm
manager node and two extra agent nodes::
magnum cluster-create --name swarm-cluster \
magnum cluster-create swarm-cluster \
--cluster-template swarm-cluster-template \
--node-count 2
@ -654,7 +654,7 @@ Alternatively, you can download and upload a pre-built image::
Then, create a ClusterTemplate by using 'mesos' as the COE, with the rest of
arguments similar to the Kubernetes ClusterTemplate::
magnum cluster-template-create --name mesos-cluster-template --image ubuntu-mesos \
magnum cluster-template-create mesos-cluster-template --image ubuntu-mesos \
--keypair testkey \
--external-network public \
--dns-nameserver 8.8.8.8 \
@ -665,7 +665,7 @@ Finally, create the cluster. Use the ClusterTemplate 'mesos-cluster-template'
as a template for cluster creation. This cluster will result in one mesos
master node and two mesos slave nodes::
magnum cluster-create --name mesos-cluster \
magnum cluster-create mesos-cluster \
--cluster-template mesos-cluster-template \
--node-count 2

6
doc/source/magnum-proxy.rst
View File

@ -40,7 +40,7 @@ Steps to configure proxies.
You can specify all three proxy parameters while creating ClusterTemplate of
any coe type. All of proxy parameters are optional.
magnum cluster-template-create --name k8s-cluster-template \
magnum cluster-template-create k8s-cluster-template \
--image fedora-atomic-latest \
--keypair testkey \
--external-network public \
@ -50,7 +50,7 @@ any coe type. All of proxy parameters are optional.
--http-proxy <http://abc-proxy.com:8080> \
--https-proxy <https://abc-proxy.com:8080> \
--no-proxy <172.24.4.4,172.24.4.9,172.24.4.8>
magnum cluster-template-create --name swarm-cluster-template \
magnum cluster-template-create swarm-cluster-template \
--image fedora-atomic-latest \
--keypair testkey \
--external-network public \
@ -60,7 +60,7 @@ any coe type. All of proxy parameters are optional.
--http-proxy <http://abc-proxy.com:8080> \
--https-proxy <https://abc-proxy.com:8080> \
--no-proxy <172.24.4.4,172.24.4.9,172.24.4.8>
magnum cluster-template-create --name mesos-cluster-template \
magnum cluster-template-create mesos-cluster-template \
--image ubuntu-mesos \
--keypair testkey \
--external-network public \

52
doc/source/userguide.rst
View File

@ -80,6 +80,14 @@ exists.
The definition and usage of the parameters of a ClusterTemplate are as follows.
They are loosely grouped as: mandatory, infrastructure, COE specific.
\<name\>
Name of the ClusterTemplate to create. The name does not have to be
unique. If multiple ClusterTemplates have the same name, you will need to
use the UUID to select the ClusterTemplate when creating a cluster or
updating, deleting a ClusterTemplate. If a name is not specified, a random
name will be generated using a string and a number, for example
"pi-13-model".
--coe \<coe\>
Specify the Container Orchestration Engine to use. Supported
COE's include 'kubernetes', 'swarm', 'mesos'. If your environment
@ -125,14 +133,6 @@ They are loosely grouped as: mandatory, infrastructure, COE specific.
the cluster. This is a mandatory parameter and there is no default
value.
--name \<name\>
Name of the ClusterTemplate to create. The name does not have to be
unique. If multiple ClusterTemplates have the same name, you will need to
use the UUID to select the ClusterTemplate when creating a cluster or
updating, deleting a ClusterTemplate. If a name is not specified, a random
name will be generated using a string and a number, for example
"pi-13-model".
--public
Access to a ClusterTemplate is normally limited to the admin, owner or users
within the same tenant as the owners. Setting this flag
@ -407,7 +407,7 @@ is used as the baymodel parameter for this command instead of
The 'cluster-create' command deploys a cluster, for example::
magnum cluster-create --name mycluster \
magnum cluster-create mycluster \
--cluster-template mytemplate \
--node-count 8 \
--master-count 3
@ -424,17 +424,17 @@ resources of a failed 'cluster-create' are retained.
The definition and usage of the parameters for 'cluster-create' are as
follows:
\<name\>
Name of the cluster to create. If a name is not specified, a random
name will be generated using a string and a number, for example
"gamma-7-cluster".
--cluster-template \<cluster-template\>
The ID or name of the ClusterTemplate to use. This is a mandatory
parameter. Once a ClusterTemplate is used to create a cluster, it cannot
be deleted or modified until all clusters that use the ClusterTemplate have
been deleted.
--name \<name\>
Name of the cluster to create. If a name is not specified, a random
name will be generated using a string and a number, for example
"gamma-7-cluster".
--keypair \<keypair\>
The name or UUID of the SSH keypair to configure in the cluster servers
for ssh access. You will need the key to be able to ssh to the
@ -934,7 +934,7 @@ Service
When Magnum deploys a Kubernetes cluster, it uses parameters defined in the
ClusterTemplate and specified on the cluster-create command, for example::
magnum cluster-template-create --name k8s-cluster-template \
magnum cluster-template-create k8s-cluster-template \
--image fedora-atomic-latest \
--keypair testkey \
--external-network public \
@ -944,7 +944,7 @@ ClusterTemplate and specified on the cluster-create command, for example::
--network-driver flannel \
--coe kubernetes
magnum cluster-create --name k8s-cluster \
magnum cluster-create k8s-cluster \
--cluster-template k8s-cluster-template \
--master-count 3 \
--node-count 8
@ -1065,7 +1065,7 @@ Magnum deploys a Swarm cluster using parameters defined in
the ClusterTemplate and specified on the 'cluster-create' command, for
example::
magnum cluster-template-create --name swarm-cluster-template \
magnum cluster-template-create swarm-cluster-template \
--image fedora-atomic-latest \
--keypair testkey \
--external-network public \
@ -1074,7 +1074,7 @@ example::
--docker-volume-size 5 \
--coe swarm
magnum cluster-create --name swarm-cluster \
magnum cluster-create swarm-cluster \
--cluster-template swarm-cluster-template \
--master-count 3 \
--node-count 8
@ -1187,7 +1187,7 @@ offered.
Magnum deploys a Mesos cluster using parameters defined in the ClusterTemplate
and specified on the 'cluster-create' command, for example::
magnum cluster-template-create --name mesos-cluster-template \
magnum cluster-template-create mesos-cluster-template \
--image ubuntu-mesos \
--keypair testkey \
--external-network public \
@ -1195,7 +1195,7 @@ and specified on the 'cluster-create' command, for example::
--flavor m1.small \
--coe mesos
magnum cluster-create --name mesos-cluster \
magnum cluster-create mesos-cluster \
--cluster-template mesos-cluster-template \
--master-count 3 \
--node-count 8
@ -1497,7 +1497,7 @@ support.
First, create a ClusterTemplate; by default TLS is enabled in
Magnum, therefore it does not need to be specified via a parameter::
magnum cluster-template-create --name secure-kubernetes \
magnum cluster-template-create secure-kubernetes \
--keypair default \
--external-network public \
--image fedora-atomic-latest \
@ -1543,7 +1543,7 @@ Magnum, therefore it does not need to be specified via a parameter::
Now create a cluster. Use the ClusterTemplate name as a template for cluster
creation::
magnum cluster-create --name secure-k8s-cluster \
magnum cluster-create secure-k8s-cluster \
--cluster-template secure-kubernetes \
--node-count 1
@ -2213,7 +2213,7 @@ development team is working on a long term solution to automate these steps.
Specify 'cinder' as the volume-driver for Kubernetes::
magnum cluster-template-create --name k8s-cluster-template \
magnum cluster-template-create k8s-cluster-template \
--image fedora-23-atomic-7 \
--keypair testkey \
--external-network public \
@ -2226,7 +2226,7 @@ development team is working on a long term solution to automate these steps.
2. Create the cluster::
magnum cluster-create --name k8s-cluster \
magnum cluster-create k8s-cluster \
--cluster-template k8s-cluster-template \
--node-count 1
@ -2348,7 +2348,7 @@ Using Cinder in Mesos
hosts are using the volume. If this is set to false, the driver
will ensure data safety by locking the volume::
magnum cluster-template-create --name mesos-cluster-template \
magnum cluster-template-create mesos-cluster-template \
--image ubuntu-mesos \
--keypair testkey \
--external-network public \
@ -2363,7 +2363,7 @@ Using Cinder in Mesos
2. Create the Mesos cluster::
magnum cluster-create --name mesos-cluster \
magnum cluster-create mesos-cluster \
--cluster-template mesos-cluster-template \
--node-count 1

4
install-guide/source/launch-instance.rst
View File

@ -87,7 +87,7 @@ and one node. Then, using docker's native API you will create a container.
.. code-block:: console
$ magnum cluster-template-create --name swarm-cluster-template \
$ magnum cluster-template-create swarm-cluster-template \
--image fedora-atomic-latest \
--keypair mykey \
--external-network public \
@ -134,7 +134,7 @@ and one node. Then, using docker's native API you will create a container.
.. code-block:: console
$ magnum cluster-create --name swarm-cluster \
$ magnum cluster-create swarm-cluster \
--cluster-template swarm-cluster-template \
--master-count 1 \
--node-count 1