openstack/magnum
Code Issues Proposed changes

Updates Documentation for non-ID Params

Browse Source 
Updates magnum documentation to reflect the changes made for
bp/rename-id-parameter-names.

Change-Id: I7c0d69970b9ac50649cac0e80932b5971ce09c3f
Depends-on: Idc6b9322ec7c0ecb386162ca46c7d49b910685d8
Implements: blueprint rename-id-parameter-names
This commit is contained in:
Stephen Watson 2016-11-11 11:38:57 -07:00
parent 2eda81c805
commit d7b88c47e5
4 changed files with 64 additions and 64 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -249,11 +249,11 @@ Fedora Atomic. The COE (Container Orchestration Engine) and keypair need to
be specified as well:: be specified as well::
magnum cluster-template-create --name k8s-cluster-template \ magnum cluster-template-create --name k8s-cluster-template \
--image-id fedora-atomic-latest \ --image fedora-atomic-latest \
--keypair-id testkey \ --keypair testkey \
--external-network-id public \ --external-network public \
--dns-nameserver 8.8.8.8 \ --dns-nameserver 8.8.8.8 \
--flavor-id m1.small \ --flavor m1.small \
--docker-volume-size 5 \ --docker-volume-size 5 \
--network-driver flannel \ --network-driver flannel \
--coe kubernetes --coe kubernetes
@ -345,11 +345,11 @@ Create a CoreOS Kubernetes ClusterTemplate, which is similar to the Atomic
Kubernetes ClusterTemplate, except for pointing to a different image:: Kubernetes ClusterTemplate, except for pointing to a different image::
magnum cluster-template-create --name k8s-cluster-template-coreos \ magnum cluster-template-create --name k8s-cluster-template-coreos \
--image-id CoreOS \ --image CoreOS \
--keypair-id testkey \ --keypair testkey \
--external-network-id public \ --external-network public \
--dns-nameserver 8.8.8.8 \ --dns-nameserver 8.8.8.8 \
--flavor-id m1.small \ --flavor m1.small \
--network-driver flannel \ --network-driver flannel \
--coe kubernetes --coe kubernetes
@ -526,11 +526,11 @@ except for the absence of some Kubernetes-specific arguments and the use of
'swarm' as the COE:: 'swarm' as the COE::
magnum cluster-template-create --name swarm-cluster-template \ magnum cluster-template-create --name swarm-cluster-template \
--image-id fedora-atomic-latest \ --image fedora-atomic-latest \
--keypair-id testkey \ --keypair testkey \
--external-network-id public \ --external-network public \
--dns-nameserver 8.8.8.8 \ --dns-nameserver 8.8.8.8 \
--flavor-id m1.small \ --flavor m1.small \
--docker-volume-size 5 \ --docker-volume-size 5 \
--coe swarm --coe swarm
@ -658,11 +658,11 @@ Alternatively, you can download and upload a pre-built image::
Then, create a ClusterTemplate by using 'mesos' as the COE, with the rest of Then, create a ClusterTemplate by using 'mesos' as the COE, with the rest of
arguments similar to the Kubernetes ClusterTemplate:: arguments similar to the Kubernetes ClusterTemplate::
magnum cluster-template-create --name mesos-cluster-template --image-id ubuntu-mesos \ magnum cluster-template-create --name mesos-cluster-template --image ubuntu-mesos \
--keypair-id testkey \ --keypair testkey \
--external-network-id public \ --external-network public \
--dns-nameserver 8.8.8.8 \ --dns-nameserver 8.8.8.8 \
--flavor-id m1.small \ --flavor m1.small \
--coe mesos --coe mesos
Finally, create the cluster. Use the ClusterTemplate 'mesos-cluster-template' Finally, create the cluster. Use the ClusterTemplate 'mesos-cluster-template'

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

@ -41,31 +41,31 @@ You can specify all three proxy parameters while creating ClusterTemplate of
any coe type. All of proxy parameters are optional. any coe type. All of proxy parameters are optional.
magnum cluster-template-create --name k8s-cluster-template \ magnum cluster-template-create --name k8s-cluster-template \
--image-id fedora-atomic-latest \ --image fedora-atomic-latest \
--keypair-id testkey \ --keypair testkey \
--external-network-id public \ --external-network public \
--dns-nameserver 8.8.8.8 \ --dns-nameserver 8.8.8.8 \
--flavor-id m1.small \ --flavor m1.small \
--coe kubernetes \ --coe kubernetes \
--http-proxy <http://abc-proxy.com:8080> \ --http-proxy <http://abc-proxy.com:8080> \
--https-proxy <https://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> --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 --name swarm-cluster-template \
--image-id fedora-atomic-latest \ --image fedora-atomic-latest \
--keypair-id testkey \ --keypair testkey \
--external-network-id public \ --external-network public \
--dns-nameserver 8.8.8.8 \ --dns-nameserver 8.8.8.8 \
--flavor-id m1.small \ --flavor m1.small \
--coe swarm \ --coe swarm \
--http-proxy <http://abc-proxy.com:8080> \ --http-proxy <http://abc-proxy.com:8080> \
--https-proxy <https://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> --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 --name mesos-cluster-template \
--image-id ubuntu-mesos \ --image ubuntu-mesos \
--keypair-id testkey \ --keypair testkey \
--external-network-id public \ --external-network public \
--dns-nameserver 8.8.8.8 \ --dns-nameserver 8.8.8.8 \
--flavor-id m1.small \ --flavor m1.small \
--coe mesos \ --coe mesos \
--http-proxy <http://abc-proxy.com:8080> \ --http-proxy <http://abc-proxy.com:8080> \
--https-proxy <https://abc-proxy.com:8080> \ --https-proxy <https://abc-proxy.com:8080> \

4
doc/source/troubleshooting-guide.rst
View File

@ -193,7 +193,7 @@ The nodes for Kubernetes, Swarm and Mesos are connected to a private
Neutron network, so to provide access to the external internet, a router Neutron network, so to provide access to the external internet, a router
connects the private network to a public network. With devstack, the connects the private network to a public network. With devstack, the
default public network is "public", but this can be replaced by the default public network is "public", but this can be replaced by the
parameter "external-network-id" in the ClusterTemplate. The "public" network parameter "external-network" in the ClusterTemplate. The "public" network
with devstack is actually not a real external network, so it is in turn with devstack is actually not a real external network, so it is in turn
routed to the network interface of the host for devstack. This is routed to the network interface of the host for devstack. This is
configured in the file local.conf with the variable PUBLIC_INTERFACE, configured in the file local.conf with the variable PUBLIC_INTERFACE,
@ -216,7 +216,7 @@ Check the following:
- Is PUBLIC_INTERFACE in devstack/local.conf the correct network - Is PUBLIC_INTERFACE in devstack/local.conf the correct network
interface? Does this interface have a route to the external internet? interface? Does this interface have a route to the external internet?
- If "external-network-id" is specified in the ClusterTemplate, does this - If "external-network" is specified in the ClusterTemplate, does this
network have a route to the external internet? network have a route to the external internet?
- Is your devstack environment behind a firewall? This can be the case for some - Is your devstack environment behind a firewall? This can be the case for some
enterprises or countries. In this case, consider using a `proxy server enterprises or countries. In this case, consider using a `proxy server

68
doc/source/userguide.rst
View File

@ -87,7 +87,7 @@ They are loosely grouped as: mandatory, infrastructure, COE specific.
documentation for the new COE names. This is a mandatory parameter documentation for the new COE names. This is a mandatory parameter
and there is no default value. and there is no default value.
--image-id \<image-id\> --image \<image\>
The name or UUID of the base image in Glance to boot the servers for The name or UUID of the base image in Glance to boot the servers for
the cluster. The image must have the attribute 'os-distro' defined the cluster. The image must have the attribute 'os-distro' defined
as appropriate for the cluster driver. For the currently supported as appropriate for the cluster driver. For the currently supported
@ -103,7 +103,7 @@ They are loosely grouped as: mandatory, infrastructure, COE specific.
This is a mandatory parameter and there is no default value. This is a mandatory parameter and there is no default value.
--keypair-id \<keypair-id\> --keypair \<keypair\>
The name or UUID of the SSH keypair to configure in the cluster servers 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 for ssh access. You will need the key to be able to ssh to the
servers in the cluster. The login name is specific to the cluster servers in the cluster. The login name is specific to the cluster
@ -111,7 +111,7 @@ They are loosely grouped as: mandatory, infrastructure, COE specific.
Cluster create. This value will be overridden by any keypair value that Cluster create. This value will be overridden by any keypair value that
is provided during Cluster create. is provided during Cluster create.
--external-network-id \<external-network-id\> --external-network \<external-network\>
The name or network ID of a Neutron network to provide connectivity The name or network ID of a Neutron network to provide connectivity
to the external internet for the cluster. This network must be an to the external internet for the cluster. This network must be an
external network, i.e. its attribute 'router:external' must be external network, i.e. its attribute 'router:external' must be
@ -177,11 +177,11 @@ They are loosely grouped as: mandatory, infrastructure, COE specific.
This is configured in the private Neutron network for the cluster. The This is configured in the private Neutron network for the cluster. The
default is '8.8.8.8'. default is '8.8.8.8'.
--flavor-id \<flavor-id\> --flavor \<flavor\>
The nova flavor id for booting the node servers. The default The nova flavor id for booting the node servers. The default
is 'm1.small'. is 'm1.small'.
--master-flavor-id \<master-flavor-id\> --master-flavor \<master-flavor\>
The nova flavor id for booting the master or manager servers. The The nova flavor id for booting the master or manager servers. The
default is 'm1.small'. default is 'm1.small'.
@ -933,11 +933,11 @@ When Magnum deploys a Kubernetes cluster, it uses parameters defined in the
ClusterTemplate and specified on the cluster-create command, for example:: ClusterTemplate and specified on the cluster-create command, for example::
magnum cluster-template-create --name k8s-cluster-template \ magnum cluster-template-create --name k8s-cluster-template \
--image-id fedora-atomic-latest \ --image fedora-atomic-latest \
--keypair-id testkey \ --keypair testkey \
--external-network-id public \ --external-network public \
--dns-nameserver 8.8.8.8 \ --dns-nameserver 8.8.8.8 \
--flavor-id m1.small \ --flavor m1.small \
--docker-volume-size 5 \ --docker-volume-size 5 \
--network-driver flannel \ --network-driver flannel \
--coe kubernetes --coe kubernetes
@ -990,7 +990,7 @@ Storage driver (docker-storage-driver)
driver to manage this logical volume and host the container writable driver to manage this logical volume and host the container writable
layer there. Refer to the `Storage`_ section for more details. layer there. Refer to the `Storage`_ section for more details.
Image (image-id) Image (image)
Specified in the ClusterTemplate to indicate the image to boot the servers. Specified in the ClusterTemplate to indicate the image to boot the servers.
The image binary is loaded in Glance with the attribute The image binary is loaded in Glance with the attribute
'os_distro = fedora-atomic'. 'os_distro = fedora-atomic'.
@ -1059,11 +1059,11 @@ the ClusterTemplate and specified on the 'cluster-create' command, for
example:: example::
magnum cluster-template-create --name swarm-cluster-template \ magnum cluster-template-create --name swarm-cluster-template \
--image-id fedora-atomic-latest \ --image fedora-atomic-latest \
--keypair-id testkey \ --keypair testkey \
--external-network-id public \ --external-network public \
--dns-nameserver 8.8.8.8 \ --dns-nameserver 8.8.8.8 \
--flavor-id m1.small \ --flavor m1.small \
--docker-volume-size 5 \ --docker-volume-size 5 \
--coe swarm --coe swarm
@ -1136,7 +1136,7 @@ Storage driver (docker-storage-driver)
Magnum will create physical volume and logical volume using the attached Magnum will create physical volume and logical volume using the attached
device. Refer to the `Storage`_ section for more details. device. Refer to the `Storage`_ section for more details.
Image (image-id) Image (image)
Specified in the ClusterTemplate to indicate the image to boot the servers Specified in the ClusterTemplate to indicate the image to boot the servers
for the Swarm manager and node. for the Swarm manager and node.
The image binary is loaded in Glance with the attribute The image binary is loaded in Glance with the attribute
@ -1188,11 +1188,11 @@ Magnum deploys a Mesos cluster using parameters defined in the ClusterTemplate
and specified on the 'cluster-create' command, for example:: and specified on the 'cluster-create' command, for example::
magnum cluster-template-create --name mesos-cluster-template \ magnum cluster-template-create --name mesos-cluster-template \
--image-id ubuntu-mesos \ --image ubuntu-mesos \
--keypair-id testkey \ --keypair testkey \
--external-network-id public \ --external-network public \
--dns-nameserver 8.8.8.8 \ --dns-nameserver 8.8.8.8 \
--flavor-id m1.small \ --flavor m1.small \
--coe mesos --coe mesos
magnum cluster-create --name mesos-cluster \ magnum cluster-create --name mesos-cluster \
@ -1252,7 +1252,7 @@ Volume driver (volume-driver)
Storage driver (docker-storage-driver) Storage driver (docker-storage-driver)
This is currently not supported for Mesos. This is currently not supported for Mesos.
Image (image-id) Image (image)
Specified in the ClusterTemplate to indicate the image to boot the servers Specified in the ClusterTemplate to indicate the image to boot the servers
for the Mesos master and slave. The image binary is loaded in for the Mesos master and slave. The image binary is loaded in
@ -1498,11 +1498,11 @@ First, create a ClusterTemplate; by default TLS is enabled in
Magnum, therefore it does not need to be specified via a parameter:: Magnum, therefore it does not need to be specified via a parameter::
magnum cluster-template-create --name secure-kubernetes \ magnum cluster-template-create --name secure-kubernetes \
--keypair-id default \ --keypair default \
--external-network-id public \ --external-network public \
--image-id fedora-atomic-latest \ --image fedora-atomic-latest \
--dns-nameserver 8.8.8.8 \ --dns-nameserver 8.8.8.8 \
--flavor-id m1.small \ --flavor m1.small \
--docker-volume-size 3 \ --docker-volume-size 3 \
--coe kubernetes \ --coe kubernetes \
--network-driver flannel --network-driver flannel
@ -1874,7 +1874,7 @@ new models are likely to be introduced in the future.
For the Neutron infrastructure, the following configuration can For the Neutron infrastructure, the following configuration can
be set in the ClusterTemplate: be set in the ClusterTemplate:
external-network-id external-network
The external Neutron network ID to connect to this cluster. This The external Neutron network ID to connect to this cluster. This
is used to connect the cluster to the external internet, allowing is used to connect the cluster to the external internet, allowing
the nodes in the cluster to access external URL for discovery, image the nodes in the cluster to access external URL for discovery, image
@ -2207,11 +2207,11 @@ development team is working on a long term solution to automate these steps.
Specify 'cinder' as the volume-driver for Kubernetes:: Specify 'cinder' as the volume-driver for Kubernetes::
magnum cluster-template-create --name k8s-cluster-template \ magnum cluster-template-create --name k8s-cluster-template \
--image-id fedora-23-atomic-7 \ --image fedora-23-atomic-7 \
--keypair-id testkey \ --keypair testkey \
--external-network-id public \ --external-network public \
--dns-nameserver 8.8.8.8 \ --dns-nameserver 8.8.8.8 \
--flavor-id m1.small \ --flavor m1.small \
--docker-volume-size 5 \ --docker-volume-size 5 \
--network-driver flannel \ --network-driver flannel \
--coe kubernetes \ --coe kubernetes \
@ -2342,14 +2342,14 @@ Using Cinder in Mesos
will ensure data safety by locking the volume:: will ensure data safety by locking the volume::
magnum cluster-template-create --name mesos-cluster-template \ magnum cluster-template-create --name mesos-cluster-template \
--image-id ubuntu-mesos \ --image ubuntu-mesos \
--keypair-id testkey \ --keypair testkey \
--external-network-id public \ --external-network public \
--dns-nameserver 8.8.8.8 \ --dns-nameserver 8.8.8.8 \
--master-flavor-id m1.magnum \ --master-flavor m1.magnum \
--docker-volume-size 4 \ --docker-volume-size 4 \
--tls-disabled \ --tls-disabled \
--flavor-id m1.magnum \ --flavor m1.magnum \
--coe mesos \ --coe mesos \
--volume-driver rexray \ --volume-driver rexray \
--labels rexray-preempt=true --labels rexray-preempt=true