Skip to content
This repository was archived by the owner on Jan 9, 2023. It is now read-only.

Commit 1277c0a

Browse files
author
Luke Addison
committed
Deduplicate Tiller documentation
1 parent 89c7b5d commit 1277c0a

File tree

1 file changed

+8
-29
lines changed

1 file changed

+8
-29
lines changed

docs/user-guide.rst

Lines changed: 8 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -183,7 +183,7 @@ The above configuration would deploy Kubernetes Dashboard with an image of `gcr.
183183
Tiller
184184
~~~~~~
185185

186-
Tarmak supports deploying `Tiller <https://github.com/kubernetes/helm>`_ when spinning up a Kubernetes cluster. The following `tarmak.yaml` snippet shows how you would enable Tiller.
186+
Tarmak supports deploying Tiller, the server-side component of `Helm <https://github.com/kubernetes/helm>`_, when spinning up a Kubernetes cluster. Tiller is configured to listen on localhost only which prevents arbitrary Pods in the cluster connecting to its unauthenticated endpoint. Helm clients can still talk to Tiller by port forwarding through the Kubernetes API Server. The following `tarmak.yaml` snippet shows how you would enable Tiller.
187187

188188
.. code-block:: yaml
189189
@@ -192,7 +192,13 @@ Tarmak supports deploying `Tiller <https://github.com/kubernetes/helm>`_ when sp
192192
enabled: true
193193
...
194194
195-
The above configuration would deploy Tiller with an image of `gcr.io/kubernetes-helm/tiller` with a fixed tag. The configuration block accepts two optional fields of `image` and `version` allowing you to change these defaults. The `version` field directly translates to the image tag used.
195+
The above configuration would deploy Tiller with an image of `gcr.io/kubernetes-helm/tiller` with a fixed tag. The configuration block accepts two optional fields of `image` and `version` allowing you to change these defaults. The `version` field directly translates to the image tag used. The version is particularly important when deploying Tiller since its minor version must match the minor version of any Helm clients.
196+
197+
.. warning::
198+
Tiller is deployed with full ``cluster-admin`` ClusterRole bound to its
199+
service account and has therefore has quiet far reaching privileges. Also
200+
consider Helm's `security best practices
201+
<https://github.com/kubernetes/helm/blob/master/docs/securing_installation.md>`_.
196202

197203
Logging
198204
~~~~~~~
@@ -380,33 +386,6 @@ certificate is valid for ``jenkins.<environment>.<zone>``.
380386
type: ssd
381387
...
382388
383-
384-
Tiller
385-
~~~~~~
386-
387-
Another configuration option allows to deploy Tiller the server-side of `Helm
388-
<https://github.com/kubernetes/helm>`_. Tiller is listening for request on the
389-
loopback device only. This makes sure that no other Pod in the cluster can
390-
speak to it, while Helm clients are still able to access it using a port
391-
forwarding through the API server.
392-
393-
As Helm and Tiller minor version need to match, the tarmak configuration also
394-
allows to override the deployed version:
395-
396-
.. code-block:: yaml
397-
398-
kubernetes:
399-
tiller:
400-
enabled: true
401-
version: 2.9.1
402-
403-
.. warning::
404-
Tiller is deployed with full ``cluster-admin`` ClusterRole bound to its
405-
service account and has therefore quiet far reaching privileges. Also
406-
consider Helm's `security best practices
407-
<https://github.com/kubernetes/helm/blob/master/docs/securing_installation.md>`_.
408-
409-
410389
Prometheus
411390
~~~~~~~~~~
412391

0 commit comments

Comments
 (0)