1# linkerd-multicluster
2
3The Linkerd-Multicluster extension contains resources to support multicluster
4linking to remote clusters
5
6
7
8
9
10**Homepage:** <https://linkerd.io>
11
12## Quickstart and documentation
13
14You can run Linkerd on any Kubernetes cluster in a matter of seconds. See the
15[Linkerd Getting Started Guide][getting-started] for how.
16
17For more comprehensive documentation, start with the [Linkerd
18docs][linkerd-docs].
19
20## Prerequisite: Linkerd Core Control-Plane
21
22Before installing the Linkerd Multicluster extension, The core control-plane has
23to be installed first by following the [Linkerd Install
24Guide](https://linkerd.io/2/tasks/install/).
25
26## Adding Linkerd's Helm repository
27
28```bash
29# To add the repo for Linkerd edge releases:
30helm repo add linkerd https://helm.linkerd.io/edge
31```
32
33## Installing the Multicluster Extension Chart
34
35```bash
36helm install linkerd-multicluster -n linkerd-multicluster --create-namespace linkerd/linkerd-multicluster
37```
38
39## Get involved
40
41* Check out Linkerd's source code at [GitHub][linkerd2].
42* Join Linkerd's [user mailing list][linkerd-users], [developer mailing
43 list][linkerd-dev], and [announcements mailing list][linkerd-announce].
44* Follow [@linkerd][twitter] on Twitter.
45* Join the [Linkerd Slack][slack].
46
47[getting-started]: https://linkerd.io/2/getting-started/
48[linkerd2]: https://github.com/linkerd/linkerd2
49[linkerd-announce]: https://lists.cncf.io/g/cncf-linkerd-announce
50[linkerd-dev]: https://lists.cncf.io/g/cncf-linkerd-dev
51[linkerd-docs]: https://linkerd.io/2/overview/
52[linkerd-users]: https://lists.cncf.io/g/cncf-linkerd-users
53[slack]: http://slack.linkerd.io
54[twitter]: https://twitter.com/linkerd
55
56## Requirements
57
58Kubernetes: `>=1.22.0-0`
59
60| Repository | Name | Version |
61|------------|------|---------|
62| file://../../../charts/partials | partials | 0.1.0 |
63
64## Values
65
66| Key | Type | Default | Description |
67|-----|------|---------|-------------|
68| commonLabels | object | `{}` | Labels to apply to all resources |
69| createNamespaceMetadataJob | bool | `true` | Creates a Job that adds necessary metadata to the extension's namespace during install; disable if lack of privileges require doing this manually |
70| enablePSP | bool | `false` | Create Roles and RoleBindings to associate this extension's ServiceAccounts to the control plane PSP resource. This requires that `enabledPSP` is set to true on the control plane install. Note PSP has been deprecated since k8s v1.21 |
71| enablePodAntiAffinity | bool | `false` | Enables Pod Anti Affinity logic to balance the placement of replicas across hosts and zones for High Availability. Enable this only when you have multiple replicas of components. |
72| gateway.GID | int | `2103` | Group id under which the gateway shall be ran |
73| gateway.UID | int | `2103` | User id under which the gateway shall be ran |
74| gateway.deploymentAnnotations | object | `{}` | Annotations to add to the gateway deployment |
75| gateway.enabled | bool | `true` | If the gateway component should be installed |
76| gateway.loadBalancerClass | string | `""` | Set loadBalancerClass on gateway service |
77| gateway.loadBalancerIP | string | `""` | Set loadBalancerIP on gateway service |
78| gateway.loadBalancerSourceRanges | list | `[]` | Set loadBalancerSourceRanges on gateway service |
79| gateway.name | string | `"linkerd-gateway"` | The name of the gateway that will be installed |
80| gateway.nodeSelector | object | `{}` | Node selectors for the gateway pod |
81| gateway.pauseImage | string | `"gcr.io/google_containers/pause:3.2"` | The pause container to use |
82| gateway.port | int | `4143` | The port on which all the gateway will accept incoming traffic |
83| gateway.probe.path | string | `"/ready"` | The path that will be used by remote clusters for determining whether the gateway is alive |
84| gateway.probe.port | int | `4191` | The port used for liveliness probing |
85| gateway.probe.seconds | int | `3` | The interval (in seconds) between liveness probes |
86| gateway.replicas | int | `1` | Number of replicas for the gateway pod |
87| gateway.serviceAnnotations | object | `{}` | Annotations to add to the gateway service |
88| gateway.serviceType | string | `"LoadBalancer"` | Service Type of gateway Service |
89| gateway.terminationGracePeriodSeconds | string | `""` | Set terminationGracePeriodSeconds on gateway deployment |
90| gateway.tolerations | list | `[]` | Tolerations for the gateway pod |
91| identityTrustDomain | string | `"cluster.local"` | Identity Trust Domain of the certificate authority |
92| imagePullPolicy | string | `"IfNotPresent"` | Docker imagePullPolicy for all multicluster components |
93| imagePullSecrets | list | `[]` | For Private docker registries, authentication is needed. Registry secrets are applied to the respective service accounts |
94| linkerdNamespace | string | `"linkerd"` | Namespace of linkerd installation |
95| linkerdVersion | string | `"linkerdVersionValue"` | Control plane version |
96| namespaceMetadata.image.name | string | `"extension-init"` | Docker image name for the namespace-metadata instance |
97| namespaceMetadata.image.pullPolicy | string | imagePullPolicy | Pull policy for the namespace-metadata instance |
98| namespaceMetadata.image.registry | string | `"cr.l5d.io/linkerd"` | Docker registry for the namespace-metadata instance |
99| namespaceMetadata.image.tag | string | `"v0.1.0"` | Docker image tag for the namespace-metadata instance |
100| namespaceMetadata.nodeSelector | object | `{}` | Node selectors for the namespace-metadata instance |
101| namespaceMetadata.tolerations | list | `[]` | Tolerations for the namespace-metadata instance |
102| podLabels | object | `{}` | Additional labels to add to all pods |
103| proxyOutboundPort | int | `4140` | The port on which the proxy accepts outbound traffic |
104| remoteMirrorServiceAccount | bool | `true` | If the remote mirror service account should be installed |
105| remoteMirrorServiceAccountName | string | `"linkerd-service-mirror-remote-access-default"` | The name of the service account used to allow remote clusters to mirror local services |
106| revisionHistoryLimit | int | `10` | Specifies the number of old ReplicaSets to retain to allow rollback. |
107
108----------------------------------------------
109Autogenerated from chart metadata using [helm-docs v1.12.0](https://github.com/norwoodj/helm-docs/releases/v1.12.0)
View as plain text