Skip to content

Commit

Permalink
Removed a reference to the stable helm chart
Browse files Browse the repository at this point in the history
Signed-off-by: Travis Beckham <[email protected]>
  • Loading branch information
travisbeckham committed Apr 12, 2024
1 parent 91df914 commit 3043518
Showing 1 changed file with 33 additions and 39 deletions.
72 changes: 33 additions & 39 deletions linkerd.io/content/2.15/tasks/install-helm.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,12 @@ command. This is recommended for production, since it allows for repeatability.

To do [automatic mutual TLS](../../features/automatic-mtls/), Linkerd requires
trust anchor certificate and an issuer certificate and key pair. When you're
using `linkerd install`, we can generate these for you. However, for Helm,
you will need to generate these yourself.
using `linkerd install`, we can generate these for you. However, for Helm, you
will need to generate these yourself.

Please follow the instructions in [Generating your own mTLS root
certificates](../generate-certificates/) to generate these.
Please follow the instructions in
[Generating your own mTLS root certificates](../generate-certificates/) to
generate these.

## Helm install procedure

Expand All @@ -28,12 +29,11 @@ helm repo add linkerd-edge https://helm.linkerd.io/edge
You need to install two separate charts in succession: first `linkerd-crds` and
then `linkerd-control-plane`.

{{< note >}}
If installing Linkerd in a cluster that uses Cilium in kube-proxy replacement
mode, additional steps may be needed to ensure service discovery works as
intended. Instrunctions are on the [Cilium cluster
configuration](../../reference/cluster-configuration/#cilium) page.
{{< /note >}}
{{< note >}} If installing Linkerd in a cluster that uses Cilium in kube-proxy
replacement mode, additional steps may be needed to ensure service discovery
works as intended. Instrunctions are on the
[Cilium cluster configuration](../../reference/cluster-configuration/#cilium)
page. {{< /note >}}

### linkerd-crds

Expand All @@ -44,15 +44,12 @@ helm install linkerd-crds linkerd/linkerd-crds \
-n linkerd --create-namespace
```

{{< note >}}
This will create the `linkerd` namespace. If it already exists or you're
creating it beforehand elsewhere in your pipeline, just omit the
`--create-namespace` flag.
{{< /note >}}
{{< note >}} This will create the `linkerd` namespace. If it already exists or
you're creating it beforehand elsewhere in your pipeline, just omit the
`--create-namespace` flag. {{< /note >}}

{{< note >}}
If you are using [Linkerd's CNI plugin](../../features/cni/), you must also add the
`--set cniEnabled=true` flag to your `helm install` command.
{{< note >}} If you are using [Linkerd's CNI plugin](../../features/cni/), you
must also add the `--set cniEnabled=true` flag to your `helm install` command.
{{< /note >}}

### linkerd-control-plane
Expand All @@ -68,17 +65,17 @@ helm install linkerd-control-plane \
linkerd/linkerd-control-plane
```

{{< note >}}
If you are using [Linkerd's CNI plugin](../../features/cni/), you must also add the
`--set cniEnabled=true` flag to your `helm install` command.
{{< note >}} If you are using [Linkerd's CNI plugin](../../features/cni/), you
must also add the `--set cniEnabled=true` flag to your `helm install` command.
{{< /note >}}

## Enabling high availability mode

The `linkerd-control-plane` chart contains a file `values-ha.yaml` that overrides
some default values 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 those files.
The `linkerd-control-plane` chart contains a file `values-ha.yaml` that
overrides some default values 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 those files.

You can get `values-ha.yaml` by fetching the chart file:

Expand Down Expand Up @@ -112,32 +109,29 @@ linkerd/linkerd-control-plane <chart-semver-version> {{% latestedge %}} Li
```

During an upgrade, you must choose whether you want to reuse the values in the
chart or move to the values specified in the newer chart. Our advice is to use
a `values.yaml` file that stores all custom overrides that you have for your
chart or move to the values specified in the newer chart. Our advice is to use a
`values.yaml` file that stores all custom overrides that you have for your
chart.

The `helm upgrade` command has a number of flags that allow you to customize its
behavior. Special attention should be paid to `--reuse-values` and
`--reset-values` and how they behave when charts change from version to version
and/or overrides are applied through `--set` and `--set-file`. For example:
and/or overrides are applied through `--set` and `--set-file`. For example:

- `--reuse-values` with no overrides - all values are reused
- `--reuse-values` with overrides - all except the values that are overridden
are reused
- `--reset-values` with no overrides - no values are reused and all changes
from provided release are applied during the upgrade
are reused
- `--reset-values` with no overrides - no values are reused and all changes from
provided release are applied during the upgrade
- `--reset-values` with overrides - no values are reused and changed from
provided release are applied together with the overrides
provided release are applied together with the overrides
- no flag and no overrides - `--reuse-values` will be used by default
- no flag and overrides - `--reset-values` will be used by default

Finally, before upgrading, check whether there are breaking changes to the chart
(i.e. renamed or moved keys, etc). You can consult the
[stable](https://artifacthub.io/packages/helm/linkerd2/linkerd-control-plane#values)
or the
[edge](https://artifacthub.io/packages/helm/linkerd2-edge/linkerd-control-plane#values)
chart docs, depending on
which one your are upgrading to. If there are, make the corresponding changes to
Finally, before upgrading, you can consult the
[edge chart](https://artifacthub.io/packages/helm/linkerd2-edge/linkerd-control-plane#values)
docs to check whether there are breaking changes to the chart (i.e.
renamed or moved keys, etc). If there are, make the corresponding changes to
your `values.yaml` file. Then you can use:

```bash
Expand Down

0 comments on commit 3043518

Please sign in to comment.