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

Commit 89c7b5d

Browse files
author
Luke Addison
committed
Split up addon documentation
1 parent cd886ed commit 89c7b5d

File tree

2 files changed

+34
-6
lines changed

2 files changed

+34
-6
lines changed

docs/user-guide.rst

Lines changed: 33 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -150,10 +150,10 @@ The configuration file can be found at ``$HOME/.tarmak/tarmak.yaml`` (default).
150150
The Pod Security Policy manifests can be found within the tarmak directory at
151151
``puppet/modules/kubernetes/templates/pod-security-policy.yaml.erb``
152152

153-
Dashboard, Cluster Autoscaler and Tiller
154-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
153+
Cluster Autoscaler
154+
~~~~~~~~~~~~~~~~~~
155155

156-
Tarmak supports a number of Kubernetes addons including Kubernetes Dashboard, Cluster Autoscaler and Tiller. The following `tarmak.yaml` snippet shows how you would enable Cluster Autoscaler.
156+
Tarmak supports deploying `Cluster Autoscaler <https://github.com/kubernetes/autoscaler/tree/master/cluster-autoscaler>`_ when spinning up a Kubernetes cluster. The following `tarmak.yaml` snippet shows how you would enable Cluster Autoscaler.
157157

158158
.. code-block:: yaml
159159
@@ -162,9 +162,37 @@ Tarmak supports a number of Kubernetes addons including Kubernetes Dashboard, Cl
162162
enabled: true
163163
...
164164
165-
The above configuration would deploy Cluster Autoscaler with an image of `gcr.io/google_containers/cluster-autoscaler` using the recommend version based on the version of your Kubernetes cluster. The configuration block also accepts two optional fields of `image` and `version` allowing you to change these defaults. Note that the final image tag used when deploying the autoscaler will be the configured version prepended with the letter `v`.
165+
The above configuration would deploy Cluster Autoscaler with an image of `gcr.io/google_containers/cluster-autoscaler` using the recommend version based on the version of your Kubernetes cluster. The configuration block accepts two optional fields of `image` and `version` allowing you to change these defaults. Note that the final image tag used when deploying Cluster Autoscaler will be the configured version prepended with the letter `v`.
166+
167+
The current implementation will configure the first instance pool of type worker in your cluster configuration to scale between `minCount` and `maxCount`. We plan to add support for an arbitrary number of worker instance pools.
168+
169+
Dashboard
170+
~~~~~~~~~
171+
172+
Tarmak supports deploying `Kubernetes Dashboard <https://github.com/kubernetes/dashboard>`_ when spinning up a Kubernetes cluster. The following `tarmak.yaml` snippet shows how you would enable Kubernetes Dashboard.
173+
174+
.. code-block:: yaml
175+
176+
kubernetes:
177+
dashboard:
178+
enabled: true
179+
...
180+
181+
The above configuration would deploy Kubernetes Dashboard with an image of `gcr.io/google_containers/kubernetes-dashboard-amd64` 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.
182+
183+
Tiller
184+
~~~~~~
185+
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.
187+
188+
.. code-block:: yaml
189+
190+
kubernetes:
191+
tiller:
192+
enabled: true
193+
...
166194
167-
This configuration works similarly for Dashboard and Tiller using images of `gcr.io/google_containers/kubernetes-dashboard-amd64` and `gcr.io/kubernetes-helm/tiller` respectively by default.
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.
168196

169197
Logging
170198
~~~~~~~

puppet/modules/kubernetes_addons/templates/tiller-deployment.yaml.erb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ spec:
1818
serviceAccountName: tiller
1919
<%- end -%>
2020
containers:
21-
- image: <%= @image %>:v<%= @version %>
21+
- image: <%= @image %>:<%= @version %>
2222
args:
2323
- /tiller
2424
- --listen=localhost:44134

0 commit comments

Comments
 (0)