...

Text file src/github.com/linkerd/linkerd2/multicluster/charts/linkerd-multicluster-link/README.md

Documentation: github.com/linkerd/linkerd2/multicluster/charts/linkerd-multicluster-link

     1# linkerd-multicluster-link
     2
     3A helm chart containing the resources to enable mirroring
     4of services from a remote cluster.
     5
     6Warning: The purpose of this chart is just to support the `linkerd
     7multicluster link` CLI command, which also produces the
     8`cluster-credentials` secret and the Link CR, which are not found in this
     9chart. Therefore this chart is not a replacement for that command, and
    10shouldn't be used as-is unless you really know what you're doing ;-)
    11
    12![Version: 0.2.0](https://img.shields.io/badge/Version-0.2.0-informational?style=flat-square)
    13
    14![AppVersion: edge-XX.X.X](https://img.shields.io/badge/AppVersion-edge--XX.X.X-informational?style=flat-square)
    15
    16## Requirements
    17
    18Kubernetes: `>=1.22.0-0`
    19
    20| Repository | Name | Version |
    21|------------|------|---------|
    22| file://../../../charts/partials | partials | 0.1.0 |
    23
    24## Values
    25
    26| Key | Type | Default | Description |
    27|-----|------|---------|-------------|
    28| commonLabels | object | `{}` | Labels to apply to all resources |
    29| controllerImage | string | `"cr.l5d.io/linkerd/controller"` | Docker image for the Service mirror component (uses the Linkerd controller image) |
    30| controllerImageVersion | string | `"linkerdVersionValue"` | Tag for the Service Mirror container Docker image |
    31| enableHeadlessServices | bool | `false` | Toggle support for mirroring headless services |
    32| enablePSP | bool | `false` | Create RoleBindings to associate ServiceAccount of target cluster Service Mirror to the control plane PSP resource. This requires that `enabledPSP` is set to true on the extension and control plane install. Note PSP has been deprecated since k8s v1.21 |
    33| 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. |
    34| gateway.enabled | bool | `true` | Controls whether link will create a probe service for the gateway |
    35| gateway.probe.port | int | `4191` | The port used for liveliness probing |
    36| imagePullSecrets | list | `[]` | For Private docker registries, authentication is needed.  Registry secrets are applied to the respective service accounts |
    37| logFormat | string | `"plain"` | Log format (`plain` or `json`) |
    38| logLevel | string | `"info"` | Log level for the Multicluster components |
    39| nodeSelector | object | `{}` | Node selectors for the Service mirror pod |
    40| podAnnotations | object | `{}` | Additional annotations to add to all pods |
    41| podLabels | object | `{}` | Additional labels to add to all pods |
    42| replicas | int | `1` | Number of service mirror replicas to run |
    43| resources | object | `{}` | Resources for the Service mirror container |
    44| revisionHistoryLimit | int | `10` | Specifies the number of old ReplicaSets to retain to allow rollback. |
    45| serviceMirrorGID | int | `2103` | Group id under which the Service Mirror shall be ran |
    46| serviceMirrorRetryLimit | int | `3` | Number of times update from the remote cluster is allowed to be requeued (retried) |
    47| serviceMirrorUID | int | `2103` | User id under which the Service Mirror shall be ran |
    48| targetClusterName | string | `""` | Name of the target cluster that's going to be linked |
    49| tolerations | object | `{}` | Tolerations for the Service mirror pod |
    50
    51----------------------------------------------
    52Autogenerated from chart metadata using [helm-docs v1.12.0](https://github.com/norwoodj/helm-docs/releases/v1.12.0)

View as plain text