227 lines
17 KiB
Markdown
227 lines
17 KiB
Markdown
|
# linkerd2
|
||
|
|
|
||
|
|
Linkerd gives you observability, reliability, and security
|
||
|
|
for your microservices — with no code change required.
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
**Homepage:** <https://linkerd.io>
|
||
|
|
|
||
|
|
## Quickstart and documentation
|
||
|
|
|
||
|
|
You can run Linkerd on any Kubernetes 1.16+ cluster in a matter of seconds. See
|
||
|
|
the [Linkerd Getting Started Guide][getting-started] for how.
|
||
|
|
|
||
|
|
For more comprehensive documentation, start with the [Linkerd
|
||
|
|
docs][linkerd-docs].
|
||
|
|
|
||
|
|
## Prerequisite: identity certificates
|
||
|
|
|
||
|
|
The identity component of Linkerd requires setting up a trust anchor
|
||
|
|
certificate, and an issuer certificate with its key. These need to be provided
|
||
|
|
to Helm by the user (unlike when using the `linkerd install` CLI which can
|
||
|
|
generate these automatically). You can provide your own, or follow [these
|
||
|
|
instructions](https://linkerd.io/2/tasks/generate-certificates/) to generate new
|
||
|
|
ones.
|
||
|
|
|
||
|
|
Note that the provided certificates must be ECDSA certificates.
|
||
|
|
|
||
|
|
## Adding Linkerd's Helm repository
|
||
|
|
|
||
|
|
```bash
|
||
|
|
# To add the repo for Linkerd2 stable releases:
|
||
|
|
helm repo add linkerd https://helm.linkerd.io/stable
|
||
|
|
# To add the repo for Linkerd2 edge releases:
|
||
|
|
helm repo add linkerd-edge https://helm.linkerd.io/edge
|
||
|
|
```
|
||
|
|
|
||
|
|
The following instructions use the `linkerd` repo. For installing an edge
|
||
|
|
release, just replace with `linkerd-edge`.
|
||
|
|
|
||
|
|
## Installing the chart
|
||
|
|
|
||
|
|
You must provide the certificates and keys described in the preceding section,
|
||
|
|
and the same expiration date you used to generate the Issuer certificate.
|
||
|
|
|
||
|
|
In this example we set the expiration date to one year ahead:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
helm install \
|
||
|
|
--set-file identityTrustAnchorsPEM=ca.crt \
|
||
|
|
--set-file identity.issuer.tls.crtPEM=issuer.crt \
|
||
|
|
--set-file identity.issuer.tls.keyPEM=issuer.key \
|
||
|
|
--set identity.issuer.crtExpiry=$(date -d '+8760 hour' +"%Y-%m-%dT%H:%M:%SZ") \
|
||
|
|
linkerd/linkerd2
|
||
|
|
```
|
||
|
|
|
||
|
|
## Setting High-Availability
|
||
|
|
|
||
|
|
Besides the default `values.yaml` file, the chart provides a `values-ha.yaml`
|
||
|
|
file that overrides some default values as to set things up under a
|
||
|
|
high-availability scenario, analogous to the `--ha` option in `linkerd install`.
|
||
|
|
Values such as higher number of replicas, higher memory/cpu limits and
|
||
|
|
affinities are specified in that file.
|
||
|
|
|
||
|
|
You can get ahold of `values-ha.yaml` by fetching the chart files:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
helm fetch --untar linkerd/linkerd2
|
||
|
|
```
|
||
|
|
|
||
|
|
Then use the `-f` flag to provide the override file, for example:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
helm install \
|
||
|
|
--set-file identityTrustAnchorsPEM=ca.crt \
|
||
|
|
--set-file identity.issuer.tls.crtPEM=issuer.crt \
|
||
|
|
--set-file identity.issuer.tls.keyPEM=issuer.key \
|
||
|
|
--set identity.issuer.crtExpiry=$(date -d '+8760 hour' +"%Y-%m-%dT%H:%M:%SZ") \
|
||
|
|
-f linkerd2/values-ha.yaml
|
||
|
|
linkerd/linkerd2
|
||
|
|
```
|
||
|
|
|
||
|
|
## Get involved
|
||
|
|
|
||
|
|
* Check out Linkerd's source code at [GitHub][linkerd2].
|
||
|
|
* Join Linkerd's [user mailing list][linkerd-users], [developer mailing
|
||
|
|
list][linkerd-dev], and [announcements mailing list][linkerd-announce].
|
||
|
|
* Follow [@linkerd][twitter] on Twitter.
|
||
|
|
* Join the [Linkerd Slack][slack].
|
||
|
|
|
||
|
|
[cncf]: https://www.cncf.io/
|
||
|
|
[getting-started]: https://linkerd.io/2/getting-started/
|
||
|
|
[linkerd2]: https://github.com/linkerd/linkerd2
|
||
|
|
[linkerd-announce]: https://lists.cncf.io/g/cncf-linkerd-announce
|
||
|
|
[linkerd-dev]: https://lists.cncf.io/g/cncf-linkerd-dev
|
||
|
|
[linkerd-docs]: https://linkerd.io/2/overview/
|
||
|
|
[linkerd-users]: https://lists.cncf.io/g/cncf-linkerd-users
|
||
|
|
[slack]: http://slack.linkerd.io
|
||
|
|
[twitter]: https://twitter.com/linkerd
|
||
|
|
|
||
|
|
## Extensions for Linkerd
|
||
|
|
|
||
|
|
The current chart installs the core Linkerd components, which grant you
|
||
|
|
reliability and security features. Other functionality is available through
|
||
|
|
extensions. Check the corresponding docs for each one of the following
|
||
|
|
extensions:
|
||
|
|
|
||
|
|
* Observability:
|
||
|
|
[Linkerd-viz](https://github.com/linkerd/linkerd2/blob/main/viz/charts/linkerd-viz/README.md)
|
||
|
|
* Multicluster:
|
||
|
|
[Linkerd-multicluster](https://github.com/linkerd/linkerd2/blob/main/multicluster/charts/linkerd-multicluster/README.md)
|
||
|
|
* Tracing:
|
||
|
|
[Linkerd-jaeger](https://github.com/linkerd/linkerd2/blob/main/jaeger/charts/linkerd-jaeger/README.md)
|
||
|
|
|
||
|
|
## Requirements
|
||
|
|
|
||
|
|
Kubernetes: `>=1.16.0-0`
|
||
|
|
|
||
|
|
| Repository | Name | Version |
|
||
|
|
|------------|------|---------|
|
||
|
|
| file://../partials | partials | 0.1.0 |
|
||
|
|
|
||
|
|
## Values
|
||
|
|
|
||
|
|
| Key | Type | Default | Description |
|
||
|
|
|-----|------|---------|-------------|
|
||
|
|
| clusterDomain | string | `"cluster.local"` | Kubernetes DNS Domain name to use |
|
||
|
|
| clusterNetworks | string | `"10.0.0.0/8,100.64.0.0/10,172.16.0.0/12,192.168.0.0/16"` | The cluster networks for which service discovery is performed. This should include the pod and service networks, but need not include the node network. By default, all private networks are specified so that resolution works in typical Kubernetes environments. |
|
||
|
|
| cniEnabled | bool | `false` | enabling this omits 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 |
|
||
|
|
| controlPlaneTracing | bool | `false` | enables control plane tracing |
|
||
|
|
| controlPlaneTracingNamespace | string | `"linkerd-jaeger"` | namespace to send control plane traces to |
|
||
|
|
| controllerImage | string | `"cr.l5d.io/linkerd/controller"` | Docker image for the destination and identity components |
|
||
|
|
| controllerLogFormat | string | `"plain"` | Log format for the control plane components |
|
||
|
|
| controllerLogLevel | string | `"info"` | Log level for the control plane components |
|
||
|
|
| controllerReplicas | int | `1` | Number of replicas for each control plane pod |
|
||
|
|
| controllerUID | int | `2103` | User ID for the control plane components |
|
||
|
|
| debugContainer.image.name | string | `"cr.l5d.io/linkerd/debug"` | Docker image for the debug container |
|
||
|
|
| debugContainer.image.pullPolicy | string | imagePullPolicy | Pull policy for the debug container Docker image |
|
||
|
|
| debugContainer.image.version | string | linkerdVersion | Tag for the debug container Docker image |
|
||
|
|
| disableHeartBeat | bool | `false` | Set to true to not start the heartbeat cronjob |
|
||
|
|
| enableEndpointSlices | bool | `false` | enables the use of EndpointSlice informers for the destination service; enableEndpointSlices should be set to true only if EndpointSlice K8s feature gate is on; the feature is still experimental. |
|
||
|
|
| enableH2Upgrade | bool | `true` | Allow proxies to perform transparent HTTP/2 upgrading |
|
||
|
|
| enablePSP | bool | `false` | Add a PSP resource and bind it to the control plane ServiceAccounts. Note PSP has been deprecated since k8s v1.21 |
|
||
|
|
| identity.externalCA | bool | `false` | If the linkerd-identity-trust-roots ConfigMap has already been created |
|
||
|
|
| identity.issuer.clockSkewAllowance | string | `"20s"` | Amount of time to allow for clock skew within a Linkerd cluster |
|
||
|
|
| identity.issuer.crtExpiry | string | `nil` | Expiration timestamp for the issuer certificate. It must be provided during install. Must match the expiry date in crtPEM |
|
||
|
|
| identity.issuer.issuanceLifetime | string | `"24h0m0s"` | Amount of time for which the Identity issuer should certify identity |
|
||
|
|
| identity.issuer.scheme | string | `"linkerd.io/tls"` | |
|
||
|
|
| identity.issuer.tls | object | `{"crtPEM":"","keyPEM":""}` | Which scheme is used for the identity issuer secret format |
|
||
|
|
| identity.issuer.tls.crtPEM | string | `""` | Issuer certificate (ECDSA). It must be provided during install. |
|
||
|
|
| identity.issuer.tls.keyPEM | string | `""` | Key for the issuer certificate (ECDSA). It must be provided during install |
|
||
|
|
| identityTrustAnchorsPEM | string | `""` | Trust root certificate (ECDSA). It must be provided during install. |
|
||
|
|
| identityTrustDomain | string | clusterDomain | Trust domain used for identity |
|
||
|
|
| imagePullPolicy | string | `"IfNotPresent"` | Docker image pull policy |
|
||
|
|
| imagePullSecrets | list | `[]` | For Private docker registries, authentication is needed. Registry secrets are applied to the respective service accounts |
|
||
|
|
| installNamespace | bool | `true` | Set to false when installing Linkerd in a custom namespace. See the [Linkerd documentation](https://linkerd.io/2/tasks/install-helm#customizing-the-namespace) for more information. |
|
||
|
|
| linkerdVersion | string | `"linkerdVersionValue"` | control plane version. See Proxy section for proxy version |
|
||
|
|
| namespace | string | `"linkerd"` | Control plane namespace |
|
||
|
|
| nodeSelector | object | `{"beta.kubernetes.io/os":"linux"}` | NodeSelector section, See the [K8S documentation](https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#nodeselector) for more information |
|
||
|
|
| podAnnotations | object | `{}` | Additional annotations to add to all pods |
|
||
|
|
| podLabels | object | `{}` | Additional labels to add to all pods |
|
||
|
|
| policyController.defaultAllowPolicy | string | "all-unauthenticated" | The default allow policy to use when no `Server` selects a pod. One of: "all-authenticated", "all-unauthenticated", "cluster-authenticated", "cluster-unauthenticated", "deny" |
|
||
|
|
| policyController.image.name | string | `"cr.l5d.io/linkerd/policy-controller"` | Docker image for the proxy |
|
||
|
|
| policyController.image.pullPolicy | string | imagePullPolicy | Pull policy for the proxy container Docker image |
|
||
|
|
| policyController.image.version | string | linkerdVersion | Tag for the proxy container Docker image |
|
||
|
|
| policyController.logLevel | string | `"linkerd=info,warn"` | Log level for the policy controller |
|
||
|
|
| policyController.resources | object | destinationResources | policy controller resource requests & limits |
|
||
|
|
| policyController.resources.cpu.limit | string | `""` | Maximum amount of CPU units that the policy controller can use |
|
||
|
|
| policyController.resources.cpu.request | string | `""` | Amount of CPU units that the policy controller requests |
|
||
|
|
| policyController.resources.memory.limit | string | `""` | Maximum amount of memory that the policy controller can use |
|
||
|
|
| policyController.resources.memory.request | string | `""` | Maximum amount of memory that the policy controller requests |
|
||
|
|
| policyValidator.caBundle | string | `""` | Bundle of CA certificates for policy validator. If not provided then Helm will use the certificate generated for `policyValidator.crtPEM`. If `policyValidator.externalSecret` is set to true, this value must be set, as no certificate will be generated. |
|
||
|
|
| policyValidator.crtPEM | string | `""` | Certificate for the policy validator. If not provided then Helm will generate one. |
|
||
|
|
| policyValidator.externalSecret | bool | `false` | Do not create a secret resource for the policyValidator webhook. If this is set to `true`, the value `policyValidator.caBundle` must be set (see below). |
|
||
|
|
| policyValidator.keyPEM | string | `""` | Certificate key for the policy validator. If not provided then Helm will generate one. |
|
||
|
|
| policyValidator.namespaceSelector | object | `{"matchExpressions":[{"key":"config.linkerd.io/admission-webhooks","operator":"NotIn","values":["disabled"]}]}` | Namespace selector used by admission webhook |
|
||
|
|
| profileValidator.caBundle | string | `""` | Bundle of CA certificates for service profile validator. If not provided then Helm will use the certificate generated for `profileValidator.crtPEM`. If `profileValidator.externalSecret` is set to true, this value must be set, as no certificate will be generated. |
|
||
|
|
| profileValidator.crtPEM | string | `""` | Certificate for the service profile validator. If not provided then Helm will generate one. |
|
||
|
|
| profileValidator.externalSecret | bool | `false` | Do not create a secret resource for the profileValidator webhook. If this is set to `true`, the value `profileValidator.caBundle` must be set (see below). |
|
||
|
|
| profileValidator.keyPEM | string | `""` | Certificate key for the service profile validator. If not provided then Helm will generate one. |
|
||
|
|
| profileValidator.namespaceSelector | object | `{"matchExpressions":[{"key":"config.linkerd.io/admission-webhooks","operator":"NotIn","values":["disabled"]}]}` | Namespace selector used by admission webhook |
|
||
|
|
| proxy.await | bool | `true` | If set, the application container will not start until the proxy is ready |
|
||
|
|
| proxy.cores | int | `0` | The `cpu.limit` and `cores` should be kept in sync. The value of `cores` must be an integer and should typically be set by rounding up from the limit. E.g. if cpu.limit is '1500m', cores should be 2. |
|
||
|
|
| proxy.enableExternalProfiles | bool | `false` | Enable service profiles for non-Kubernetes services |
|
||
|
|
| proxy.image.name | string | `"cr.l5d.io/linkerd/proxy"` | Docker image for the proxy |
|
||
|
|
| proxy.image.pullPolicy | string | imagePullPolicy | Pull policy for the proxy container Docker image |
|
||
|
|
| proxy.image.version | string | linkerdVersion | Tag for the proxy container Docker image |
|
||
|
|
| proxy.inboundConnectTimeout | string | `"100ms"` | Maximum time allowed for the proxy to establish an inbound TCP connection |
|
||
|
|
| proxy.logFormat | string | `"plain"` | Log format (`plain` or `json`) for the proxy |
|
||
|
|
| proxy.logLevel | string | `"warn,linkerd=info"` | Log level for the proxy |
|
||
|
|
| proxy.opaquePorts | string | `"25,587,3306,4444,5432,6379,9300,11211"` | Default set of opaque ports - SMTP (25,587) server-first - MYSQL (3306) server-first - Galera (4444) server-first - PostgreSQL (5432) server-first - Redis (6379) server-first - ElasticSearch (9300) server-first - Memcached (11211) clients do not issue any preamble, which breaks detection |
|
||
|
|
| proxy.outboundConnectTimeout | string | `"1000ms"` | Maximum time allowed for the proxy to establish an outbound TCP connection |
|
||
|
|
| proxy.ports.admin | int | `4191` | Admin port for the proxy container |
|
||
|
|
| proxy.ports.control | int | `4190` | Control port for the proxy container |
|
||
|
|
| proxy.ports.inbound | int | `4143` | Inbound port for the proxy container |
|
||
|
|
| proxy.ports.outbound | int | `4140` | Outbound port for the proxy container |
|
||
|
|
| proxy.requireIdentityOnInboundPorts | string | `""` | |
|
||
|
|
| proxy.resources.cpu.limit | string | `""` | Maximum amount of CPU units that the proxy can use |
|
||
|
|
| proxy.resources.cpu.request | string | `""` | Amount of CPU units that the proxy requests |
|
||
|
|
| proxy.resources.memory.limit | string | `""` | Maximum amount of memory that the proxy can use |
|
||
|
|
| proxy.resources.memory.request | string | `""` | Maximum amount of memory that the proxy requests |
|
||
|
|
| proxy.uid | int | `2102` | User id under which the proxy runs |
|
||
|
|
| proxy.waitBeforeExitSeconds | int | `0` | If set 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`. See [Lifecycle hooks](https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks) for more info on container lifecycle hooks. |
|
||
|
|
| proxyInit.closeWaitTimeoutSecs | int | `0` | |
|
||
|
|
| proxyInit.ignoreInboundPorts | string | `"4567,4568"` | Default set of inbound ports to skip via iptables - Galera (4567,4568) |
|
||
|
|
| proxyInit.ignoreOutboundPorts | string | `"4567,4568"` | Default set of outbound ports to skip via iptables - Galera (4567,4568) |
|
||
|
|
| proxyInit.image.name | string | `"cr.l5d.io/linkerd/proxy-init"` | Docker image for the proxy-init container |
|
||
|
|
| proxyInit.image.pullPolicy | string | imagePullPolicy | Pull policy for the proxy-init container Docker image |
|
||
|
|
| proxyInit.image.version | string | `"v1.4.0"` | Tag for the proxy-init container Docker image |
|
||
|
|
| proxyInit.resources.cpu.limit | string | `"100m"` | Maximum amount of CPU units that the proxy-init container can use |
|
||
|
|
| proxyInit.resources.cpu.request | string | `"10m"` | Amount of CPU units that the proxy-init container requests |
|
||
|
|
| proxyInit.resources.memory.limit | string | `"50Mi"` | Maximum amount of memory that the proxy-init container can use |
|
||
|
|
| proxyInit.resources.memory.request | string | `"10Mi"` | Amount of memory that the proxy-init container requests |
|
||
|
|
| proxyInit.xtMountPath.mountPath | string | `"/run"` | |
|
||
|
|
| proxyInit.xtMountPath.name | string | `"linkerd-proxy-init-xtables-lock"` | |
|
||
|
|
| proxyInjector.caBundle | string | `""` | Bundle of CA certificates for proxy injector. If not provided then Helm will use the certificate generated for `proxyInjector.crtPEM`. If `proxyInjector.externalSecret` is set to true, this value must be set, as no certificate will be generated. |
|
||
|
|
| proxyInjector.crtPEM | string | `""` | Certificate for the proxy injector. If not provided then Helm will generate one. |
|
||
|
|
| proxyInjector.externalSecret | bool | `false` | Do not create a secret resource for the profileValidator webhook. If this is set to `true`, the value `proxyInjector.caBundle` must be set (see below) |
|
||
|
|
| proxyInjector.keyPEM | string | `""` | Certificate key for the proxy injector. If not provided then Helm will generate one. |
|
||
|
|
| proxyInjector.namespaceSelector | object | `{"matchExpressions":[{"key":"config.linkerd.io/admission-webhooks","operator":"NotIn","values":["disabled"]}]}` | Namespace selector used by admission webhook. If not set defaults to all namespaces without the annotation config.linkerd.io/admission-webhooks=disabled |
|
||
|
|
| webhookFailurePolicy | string | `"Ignore"` | Failure policy for the proxy injector |
|
||
|
|
|
||
|
|
----------------------------------------------
|
||
|
|
Autogenerated from chart metadata using [helm-docs v1.4.0](https://github.com/norwoodj/helm-docs/releases/v1.4.0)
|