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

Commit 7822d5c

Browse files
author
Luke Addison
committed
Reverse Tiller and Dashboard documentation changes
1 parent d723d4d commit 7822d5c

File tree

1 file changed

+25
-51
lines changed

1 file changed

+25
-51
lines changed

docs/user-guide.rst

Lines changed: 25 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -176,57 +176,6 @@ The current implementation will configure the first instance pool of type worker
176176
in your cluster configuration to scale between `minCount` and `maxCount`. We
177177
plan to add support for an arbitrary number of worker instance pools.
178178

179-
Dashboard
180-
~~~~~~~~~
181-
182-
Tarmak supports deploying `Kubernetes Dashboard
183-
<https://github.com/kubernetes/dashboard>`_ when spinning up a Kubernetes
184-
cluster. The following `tarmak.yaml` snippet shows how you would enable
185-
Kubernetes Dashboard.
186-
187-
.. code-block:: yaml
188-
189-
kubernetes:
190-
dashboard:
191-
enabled: true
192-
...
193-
194-
The above configuration would deploy Kubernetes Dashboard with an image of
195-
`gcr.io/google_containers/kubernetes-dashboard-amd64` with a fixed tag. The
196-
configuration block accepts two optional fields of `image` and `version`
197-
allowing you to change these defaults. The `version` field directly translates
198-
to the image tag used.
199-
200-
Tiller
201-
~~~~~~
202-
203-
Tarmak supports deploying Tiller, the server-side component of `Helm
204-
<https://github.com/kubernetes/helm>`_, when spinning up a Kubernetes cluster.
205-
Tiller is configured to listen on localhost only which prevents arbitrary Pods
206-
in the cluster connecting to its unauthenticated endpoint. Helm clients can
207-
still talk to Tiller by port forwarding through the Kubernetes API Server. The
208-
following `tarmak.yaml` snippet shows how you would enable Tiller.
209-
210-
.. code-block:: yaml
211-
212-
kubernetes:
213-
tiller:
214-
enabled: true
215-
...
216-
217-
The above configuration would deploy Tiller with an image of
218-
`gcr.io/kubernetes-helm/tiller` with a fixed tag. The configuration block
219-
accepts two optional fields of `image` and `version` allowing you to change
220-
these defaults. The `version` field directly translates to the image tag used.
221-
The version is particularly important when deploying Tiller since its minor
222-
version must match the minor version of any Helm clients.
223-
224-
.. warning::
225-
Tiller is deployed with full ``cluster-admin`` ClusterRole bound to its
226-
service account and has therefore has quiet far reaching privileges. Also
227-
consider Helm's `security best practices
228-
<https://github.com/kubernetes/helm/blob/master/docs/securing_installation.md>`_.
229-
230179
Logging
231180
~~~~~~~
232181

@@ -413,6 +362,31 @@ certificate is valid for ``jenkins.<environment>.<zone>``.
413362
type: ssd
414363
...
415364
365+
Tiller
366+
~~~~~~
367+
368+
Another configuration option allows to deploy Tiller the server-side of `Helm
369+
<https://github.com/kubernetes/helm>`_. Tiller is listening for request on the
370+
loopback device only. This makes sure that no other Pod in the cluster can
371+
speak to it, while Helm clients are still able to access it using a port
372+
forwarding through the API server.
373+
374+
As Helm and Tiller minor version need to match, the tarmak configuration also
375+
allows to override the deployed version:
376+
377+
.. code-block:: yaml
378+
379+
kubernetes:
380+
tiller:
381+
enabled: true
382+
version: 2.9.1
383+
384+
.. warning::
385+
Tiller is deployed with full ``cluster-admin`` ClusterRole bound to its
386+
service account and has therefore quiet far reaching privileges. Also
387+
consider Helm's `security best practices
388+
<https://github.com/kubernetes/helm/blob/master/docs/securing_installation.md>`_.
389+
416390
Prometheus
417391
~~~~~~~~~~
418392

0 commit comments

Comments
 (0)