Adjust helm readme (#5104)

Fixed some discrepancies between the Linkerd's chart README and the default values.

Signed-off-by: Zahari Dichev zaharidichev@gmail.com
This commit is contained in:
Zahari Dichev 2020-10-21 16:38:05 +03:00 committed by GitHub
parent 84b1a826bd
commit 8c4c32eb38
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 13 deletions

View File

@ -103,14 +103,14 @@ their default values.
| `global.clusterNetworks` | The networks that may include pods & services in this cluscter | `10.0.0.0/8,100.64.0.0/10,172.16.0.0/12,192.168.0.0/16` |
| `global.cniEnabled` | Omit the NET_ADMIN capability in the PSP and the proxy-init container when injecting the proxy; requires the linkerd-cni plugin to already be installed | `false` |
| `global.controllerComponentLabel` | Control plane label. Do not edit | `linkerd.io/control-plane-component` |
| `global.controllerNamespaceLabel` | Control plane label. Do not edit | `linkerd.io/control-plane-component` |
| `global.controllerNamespaceLabel` | Control plane label. Do not edit | `linkerd.io/control-plane-ns` |
| `global.podLabels` | Additional labels to add to all pods | `{}` |
| `global.podAnnotations` | Additional annotations to add to all pods | `{}` |
| `global.createdByAnnotation` | Annotation label for the proxy create. Do not edit. | `linkerd.io/created-by` |
| `global.identityTrustAnchorsPEM` | Trust root certificate (ECDSA). It must be provided during install. | |
| `global.identityTrustDomain` | Trust domain used for identity | `cluster.local` |
| `global.imagePullPolicy` | Docker image pull policy | `IfNotPresent` |
| `global.linkerdNamespaceLabel` | Control plane label. Do not edit | `linkerd.io/control-plane-component` |
| `global.linkerdNamespaceLabel` | Control plane label. Do not edit | `linkerd.io/is-control-plane` |
| `global.linkerdVersion` | Control plane version | latest version |
| `global.namespace` | Control plane namespace | `linkerd` |
| `global.proxy.enableExternalProfiles` | Enable service profiles for non-Kubernetes services | `false` |
@ -127,14 +127,14 @@ their default values.
| `global.proxy.resources.cpu.request` | Amount of CPU units that the proxy requests | |
| `global.proxy.resources.memory.limit` | Maximum amount of memory that the proxy can use | |
| `global.proxy.resources.memory.request` | Amount of memory that the proxy requests | |
| `global.proxy.trace.collectorSvcAccount` | Service account associated with the Trace collector instance | |
| `global.proxy.trace.collectorSvcAccount` | Service account associated with the Trace collector instance | `default` |
| `global.proxy.trace.collectorSvcAddr` | Collector Service address for the proxies to send Trace Data | |
| `global.proxy.uid` | User id under which the proxy runs | `2102` |
| `global.proxy.waitBeforeExitSeconds` | The proxy sidecar will stay alive for at least the given period before receiving SIGTERM signal from Kubernetes but no longer than pod's `terminationGracePeriodSeconds`. | `0` |
| `global.proxy.outboundConnectTimeout` | Maximum time allowed for the proxy to establish an outbound TCP connection | `1000ms` |
| `global.proxy.inboundConnectTimeout` | Maximum time allowed for the proxy to establish an inbound TCP connection | `100ms` |
| `global.proxyInit.ignoreInboundPorts` | Inbound ports the proxy should ignore | |
| `global.proxyInit.ignoreOutboundPorts` | Outbound ports the proxy should ignore | |
| `global.proxyInit.ignoreInboundPorts` | Inbound ports the proxy should ignore | `25,443,587,3306,11211` |
| `global.proxyInit.ignoreOutboundPorts` | Outbound ports the proxy should ignore | `25,443,587,3306,11211` |
| `global.proxyInit.image.name` | Docker image for the proxy-init container | `ghcr.io/linkerd/proxy-init` |
| `global.proxyInit.image.pullPolicy` | Pull policy for the proxy-init container Docker image | `IfNotPresent` |
| `global.proxyInit.image.version` | Tag for the proxy-init container Docker image | latest version |
@ -142,13 +142,13 @@ their default values.
| `global.proxyInit.resources.cpu.request` | Amount of CPU units that the proxy-init container requests | `10m` |
| `global.ProxyInit.resources.memory.limit` | Maximum amount of memory that the proxy-init container can use | `50Mi` |
| `global.proxyInit.resources.memory.request` | Amount of memory that the proxy-init container requests | `10Mi` |
| `global.proxyInjectAnnotation` | Annotation label to signal injection. Do not edit. | |
| `global.proxyInjectAnnotation` | Annotation label to signal injection. Do not edit. | `linkerd.io/inject` |
| `global.proxyInjectDisabled` | Annotation value to disable injection. Do not edit. | `disabled` |
| `heartbeatSchedule` | Config for the heartbeat cronjob | `0 0 * * *` |
| `identity.issuer.clockSkewAllowance` | Amount of time to allow for clock skew within a Linkerd cluster | `20s` |
| `identity.issuer.crtExpiry` | Expiration timestamp for the issuer certificate. It must be provided during install | |
| `identity.issuer.crtExpiryAnnotation` | Annotation used to identity the issuer certificate expiration timestamp. Do not edit. | `linkerd.io/identity-issuer-expiry` |
| `identity.issuer.issuanceLifetime` | Amount of time for which the Identity issuer should certify identity | `86400s` |
| `identity.issuer.issuanceLifetime` | Amount of time for which the Identity issuer should certify identity | `24h0m0s` |
| `identity.issuer.scheme` | Which scheme is used for the identity issuer secret format | `linkerd.io/tls` |
| `identity.issuer.tls.crtPEM` | Issuer certificate (ECDSA). It must be provided during install. | |
| `identity.issuer.tls.keyPEM` | Key for the issuer certificate (ECDSA). It must be provided during install. | |
@ -212,13 +212,14 @@ The following table lists the configurable parameters for the Prometheus Add-On.
| `prometheus.enabled` | Flag to enable prometheus instance to be installed | `true` |
| `prometheus.alert_relabel_configs` | Alert relabeling is applied to alerts before they are sent to the Alertmanager. | `[]` |
| `prometheus.alertManagers` | Alertmanager instances the Prometheus server sends alerts to configured via the static_configs parameter. | `[]` |
| `prometheus.args` | Command line options for Prometheus binary | `storage.tsdb.path: /data, storage.tsdb.retention.time: 6h, config.file: /etc/prometheus/prometheus.yml, log.level: *controller_log_level` |
| `prometheus.args` | Command line options for Prometheus binary | `storage.tsdb.path: /data, storage.tsdb.retention.time: 6h, config.file: /etc/prometheus/prometheus.yml, log.level: info` |
| `prometheus.globalConfig` | The global configuration specifies parameters that are valid in all other configuration contexts. | `scrape_interval: 10s, scrape_timeout: 10s, evaluation_interval: 10s` |
| `prometheus.image` | Docker image for the prometheus instance | `prom/prometheus:v2.19.3` |
| `prometheus.proxy.resources` | CPU and Memory resources required by proxy injected into prometheus pod (see `global.proxy.resources` for sub-fields) | values in `global.proxy.resources` |
| `prometheus.persistence.storageClass` | Storage class used to create prometheus data PV. | `nil` |
| `prometheus.persistence.accessMode` | PVC access mode. | `ReadWriteOnce` |
| `prometheus.persistence.size` | Prometheus data volume size. | `8Gi` |
| `prometheus.remoteWrite` | Allows transparently sending samples to an endpoint. Mostly used for long term storage. ||
| `prometheus.resources.cpu.limit` | Maximum amount of CPU units that the prometheus container can use ||
| `prometheus.resources.cpu.request` | Amount of CPU units that the prometheus container requests ||
| `prometheus.resources.memory.limit` | Maximum amount of memory that prometheus container can use ||
@ -238,11 +239,11 @@ The following table lists the configurable parameters for the Tracing Add-On.
|:---------------------------------------------|:-----------------------------------------------------------------------|:---------------------------------------|
| `tracing.enabled` | Flag to enable tracing components to be installed | `false` |
| `tracing.collector.image` | Docker image for the trace collector | `omnition/opencensus-collector:0.1.10` |
| `tracing.collector.resources.cpu.limit` | Maximum amount of CPU units that the trace collector container can use | `1` |
| `tracing.collector.resources.cpu.request` | Amount of CPU units that the trace collector container requests | `200m` |
| `tracing.collector.resources.memory.limit` | Maximum amount of memory that the trace collector container can use | `2Gi` |
| `tracing.collector.resources.memory.request` | Amount of memory that the trace collector container requests | `400Mi` |
| `tracing.jaeger.image` | Docker image for the jaeger instance | `jaegertracing/all-in-one:1.8` |
| `tracing.collector.resources.cpu.limit` | Maximum amount of CPU units that the trace collector container can use | |
| `tracing.collector.resources.cpu.request` | Amount of CPU units that the trace collector container requests | |
| `tracing.collector.resources.memory.limit` | Maximum amount of memory that the trace collector container can use | |
| `tracing.collector.resources.memory.request` | Amount of memory that the trace collector container requests | |
| `tracing.jaeger.image` | Docker image for the jaeger instance | `jaegertracing/all-in-one:1.19.2` |
| `tracing.jaeger.resources.cpu.limit` | Maximum amount of CPU units that the jaeger container can use | |
| `tracing.jaeger.resources.cpu.request` | Amount of CPU units that the jaeger container requests | |
| `tracing.jaeger.resources.memory.limit` | Maximum amount of memory that the jaeger container can use | |