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

Add TOC to helm reference (#11144)

This commit is contained in:
Luke Kysow 2021-09-28 16:25:40 -07:00 committed by GitHub
parent 410d57879c
commit dfc74f56f5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 40 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -6,18 +6,37 @@ description: Configuration for the Consul Helm chart.
# Helm Chart Configuration # Helm Chart Configuration
## Configuration (Values)
The chart is highly customizable using The chart is highly customizable using
[Helm configuration values](https://helm.sh/docs/intro/using_helm/#customizing-the-chart-before-installing). [Helm configuration values](https://helm.sh/docs/intro/using_helm/#customizing-the-chart-before-installing).
Each value has a reasonable default tuned for an optimal getting started experience Each value has a reasonable default tuned for an optimal getting started experience
with Consul. Before going into production, please review the parameters below with Consul.
and consider if they're appropriate for your deployment.
<!-- DO NOT EDIT. The docs below are generated automatically. To change, edit <!-- DO NOT EDIT. The docs below are generated automatically. To change, edit
the consul-helm repo's values.yaml file --> the consul-helm repo's values.yaml file -->
<!-- codegen: start --> <!-- codegen: start -->
## Top-Level Stanzas
Use these links to navigate to a particular top-level stanza.
- [`global`](#global)
- [`server`](#server)
- [`externalServers`](#externalservers)
- [`client`](#client)
- [`dns`](#dns)
- [`ui`](#ui)
- [`syncCatalog`](#synccatalog)
- [`connectInject`](#connectinject)
- [`controller`](#controller)
- [`meshGateway`](#meshgateway)
- [`ingressGateways`](#ingressgateways)
- [`terminatingGateways`](#terminatinggateways)
- [`webhookCertManager`](#webhookcertmanager)
- [`prometheus`](#prometheus)
- [`tests`](#tests)
## All Values
### global ### global
- `global` ((#v-global)) - Holds values that affect multiple components of the chart. - `global` ((#v-global)) - Holds values that affect multiple components of the chart.
@ -1221,6 +1240,7 @@ and consider if they're appropriate for your deployment.
add prometheus annotations to connect-injected pods. It will also add prometheus annotations to connect-injected pods. It will also
add a listener on the Envoy sidecar to expose metrics. The exposed add a listener on the Envoy sidecar to expose metrics. The exposed
metrics will depend on whether metrics merging is enabled: metrics will depend on whether metrics merging is enabled:
- If metrics merging is enabled: - If metrics merging is enabled:
the Consul sidecar will run a merged metrics server the Consul sidecar will run a merged metrics server
combining Envoy sidecar and Connect service metrics, combining Envoy sidecar and Connect service metrics,
@ -1240,14 +1260,14 @@ and consider if they're appropriate for your deployment.
- `defaultPrometheusScrapePort` ((#v-connectinject-metrics-defaultprometheusscrapeport)) (`integer: 20200`) - Configures the port Prometheus will scrape metrics from, by configuring - `defaultPrometheusScrapePort` ((#v-connectinject-metrics-defaultprometheusscrapeport)) (`integer: 20200`) - Configures the port Prometheus will scrape metrics from, by configuring
the Pod annotation `prometheus.io/port` and the corresponding listener in the Pod annotation `prometheus.io/port` and the corresponding listener in
the Envoy sidecar. the Envoy sidecar.
NOTE: This is *not* the port that your application exposes metrics on. NOTE: This is _not_ the port that your application exposes metrics on.
That can be configured with the That can be configured with the
`consul.hashicorp.com/service-metrics-port` annotation. `consul.hashicorp.com/service-metrics-port` annotation.
- `defaultPrometheusScrapePath` ((#v-connectinject-metrics-defaultprometheusscrapepath)) (`string: /metrics`) - Configures the path Prometheus will scrape metrics from, by configuring the pod - `defaultPrometheusScrapePath` ((#v-connectinject-metrics-defaultprometheusscrapepath)) (`string: /metrics`) - Configures the path Prometheus will scrape metrics from, by configuring the pod
annotation `prometheus.io/path` and the corresponding handler in the Envoy annotation `prometheus.io/path` and the corresponding handler in the Envoy
sidecar. sidecar.
NOTE: This is *not* the path that your application exposes metrics on. NOTE: This is _not_ the path that your application exposes metrics on.
That can be configured with the That can be configured with the
`consul.hashicorp.com/service-metrics-path` annotation. `consul.hashicorp.com/service-metrics-path` annotation.
@ -1449,6 +1469,7 @@ and consider if they're appropriate for your deployment.
`global.acls.manageSystemACLs`). `global.acls.manageSystemACLs`).
If running Consul OSS, requires permissions: If running Consul OSS, requires permissions:
```hcl ```hcl
operator = "write" operator = "write"
service_prefix "" { service_prefix "" {
@ -1456,6 +1477,7 @@ and consider if they're appropriate for your deployment.
intentions = "write" intentions = "write"
} }
``` ```
If running Consul Enterprise, talk to your account manager for assistance. If running Consul Enterprise, talk to your account manager for assistance.
- `secretName` ((#v-controller-acltoken-secretname)) (`string: null`) - The name of the Kubernetes secret. - `secretName` ((#v-controller-acltoken-secretname)) (`string: null`) - The name of the Kubernetes secret.
@ -1788,6 +1810,7 @@ and consider if they're appropriate for your deployment.
is only useful when running helm template. is only useful when running helm template.
- `enabled` ((#v-tests-enabled)) (`boolean: true`) - `enabled` ((#v-tests-enabled)) (`boolean: true`)
<!-- codegen: end --> <!-- codegen: end -->
## Helm Chart Examples ## Helm Chart Examples