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

Commit d723d4d

Browse files
author
Luke Addison
committed
Truncate docs to 80 chars and add localhost to spelling wordlist
1 parent 1277c0a commit d723d4d

File tree

2 files changed

+35
-7
lines changed

2 files changed

+35
-7
lines changed

docs/spelling_wordlist.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,3 +73,4 @@ offline
7373
admin
7474
plugin
7575
checklist
76+
localhost

docs/user-guide.rst

Lines changed: 34 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,10 @@ The Pod Security Policy manifests can be found within the tarmak directory at
153153
Cluster Autoscaler
154154
~~~~~~~~~~~~~~~~~~
155155

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.
156+
Tarmak supports deploying `Cluster Autoscaler
157+
<https://github.com/kubernetes/autoscaler/tree/master/cluster-autoscaler>`_ when
158+
spinning up a Kubernetes cluster. The following `tarmak.yaml` snippet shows how
159+
you would enable Cluster Autoscaler.
157160

158161
.. code-block:: yaml
159162
@@ -162,14 +165,24 @@ Tarmak supports deploying `Cluster Autoscaler <https://github.com/kubernetes/aut
162165
enabled: true
163166
...
164167
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`.
168+
The above configuration would deploy Cluster Autoscaler with an image of
169+
`gcr.io/google_containers/cluster-autoscaler` using the recommend version based
170+
on the version of your Kubernetes cluster. The configuration block accepts two
171+
optional fields of `image` and `version` allowing you to change these defaults.
172+
Note that the final image tag used when deploying Cluster Autoscaler will be the
173+
configured version prepended with the letter `v`.
166174

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.
175+
The current implementation will configure the first instance pool of type worker
176+
in your cluster configuration to scale between `minCount` and `maxCount`. We
177+
plan to add support for an arbitrary number of worker instance pools.
168178

169179
Dashboard
170180
~~~~~~~~~
171181

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.
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.
173186

174187
.. code-block:: yaml
175188
@@ -178,12 +191,21 @@ Tarmak supports deploying `Kubernetes Dashboard <https://github.com/kubernetes/d
178191
enabled: true
179192
...
180193
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.
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.
182199

183200
Tiller
184201
~~~~~~
185202

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.
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.
187209

188210
.. code-block:: yaml
189211
@@ -192,7 +214,12 @@ Tarmak supports deploying Tiller, the server-side component of `Helm <https://gi
192214
enabled: true
193215
...
194216
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.
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.
196223

197224
.. warning::
198225
Tiller is deployed with full ``cluster-admin`` ClusterRole bound to its

0 commit comments

Comments
 (0)