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

[docs] use values.yaml instead of config.yaml everywhere for helm configurations (#14554) 

* use values.yaml instead of config.yaml everywhere for helm values
* update docs
This commit is contained in:
Kyle Schochenmaier 2022-09-09 15:56:33 -05:00 committed by GitHub
parent 25895b8942
commit 208dd1452a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
10 changed files with 71 additions and 72 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
website/content/docs/k8s/connect/connect-ca-provider.mdx
View File

@ -98,7 +98,7 @@ $ kubectl create secret generic vault-config --from-file=config=vault-config.jso
We will provide this secret and the Vault CA secret, to the Consul server via the
`server.extraVolumes` Helm value.
<CodeBlockConfig filename="config.yaml" highlight="4-13">
<CodeBlockConfig filename="values.yaml" highlight="4-13">
```yaml
global:
@ -123,7 +123,7 @@ We will provide this secret and the Vault CA secret, to the Consul server via th
Finally, [install](/docs/k8s/installation/install#installing-consul) the Helm chart using the above config file:
```shell-session
$ helm install consul --values config.yaml hashicorp/consul
$ helm install consul --values values.yaml hashicorp/consul
```
Verify that the CA provider is set correctly:

6
website/content/docs/k8s/connect/ingress-gateways.mdx
View File

@ -26,7 +26,7 @@ Adding an ingress gateway is a multi-step process that consists of the following
When deploying the Helm chart you must provide Helm with a custom YAML file that contains your environment configuration.
<CodeBlockConfig filename="config.yaml">
<CodeBlockConfig filename="values.yaml">
```yaml
global:
@ -260,7 +260,7 @@ leaving an open and unauthenticated load balancer alive in your cluster.
To delete the ingress gateway, set enabled to `false` in your Helm configuration:
<CodeBlockConfig filename="config.yaml" highlight="8">
<CodeBlockConfig filename="values.yaml" highlight="8">
```yaml
global:
@ -282,5 +282,5 @@ ingressGateways:
And run Helm upgrade:
```shell-session
$ helm upgrade consul hashicorp/consul --values config.yaml
$ helm upgrade consul hashicorp/consul --values values.yaml
```

4
website/content/docs/k8s/connect/terminating-gateways.mdx
View File

@ -23,7 +23,7 @@ Adding a terminating gateway is a multi-step process:
Minimum required Helm options:
<CodeBlockConfig filename="config.yaml">
<CodeBlockConfig filename="values.yaml">
```yaml
global:
@ -43,7 +43,7 @@ terminatingGateways:
The Helm chart may be deployed using the [Consul on Kubernetes CLI](/docs/k8s/k8s-cli).
```shell-session
$ consul-k8s install -f config.yaml
$ consul-k8s install -f values.yaml
```
## Accessing the Consul agent

10
website/content/docs/k8s/deployment-configurations/consul-enterprise.mdx
View File

@ -21,9 +21,9 @@ kubectl create secret generic consul-ent-license --from-literal="key=${secret}"
-> **Note:** If you cannot find your `.hclic` file, please contact your sales team or Technical Account Manager.
In your `config.yaml`, change the value of `global.image` to one of the enterprise [release tags](https://hub.docker.com/r/hashicorp/consul-enterprise/tags).
In your `values.yaml`, change the value of `global.image` to one of the enterprise [release tags](https://hub.docker.com/r/hashicorp/consul-enterprise/tags).
<CodeBlockConfig filename="config.yaml" highlight="2">
<CodeBlockConfig filename="values.yaml" highlight="2">
```yaml
global:
@ -34,7 +34,7 @@ global:
Add the name and key of the secret you just created to `server.enterpriseLicense`, if using Consul version 1.10+.
<CodeBlockConfig filename="config.yaml" highlight="4-6">
<CodeBlockConfig filename="values.yaml" highlight="4-6">
```yaml
global:
@ -51,7 +51,7 @@ If the version of Consul is < 1.10, use the following config with the name and k
-> **Note:** The value of `server.enterpriseLicense.enableLicenseAutoload` must be set to `false`.
<CodeBlockConfig filename="config.yaml" highlight="7">
<CodeBlockConfig filename="values.yaml" highlight="7">
```yaml
global:
@ -67,7 +67,7 @@ global:
Now run `helm install`:
```shell-session
$ helm install --wait hashicorp hashicorp/consul --values config.yaml
$ helm install --wait hashicorp hashicorp/consul --values values.yaml
```
Once the cluster is up, you can verify the nodes are running Consul Enterprise by

12
website/content/docs/k8s/deployment-configurations/multi-cluster/kubernetes.mdx
View File

@ -31,10 +31,10 @@ If you haven't installed Consul on your cluster, continue reading below. If you'
already installed Consul on a cluster and want to upgrade it to
support federation, see [Upgrading An Existing Cluster](#upgrading-an-existing-cluster).
You will need to use the following `config.yaml` file for your primary cluster,
You will need to use the following `values.yaml` file for your primary cluster,
with the possible modifications listed below.
<CodeBlockConfig filename="config.yaml">
<CodeBlockConfig filename="values.yaml">
```yaml
global:
@ -114,7 +114,7 @@ Modifications:
mesh gateway, for example using a Node Port service or a custom DNS entry,
see the [Helm reference](/docs/k8s/helm#v-meshgateway) for that setting.
With your `config.yaml` ready to go, follow our [Installation Guide](/docs/k8s/installation/install)
With your `values.yaml` ready to go, follow our [Installation Guide](/docs/k8s/installation/install)
to install Consul on your primary cluster.
-> **NOTE:** You must be using consul-helm 0.21.0+. To update, run `helm repo update`.
@ -124,7 +124,7 @@ to install Consul on your primary cluster.
If you have an existing cluster, you will need to upgrade it to ensure it has
the following config:
<CodeBlockConfig filename="config.yaml">
<CodeBlockConfig filename="values.yaml">
```yaml
global:
@ -316,7 +316,7 @@ With the primary cluster up and running, and the [federation secret](#federation
into the secondary cluster, we can now install Consul into the secondary
cluster.
You will need to use the following `config.yaml` file for your secondary cluster(s),
You will need to use the following `values.yaml` file for your secondary cluster(s),
with the modifications listed below.
-> **NOTE: ** You must use a separate Helm config file for each cluster (primary and secondaries) since their
@ -414,7 +414,7 @@ Modifications:
mesh gateway, for example using a Node Port service or a custom DNS entry,
see the [Helm reference](/docs/k8s/helm#v-meshgateway) for that setting.
With your `config.yaml` ready to go, follow our [Installation Guide](/docs/k8s/installation/install)
With your `values.yaml` ready to go, follow our [Installation Guide](/docs/k8s/installation/install)
to install Consul on your secondary cluster(s).
## Verifying Federation

14
website/content/docs/k8s/deployment-configurations/servers-outside-kubernetes.mdx
View File

@ -9,7 +9,7 @@ description: Running Consul servers outside of Kubernetes
If you have a Consul cluster already running, you can configure your
Consul clients inside Kubernetes to join this existing cluster.
The below `config.yaml` file shows how to configure the Helm chart to install
The below `values.yaml` file shows how to configure the Helm chart to install
Consul clients that will join an existing cluster.
The `global.enabled` value first disables all chart components by default
@ -27,7 +27,7 @@ example above, a fake [cloud auto-join](/docs/agent/cloud-auto-join)
value is specified. This should be set to resolve to the proper addresses of
your existing Consul cluster.
<CodeBlockConfig filename="config.yaml">
<CodeBlockConfig filename="values.yaml">
```yaml
global:
@ -66,7 +66,7 @@ If you would like to use this feature with external Consul servers, you need to
so that it can retrieve the clients' CA to use for securing the rest of the cluster.
To do that, you must add the following values, in addition to the values mentioned above:
<CodeBlockConfig filename="config.yaml" highlight="2-8">
<CodeBlockConfig filename="values.yaml" highlight="2-8">
```yaml
global:
@ -106,7 +106,7 @@ kubectl create secret generic bootstrap-token --from-literal='token=<your bootst
Then provide that secret to the Helm chart:
<CodeBlockConfig filename="config.yaml" highlight="4-6">
<CodeBlockConfig filename="values.yaml" highlight="4-6">
```yaml
global:
@ -131,7 +131,7 @@ to create policies, tokens, and an auth method. If you are [enabling Consul Conn
so that the Consul servers can validate a Kubernetes service account token when using the [Kubernetes auth method](/docs/security/acl/auth-methods/kubernetes)
with `consul login`.
<CodeBlockConfig filename="config.yaml">
<CodeBlockConfig filename="values.yaml">
```yaml
externalServers:
@ -145,7 +145,7 @@ externalServers:
Your resulting Helm configuration will end up looking similar to this:
<CodeBlockConfig filename="config.yaml">
<CodeBlockConfig filename="values.yaml">
```yaml
global:
@ -176,7 +176,7 @@ externalServers:
If you would like the Helm chart to call the bootstrapping API and set the server tokens for you, then the steps are similar.
The only difference is that you don't need to set the bootstrap token. The Helm chart will save the bootstrap token as a Kubernetes secret.
<CodeBlockConfig filename="config.yaml">
<CodeBlockConfig filename="values.yaml">
```yaml
global:

8
website/content/docs/k8s/deployment-configurations/single-dc-multi-k8s.mdx
View File

@ -42,7 +42,7 @@ Before proceeding with installation, prepare the Helm release names as environme
First, deploy the first cluster with Consul Servers and Clients with the example Helm configuration below.
<CodeBlockConfig filename="cluster1-config.yaml">
<CodeBlockConfig filename="cluster1-values.yaml">
```yaml
global:
@ -82,7 +82,7 @@ $ kubectl create secret generic consul-gossip-encryption-key --from-literal=key=
Now install Consul cluster with Helm:
```shell-session
$ helm install ${HELM_RELEASE_SERVER} --values cluster1-config.yaml hashicorp/consul
$ helm install ${HELM_RELEASE_SERVER} --values cluster1-values.yaml hashicorp/consul
```
@ -112,7 +112,7 @@ $ kubectl apply --filename cluster1-credentials.yaml
```
To deploy in the second cluster, the following example Helm configuration will be used:
<CodeBlockConfig filename="cluster2-config.yaml" highlight="6-11,15-17">
<CodeBlockConfig filename="cluster2-values.yaml" highlight="6-11,15-17">
```yaml
global:
@ -202,7 +202,7 @@ for more details.
Now, proceed with the installation of the second cluster.
```shell-session
$ helm install ${HELM_RELEASE_CLIENT} --values cluster2-config.yaml hashicorp/consul
$ helm install ${HELM_RELEASE_CLIENT} --values cluster2-values.yaml hashicorp/consul
```
## Verifying the Consul Service Mesh works

8
website/content/docs/k8s/helm.mdx
View File

@ -2385,10 +2385,10 @@ Use these links to navigate to a particular top-level stanza.
## Helm Chart Examples
The below `config.yaml` results in a single server Consul cluster with a `LoadBalancer` to allow external access to the UI and API.
The below `values.yaml` results in a single server Consul cluster with a `LoadBalancer` to allow external access to the UI and API.
```yaml
# config.yaml
# values.yaml
server:
replicas: 1
bootstrapExpect: 1
@ -2398,12 +2398,12 @@ ui:
type: LoadBalancer
```
The below `config.yaml` results in a three server Consul Enterprise cluster with 100GB of storage and automatic Connect injection.
The below `values.yaml` results in a three server Consul Enterprise cluster with 100GB of storage and automatic Connect injection.
Note, this would require a secret that contains the enterprise license key.
```yaml
# config.yaml
# values.yaml
global:
image: 'hashicorp/consul-enterprise:1.4.2-ent'

23
website/content/docs/k8s/installation/install.mdx
View File

@ -78,15 +78,15 @@ mesh](https://learn.hashicorp.com/tutorials/consul/service-mesh-deploy?utm_sourc
## Custom installation
If you want to customize your installation,
create a `config.yaml` file to override the default settings.
create a `values.yaml` file to override the default settings.
You can learn what settings are available by running `helm inspect values hashicorp/consul`
or by reading the [Helm Chart Reference](/docs/k8s/helm).
### Minimal `config.yaml` for Consul service mesh
### Minimal `values.yaml` for Consul service mesh
The minimal settings to enable [Consul Service Mesh]((/docs/k8s/connect)) would be captured in the following `config.yaml` config file:
The minimal settings to enable [Consul Service Mesh]((/docs/k8s/connect)) would be captured in the following `values.yaml` config file:
<CodeBlockConfig filename="config.yaml">
<CodeBlockConfig filename="values.yaml">
```yaml
global:
@ -99,10 +99,10 @@ controller:
</CodeBlockConfig>
Once you've created your `config.yaml` file, run `helm install` with the `--values` flag:
Once you've created your `values.yaml` file, run `helm install` with the `--values` flag:
```shell-session
$ helm install consul hashicorp/consul --create-namespace --namespace consul --values config.yaml
$ helm install consul hashicorp/consul --create-namespace --namespace consul --values values.yaml
NAME: consul
...
```
@ -117,11 +117,11 @@ Instead, you can enable the Consul container network interface (CNI) plugin to p
Because the plugin is executed by the local Kubernetes kubelet, the plugin already has the elevated privileges necessary to configure the network.
The Consul Helm Chart is responsible for installing the Consul CNI plugin.
To configure the plugin to be installed, add the following configuration to your `config.yaml` file:
To configure the plugin to be installed, add the following configuration to your `values.yaml` file:
<CodeTabs tabs={[ "Reference configuration","GKE configuration" ]}>
<CodeBlockConfig filename="config.yaml">
<CodeBlockConfig filename="values.yaml">
```yaml
global:
@ -136,7 +136,7 @@ connectInject:
```
</CodeBlockConfig>
<CodeBlockConfig filename="config.yaml">
<CodeBlockConfig filename="values.yaml">
```yaml
global:
@ -167,7 +167,7 @@ The following table describes the available CNI plugin options:
By default, Consul Service Mesh is enabled on almost all namespaces (with the exception of `kube-system` and `local-path-storage`) within a Kubernetes cluster. You can restrict this to a subset of namespaces by specifying a `namespaceSelector` that matches a label attached to each namespace denoting whether to enable Consul service mesh. In order to default to enabling service mesh on select namespaces by label, the `connectInject.default` value must be set to `true`.
<CodeBlockConfig filename="config.yaml">
<CodeBlockConfig filename="values.yaml">
```yaml
global:
@ -194,9 +194,8 @@ $ kubectl label namespace foo connect-inject=enabled
Next, run `helm install` with the `--values` flag:
```shell-session
$ helm install consul hashicorp/consul --create-namespace --namespace consul --values config.yaml
$ helm install consul hashicorp/consul --create-namespace --namespace consul --values values.yaml
NAME: consul
...
```
### Update your Consul on Kubernetes configuration

4
website/content/docs/k8s/upgrade/index.mdx
View File

@ -18,7 +18,7 @@ for those changes to take effect.
For example, if you've installed Consul with the following:
<CodeBlockConfig filename="config.yaml">
<CodeBlockConfig filename="values.yaml">
```yaml
global:
@ -251,7 +251,7 @@ To initiate the upgrade:
By default there are 3 servers, so you would set this value to `3`
1. Set the `updateStrategy` for clients to `OnDelete`
<CodeBlockConfig filename="config.yaml">
<CodeBlockConfig filename="values.yaml">
```yaml
global: