status-im
/
consul
mirror of https://github.com/status-im/consul.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge pull request #5230 from hashicorp/docs/helm-formatting 

Docs/helm formatting
This commit is contained in:
Rebecca Zanzig 2019-01-16 15:00:42 -08:00 committed by GitHub
parent 388ff4caed ebba215891
commit fbb40d72c0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 30 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

58
website/source/docs/platform/k8s/helm.html.md
View File

@ -26,7 +26,7 @@ may still change significantly over time. Please always run Helm with
of Consul. This provides a less complicated out-of-box experience for new users, of Consul. This provides a less complicated out-of-box experience for new users,
but is not appropriate for a production setup. It is highly recommended to use but is not appropriate for a production setup. It is highly recommended to use
a properly secured Kubernetes cluster or make sure that you understand and enable a properly secured Kubernetes cluster or make sure that you understand and enable
the [recommended security features](/docs/internals/security.html.md). Currently, the [recommended security features](/docs/internals/security.html). Currently,
some of these features are not supported in the Helm chart and require additional some of these features are not supported in the Helm chart and require additional
manual configuration. manual configuration.
@ -157,14 +157,14 @@ and consider if they're appropriate for your deployment.
won't request any specific amount of resources. **Setting this is highly won't request any specific amount of resources. **Setting this is highly
recommended.** recommended.**
```yaml ```yaml
# Resources are defined as a formatted multi-line string: # Resources are defined as a formatted multi-line string:
resources: | resources: |
requests: requests:
memory: "10Gi" memory: "10Gi"
limits: limits:
memory: "10Gi" memory: "10Gi"
``` ```
- <a name="v-server-updatepartition" href="#v-server-updatepartition">`updatePartition`</a> (`integer: 0`) - - <a name="v-server-updatepartition" href="#v-server-updatepartition">`updatePartition`</a> (`integer: 0`) -
This value is used to carefully control a rolling update of Consul server This value is used to carefully control a rolling update of Consul server
@ -221,18 +221,18 @@ and consider if they're appropriate for your deployment.
If you need to run more pods per node (for example, testing on Minikube), If you need to run more pods per node (for example, testing on Minikube),
set this value to `null`. set this value to `null`.
```yaml ```yaml
# Recommended default server affinity: # Recommended default server affinity:
affinity: | affinity: |
podAntiAffinity: podAntiAffinity:
requiredDuringSchedulingIgnoredDuringExecution: requiredDuringSchedulingIgnoredDuringExecution:
- labelSelector: - labelSelector:
matchLabels: matchLabels:
app: {{ template "consul.name" . }} app: {{ template "consul.name" . }}
release: "{{ .Release.Name }}" release: "{{ .Release.Name }}"
component: server component: server
topologyKey: kubernetes.io/hostname topologyKey: kubernetes.io/hostname
``` ```
* <a name="v-client" href="#v-client">`client`</a> - Values that configure * <a name="v-client" href="#v-client">`client`</a> - Values that configure
running a Consul client agent on Kubernetes nodes. running a Consul client agent on Kubernetes nodes.
@ -265,14 +265,14 @@ and consider if they're appropriate for your deployment.
[ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.11/#resourcerequirements-v1-core) object. If this isn't specified, then the pods [ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.11/#resourcerequirements-v1-core) object. If this isn't specified, then the pods
won't request any specific amount of resources. won't request any specific amount of resources.
```yaml ```yaml
# Resources are defined as a formatted multi-line string: # Resources are defined as a formatted multi-line string:
resources: | resources: |
requests: requests:
memory: "10Gi" memory: "10Gi"
limits: limits:
memory: "10Gi" memory: "10Gi"
``` ```
- <a name="v-client-extraconfig" href="#v-client-extraconfig">`extraConfig`</a> (`string: "{}"`) - - <a name="v-client-extraconfig" href="#v-client-extraconfig">`extraConfig`</a> (`string: "{}"`) -
A raw string of extra JSON or HCL configuration for Consul clients. This A raw string of extra JSON or HCL configuration for Consul clients. This

2
website/source/docs/platform/k8s/run.html.md
View File

@ -39,7 +39,7 @@ it is highly recommended that you
of Consul. This provides a less complicated out-of-box experience for new users, of Consul. This provides a less complicated out-of-box experience for new users,
but is not appropriate for a production setup. It is highly recommended to use but is not appropriate for a production setup. It is highly recommended to use
a properly secured Kubernetes cluster or make sure that you understand and enable a properly secured Kubernetes cluster or make sure that you understand and enable
the [recommended security features](/docs/internals/security.html.md). Currently, the [recommended security features](/docs/internals/security.html). Currently,
some of these features are not supported in the Helm chart and require additional some of these features are not supported in the Helm chart and require additional
manual configuration. manual configuration.