Skip to content

Commit

Permalink
Merge branch 'main' into flynn/seo
Browse files Browse the repository at this point in the history
  • Loading branch information
kflynn committed Apr 14, 2024
2 parents 421442d + edbe244 commit 495af43
Show file tree
Hide file tree
Showing 21 changed files with 156 additions and 247 deletions.
8 changes: 1 addition & 7 deletions MAINTAINERS.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,2 @@
The maintainers of the Linkerd website are the Linkerd maintainers listed in
https://github.com/linkerd/linkerd2/blob/main/MAINTAINERS.md, plus:

- Paul Michael Armstrong (@PaulMichaelArmstrong)
- Charles Pretzer (@cpretzer)
- William Morgan (@wmorgan)

If you'd like to become a maintainer, just come talk to us!
https://github.com/linkerd/linkerd2/blob/main/MAINTAINERS.md.
1 change: 1 addition & 0 deletions linkerd.io/.htmltest.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ IgnoreURLs:
- https://godaddy.com/
- https://www.linkedin.com/
- https://tools.ietf.org/
- ^/2/*
DirectoryPath: public
TestFilesConcurrently: true
DocumentConcurrencyLimit: 16
Expand Down
2 changes: 1 addition & 1 deletion linkerd.io/content/2-edge/tasks/distributed-tracing.md
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,7 @@ The YAML file is merged with the [Helm values.yaml][helm-values] which shows
other possible values that can be configured.

<!-- markdownlint-disable MD034 -->
[helm-values]: https://github.com/linkerd/linkerd2/blob/stable-{{% latest-linkerd2-stable-version %}}.0/jaeger/charts/linkerd-jaeger/values.yaml
[helm-values]: https://github.com/linkerd/linkerd2/blob/main/jaeger/charts/linkerd-jaeger/values.yaml

It is also possible to manually edit the OpenCensus configuration to have it
export to any backend which it supports. See the
Expand Down
2 changes: 1 addition & 1 deletion linkerd.io/content/2.11/tasks/distributed-tracing.md
Original file line number Diff line number Diff line change
Expand Up @@ -207,7 +207,7 @@ The YAML file is merged with the [Helm values.yaml][helm-values] which shows
other possible values that can be configured.

<!-- markdownlint-disable MD034 -->
[helm-values]: https://github.com/linkerd/linkerd2/blob/stable-{{% latest-linkerd2-stable-version %}}.0/jaeger/charts/linkerd-jaeger/values.yaml
[helm-values]: https://github.com/linkerd/linkerd2/blob/main/jaeger/charts/linkerd-jaeger/values.yaml

It is also possible to manually edit the OpenCensus configuration to have it
export to any backend which it supports. See the
Expand Down
2 changes: 1 addition & 1 deletion linkerd.io/content/2.12/tasks/distributed-tracing.md
Original file line number Diff line number Diff line change
Expand Up @@ -207,7 +207,7 @@ The YAML file is merged with the [Helm values.yaml][helm-values] which shows
other possible values that can be configured.

<!-- markdownlint-disable MD034 -->
[helm-values]: https://github.com/linkerd/linkerd2/blob/stable-{{% latest-linkerd2-stable-version %}}.0/jaeger/charts/linkerd-jaeger/values.yaml
[helm-values]: https://github.com/linkerd/linkerd2/blob/main/jaeger/charts/linkerd-jaeger/values.yaml

It is also possible to manually edit the OpenCensus configuration to have it
export to any backend which it supports. See the
Expand Down
2 changes: 1 addition & 1 deletion linkerd.io/content/2.13/tasks/distributed-tracing.md
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,7 @@ The YAML file is merged with the [Helm values.yaml][helm-values] which shows
other possible values that can be configured.

<!-- markdownlint-disable MD034 -->
[helm-values]: https://github.com/linkerd/linkerd2/blob/stable-{{% latest-linkerd2-stable-version %}}.0/jaeger/charts/linkerd-jaeger/values.yaml
[helm-values]: https://github.com/linkerd/linkerd2/blob/main/jaeger/charts/linkerd-jaeger/values.yaml

It is also possible to manually edit the OpenCensus configuration to have it
export to any backend which it supports. See the
Expand Down
2 changes: 1 addition & 1 deletion linkerd.io/content/2.14/tasks/distributed-tracing.md
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,7 @@ The YAML file is merged with the [Helm values.yaml][helm-values] which shows
other possible values that can be configured.

<!-- markdownlint-disable MD034 -->
[helm-values]: https://github.com/linkerd/linkerd2/blob/stable-{{% latest-linkerd2-stable-version %}}.0/jaeger/charts/linkerd-jaeger/values.yaml
[helm-values]: https://github.com/linkerd/linkerd2/blob/main/jaeger/charts/linkerd-jaeger/values.yaml

It is also possible to manually edit the OpenCensus configuration to have it
export to any backend which it supports. See the
Expand Down
6 changes: 1 addition & 5 deletions linkerd.io/content/2.15/getting-started/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,7 @@ install the *CLI* (command-line interface) onto your local machine. Using this
CLI, you'll then install the *control plane* onto your Kubernetes cluster.
Finally, you'll "mesh" an application by adding Linkerd's *data plane* to it.

{{< note >}}
This page contains quick start instructions intended for non-production
installations. For production-oriented configurations, we suggest reviewing
resources in [Going to Production](/going-to-production/).
{{< /note >}}
{{< releases >}}

## Step 0: Setup

Expand Down
13 changes: 13 additions & 0 deletions linkerd.io/content/2.15/reference/helm-chart-version-matrix.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
+++
title = "Helm Chart Version Matrix"
+++

The following version matrices include only the latest versions of the stable
releases along with corresponding app and Helm versions for Linkerd and
extensions. Use these to guide you to the right Helm chart version or to
automate workflows you might have.

* [YAML matrix](/releases/release_matrix.yaml)
* [JSON matrix](/releases/release_matrix.json)

{{< release-data-table />}}
2 changes: 1 addition & 1 deletion linkerd.io/content/2.15/tasks/distributed-tracing.md
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,7 @@ The YAML file is merged with the [Helm values.yaml][helm-values] which shows
other possible values that can be configured.

<!-- markdownlint-disable MD034 -->
[helm-values]: https://github.com/linkerd/linkerd2/blob/stable-{{% latest-linkerd2-stable-version %}}.0/jaeger/charts/linkerd-jaeger/values.yaml
[helm-values]: https://github.com/linkerd/linkerd2/blob/main/jaeger/charts/linkerd-jaeger/values.yaml

It is also possible to manually edit the OpenCensus configuration to have it
export to any backend which it supports. See the
Expand Down
91 changes: 38 additions & 53 deletions linkerd.io/content/2.15/tasks/install-helm.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,43 +6,34 @@ description = "Install Linkerd onto your Kubernetes cluster using Helm."
Linkerd can be installed via Helm rather than with the `linkerd install`
command. This is recommended for production, since it allows for repeatability.

{{< trylpt >}}
{{< releases >}}

## Prerequisite: generate identity certificates
## Prerequisite: generate mTLS certificates

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 for stable releases
## Helm install procedure

```bash
# To add the repo for Linkerd stable releases:
helm repo add linkerd https://helm.linkerd.io/stable

# To add the repo for Linkerd edge releases:
# Add the Helm repo for Linkerd 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`, and add the `--devel` flag to all
commands.

## Helm install procedure

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 @@ -53,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 @@ -77,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 @@ -117,36 +105,33 @@ helm repo update
helm search repo linkerd
NAME CHART VERSION APP VERSION DESCRIPTION
linkerd/linkerd-crds <chart-semver-version> Linkerd gives you observability, reliability, and securit...
linkerd/linkerd-control-plane <chart-semver-version> {{% latestversion %}} Linkerd gives you observability, reliability, and securit...
linkerd/linkerd-control-plane <chart-semver-version> {{% latestedge %}} Linkerd gives you observability, reliability, and securit...
```

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
4 changes: 2 additions & 2 deletions linkerd.io/content/2.15/tasks/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,13 @@ Linkerd's control plane can be installed in two ways: with the CLI and with
Helm. The CLI is convenient and easy, but for production use cases we recommend
Helm which allows for repeatability.

{{< trylpt >}}

In either case, we recommend installing the CLI itself so that you can validate
the success of the installation. See the [Getting Started
Guide](../../getting-started/) for how to install the CLI if you haven't done
this already.

{{< releases >}}

## Requirements

Linkerd requires a Kubernetes cluster on which to run. Where this cluster lives
Expand Down
Loading

0 comments on commit 495af43

Please sign in to comment.