openstack/magnum
Code Issues Proposed changes

Document use of kube_tag label

Browse Source 
Explain how to select a specific Kubernetes version by specifying the
kube_tag label.

In the process, also fix the broken list of images that must be
mirrored, immediately above kube_tag.

In addition, fix an unrelated whitespace error in
specs/containers-service.rst which would cause tox -e docs to fail.

Change-Id: Ieff1474b74e0b1595c05d945b69bec16bfef9c3b
This commit is contained in:
Florian Haas 2018-02-13 13:26:22 +01:00
parent ae21e41ec4
commit 11e7f330fb
2 changed files with 11 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/source/user/index.rst
View File

@ -336,6 +336,8 @@ the table are linked to more details elsewhere in the user guide.
+---------------------------------------+--------------------+---------------+ +---------------------------------------+--------------------+---------------+
| `grafana_admin_passwd`_ | (any string) | "admin" | | `grafana_admin_passwd`_ | (any string) | "admin" |
+---------------------------------------+--------------------+---------------+ +---------------------------------------+--------------------+---------------+
| `kube_tag`_ | see below | see below |
+---------------------------------------+--------------------+---------------+
| `kube_dashboard_enabled`_ | - true | true | | `kube_dashboard_enabled`_ | - true | true |
| | - false | | | | - false | |
+---------------------------------------+--------------------+---------------+ +---------------------------------------+--------------------+---------------+
@ -1087,6 +1089,7 @@ _`container_infra_prefix`
which assumes an operator has cloned all expected images in which assumes an operator has cloned all expected images in
myregistry.example.com/mycloud. myregistry.example.com/mycloud.
Images that must be mirrored: Images that must be mirrored:
* docker.io/coredns/coredns:011 * docker.io/coredns/coredns:011
* docker.io/grafana/grafana:latest * docker.io/grafana/grafana:latest
* docker.io/openstackmagnum/kubernetes-apiserver * docker.io/openstackmagnum/kubernetes-apiserver
@ -1099,6 +1102,13 @@ _`container_infra_prefix`
* gcr.io/google_containers/kubernetes-dashboard-amd64:v1.5.1 * gcr.io/google_containers/kubernetes-dashboard-amd64:v1.5.1
* gcr.io/google_containers/pause:3.0 * gcr.io/google_containers/pause:3.0
_`kube_tag`
This label allows users to select `a specific Kubernetes release,
based on its container tag
<https://hub.docker.com/r/openstackmagnum/kubernetes-apiserver/tags/>`_.
If unset, the current Magnum version's default Kubernetes release is
installed.
_`kube_dashboard_enabled` _`kube_dashboard_enabled`
This label triggers the deployment of the kubernetes dashboard. This label triggers the deployment of the kubernetes dashboard.
The default value is 1, meaning it will be enabled. The default value is 1, meaning it will be enabled.

2
specs/containers-service.rst
View File

@ -175,7 +175,7 @@ with the Containers Service, and can be controlled only by a Nova virt driver.
|           +-------+ |  | +-----+                   | |           +-------+ |  | +-----+                   |
|                     |  |                           | |                     |  |                           |
+-----------+---------+  +---------------+-----------+ +-----------+---------+  +---------------+-----------+
            |                            |                         |                            |
+-----------+----+ Compute Host ---------|-----------+ +-----------+----+ Compute Host ---------|-----------+
|                                    +---+---+       | |                                    +---+---+       |
|                               +----+ Relay +---+   | |                               +----+ Relay +---+   |