Skip to content

Commit 11e7f33

Browse files
committed
Document use of kube_tag label
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
1 parent ae21e41 commit 11e7f33

File tree

2 files changed

+11
-1
lines changed

2 files changed

+11
-1
lines changed

doc/source/user/index.rst

+10
Original file line numberDiff line numberDiff line change
@@ -336,6 +336,8 @@ the table are linked to more details elsewhere in the user guide.
336336
+---------------------------------------+--------------------+---------------+
337337
| `grafana_admin_passwd`_ | (any string) | "admin" |
338338
+---------------------------------------+--------------------+---------------+
339+
| `kube_tag`_ | see below | see below |
340+
+---------------------------------------+--------------------+---------------+
339341
| `kube_dashboard_enabled`_ | - true | true |
340342
| | - false | |
341343
+---------------------------------------+--------------------+---------------+
@@ -1087,6 +1089,7 @@ _`container_infra_prefix`
10871089
which assumes an operator has cloned all expected images in
10881090
myregistry.example.com/mycloud.
10891091
Images that must be mirrored:
1092+
10901093
* docker.io/coredns/coredns:011
10911094
* docker.io/grafana/grafana:latest
10921095
* docker.io/openstackmagnum/kubernetes-apiserver
@@ -1099,6 +1102,13 @@ _`container_infra_prefix`
10991102
* gcr.io/google_containers/kubernetes-dashboard-amd64:v1.5.1
11001103
* gcr.io/google_containers/pause:3.0
11011104

1105+
_`kube_tag`
1106+
This label allows users to select `a specific Kubernetes release,
1107+
based on its container tag
1108+
<https://hub.docker.com/r/openstackmagnum/kubernetes-apiserver/tags/>`_.
1109+
If unset, the current Magnum version's default Kubernetes release is
1110+
installed.
1111+
11021112
_`kube_dashboard_enabled`
11031113
This label triggers the deployment of the kubernetes dashboard.
11041114
The default value is 1, meaning it will be enabled.

specs/containers-service.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,7 @@ with the Containers Service, and can be controlled only by a Nova virt driver.
175175
|           +-------+ |  | +-----+                   |
176176
|                     |  |                           |
177177
+-----------+---------+  +---------------+-----------+
178-
            |                            |            
178+
            |                            |
179179
+-----------+----+ Compute Host ---------|-----------+
180180
|                                    +---+---+       |
181181
|                               +----+ Relay +---+   |

0 commit comments

Comments
 (0)