diff --git a/linkerd.io/assets/alias.html b/linkerd.io/assets/alias.html index 51817e4b07..b14c4efa60 100644 --- a/linkerd.io/assets/alias.html +++ b/linkerd.io/assets/alias.html @@ -1,13 +1,13 @@ - - + + {{ .Permalink }} - - - - + + + + diff --git a/linkerd.io/config/_default/security.yaml b/linkerd.io/config/_default/security.yaml index 7a0acff044..fef1d4963e 100644 --- a/linkerd.io/config/_default/security.yaml +++ b/linkerd.io/config/_default/security.yaml @@ -1 +1,2 @@ allowContent: ['.*'] +enableInlineShortcodes: true diff --git a/linkerd.io/content/2-edge/common-errors/_index.md b/linkerd.io/content/2-edge/common-errors/_index.md index 68771bf652..a57718ba55 100644 --- a/linkerd.io/content/2-edge/common-errors/_index.md +++ b/linkerd.io/content/2-edge/common-errors/_index.md @@ -18,4 +18,4 @@ this command is. ## Common Errors -{{< docs/section-toc >}} +{{< section-toc >}} diff --git a/linkerd.io/content/2-edge/features/_index.md b/linkerd.io/content/2-edge/features/_index.md index cf341d4e7e..3eebfe67f4 100644 --- a/linkerd.io/content/2-edge/features/_index.md +++ b/linkerd.io/content/2-edge/features/_index.md @@ -11,4 +11,4 @@ please see the [Linkerd task docs](../tasks/). For a reference, see the ## Linkerd's features -{{< docs/section-toc >}} +{{< section-toc >}} diff --git a/linkerd.io/content/2-edge/getting-started/_index.md b/linkerd.io/content/2-edge/getting-started/_index.md index 5e3af75210..d58cceee52 100644 --- a/linkerd.io/content/2-edge/getting-started/_index.md +++ b/linkerd.io/content/2-edge/getting-started/_index.md @@ -16,7 +16,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. -{{< docs/edge-note >}} +{{< edge-note >}} ## Step 0: Setup diff --git a/linkerd.io/content/2-edge/reference/_index.md b/linkerd.io/content/2-edge/reference/_index.md index f2045c2b56..c066e0b8ee 100644 --- a/linkerd.io/content/2-edge/reference/_index.md +++ b/linkerd.io/content/2-edge/reference/_index.md @@ -3,4 +3,4 @@ title: Reference weight: 5 --- -{{< docs/section-toc >}} +{{< section-toc >}} diff --git a/linkerd.io/content/2-edge/reference/cli/_index.md b/linkerd.io/content/2-edge/reference/cli/_index.md index ee36df6287..4d4170ffa7 100644 --- a/linkerd.io/content/2-edge/reference/cli/_index.md +++ b/linkerd.io/content/2-edge/reference/cli/_index.md @@ -9,10 +9,10 @@ detailed metrics for how your service is performing. As reference, check out the commands below: -{{< docs/cli-commands >}} +{{< cli-commands >}} ## Global flags The following flags are available for _all_ linkerd CLI commands: -{{< docs/cli-global-flags >}} +{{< cli-global-flags >}} diff --git a/linkerd.io/content/2-edge/reference/cli/authz.md b/linkerd.io/content/2-edge/reference/cli/authz.md index 2a6e55b55d..22df19a41c 100644 --- a/linkerd.io/content/2-edge/reference/cli/authz.md +++ b/linkerd.io/content/2-edge/reference/cli/authz.md @@ -2,10 +2,10 @@ title: authz --- -{{< docs/cli-description "authz" >}} +{{< cli-description "authz" >}} Check out the [Authorization Policy](../authorization-policy/) and [Restricting Access to Services](../../tasks/restricting-access/) documentation for all the details about authorization policy in Linkerd. -{{< docs/cli-flags "authz" >}} +{{< cli-flags "authz" >}} diff --git a/linkerd.io/content/2-edge/reference/cli/check.md b/linkerd.io/content/2-edge/reference/cli/check.md index 7cd61cd237..0c18a5da03 100644 --- a/linkerd.io/content/2-edge/reference/cli/check.md +++ b/linkerd.io/content/2-edge/reference/cli/check.md @@ -2,12 +2,12 @@ title: check --- -{{< docs/cli-description "check" >}} +{{< cli-description "check" >}} Take a look at the [troubleshooting](../../tasks/troubleshooting/) documentation for a full list of all the possible checks, what they do and how to fix them. -{{< docs/cli-examples "check" >}} +{{< cli-examples "check" >}} ## Example output @@ -53,4 +53,4 @@ control-plane-version Status check results are √ ``` -{{< docs/cli-flags "check" >}} +{{< cli-flags "check" >}} diff --git a/linkerd.io/content/2-edge/reference/cli/completion.md b/linkerd.io/content/2-edge/reference/cli/completion.md index 40e8438b72..6007a47fa5 100644 --- a/linkerd.io/content/2-edge/reference/cli/completion.md +++ b/linkerd.io/content/2-edge/reference/cli/completion.md @@ -2,8 +2,8 @@ title: completion --- -{{< docs/cli-description "completion" >}} +{{< cli-description "completion" >}} -{{< docs/cli-examples "completion" >}} +{{< cli-examples "completion" >}} -{{< docs/cli-flags "completion" >}} +{{< cli-flags "completion" >}} diff --git a/linkerd.io/content/2-edge/reference/cli/diagnostics.md b/linkerd.io/content/2-edge/reference/cli/diagnostics.md index ffa45c39be..8e4e36d234 100644 --- a/linkerd.io/content/2-edge/reference/cli/diagnostics.md +++ b/linkerd.io/content/2-edge/reference/cli/diagnostics.md @@ -2,44 +2,44 @@ title: diagnostics --- -{{< docs/cli-description "diagnostics" >}} +{{< cli-description "diagnostics" >}} -{{< docs/cli-examples "diagnostics" >}} +{{< cli-examples "diagnostics" >}} -{{< docs/cli-flags "diagnostics" >}} +{{< cli-flags "diagnostics" >}} ## Subcommands -{{< docs/cli-subcommands "diagnostics" >}} +{{< cli-subcommands "diagnostics" >}} ### controller-metrics -{{< docs/cli-description "diagnostics controller-metrics" >}} +{{< cli-description "diagnostics controller-metrics" >}} -{{< docs/cli-examples "diagnostics controller-metrics" >}} +{{< cli-examples "diagnostics controller-metrics" >}} -{{< docs/cli-flags "diagnostics controller-metrics" >}} +{{< cli-flags "diagnostics controller-metrics" >}} ### endpoints -{{< docs/cli-description "diagnostics endpoints" >}} +{{< cli-description "diagnostics endpoints" >}} -{{< docs/cli-examples "diagnostics endpoints" >}} +{{< cli-examples "diagnostics endpoints" >}} -{{< docs/cli-flags "diagnostics endpoints" >}} +{{< cli-flags "diagnostics endpoints" >}} ### install-sp -{{< docs/cli-description "diagnostics install-sp" >}} +{{< cli-description "diagnostics install-sp" >}} -{{< docs/cli-examples "diagnostics install-sp" >}} +{{< cli-examples "diagnostics install-sp" >}} -{{< docs/cli-flags "diagnostics install-sp" >}} +{{< cli-flags "diagnostics install-sp" >}} ### proxy-metrics -{{< docs/cli-description "diagnostics proxy-metrics" >}} +{{< cli-description "diagnostics proxy-metrics" >}} -{{< docs/cli-examples "diagnostics proxy-metrics" >}} +{{< cli-examples "diagnostics proxy-metrics" >}} -{{< docs/cli-flags "diagnostics proxy-metrics" >}} +{{< cli-flags "diagnostics proxy-metrics" >}} diff --git a/linkerd.io/content/2-edge/reference/cli/identity.md b/linkerd.io/content/2-edge/reference/cli/identity.md index 576d175930..c7962e8027 100644 --- a/linkerd.io/content/2-edge/reference/cli/identity.md +++ b/linkerd.io/content/2-edge/reference/cli/identity.md @@ -2,8 +2,8 @@ title: identity --- -{{< docs/cli-description "identity" >}} +{{< cli-description "identity" >}} -{{< docs/cli-examples "identity" >}} +{{< cli-examples "identity" >}} -{{< docs/cli-flags "identity" >}} +{{< cli-flags "identity" >}} diff --git a/linkerd.io/content/2-edge/reference/cli/inject.md b/linkerd.io/content/2-edge/reference/cli/inject.md index aafdacdb29..92fc0ca3cb 100644 --- a/linkerd.io/content/2-edge/reference/cli/inject.md +++ b/linkerd.io/content/2-edge/reference/cli/inject.md @@ -19,6 +19,6 @@ Alternatively, this command can also perform the full injection purely on the client side, by enabling with the `--manual` flag. (Prior to Linkerd 2.4, this was the default behavior.) -{{< docs/cli-examples "inject" >}} +{{< cli-examples "inject" >}} -{{< docs/cli-flags "inject" >}} +{{< cli-flags "inject" >}} diff --git a/linkerd.io/content/2-edge/reference/cli/install-cni.md b/linkerd.io/content/2-edge/reference/cli/install-cni.md index c7c457a6f1..d0577e3d3b 100644 --- a/linkerd.io/content/2-edge/reference/cli/install-cni.md +++ b/linkerd.io/content/2-edge/reference/cli/install-cni.md @@ -2,8 +2,8 @@ title: install-cni --- -{{< docs/cli-description "install-cni" >}} +{{< cli-description "install-cni" >}} -{{< docs/cli-examples "install-cni" >}} +{{< cli-examples "install-cni" >}} -{{< docs/cli-flags "install-cni" >}} +{{< cli-flags "install-cni" >}} diff --git a/linkerd.io/content/2-edge/reference/cli/install.md b/linkerd.io/content/2-edge/reference/cli/install.md index ab0dde824e..5fea59d7eb 100644 --- a/linkerd.io/content/2-edge/reference/cli/install.md +++ b/linkerd.io/content/2-edge/reference/cli/install.md @@ -2,11 +2,11 @@ title: install --- -{{< docs/cli-description "install" >}} +{{< cli-description "install" >}} For further details on how to install Linkerd onto your own cluster, check out the [install documentation](../../tasks/install/). -{{< docs/cli-examples "install" >}} +{{< cli-examples "install" >}} -{{< docs/cli-flags "install" >}} +{{< cli-flags "install" >}} diff --git a/linkerd.io/content/2-edge/reference/cli/multicluster.md b/linkerd.io/content/2-edge/reference/cli/multicluster.md index 523191d82b..134d809f01 100644 --- a/linkerd.io/content/2-edge/reference/cli/multicluster.md +++ b/linkerd.io/content/2-edge/reference/cli/multicluster.md @@ -2,60 +2,60 @@ title: multicluster --- -{{< docs/cli-description "multicluster" >}} +{{< cli-description "multicluster" >}} -{{< docs/cli-examples "multicluster" >}} +{{< cli-examples "multicluster" >}} -{{< docs/cli-flags "multicluster" >}} +{{< cli-flags "multicluster" >}} ## Subcommands -{{< docs/cli-subcommands "multicluster" >}} +{{< cli-subcommands "multicluster" >}} ### allow -{{< docs/cli-description "multicluster allow" >}} +{{< cli-description "multicluster allow" >}} -{{< docs/cli-examples "multicluster allow" >}} +{{< cli-examples "multicluster allow" >}} -{{< docs/cli-flags "multicluster allow" >}} +{{< cli-flags "multicluster allow" >}} ### check -{{< docs/cli-description "multicluster check" >}} +{{< cli-description "multicluster check" >}} -{{< docs/cli-examples "multicluster check" >}} +{{< cli-examples "multicluster check" >}} -{{< docs/cli-flags "multicluster check" >}} +{{< cli-flags "multicluster check" >}} ### gateways -{{< docs/cli-description "multicluster gateways" >}} +{{< cli-description "multicluster gateways" >}} -{{< docs/cli-examples "multicluster gateways" >}} +{{< cli-examples "multicluster gateways" >}} -{{< docs/cli-flags "multicluster gateways" >}} +{{< cli-flags "multicluster gateways" >}} ### install -{{< docs/cli-description "multicluster install" >}} +{{< cli-description "multicluster install" >}} -{{< docs/cli-examples "multicluster install" >}} +{{< cli-examples "multicluster install" >}} -{{< docs/cli-flags "multicluster install" >}} +{{< cli-flags "multicluster install" >}} ### link-gen -{{< docs/cli-description "multicluster link-gen" >}} +{{< cli-description "multicluster link-gen" >}} -{{< docs/cli-examples "multicluster link-gen" >}} +{{< cli-examples "multicluster link-gen" >}} -{{< docs/cli-flags "multicluster link-gen" >}} +{{< cli-flags "multicluster link-gen" >}} ### uninstall -{{< docs/cli-description "multicluster uninstall" >}} +{{< cli-description "multicluster uninstall" >}} -{{< docs/cli-examples "multicluster uninstall" >}} +{{< cli-examples "multicluster uninstall" >}} -{{< docs/cli-flags "multicluster uninstall" >}} +{{< cli-flags "multicluster uninstall" >}} diff --git a/linkerd.io/content/2-edge/reference/cli/profile.md b/linkerd.io/content/2-edge/reference/cli/profile.md index 5cc919b876..bf2545c313 100644 --- a/linkerd.io/content/2-edge/reference/cli/profile.md +++ b/linkerd.io/content/2-edge/reference/cli/profile.md @@ -2,12 +2,12 @@ title: profile --- -{{< docs/cli-description "profile" >}} +{{< cli-description "profile" >}} Check out the [service profile](../../features/service-profiles/) documentation for more details on what this command does and what you can do with service profiles. -{{< docs/cli-examples "profile" >}} +{{< cli-examples "profile" >}} -{{< docs/cli-flags "profile" >}} +{{< cli-flags "profile" >}} diff --git a/linkerd.io/content/2-edge/reference/cli/prune.md b/linkerd.io/content/2-edge/reference/cli/prune.md index 68675991ed..1ec604588f 100644 --- a/linkerd.io/content/2-edge/reference/cli/prune.md +++ b/linkerd.io/content/2-edge/reference/cli/prune.md @@ -2,8 +2,8 @@ title: prune --- -{{< docs/cli-description "prune" >}} +{{< cli-description "prune" >}} -{{< docs/cli-examples "prune" >}} +{{< cli-examples "prune" >}} -{{< docs/cli-flags "prune" >}} +{{< cli-flags "prune" >}} diff --git a/linkerd.io/content/2-edge/reference/cli/uninject.md b/linkerd.io/content/2-edge/reference/cli/uninject.md index 9ad619698a..6f43c3cf0a 100644 --- a/linkerd.io/content/2-edge/reference/cli/uninject.md +++ b/linkerd.io/content/2-edge/reference/cli/uninject.md @@ -2,8 +2,8 @@ title: uninject --- -{{< docs/cli-description "uninject" >}} +{{< cli-description "uninject" >}} -{{< docs/cli-examples "uninject" >}} +{{< cli-examples "uninject" >}} -{{< docs/cli-flags "uninject" >}} +{{< cli-flags "uninject" >}} diff --git a/linkerd.io/content/2-edge/reference/cli/uninstall.md b/linkerd.io/content/2-edge/reference/cli/uninstall.md index d5e00031ed..d62dd11612 100644 --- a/linkerd.io/content/2-edge/reference/cli/uninstall.md +++ b/linkerd.io/content/2-edge/reference/cli/uninstall.md @@ -2,8 +2,8 @@ title: uninstall --- -{{< docs/cli-description "uninstall" >}} +{{< cli-description "uninstall" >}} -{{< docs/cli-examples "uninstall" >}} +{{< cli-examples "uninstall" >}} -{{< docs/cli-flags "uninstall" >}} +{{< cli-flags "uninstall" >}} diff --git a/linkerd.io/content/2-edge/reference/cli/upgrade.md b/linkerd.io/content/2-edge/reference/cli/upgrade.md index c4422b57c9..70b3296d8a 100644 --- a/linkerd.io/content/2-edge/reference/cli/upgrade.md +++ b/linkerd.io/content/2-edge/reference/cli/upgrade.md @@ -2,8 +2,8 @@ title: upgrade --- -{{< docs/cli-description "upgrade" >}} +{{< cli-description "upgrade" >}} -{{< docs/cli-examples "upgrade" >}} +{{< cli-examples "upgrade" >}} -{{< docs/cli-flags "upgrade" >}} +{{< cli-flags "upgrade" >}} diff --git a/linkerd.io/content/2-edge/reference/cli/version.md b/linkerd.io/content/2-edge/reference/cli/version.md index 159f0b2f65..d31d7b18e6 100644 --- a/linkerd.io/content/2-edge/reference/cli/version.md +++ b/linkerd.io/content/2-edge/reference/cli/version.md @@ -2,8 +2,8 @@ title: version --- -{{< docs/cli-description "version" >}} +{{< cli-description "version" >}} -{{< docs/cli-examples "version" >}} +{{< cli-examples "version" >}} -{{< docs/cli-flags "version" >}} +{{< cli-flags "version" >}} diff --git a/linkerd.io/content/2-edge/reference/cli/viz.md b/linkerd.io/content/2-edge/reference/cli/viz.md index 642bad742d..da24ef2e19 100644 --- a/linkerd.io/content/2-edge/reference/cli/viz.md +++ b/linkerd.io/content/2-edge/reference/cli/viz.md @@ -2,50 +2,50 @@ title: viz --- -{{< docs/cli-description "viz" >}} +{{< cli-description "viz" >}} -{{< docs/cli-examples "viz" >}} +{{< cli-examples "viz" >}} -{{< docs/cli-flags "viz" >}} +{{< cli-flags "viz" >}} ## Subcommands -{{< docs/cli-subcommands "viz" >}} +{{< cli-subcommands "viz" >}} ### allow-scrapes -{{< docs/cli-description "viz allow-scrapes" >}} +{{< cli-description "viz allow-scrapes" >}} -{{< docs/cli-examples "viz allow-scrapes" >}} +{{< cli-examples "viz allow-scrapes" >}} -{{< docs/cli-flags "viz allow-scrapes" >}} +{{< cli-flags "viz allow-scrapes" >}} ### authz -{{< docs/cli-description "viz authz" >}} +{{< cli-description "viz authz" >}} -{{< docs/cli-examples "viz authz" >}} +{{< cli-examples "viz authz" >}} -{{< docs/cli-flags "viz authz" >}} +{{< cli-flags "viz authz" >}} ### check -{{< docs/cli-description "viz check" >}} +{{< cli-description "viz check" >}} -{{< docs/cli-examples "viz check" >}} +{{< cli-examples "viz check" >}} -{{< docs/cli-flags "viz check" >}} +{{< cli-flags "viz check" >}} ### dashboard -{{< docs/cli-description "viz dashboard" >}} +{{< cli-description "viz dashboard" >}} Check out the [architecture](../architecture/#dashboard) docs for a more thorough explanation of what this command does. -{{< docs/cli-examples "viz dashboard" >}} +{{< cli-examples "viz dashboard" >}} -{{< docs/cli-flags "viz dashboard" >}} +{{< cli-flags "viz dashboard" >}} (\*) You'll need to tweak the dashboard's `enforced-host` parameter with this value, as explained in @@ -53,35 +53,35 @@ value, as explained in ### edges -{{< docs/cli-description "viz edges" >}} +{{< cli-description "viz edges" >}} -{{< docs/cli-examples "viz edges" >}} +{{< cli-examples "viz edges" >}} -{{< docs/cli-flags "viz edges" >}} +{{< cli-flags "viz edges" >}} ### install -{{< docs/cli-description "viz install" >}} +{{< cli-description "viz install" >}} -{{< docs/cli-examples "viz install" >}} +{{< cli-examples "viz install" >}} -{{< docs/cli-flags "viz install" >}} +{{< cli-flags "viz install" >}} ### list -{{< docs/cli-description "viz list" >}} +{{< cli-description "viz list" >}} -{{< docs/cli-examples "viz list" >}} +{{< cli-examples "viz list" >}} -{{< docs/cli-flags "viz list" >}} +{{< cli-flags "viz list" >}} ### profile -{{< docs/cli-description "viz profile" >}} +{{< cli-description "viz profile" >}} -{{< docs/cli-examples "viz profile" >}} +{{< cli-examples "viz profile" >}} -{{< docs/cli-flags "viz profile" >}} +{{< cli-flags "viz profile" >}} ### routes @@ -140,21 +140,21 @@ information. Because retries are only performed on the _outbound_ (client) side, the `-o wide` flag can only be used when the `--to` flag is specified. -{{< docs/cli-examples "viz routes" >}} +{{< cli-examples "viz routes" >}} -{{< docs/cli-flags "viz routes" >}} +{{< cli-flags "viz routes" >}} ### stat -{{< docs/cli-description "viz stat" >}} +{{< cli-description "viz stat" >}} -{{< docs/cli-examples "viz stat" >}} +{{< cli-examples "viz stat" >}} -{{< docs/cli-flags "viz stat" >}} +{{< cli-flags "viz stat" >}} ### tap -{{< docs/cli-description "viz tap" >}} +{{< cli-description "viz tap" >}} {{< note >}}If a pod is configured with the annotations `config.linkerd.io/skip-inbound-ports` or @@ -162,22 +162,22 @@ Because retries are only performed on the _outbound_ (client) side, the Linkerd proxy. Because `linkerd tap` observes traffic through the proxy, **traffic on skipped ports cannot be tapped**.{{< /note >}} -{{< docs/cli-examples "viz tap" >}} +{{< cli-examples "viz tap" >}} -{{< docs/cli-flags "viz tap" >}} +{{< cli-flags "viz tap" >}} ### top -{{< docs/cli-description "viz top" >}} +{{< cli-description "viz top" >}} -{{< docs/cli-examples "viz top" >}} +{{< cli-examples "viz top" >}} -{{< docs/cli-flags "viz top" >}} +{{< cli-flags "viz top" >}} ### uninstall -{{< docs/cli-description "viz uninstall" >}} +{{< cli-description "viz uninstall" >}} -{{< docs/cli-examples "viz uninstall" >}} +{{< cli-examples "viz uninstall" >}} -{{< docs/cli-flags "viz uninstall" >}} +{{< cli-flags "viz uninstall" >}} diff --git a/linkerd.io/content/2-edge/reference/extension-list.md b/linkerd.io/content/2-edge/reference/extension-list.md index e6bdad697e..32afc3fd09 100644 --- a/linkerd.io/content/2-edge/reference/extension-list.md +++ b/linkerd.io/content/2-edge/reference/extension-list.md @@ -9,7 +9,7 @@ Linkerd provides a mix of built-in and third-party [extensions](../tasks/extensions/) to add additional functionality to the base installation. The following is the list of known extensions: -{{< docs/extensions >}} +{{< extensions >}} If you have an extension for Linkerd and it is not on the list, [please edit this page!](https://github.com/linkerd/website/edit/main/linkerd.io/data/extension-list.yaml) diff --git a/linkerd.io/content/2-edge/reference/proxy-configuration.md b/linkerd.io/content/2-edge/reference/proxy-configuration.md index 80b471f88b..847b0a53d4 100644 --- a/linkerd.io/content/2-edge/reference/proxy-configuration.md +++ b/linkerd.io/content/2-edge/reference/proxy-configuration.md @@ -11,7 +11,7 @@ configurations of [auto-injected proxies](../features/proxy-injection/). The following is the list of supported annotations: -{{< docs/cli-annotations "inject" >}} +{{< cli-annotations "inject" >}} For example, to update an auto-injected proxy's CPU and memory resources, we insert the appropriate annotations into the `spec.template.metadata.annotations` diff --git a/linkerd.io/content/2-edge/tasks/_index.md b/linkerd.io/content/2-edge/tasks/_index.md index cfca319184..19a83aee53 100644 --- a/linkerd.io/content/2-edge/tasks/_index.md +++ b/linkerd.io/content/2-edge/tasks/_index.md @@ -9,4 +9,4 @@ common tasks that you may need to perform when using Linkerd. ## Common Linkerd tasks -{{< docs/section-toc >}} +{{< section-toc >}} diff --git a/linkerd.io/content/2-edge/tasks/automatic-failover.md b/linkerd.io/content/2-edge/tasks/automatic-failover.md index f45c66d817..233764e38f 100644 --- a/linkerd.io/content/2-edge/tasks/automatic-failover.md +++ b/linkerd.io/content/2-edge/tasks/automatic-failover.md @@ -25,7 +25,7 @@ Emojivoto application on two Kubernetes clusters and simulating a failure in one cluster. We will see the failover controller shift traffic to the other cluster to ensure the service remains available. -{{< docs/production-note >}} +{{< production-note >}} ## Prerequisites diff --git a/linkerd.io/content/2-edge/tasks/automatically-rotating-control-plane-tls-credentials.md b/linkerd.io/content/2-edge/tasks/automatically-rotating-control-plane-tls-credentials.md index fb3c874952..425dd65dad 100644 --- a/linkerd.io/content/2-edge/tasks/automatically-rotating-control-plane-tls-credentials.md +++ b/linkerd.io/content/2-edge/tasks/automatically-rotating-control-plane-tls-credentials.md @@ -27,7 +27,7 @@ with a validity of one year but require manual rotation by the user to prevent expiry. While this setup is convenient for quick start testing, it's not advisable nor recommended for production environments. -{{< docs/production-note >}} +{{< production-note >}} ## Automating Certificate Management with cert-manager and trust-manager @@ -244,18 +244,18 @@ EOF {{< warning >}} The default value of the `rotationPolicy` in the Certificate's `privateKey` -section is dependent on your version of cert-manager. In version 1.17 and -below, the default value was `Never`. With this configuration, cert-manager -**will not** actually rotate the trust anchor: instead, it will update the -validity timestamps but **not** generate a new private key. -**This is definitely not as secure as rotating the private key**. +section is dependent on your version of cert-manager. In version 1.17 and below, +the default value was `Never`. With this configuration, cert-manager **will +not** actually rotate the trust anchor: instead, it will update the validity +timestamps but **not** generate a new private key. **This is definitely not as +secure as rotating the private key**. If you are upgrading cert-manager from version 1.17 or below to version 1.18 or above, be aware that this new default will change the `rotationPolicy` if you are not explicitly setting it in your Certificate resource manifest. -To avoid ambiguity, we recommend always setting `rotationPolicy: Always` for -any certificate that cert-manager is managing. +To avoid ambiguity, we recommend always setting `rotationPolicy: Always` for any +certificate that cert-manager is managing. {{< /warning >}} @@ -360,18 +360,18 @@ EOF {{< warning >}} The default value of the `rotationPolicy` in the Certificate's `privateKey` -section is dependent on your version of cert-manager. In version 1.17 and -below, the default value was `Never`. With this configuration, cert-manager -**will not** actually rotate the trust anchor: instead, it will update the -validity timestamps but **not** generate a new private key. -**This is definitely not as secure as rotating the private key**. +section is dependent on your version of cert-manager. In version 1.17 and below, +the default value was `Never`. With this configuration, cert-manager **will +not** actually rotate the trust anchor: instead, it will update the validity +timestamps but **not** generate a new private key. **This is definitely not as +secure as rotating the private key**. If you are upgrading cert-manager from version 1.17 or below to version 1.18 or above, be aware that this new default will change the `rotationPolicy` if you are not explicitly setting it in your Certificate resource manifest. -To avoid ambiguity, we recommend always setting `rotationPolicy: Always` for -any certificate that cert-manager is managing. +To avoid ambiguity, we recommend always setting `rotationPolicy: Always` for any +certificate that cert-manager is managing. {{< /warning >}} @@ -777,10 +777,10 @@ _requires_ manual intervention, because while cert-manager can handle the hard work of actually rotating the trust anchor, it can't trigger the needed restarts. -This means that the simplest way to handle trust anchor rotation is -to _trigger the rotation manually_ whenever it's convenient for you so that -you can manage the trust bundle and restarts while letting cert-manager manage -the trust anchor certificate. +This means that the simplest way to handle trust anchor rotation is to _trigger +the rotation manually_ whenever it's convenient for you so that you can manage +the trust bundle and restarts while letting cert-manager manage the trust anchor +certificate. The process of actually doing this is straightforward, but again, there are several steps: @@ -830,8 +830,8 @@ kubectl get secret -n cert-manager linkerd-previous-anchor \ | base64 -d | inspect_cert ``` -Verify that the `linkerd-identity-trust-roots` ConfigMap now contains -the Subject keys from both Secrets. +Verify that the `linkerd-identity-trust-roots` ConfigMap now contains the +Subject keys from both Secrets. ```bash kubectl get configmap -n linkerd linkerd-identity-trust-roots \ @@ -858,9 +858,9 @@ This will cause the control plane to pick up the new trust anchor bundle. #### 3. Restart the data plane At this point, you'll need to restart your workloads as well, to force the -proxies to have the new trust anchor bundle. The exact mechanism to do this -will depend on your workloads, but it's often just `kubectl rollout restart` for -each of your application namespaces. +proxies to have the new trust anchor bundle. The exact mechanism to do this will +depend on your workloads, but it's often just `kubectl rollout restart` for each +of your application namespaces. #### 4. Triggering identity issuer rotation @@ -905,10 +905,10 @@ issuer. #### 6. Restart the data plane -Again, you'll need to restart your workloads, to force the -proxies to switch to the new identity issuer signed by the new trust anchor. -The exact mechanism to do this will depend on your workloads, but it's often -just `kubectl rollout restart` for each of your application namespaces. +Again, you'll need to restart your workloads, to force the proxies to switch to +the new identity issuer signed by the new trust anchor. The exact mechanism to +do this will depend on your workloads, but it's often just +`kubectl rollout restart` for each of your application namespaces. #### 7. Remove the old anchor from the trust bundle diff --git a/linkerd.io/content/2-edge/tasks/automatically-rotating-webhook-tls-credentials.md b/linkerd.io/content/2-edge/tasks/automatically-rotating-webhook-tls-credentials.md index b6368510c0..9d96cddce9 100644 --- a/linkerd.io/content/2-edge/tasks/automatically-rotating-webhook-tls-credentials.md +++ b/linkerd.io/content/2-edge/tasks/automatically-rotating-webhook-tls-credentials.md @@ -22,7 +22,7 @@ This workflow is suitable for most users. However, if you need these webhook certificates to be rotated automatically on a regular basis, it is possible to use cert-manager to automatically manage them. -{{< docs/production-note >}} +{{< production-note >}} ## Install Cert manager diff --git a/linkerd.io/content/2-edge/tasks/circuit-breakers.md b/linkerd.io/content/2-edge/tasks/circuit-breakers.md index 13425e16dd..d038ccf382 100644 --- a/linkerd.io/content/2-edge/tasks/circuit-breakers.md +++ b/linkerd.io/content/2-edge/tasks/circuit-breakers.md @@ -13,7 +13,7 @@ improve client success rate when a backend replica is unhealthy. See the [reference documentation](../reference/circuit-breaking/) for more details on how Linkerd implements circuit breaking. -{{< docs/production-note >}} +{{< production-note >}} ## Prerequisites diff --git a/linkerd.io/content/2-edge/tasks/customize-install.md b/linkerd.io/content/2-edge/tasks/customize-install.md index dc71604c3c..512bb3629d 100644 --- a/linkerd.io/content/2-edge/tasks/customize-install.md +++ b/linkerd.io/content/2-edge/tasks/customize-install.md @@ -9,7 +9,7 @@ Instead of forking the Linkerd install and upgrade process, `linkerd install` in a consistent way. This allows customization of the install to add functionality specific to installations. -{{< docs/production-note >}} +{{< production-note >}} To get started, save the output of `linkerd install` to a YAML file. This will be the base resource that Kustomize uses to patch and generate what is added to diff --git a/linkerd.io/content/2-edge/tasks/exporting-metrics.md b/linkerd.io/content/2-edge/tasks/exporting-metrics.md index 877aedf5a2..96fc7f24f0 100644 --- a/linkerd.io/content/2-edge/tasks/exporting-metrics.md +++ b/linkerd.io/content/2-edge/tasks/exporting-metrics.md @@ -13,7 +13,7 @@ each proxy only provides a portion of the full picture. Instead, a separate tool is used to collect metrics from all proxies and aggregate them together for consumption. -{{< docs/production-note >}} +{{< production-note >}} One easy option is the [linkerd-viz](../features/dashboard/) extension, which will create an on-cluster Prometheus instance as well as dashboards and CLI @@ -74,7 +74,7 @@ metadata: k8s-app: linkerd-prometheus release: monitoring name: linkerd-federate - namespace: {{.Namespace}} + namespace: { { .Namespace } } spec: endpoints: - interval: 30s @@ -94,7 +94,7 @@ spec: jobLabel: app namespaceSelector: matchNames: - - {{.Namespace}} + - { { .Namespace } } selector: matchLabels: component: prometheus diff --git a/linkerd.io/content/2-edge/tasks/exposing-dashboard.md b/linkerd.io/content/2-edge/tasks/exposing-dashboard.md index fe8cf24afe..0f0d9ef682 100644 --- a/linkerd.io/content/2-edge/tasks/exposing-dashboard.md +++ b/linkerd.io/content/2-edge/tasks/exposing-dashboard.md @@ -10,7 +10,7 @@ going on, you can expose the dashboard via an ingress. This will also expose Grafana, if you have it linked against Linkerd viz through the `grafana.url` setting. -{{< docs/toc >}} +{{< toc >}} ## Nginx diff --git a/linkerd.io/content/2-edge/tasks/external-prometheus.md b/linkerd.io/content/2-edge/tasks/external-prometheus.md index ccd0434d2d..4bc0dc59e6 100644 --- a/linkerd.io/content/2-edge/tasks/external-prometheus.md +++ b/linkerd.io/content/2-edge/tasks/external-prometheus.md @@ -12,7 +12,7 @@ both the control plane as well as the proxy's metrics in a format that is consumable both by a user as well as Linkerd control plane components like web, etc. -{{< docs/production-note >}} +{{< production-note >}} There are two important points to tackle here. diff --git a/linkerd.io/content/2-edge/tasks/flagger.md b/linkerd.io/content/2-edge/tasks/flagger.md index 356ac3b38e..a8a03f093e 100644 --- a/linkerd.io/content/2-edge/tasks/flagger.md +++ b/linkerd.io/content/2-edge/tasks/flagger.md @@ -23,7 +23,7 @@ tools: [Flagger](https://flagger.app/) and metrics and request routing together in a control loop, allowing for fully-automated, metrics-aware canary deployments. -{{< docs/production-note >}} +{{< production-note >}} ## Prerequisites diff --git a/linkerd.io/content/2-edge/tasks/generate-certificates.md b/linkerd.io/content/2-edge/tasks/generate-certificates.md index 35013ac056..33dd6751d1 100644 --- a/linkerd.io/content/2-edge/tasks/generate-certificates.md +++ b/linkerd.io/content/2-edge/tasks/generate-certificates.md @@ -23,7 +23,7 @@ algorithm which is the default for `step`. To generate ECDSA P-256 certificates with openssl, you can use the `openssl ecparam -name prime256v1` command. In this tutorial, we'll walk you through how to to use the `step` CLI to do this. -{{< docs/production-note >}} +{{< production-note >}} ## Generating the certificates with `step` diff --git a/linkerd.io/content/2-edge/tasks/gitops.md b/linkerd.io/content/2-edge/tasks/gitops.md index 51328396a3..70c2346f70 100644 --- a/linkerd.io/content/2-edge/tasks/gitops.md +++ b/linkerd.io/content/2-edge/tasks/gitops.md @@ -12,7 +12,7 @@ This guide will show you how to set up [Argo CD](https://argoproj.github.io/argo-cd/) to manage the installation and upgrade of Linkerd using a GitOps workflow. -{{< docs/production-note >}} +{{< production-note >}} Specifically, this guide provides instructions on how to securely generate and manage Linkerd's mTLS private keys and certificates using diff --git a/linkerd.io/content/2-edge/tasks/grafana.md b/linkerd.io/content/2-edge/tasks/grafana.md index 37cb3d5cfa..24f88e6dc3 100644 --- a/linkerd.io/content/2-edge/tasks/grafana.md +++ b/linkerd.io/content/2-edge/tasks/grafana.md @@ -13,7 +13,7 @@ First, you need to install Grafana from a variety of possible sources, and then load the suite of Grafana dashboards that have been pre-configured to consume the metrics exposed by Linkerd. -{{< docs/production-note >}} +{{< production-note >}} ## Install Prometheus diff --git a/linkerd.io/content/2-edge/tasks/install-helm.md b/linkerd.io/content/2-edge/tasks/install-helm.md index 1c4082dfe7..5f31f1d3a9 100644 --- a/linkerd.io/content/2-edge/tasks/install-helm.md +++ b/linkerd.io/content/2-edge/tasks/install-helm.md @@ -6,7 +6,7 @@ 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. -{{< docs/edge-note >}} +{{< edge-note >}} ## Prerequisite: install the Gateway API diff --git a/linkerd.io/content/2-edge/tasks/installing-multicluster.md b/linkerd.io/content/2-edge/tasks/installing-multicluster.md index 2323119ef8..d3e47ded8e 100644 --- a/linkerd.io/content/2-edge/tasks/installing-multicluster.md +++ b/linkerd.io/content/2-edge/tasks/installing-multicluster.md @@ -9,7 +9,7 @@ through this installation and configuration as well as common problems that you may encounter. For a detailed walkthrough and explanation of what's going on, check out [getting started](multicluster/). -{{< docs/production-note >}} +{{< production-note >}} ## Requirements diff --git a/linkerd.io/content/2-edge/tasks/rate-limit-aware-load-balancing.md b/linkerd.io/content/2-edge/tasks/rate-limit-aware-load-balancing.md index d06cc36817..695ffaeb63 100644 --- a/linkerd.io/content/2-edge/tasks/rate-limit-aware-load-balancing.md +++ b/linkerd.io/content/2-edge/tasks/rate-limit-aware-load-balancing.md @@ -15,7 +15,7 @@ loop where clients experience high 429 or RESOURCE_EXHAUSTED rates. Linkerd has two experimental features to help route traffic away from endpoints which are in a rate-limited state. -{{< docs/production-note >}} +{{< production-note >}} {{< warning >}} diff --git a/linkerd.io/content/2-edge/tasks/setting-up-service-profiles.md b/linkerd.io/content/2-edge/tasks/setting-up-service-profiles.md index 25f6084bea..be9284058e 100644 --- a/linkerd.io/content/2-edge/tasks/setting-up-service-profiles.md +++ b/linkerd.io/content/2-edge/tasks/setting-up-service-profiles.md @@ -63,7 +63,7 @@ demo. There are a couple different ways to use `linkerd profile` to create service profiles. -{{< docs/toc >}} +{{< toc >}} Requests which have been associated with a route will have a `rt_route` annotation. To manually verify if the requests are being associated correctly, diff --git a/linkerd.io/content/2-edge/tasks/traffic-shifting.md b/linkerd.io/content/2-edge/tasks/traffic-shifting.md index 3c1bcdec9f..1091aa6198 100644 --- a/linkerd.io/content/2-edge/tasks/traffic-shifting.md +++ b/linkerd.io/content/2-edge/tasks/traffic-shifting.md @@ -20,7 +20,7 @@ development. {{< /note >}} -{{< docs/production-note >}} +{{< production-note >}} ## Prerequisites diff --git a/linkerd.io/content/2-edge/tasks/using-the-debug-container.md b/linkerd.io/content/2-edge/tasks/using-the-debug-container.md index 6e40eecd1a..ff7a10bce9 100644 --- a/linkerd.io/content/2-edge/tasks/using-the-debug-container.md +++ b/linkerd.io/content/2-edge/tasks/using-the-debug-container.md @@ -19,7 +19,7 @@ time. For convenience, the `linkerd inject` command provides an adding this annotation to a pre-existing pod will not work. It must be present at pod _creation_ time.) -{{< docs/production-note >}} +{{< production-note >}} The debug sidecar image contains [`tshark`](https://www.wireshark.org/docs/man-pages/tshark.html), `tcpdump`, diff --git a/linkerd.io/content/2.10/features/_index.md b/linkerd.io/content/2.10/features/_index.md index cf341d4e7e..3eebfe67f4 100644 --- a/linkerd.io/content/2.10/features/_index.md +++ b/linkerd.io/content/2.10/features/_index.md @@ -11,4 +11,4 @@ please see the [Linkerd task docs](../tasks/). For a reference, see the ## Linkerd's features -{{< docs/section-toc >}} +{{< section-toc >}} diff --git a/linkerd.io/content/2.10/reference/_index.md b/linkerd.io/content/2.10/reference/_index.md index f2045c2b56..c066e0b8ee 100644 --- a/linkerd.io/content/2.10/reference/_index.md +++ b/linkerd.io/content/2.10/reference/_index.md @@ -3,4 +3,4 @@ title: Reference weight: 5 --- -{{< docs/section-toc >}} +{{< section-toc >}} diff --git a/linkerd.io/content/2.10/reference/cli/_index.md b/linkerd.io/content/2.10/reference/cli/_index.md index ee36df6287..4d4170ffa7 100644 --- a/linkerd.io/content/2.10/reference/cli/_index.md +++ b/linkerd.io/content/2.10/reference/cli/_index.md @@ -9,10 +9,10 @@ detailed metrics for how your service is performing. As reference, check out the commands below: -{{< docs/cli-commands >}} +{{< cli-commands >}} ## Global flags The following flags are available for _all_ linkerd CLI commands: -{{< docs/cli-global-flags >}} +{{< cli-global-flags >}} diff --git a/linkerd.io/content/2.10/reference/cli/check.md b/linkerd.io/content/2.10/reference/cli/check.md index 312891f8ef..a056a799fa 100644 --- a/linkerd.io/content/2.10/reference/cli/check.md +++ b/linkerd.io/content/2.10/reference/cli/check.md @@ -2,12 +2,12 @@ title: check --- -{{< docs/cli-description "check" >}} +{{< cli-description "check" >}} Take a look at the [troubleshooting](../../tasks/troubleshooting/) documentation for a full list of all the possible checks, what they do and how to fix them. -{{< docs/cli-examples "check" >}} +{{< cli-examples "check" >}} ## Example output @@ -53,7 +53,7 @@ control-plane-version Status check results are √ ``` -{{< docs/cli-flags "check" >}} +{{< cli-flags "check" >}} ## Subcommands @@ -62,8 +62,8 @@ Check supports subcommands as part of the ### config -{{< docs/cli-description "check config" >}} +{{< cli-description "check config" >}} -{{< docs/cli-examples "check config" >}} +{{< cli-examples "check config" >}} -{{< docs/cli-flags "check config" >}} +{{< cli-flags "check config" >}} diff --git a/linkerd.io/content/2.10/reference/cli/completion.md b/linkerd.io/content/2.10/reference/cli/completion.md index 40e8438b72..6007a47fa5 100644 --- a/linkerd.io/content/2.10/reference/cli/completion.md +++ b/linkerd.io/content/2.10/reference/cli/completion.md @@ -2,8 +2,8 @@ title: completion --- -{{< docs/cli-description "completion" >}} +{{< cli-description "completion" >}} -{{< docs/cli-examples "completion" >}} +{{< cli-examples "completion" >}} -{{< docs/cli-flags "completion" >}} +{{< cli-flags "completion" >}} diff --git a/linkerd.io/content/2.10/reference/cli/diagnostics.md b/linkerd.io/content/2.10/reference/cli/diagnostics.md index ffa45c39be..8e4e36d234 100644 --- a/linkerd.io/content/2.10/reference/cli/diagnostics.md +++ b/linkerd.io/content/2.10/reference/cli/diagnostics.md @@ -2,44 +2,44 @@ title: diagnostics --- -{{< docs/cli-description "diagnostics" >}} +{{< cli-description "diagnostics" >}} -{{< docs/cli-examples "diagnostics" >}} +{{< cli-examples "diagnostics" >}} -{{< docs/cli-flags "diagnostics" >}} +{{< cli-flags "diagnostics" >}} ## Subcommands -{{< docs/cli-subcommands "diagnostics" >}} +{{< cli-subcommands "diagnostics" >}} ### controller-metrics -{{< docs/cli-description "diagnostics controller-metrics" >}} +{{< cli-description "diagnostics controller-metrics" >}} -{{< docs/cli-examples "diagnostics controller-metrics" >}} +{{< cli-examples "diagnostics controller-metrics" >}} -{{< docs/cli-flags "diagnostics controller-metrics" >}} +{{< cli-flags "diagnostics controller-metrics" >}} ### endpoints -{{< docs/cli-description "diagnostics endpoints" >}} +{{< cli-description "diagnostics endpoints" >}} -{{< docs/cli-examples "diagnostics endpoints" >}} +{{< cli-examples "diagnostics endpoints" >}} -{{< docs/cli-flags "diagnostics endpoints" >}} +{{< cli-flags "diagnostics endpoints" >}} ### install-sp -{{< docs/cli-description "diagnostics install-sp" >}} +{{< cli-description "diagnostics install-sp" >}} -{{< docs/cli-examples "diagnostics install-sp" >}} +{{< cli-examples "diagnostics install-sp" >}} -{{< docs/cli-flags "diagnostics install-sp" >}} +{{< cli-flags "diagnostics install-sp" >}} ### proxy-metrics -{{< docs/cli-description "diagnostics proxy-metrics" >}} +{{< cli-description "diagnostics proxy-metrics" >}} -{{< docs/cli-examples "diagnostics proxy-metrics" >}} +{{< cli-examples "diagnostics proxy-metrics" >}} -{{< docs/cli-flags "diagnostics proxy-metrics" >}} +{{< cli-flags "diagnostics proxy-metrics" >}} diff --git a/linkerd.io/content/2.10/reference/cli/identity.md b/linkerd.io/content/2.10/reference/cli/identity.md index 576d175930..c7962e8027 100644 --- a/linkerd.io/content/2.10/reference/cli/identity.md +++ b/linkerd.io/content/2.10/reference/cli/identity.md @@ -2,8 +2,8 @@ title: identity --- -{{< docs/cli-description "identity" >}} +{{< cli-description "identity" >}} -{{< docs/cli-examples "identity" >}} +{{< cli-examples "identity" >}} -{{< docs/cli-flags "identity" >}} +{{< cli-flags "identity" >}} diff --git a/linkerd.io/content/2.10/reference/cli/inject.md b/linkerd.io/content/2.10/reference/cli/inject.md index aafdacdb29..92fc0ca3cb 100644 --- a/linkerd.io/content/2.10/reference/cli/inject.md +++ b/linkerd.io/content/2.10/reference/cli/inject.md @@ -19,6 +19,6 @@ Alternatively, this command can also perform the full injection purely on the client side, by enabling with the `--manual` flag. (Prior to Linkerd 2.4, this was the default behavior.) -{{< docs/cli-examples "inject" >}} +{{< cli-examples "inject" >}} -{{< docs/cli-flags "inject" >}} +{{< cli-flags "inject" >}} diff --git a/linkerd.io/content/2.10/reference/cli/install-cni.md b/linkerd.io/content/2.10/reference/cli/install-cni.md index c7c457a6f1..d0577e3d3b 100644 --- a/linkerd.io/content/2.10/reference/cli/install-cni.md +++ b/linkerd.io/content/2.10/reference/cli/install-cni.md @@ -2,8 +2,8 @@ title: install-cni --- -{{< docs/cli-description "install-cni" >}} +{{< cli-description "install-cni" >}} -{{< docs/cli-examples "install-cni" >}} +{{< cli-examples "install-cni" >}} -{{< docs/cli-flags "install-cni" >}} +{{< cli-flags "install-cni" >}} diff --git a/linkerd.io/content/2.10/reference/cli/install.md b/linkerd.io/content/2.10/reference/cli/install.md index 7c34adb8ab..d71e947348 100644 --- a/linkerd.io/content/2.10/reference/cli/install.md +++ b/linkerd.io/content/2.10/reference/cli/install.md @@ -2,14 +2,14 @@ title: install --- -{{< docs/cli-description "install" >}} +{{< cli-description "install" >}} For further details on how to install Linkerd onto your own cluster, check out the [install documentation](../../tasks/install/). -{{< docs/cli-examples "install" >}} +{{< cli-examples "install" >}} -{{< docs/cli-flags "install" >}} +{{< cli-flags "install" >}} ## Subcommands @@ -18,16 +18,16 @@ Install supports subcommands as part of the ### config -{{< docs/cli-description "install config" >}} +{{< cli-description "install config" >}} -{{< docs/cli-examples "install config" >}} +{{< cli-examples "install config" >}} -{{< docs/cli-flags "install config" >}} +{{< cli-flags "install config" >}} ### control-plane -{{< docs/cli-description "install control-plane" >}} +{{< cli-description "install control-plane" >}} -{{< docs/cli-examples "install control-plane" >}} +{{< cli-examples "install control-plane" >}} -{{< docs/cli-flags "install control-plane" >}} +{{< cli-flags "install control-plane" >}} diff --git a/linkerd.io/content/2.10/reference/cli/jaeger.md b/linkerd.io/content/2.10/reference/cli/jaeger.md index 1301361532..820ad6489c 100644 --- a/linkerd.io/content/2.10/reference/cli/jaeger.md +++ b/linkerd.io/content/2.10/reference/cli/jaeger.md @@ -2,52 +2,52 @@ title: jaeger --- -{{< docs/cli-description "jaeger" >}} +{{< cli-description "jaeger" >}} -{{< docs/cli-examples "jaeger" >}} +{{< cli-examples "jaeger" >}} -{{< docs/cli-flags "jaeger" >}} +{{< cli-flags "jaeger" >}} ## Subcommands -{{< docs/cli-subcommands "jaeger" >}} +{{< cli-subcommands "jaeger" >}} ### check -{{< docs/cli-description "jaeger check" >}} +{{< cli-description "jaeger check" >}} -{{< docs/cli-examples "jaeger check" >}} +{{< cli-examples "jaeger check" >}} -{{< docs/cli-flags "jaeger check" >}} +{{< cli-flags "jaeger check" >}} ### dashboard -{{< docs/cli-description "jaeger dashboard" >}} +{{< cli-description "jaeger dashboard" >}} -{{< docs/cli-examples "jaeger dashboard" >}} +{{< cli-examples "jaeger dashboard" >}} -{{< docs/cli-flags "jaeger dashboard" >}} +{{< cli-flags "jaeger dashboard" >}} ### install -{{< docs/cli-description "jaeger install" >}} +{{< cli-description "jaeger install" >}} -{{< docs/cli-examples "jaeger install" >}} +{{< cli-examples "jaeger install" >}} -{{< docs/cli-flags "jaeger install" >}} +{{< cli-flags "jaeger install" >}} ### list -{{< docs/cli-description "jaeger list" >}} +{{< cli-description "jaeger list" >}} -{{< docs/cli-examples "jaeger list" >}} +{{< cli-examples "jaeger list" >}} -{{< docs/cli-flags "jaeger list" >}} +{{< cli-flags "jaeger list" >}} ### uninstall -{{< docs/cli-description "jaeger uninstall" >}} +{{< cli-description "jaeger uninstall" >}} -{{< docs/cli-examples "jaeger uninstall" >}} +{{< cli-examples "jaeger uninstall" >}} -{{< docs/cli-flags "jaeger uninstall" >}} +{{< cli-flags "jaeger uninstall" >}} diff --git a/linkerd.io/content/2.10/reference/cli/multicluster.md b/linkerd.io/content/2.10/reference/cli/multicluster.md index 519ba5b57e..72c9ac0a4f 100644 --- a/linkerd.io/content/2.10/reference/cli/multicluster.md +++ b/linkerd.io/content/2.10/reference/cli/multicluster.md @@ -2,68 +2,68 @@ title: multicluster --- -{{< docs/cli-description "multicluster" >}} +{{< cli-description "multicluster" >}} -{{< docs/cli-examples "multicluster" >}} +{{< cli-examples "multicluster" >}} -{{< docs/cli-flags "multicluster" >}} +{{< cli-flags "multicluster" >}} ## Subcommands -{{< docs/cli-subcommands "multicluster" >}} +{{< cli-subcommands "multicluster" >}} ### allow -{{< docs/cli-description "multicluster allow" >}} +{{< cli-description "multicluster allow" >}} -{{< docs/cli-examples "multicluster allow" >}} +{{< cli-examples "multicluster allow" >}} -{{< docs/cli-flags "multicluster allow" >}} +{{< cli-flags "multicluster allow" >}} ### check -{{< docs/cli-description "multicluster check" >}} +{{< cli-description "multicluster check" >}} -{{< docs/cli-examples "multicluster check" >}} +{{< cli-examples "multicluster check" >}} -{{< docs/cli-flags "multicluster check" >}} +{{< cli-flags "multicluster check" >}} ### gateways -{{< docs/cli-description "multicluster gateways" >}} +{{< cli-description "multicluster gateways" >}} -{{< docs/cli-examples "multicluster gateways" >}} +{{< cli-examples "multicluster gateways" >}} -{{< docs/cli-flags "multicluster gateways" >}} +{{< cli-flags "multicluster gateways" >}} ### install -{{< docs/cli-description "multicluster install" >}} +{{< cli-description "multicluster install" >}} -{{< docs/cli-examples "multicluster install" >}} +{{< cli-examples "multicluster install" >}} -{{< docs/cli-flags "multicluster install" >}} +{{< cli-flags "multicluster install" >}} ### link -{{< docs/cli-description "multicluster link" >}} +{{< cli-description "multicluster link" >}} -{{< docs/cli-examples "multicluster link" >}} +{{< cli-examples "multicluster link" >}} -{{< docs/cli-flags "multicluster link" >}} +{{< cli-flags "multicluster link" >}} ### uninstall -{{< docs/cli-description "multicluster uninstall" >}} +{{< cli-description "multicluster uninstall" >}} -{{< docs/cli-examples "multicluster uninstall" >}} +{{< cli-examples "multicluster uninstall" >}} -{{< docs/cli-flags "multicluster uninstall" >}} +{{< cli-flags "multicluster uninstall" >}} ### unlink -{{< docs/cli-description "multicluster unlink" >}} +{{< cli-description "multicluster unlink" >}} -{{< docs/cli-examples "multicluster unlink" >}} +{{< cli-examples "multicluster unlink" >}} -{{< docs/cli-flags "multicluster unlink" >}} +{{< cli-flags "multicluster unlink" >}} diff --git a/linkerd.io/content/2.10/reference/cli/profile.md b/linkerd.io/content/2.10/reference/cli/profile.md index 5cc919b876..bf2545c313 100644 --- a/linkerd.io/content/2.10/reference/cli/profile.md +++ b/linkerd.io/content/2.10/reference/cli/profile.md @@ -2,12 +2,12 @@ title: profile --- -{{< docs/cli-description "profile" >}} +{{< cli-description "profile" >}} Check out the [service profile](../../features/service-profiles/) documentation for more details on what this command does and what you can do with service profiles. -{{< docs/cli-examples "profile" >}} +{{< cli-examples "profile" >}} -{{< docs/cli-flags "profile" >}} +{{< cli-flags "profile" >}} diff --git a/linkerd.io/content/2.10/reference/cli/repair.md b/linkerd.io/content/2.10/reference/cli/repair.md index 94b95f1809..6d4032bd66 100644 --- a/linkerd.io/content/2.10/reference/cli/repair.md +++ b/linkerd.io/content/2.10/reference/cli/repair.md @@ -2,8 +2,8 @@ title: repair --- -{{< docs/cli-description "repair" >}} +{{< cli-description "repair" >}} -{{< docs/cli-examples "repair" >}} +{{< cli-examples "repair" >}} -{{< docs/cli-flags "repair" >}} +{{< cli-flags "repair" >}} diff --git a/linkerd.io/content/2.10/reference/cli/uninject.md b/linkerd.io/content/2.10/reference/cli/uninject.md index 9ad619698a..6f43c3cf0a 100644 --- a/linkerd.io/content/2.10/reference/cli/uninject.md +++ b/linkerd.io/content/2.10/reference/cli/uninject.md @@ -2,8 +2,8 @@ title: uninject --- -{{< docs/cli-description "uninject" >}} +{{< cli-description "uninject" >}} -{{< docs/cli-examples "uninject" >}} +{{< cli-examples "uninject" >}} -{{< docs/cli-flags "uninject" >}} +{{< cli-flags "uninject" >}} diff --git a/linkerd.io/content/2.10/reference/cli/uninstall.md b/linkerd.io/content/2.10/reference/cli/uninstall.md index d5e00031ed..d62dd11612 100644 --- a/linkerd.io/content/2.10/reference/cli/uninstall.md +++ b/linkerd.io/content/2.10/reference/cli/uninstall.md @@ -2,8 +2,8 @@ title: uninstall --- -{{< docs/cli-description "uninstall" >}} +{{< cli-description "uninstall" >}} -{{< docs/cli-examples "uninstall" >}} +{{< cli-examples "uninstall" >}} -{{< docs/cli-flags "uninstall" >}} +{{< cli-flags "uninstall" >}} diff --git a/linkerd.io/content/2.10/reference/cli/upgrade.md b/linkerd.io/content/2.10/reference/cli/upgrade.md index 521cc84d67..a0cd538fa0 100644 --- a/linkerd.io/content/2.10/reference/cli/upgrade.md +++ b/linkerd.io/content/2.10/reference/cli/upgrade.md @@ -2,11 +2,11 @@ title: upgrade --- -{{< docs/cli-description "upgrade" >}} +{{< cli-description "upgrade" >}} -{{< docs/cli-examples "upgrade" >}} +{{< cli-examples "upgrade" >}} -{{< docs/cli-flags "upgrade" >}} +{{< cli-flags "upgrade" >}} ## Subcommands @@ -15,16 +15,16 @@ Upgrade supports subcommands as part of the ### config -{{< docs/cli-description "upgrade config" >}} +{{< cli-description "upgrade config" >}} -{{< docs/cli-examples "upgrade config" >}} +{{< cli-examples "upgrade config" >}} -{{< docs/cli-flags "upgrade config" >}} +{{< cli-flags "upgrade config" >}} ### control-plane -{{< docs/cli-description "upgrade control-plane" >}} +{{< cli-description "upgrade control-plane" >}} -{{< docs/cli-examples "upgrade control-plane" >}} +{{< cli-examples "upgrade control-plane" >}} -{{< docs/cli-flags "upgrade control-plane" >}} +{{< cli-flags "upgrade control-plane" >}} diff --git a/linkerd.io/content/2.10/reference/cli/version.md b/linkerd.io/content/2.10/reference/cli/version.md index 159f0b2f65..d31d7b18e6 100644 --- a/linkerd.io/content/2.10/reference/cli/version.md +++ b/linkerd.io/content/2.10/reference/cli/version.md @@ -2,8 +2,8 @@ title: version --- -{{< docs/cli-description "version" >}} +{{< cli-description "version" >}} -{{< docs/cli-examples "version" >}} +{{< cli-examples "version" >}} -{{< docs/cli-flags "version" >}} +{{< cli-flags "version" >}} diff --git a/linkerd.io/content/2.10/reference/cli/viz.md b/linkerd.io/content/2.10/reference/cli/viz.md index 4dfe37e219..1d014119f7 100644 --- a/linkerd.io/content/2.10/reference/cli/viz.md +++ b/linkerd.io/content/2.10/reference/cli/viz.md @@ -2,34 +2,34 @@ title: viz --- -{{< docs/cli-description "viz" >}} +{{< cli-description "viz" >}} -{{< docs/cli-examples "viz" >}} +{{< cli-examples "viz" >}} -{{< docs/cli-flags "viz" >}} +{{< cli-flags "viz" >}} ## Subcommands -{{< docs/cli-subcommands "viz" >}} +{{< cli-subcommands "viz" >}} ### check -{{< docs/cli-description "viz check" >}} +{{< cli-description "viz check" >}} -{{< docs/cli-examples "viz check" >}} +{{< cli-examples "viz check" >}} -{{< docs/cli-flags "viz check" >}} +{{< cli-flags "viz check" >}} ### dashboard -{{< docs/cli-description "viz dashboard" >}} +{{< cli-description "viz dashboard" >}} Check out the [architecture](../architecture/#dashboard) docs for a more thorough explanation of what this command does. -{{< docs/cli-examples "viz dashboard" >}} +{{< cli-examples "viz dashboard" >}} -{{< docs/cli-flags "viz dashboard" >}} +{{< cli-flags "viz dashboard" >}} (\*) You'll need to tweak the dashboard's `enforced-host` parameter with this value, as explained in @@ -37,35 +37,35 @@ value, as explained in ### edges -{{< docs/cli-description "viz edges" >}} +{{< cli-description "viz edges" >}} -{{< docs/cli-examples "viz edges" >}} +{{< cli-examples "viz edges" >}} -{{< docs/cli-flags "viz edges" >}} +{{< cli-flags "viz edges" >}} ### install -{{< docs/cli-description "viz install" >}} +{{< cli-description "viz install" >}} -{{< docs/cli-examples "viz install" >}} +{{< cli-examples "viz install" >}} -{{< docs/cli-flags "viz install" >}} +{{< cli-flags "viz install" >}} ### list -{{< docs/cli-description "viz list" >}} +{{< cli-description "viz list" >}} -{{< docs/cli-examples "viz list" >}} +{{< cli-examples "viz list" >}} -{{< docs/cli-flags "viz list" >}} +{{< cli-flags "viz list" >}} ### profile -{{< docs/cli-description "viz profile" >}} +{{< cli-description "viz profile" >}} -{{< docs/cli-examples "viz profile" >}} +{{< cli-examples "viz profile" >}} -{{< docs/cli-flags "viz profile" >}} +{{< cli-flags "viz profile" >}} ### routes @@ -124,38 +124,38 @@ information. Because retries are only performed on the _outbound_ (client) side, the `-o wide` flag can only be used when the `--to` flag is specified. -{{< docs/cli-examples "viz routes" >}} +{{< cli-examples "viz routes" >}} -{{< docs/cli-flags "viz routes" >}} +{{< cli-flags "viz routes" >}} ### stat -{{< docs/cli-description "viz stat" >}} +{{< cli-description "viz stat" >}} -{{< docs/cli-examples "viz stat" >}} +{{< cli-examples "viz stat" >}} -{{< docs/cli-flags "viz stat" >}} +{{< cli-flags "viz stat" >}} ### tap -{{< docs/cli-description "viz tap" >}} +{{< cli-description "viz tap" >}} -{{< docs/cli-examples "viz tap" >}} +{{< cli-examples "viz tap" >}} -{{< docs/cli-flags "viz tap" >}} +{{< cli-flags "viz tap" >}} ### top -{{< docs/cli-description "viz top" >}} +{{< cli-description "viz top" >}} -{{< docs/cli-examples "viz top" >}} +{{< cli-examples "viz top" >}} -{{< docs/cli-flags "viz top" >}} +{{< cli-flags "viz top" >}} ### uninstall -{{< docs/cli-description "viz uninstall" >}} +{{< cli-description "viz uninstall" >}} -{{< docs/cli-examples "viz uninstall" >}} +{{< cli-examples "viz uninstall" >}} -{{< docs/cli-flags "viz uninstall" >}} +{{< cli-flags "viz uninstall" >}} diff --git a/linkerd.io/content/2.10/reference/extension-list.md b/linkerd.io/content/2.10/reference/extension-list.md index e6bdad697e..32afc3fd09 100644 --- a/linkerd.io/content/2.10/reference/extension-list.md +++ b/linkerd.io/content/2.10/reference/extension-list.md @@ -9,7 +9,7 @@ Linkerd provides a mix of built-in and third-party [extensions](../tasks/extensions/) to add additional functionality to the base installation. The following is the list of known extensions: -{{< docs/extensions >}} +{{< extensions >}} If you have an extension for Linkerd and it is not on the list, [please edit this page!](https://github.com/linkerd/website/edit/main/linkerd.io/data/extension-list.yaml) diff --git a/linkerd.io/content/2.10/reference/proxy-configuration.md b/linkerd.io/content/2.10/reference/proxy-configuration.md index e5960a8924..f662296cb0 100644 --- a/linkerd.io/content/2.10/reference/proxy-configuration.md +++ b/linkerd.io/content/2.10/reference/proxy-configuration.md @@ -11,7 +11,7 @@ configurations of [auto-injected proxies](../features/proxy-injection/). The following is the list of supported annotations: -{{< docs/cli-annotations "inject" >}} +{{< cli-annotations "inject" >}} For example, to update an auto-injected proxy's CPU and memory resources, we insert the appropriate annotations into the `spec.template.metadata.annotations` diff --git a/linkerd.io/content/2.10/tasks/_index.md b/linkerd.io/content/2.10/tasks/_index.md index cfca319184..19a83aee53 100644 --- a/linkerd.io/content/2.10/tasks/_index.md +++ b/linkerd.io/content/2.10/tasks/_index.md @@ -9,4 +9,4 @@ common tasks that you may need to perform when using Linkerd. ## Common Linkerd tasks -{{< docs/section-toc >}} +{{< section-toc >}} diff --git a/linkerd.io/content/2.10/tasks/automatically-rotating-control-plane-tls-credentials.md b/linkerd.io/content/2.10/tasks/automatically-rotating-control-plane-tls-credentials.md index 3304af943d..6b30373634 100644 --- a/linkerd.io/content/2.10/tasks/automatically-rotating-control-plane-tls-credentials.md +++ b/linkerd.io/content/2.10/tasks/automatically-rotating-control-plane-tls-credentials.md @@ -16,7 +16,7 @@ external solution. [must still be manually rotated](manually-rotating-control-plane-tls-credentials/) on long-lived clusters.) -{{< docs/production-note >}} +{{< production-note >}} ## Cert manager diff --git a/linkerd.io/content/2.10/tasks/automatically-rotating-webhook-tls-credentials.md b/linkerd.io/content/2.10/tasks/automatically-rotating-webhook-tls-credentials.md index 068e392db9..00821da855 100644 --- a/linkerd.io/content/2.10/tasks/automatically-rotating-webhook-tls-credentials.md +++ b/linkerd.io/content/2.10/tasks/automatically-rotating-webhook-tls-credentials.md @@ -22,7 +22,7 @@ This workflow is suitable for most users. However, if you need these webhook certificates to be rotated automatically on a regular basis, it is possible to use cert-manager to automatically manage them. -{{< docs/production-note >}} +{{< production-note >}} ## Install Cert manager diff --git a/linkerd.io/content/2.10/tasks/canary-release.md b/linkerd.io/content/2.10/tasks/canary-release.md index 91ceed6956..db4d37719e 100644 --- a/linkerd.io/content/2.10/tasks/canary-release.md +++ b/linkerd.io/content/2.10/tasks/canary-release.md @@ -23,7 +23,7 @@ In this tutorial, we'll walk you through how to combine Linkerd with metrics and traffic splitting together in a control loop, allowing for fully-automated, metrics-aware canary deployments. -{{< docs/production-note >}} +{{< production-note >}} ## Prerequisites diff --git a/linkerd.io/content/2.10/tasks/customize-install.md b/linkerd.io/content/2.10/tasks/customize-install.md index 2475806955..8b36c506b9 100644 --- a/linkerd.io/content/2.10/tasks/customize-install.md +++ b/linkerd.io/content/2.10/tasks/customize-install.md @@ -9,7 +9,7 @@ Instead of forking the Linkerd install and upgrade process, `linkerd install` in a consistent way. This allows customization of the install to add functionality specific to installations. -{{< docs/production-note >}} +{{< production-note >}} To get started, save the output of `linkerd install` to a YAML file. This will be the base resource that Kustomize uses to patch and generate what is added to diff --git a/linkerd.io/content/2.10/tasks/exporting-metrics.md b/linkerd.io/content/2.10/tasks/exporting-metrics.md index ed3866c817..5566d1d80a 100644 --- a/linkerd.io/content/2.10/tasks/exporting-metrics.md +++ b/linkerd.io/content/2.10/tasks/exporting-metrics.md @@ -12,7 +12,7 @@ By design, Linkerd only keeps metrics data for a short, fixed window of time (currently, 6 hours). This means that if Linkerd's metrics data is valuable to you, you will probably want to export it into a full-fledged metrics store. -{{< docs/production-note >}} +{{< production-note >}} Internally, Linkerd stores its metrics in a Prometheus instance that runs as part of the Viz extension. The following tutorial requires the viz extension to diff --git a/linkerd.io/content/2.10/tasks/exposing-dashboard.md b/linkerd.io/content/2.10/tasks/exposing-dashboard.md index 1044e0b33f..cbc4d039e0 100644 --- a/linkerd.io/content/2.10/tasks/exposing-dashboard.md +++ b/linkerd.io/content/2.10/tasks/exposing-dashboard.md @@ -9,7 +9,7 @@ Instead of using `linkerd viz dashboard` every time you'd like to see what's going on, you can expose the dashboard via an ingress. This will also expose Grafana. -{{< docs/toc >}} +{{< toc >}} ## Nginx diff --git a/linkerd.io/content/2.10/tasks/external-prometheus.md b/linkerd.io/content/2.10/tasks/external-prometheus.md index 9b6e1ab177..607d0fe762 100644 --- a/linkerd.io/content/2.10/tasks/external-prometheus.md +++ b/linkerd.io/content/2.10/tasks/external-prometheus.md @@ -12,7 +12,7 @@ both the control plane as well as the proxy's metrics in a format that is consumable both by a user as well as Linkerd control plane components like web, etc. -{{< docs/production-note >}} +{{< production-note >}} There are two important points to tackle here. diff --git a/linkerd.io/content/2.10/tasks/generate-certificates.md b/linkerd.io/content/2.10/tasks/generate-certificates.md index 646c3bf81e..f3ebf8dce5 100644 --- a/linkerd.io/content/2.10/tasks/generate-certificates.md +++ b/linkerd.io/content/2.10/tasks/generate-certificates.md @@ -23,7 +23,7 @@ algorithm which is the default for `step`. To generate ECDSA P-256 certificates with openssl, you can use the `openssl ecparam -name prime256v1` command. In this tutorial, we'll walk you through how to to use the `step` CLI to do this. -{{< docs/production-note >}} +{{< production-note >}} ## Generating the certificates with `step` diff --git a/linkerd.io/content/2.10/tasks/gitops.md b/linkerd.io/content/2.10/tasks/gitops.md index 83341ac61a..da02584e47 100644 --- a/linkerd.io/content/2.10/tasks/gitops.md +++ b/linkerd.io/content/2.10/tasks/gitops.md @@ -12,7 +12,7 @@ This guide will show you how to set up [Argo CD](https://argoproj.github.io/argo-cd/) to manage the installation and upgrade of Linkerd using a GitOps workflow. -{{< docs/production-note >}} +{{< production-note >}} Specifically, this guide provides instructions on how to securely generate and manage Linkerd's mTLS private keys and certificates using diff --git a/linkerd.io/content/2.10/tasks/install-helm.md b/linkerd.io/content/2.10/tasks/install-helm.md index bf9bed033c..3719e51efd 100644 --- a/linkerd.io/content/2.10/tasks/install-helm.md +++ b/linkerd.io/content/2.10/tasks/install-helm.md @@ -6,7 +6,7 @@ description: Install Linkerd onto your own Kubernetes cluster using Helm. Linkerd can optionally be installed via Helm rather than with the `linkerd install` command. -{{< docs/production-note >}} +{{< production-note >}} ## Prerequisite: identity certificates diff --git a/linkerd.io/content/2.10/tasks/install.md b/linkerd.io/content/2.10/tasks/install.md index f29fddc9ad..710505e473 100644 --- a/linkerd.io/content/2.10/tasks/install.md +++ b/linkerd.io/content/2.10/tasks/install.md @@ -7,7 +7,7 @@ Before you can use Linkerd, you'll need to install the [core control plane](../reference/architecture/#control-plane). This page covers how to accomplish that, as well as common problems that you may encounter. -{{< docs/production-note >}} +{{< production-note >}} Note that the control plane is typically installed by using Linkerd's CLI. See [Getting Started](../getting-started/) for how to install the CLI onto your diff --git a/linkerd.io/content/2.10/tasks/installing-multicluster.md b/linkerd.io/content/2.10/tasks/installing-multicluster.md index 6bdc588f58..175aaa3814 100644 --- a/linkerd.io/content/2.10/tasks/installing-multicluster.md +++ b/linkerd.io/content/2.10/tasks/installing-multicluster.md @@ -9,7 +9,7 @@ through this installation and configuration as well as common problems that you may encounter. For a detailed walkthrough and explanation of what's going on, check out [getting started](multicluster/). -{{< docs/production-note >}} +{{< production-note >}} ## Requirements diff --git a/linkerd.io/content/2.10/tasks/setting-up-service-profiles.md b/linkerd.io/content/2.10/tasks/setting-up-service-profiles.md index 704be61323..8108dcbe90 100644 --- a/linkerd.io/content/2.10/tasks/setting-up-service-profiles.md +++ b/linkerd.io/content/2.10/tasks/setting-up-service-profiles.md @@ -56,7 +56,7 @@ demo. There are a couple different ways to use `linkerd profile` to create service profiles. -{{< docs/toc >}} +{{< toc >}} Requests which have been associated with a route will have a `rt_route` annotation. To manually verify if the requests are being associated correctly, diff --git a/linkerd.io/content/2.10/tasks/using-the-debug-container.md b/linkerd.io/content/2.10/tasks/using-the-debug-container.md index 6e40eecd1a..ff7a10bce9 100644 --- a/linkerd.io/content/2.10/tasks/using-the-debug-container.md +++ b/linkerd.io/content/2.10/tasks/using-the-debug-container.md @@ -19,7 +19,7 @@ time. For convenience, the `linkerd inject` command provides an adding this annotation to a pre-existing pod will not work. It must be present at pod _creation_ time.) -{{< docs/production-note >}} +{{< production-note >}} The debug sidecar image contains [`tshark`](https://www.wireshark.org/docs/man-pages/tshark.html), `tcpdump`, diff --git a/linkerd.io/content/2.11/features/_index.md b/linkerd.io/content/2.11/features/_index.md index cf341d4e7e..3eebfe67f4 100644 --- a/linkerd.io/content/2.11/features/_index.md +++ b/linkerd.io/content/2.11/features/_index.md @@ -11,4 +11,4 @@ please see the [Linkerd task docs](../tasks/). For a reference, see the ## Linkerd's features -{{< docs/section-toc >}} +{{< section-toc >}} diff --git a/linkerd.io/content/2.11/reference/_index.md b/linkerd.io/content/2.11/reference/_index.md index f2045c2b56..c066e0b8ee 100644 --- a/linkerd.io/content/2.11/reference/_index.md +++ b/linkerd.io/content/2.11/reference/_index.md @@ -3,4 +3,4 @@ title: Reference weight: 5 --- -{{< docs/section-toc >}} +{{< section-toc >}} diff --git a/linkerd.io/content/2.11/reference/cli/_index.md b/linkerd.io/content/2.11/reference/cli/_index.md index ee36df6287..4d4170ffa7 100644 --- a/linkerd.io/content/2.11/reference/cli/_index.md +++ b/linkerd.io/content/2.11/reference/cli/_index.md @@ -9,10 +9,10 @@ detailed metrics for how your service is performing. As reference, check out the commands below: -{{< docs/cli-commands >}} +{{< cli-commands >}} ## Global flags The following flags are available for _all_ linkerd CLI commands: -{{< docs/cli-global-flags >}} +{{< cli-global-flags >}} diff --git a/linkerd.io/content/2.11/reference/cli/authz.md b/linkerd.io/content/2.11/reference/cli/authz.md index 2a6e55b55d..22df19a41c 100644 --- a/linkerd.io/content/2.11/reference/cli/authz.md +++ b/linkerd.io/content/2.11/reference/cli/authz.md @@ -2,10 +2,10 @@ title: authz --- -{{< docs/cli-description "authz" >}} +{{< cli-description "authz" >}} Check out the [Authorization Policy](../authorization-policy/) and [Restricting Access to Services](../../tasks/restricting-access/) documentation for all the details about authorization policy in Linkerd. -{{< docs/cli-flags "authz" >}} +{{< cli-flags "authz" >}} diff --git a/linkerd.io/content/2.11/reference/cli/check.md b/linkerd.io/content/2.11/reference/cli/check.md index 312891f8ef..a056a799fa 100644 --- a/linkerd.io/content/2.11/reference/cli/check.md +++ b/linkerd.io/content/2.11/reference/cli/check.md @@ -2,12 +2,12 @@ title: check --- -{{< docs/cli-description "check" >}} +{{< cli-description "check" >}} Take a look at the [troubleshooting](../../tasks/troubleshooting/) documentation for a full list of all the possible checks, what they do and how to fix them. -{{< docs/cli-examples "check" >}} +{{< cli-examples "check" >}} ## Example output @@ -53,7 +53,7 @@ control-plane-version Status check results are √ ``` -{{< docs/cli-flags "check" >}} +{{< cli-flags "check" >}} ## Subcommands @@ -62,8 +62,8 @@ Check supports subcommands as part of the ### config -{{< docs/cli-description "check config" >}} +{{< cli-description "check config" >}} -{{< docs/cli-examples "check config" >}} +{{< cli-examples "check config" >}} -{{< docs/cli-flags "check config" >}} +{{< cli-flags "check config" >}} diff --git a/linkerd.io/content/2.11/reference/cli/completion.md b/linkerd.io/content/2.11/reference/cli/completion.md index 40e8438b72..6007a47fa5 100644 --- a/linkerd.io/content/2.11/reference/cli/completion.md +++ b/linkerd.io/content/2.11/reference/cli/completion.md @@ -2,8 +2,8 @@ title: completion --- -{{< docs/cli-description "completion" >}} +{{< cli-description "completion" >}} -{{< docs/cli-examples "completion" >}} +{{< cli-examples "completion" >}} -{{< docs/cli-flags "completion" >}} +{{< cli-flags "completion" >}} diff --git a/linkerd.io/content/2.11/reference/cli/diagnostics.md b/linkerd.io/content/2.11/reference/cli/diagnostics.md index ffa45c39be..8e4e36d234 100644 --- a/linkerd.io/content/2.11/reference/cli/diagnostics.md +++ b/linkerd.io/content/2.11/reference/cli/diagnostics.md @@ -2,44 +2,44 @@ title: diagnostics --- -{{< docs/cli-description "diagnostics" >}} +{{< cli-description "diagnostics" >}} -{{< docs/cli-examples "diagnostics" >}} +{{< cli-examples "diagnostics" >}} -{{< docs/cli-flags "diagnostics" >}} +{{< cli-flags "diagnostics" >}} ## Subcommands -{{< docs/cli-subcommands "diagnostics" >}} +{{< cli-subcommands "diagnostics" >}} ### controller-metrics -{{< docs/cli-description "diagnostics controller-metrics" >}} +{{< cli-description "diagnostics controller-metrics" >}} -{{< docs/cli-examples "diagnostics controller-metrics" >}} +{{< cli-examples "diagnostics controller-metrics" >}} -{{< docs/cli-flags "diagnostics controller-metrics" >}} +{{< cli-flags "diagnostics controller-metrics" >}} ### endpoints -{{< docs/cli-description "diagnostics endpoints" >}} +{{< cli-description "diagnostics endpoints" >}} -{{< docs/cli-examples "diagnostics endpoints" >}} +{{< cli-examples "diagnostics endpoints" >}} -{{< docs/cli-flags "diagnostics endpoints" >}} +{{< cli-flags "diagnostics endpoints" >}} ### install-sp -{{< docs/cli-description "diagnostics install-sp" >}} +{{< cli-description "diagnostics install-sp" >}} -{{< docs/cli-examples "diagnostics install-sp" >}} +{{< cli-examples "diagnostics install-sp" >}} -{{< docs/cli-flags "diagnostics install-sp" >}} +{{< cli-flags "diagnostics install-sp" >}} ### proxy-metrics -{{< docs/cli-description "diagnostics proxy-metrics" >}} +{{< cli-description "diagnostics proxy-metrics" >}} -{{< docs/cli-examples "diagnostics proxy-metrics" >}} +{{< cli-examples "diagnostics proxy-metrics" >}} -{{< docs/cli-flags "diagnostics proxy-metrics" >}} +{{< cli-flags "diagnostics proxy-metrics" >}} diff --git a/linkerd.io/content/2.11/reference/cli/identity.md b/linkerd.io/content/2.11/reference/cli/identity.md index 576d175930..c7962e8027 100644 --- a/linkerd.io/content/2.11/reference/cli/identity.md +++ b/linkerd.io/content/2.11/reference/cli/identity.md @@ -2,8 +2,8 @@ title: identity --- -{{< docs/cli-description "identity" >}} +{{< cli-description "identity" >}} -{{< docs/cli-examples "identity" >}} +{{< cli-examples "identity" >}} -{{< docs/cli-flags "identity" >}} +{{< cli-flags "identity" >}} diff --git a/linkerd.io/content/2.11/reference/cli/inject.md b/linkerd.io/content/2.11/reference/cli/inject.md index aafdacdb29..92fc0ca3cb 100644 --- a/linkerd.io/content/2.11/reference/cli/inject.md +++ b/linkerd.io/content/2.11/reference/cli/inject.md @@ -19,6 +19,6 @@ Alternatively, this command can also perform the full injection purely on the client side, by enabling with the `--manual` flag. (Prior to Linkerd 2.4, this was the default behavior.) -{{< docs/cli-examples "inject" >}} +{{< cli-examples "inject" >}} -{{< docs/cli-flags "inject" >}} +{{< cli-flags "inject" >}} diff --git a/linkerd.io/content/2.11/reference/cli/install-cni.md b/linkerd.io/content/2.11/reference/cli/install-cni.md index c7c457a6f1..d0577e3d3b 100644 --- a/linkerd.io/content/2.11/reference/cli/install-cni.md +++ b/linkerd.io/content/2.11/reference/cli/install-cni.md @@ -2,8 +2,8 @@ title: install-cni --- -{{< docs/cli-description "install-cni" >}} +{{< cli-description "install-cni" >}} -{{< docs/cli-examples "install-cni" >}} +{{< cli-examples "install-cni" >}} -{{< docs/cli-flags "install-cni" >}} +{{< cli-flags "install-cni" >}} diff --git a/linkerd.io/content/2.11/reference/cli/install.md b/linkerd.io/content/2.11/reference/cli/install.md index 7c34adb8ab..d71e947348 100644 --- a/linkerd.io/content/2.11/reference/cli/install.md +++ b/linkerd.io/content/2.11/reference/cli/install.md @@ -2,14 +2,14 @@ title: install --- -{{< docs/cli-description "install" >}} +{{< cli-description "install" >}} For further details on how to install Linkerd onto your own cluster, check out the [install documentation](../../tasks/install/). -{{< docs/cli-examples "install" >}} +{{< cli-examples "install" >}} -{{< docs/cli-flags "install" >}} +{{< cli-flags "install" >}} ## Subcommands @@ -18,16 +18,16 @@ Install supports subcommands as part of the ### config -{{< docs/cli-description "install config" >}} +{{< cli-description "install config" >}} -{{< docs/cli-examples "install config" >}} +{{< cli-examples "install config" >}} -{{< docs/cli-flags "install config" >}} +{{< cli-flags "install config" >}} ### control-plane -{{< docs/cli-description "install control-plane" >}} +{{< cli-description "install control-plane" >}} -{{< docs/cli-examples "install control-plane" >}} +{{< cli-examples "install control-plane" >}} -{{< docs/cli-flags "install control-plane" >}} +{{< cli-flags "install control-plane" >}} diff --git a/linkerd.io/content/2.11/reference/cli/jaeger.md b/linkerd.io/content/2.11/reference/cli/jaeger.md index 1301361532..820ad6489c 100644 --- a/linkerd.io/content/2.11/reference/cli/jaeger.md +++ b/linkerd.io/content/2.11/reference/cli/jaeger.md @@ -2,52 +2,52 @@ title: jaeger --- -{{< docs/cli-description "jaeger" >}} +{{< cli-description "jaeger" >}} -{{< docs/cli-examples "jaeger" >}} +{{< cli-examples "jaeger" >}} -{{< docs/cli-flags "jaeger" >}} +{{< cli-flags "jaeger" >}} ## Subcommands -{{< docs/cli-subcommands "jaeger" >}} +{{< cli-subcommands "jaeger" >}} ### check -{{< docs/cli-description "jaeger check" >}} +{{< cli-description "jaeger check" >}} -{{< docs/cli-examples "jaeger check" >}} +{{< cli-examples "jaeger check" >}} -{{< docs/cli-flags "jaeger check" >}} +{{< cli-flags "jaeger check" >}} ### dashboard -{{< docs/cli-description "jaeger dashboard" >}} +{{< cli-description "jaeger dashboard" >}} -{{< docs/cli-examples "jaeger dashboard" >}} +{{< cli-examples "jaeger dashboard" >}} -{{< docs/cli-flags "jaeger dashboard" >}} +{{< cli-flags "jaeger dashboard" >}} ### install -{{< docs/cli-description "jaeger install" >}} +{{< cli-description "jaeger install" >}} -{{< docs/cli-examples "jaeger install" >}} +{{< cli-examples "jaeger install" >}} -{{< docs/cli-flags "jaeger install" >}} +{{< cli-flags "jaeger install" >}} ### list -{{< docs/cli-description "jaeger list" >}} +{{< cli-description "jaeger list" >}} -{{< docs/cli-examples "jaeger list" >}} +{{< cli-examples "jaeger list" >}} -{{< docs/cli-flags "jaeger list" >}} +{{< cli-flags "jaeger list" >}} ### uninstall -{{< docs/cli-description "jaeger uninstall" >}} +{{< cli-description "jaeger uninstall" >}} -{{< docs/cli-examples "jaeger uninstall" >}} +{{< cli-examples "jaeger uninstall" >}} -{{< docs/cli-flags "jaeger uninstall" >}} +{{< cli-flags "jaeger uninstall" >}} diff --git a/linkerd.io/content/2.11/reference/cli/multicluster.md b/linkerd.io/content/2.11/reference/cli/multicluster.md index 519ba5b57e..72c9ac0a4f 100644 --- a/linkerd.io/content/2.11/reference/cli/multicluster.md +++ b/linkerd.io/content/2.11/reference/cli/multicluster.md @@ -2,68 +2,68 @@ title: multicluster --- -{{< docs/cli-description "multicluster" >}} +{{< cli-description "multicluster" >}} -{{< docs/cli-examples "multicluster" >}} +{{< cli-examples "multicluster" >}} -{{< docs/cli-flags "multicluster" >}} +{{< cli-flags "multicluster" >}} ## Subcommands -{{< docs/cli-subcommands "multicluster" >}} +{{< cli-subcommands "multicluster" >}} ### allow -{{< docs/cli-description "multicluster allow" >}} +{{< cli-description "multicluster allow" >}} -{{< docs/cli-examples "multicluster allow" >}} +{{< cli-examples "multicluster allow" >}} -{{< docs/cli-flags "multicluster allow" >}} +{{< cli-flags "multicluster allow" >}} ### check -{{< docs/cli-description "multicluster check" >}} +{{< cli-description "multicluster check" >}} -{{< docs/cli-examples "multicluster check" >}} +{{< cli-examples "multicluster check" >}} -{{< docs/cli-flags "multicluster check" >}} +{{< cli-flags "multicluster check" >}} ### gateways -{{< docs/cli-description "multicluster gateways" >}} +{{< cli-description "multicluster gateways" >}} -{{< docs/cli-examples "multicluster gateways" >}} +{{< cli-examples "multicluster gateways" >}} -{{< docs/cli-flags "multicluster gateways" >}} +{{< cli-flags "multicluster gateways" >}} ### install -{{< docs/cli-description "multicluster install" >}} +{{< cli-description "multicluster install" >}} -{{< docs/cli-examples "multicluster install" >}} +{{< cli-examples "multicluster install" >}} -{{< docs/cli-flags "multicluster install" >}} +{{< cli-flags "multicluster install" >}} ### link -{{< docs/cli-description "multicluster link" >}} +{{< cli-description "multicluster link" >}} -{{< docs/cli-examples "multicluster link" >}} +{{< cli-examples "multicluster link" >}} -{{< docs/cli-flags "multicluster link" >}} +{{< cli-flags "multicluster link" >}} ### uninstall -{{< docs/cli-description "multicluster uninstall" >}} +{{< cli-description "multicluster uninstall" >}} -{{< docs/cli-examples "multicluster uninstall" >}} +{{< cli-examples "multicluster uninstall" >}} -{{< docs/cli-flags "multicluster uninstall" >}} +{{< cli-flags "multicluster uninstall" >}} ### unlink -{{< docs/cli-description "multicluster unlink" >}} +{{< cli-description "multicluster unlink" >}} -{{< docs/cli-examples "multicluster unlink" >}} +{{< cli-examples "multicluster unlink" >}} -{{< docs/cli-flags "multicluster unlink" >}} +{{< cli-flags "multicluster unlink" >}} diff --git a/linkerd.io/content/2.11/reference/cli/profile.md b/linkerd.io/content/2.11/reference/cli/profile.md index 5cc919b876..bf2545c313 100644 --- a/linkerd.io/content/2.11/reference/cli/profile.md +++ b/linkerd.io/content/2.11/reference/cli/profile.md @@ -2,12 +2,12 @@ title: profile --- -{{< docs/cli-description "profile" >}} +{{< cli-description "profile" >}} Check out the [service profile](../../features/service-profiles/) documentation for more details on what this command does and what you can do with service profiles. -{{< docs/cli-examples "profile" >}} +{{< cli-examples "profile" >}} -{{< docs/cli-flags "profile" >}} +{{< cli-flags "profile" >}} diff --git a/linkerd.io/content/2.11/reference/cli/repair.md b/linkerd.io/content/2.11/reference/cli/repair.md index 94b95f1809..6d4032bd66 100644 --- a/linkerd.io/content/2.11/reference/cli/repair.md +++ b/linkerd.io/content/2.11/reference/cli/repair.md @@ -2,8 +2,8 @@ title: repair --- -{{< docs/cli-description "repair" >}} +{{< cli-description "repair" >}} -{{< docs/cli-examples "repair" >}} +{{< cli-examples "repair" >}} -{{< docs/cli-flags "repair" >}} +{{< cli-flags "repair" >}} diff --git a/linkerd.io/content/2.11/reference/cli/uninject.md b/linkerd.io/content/2.11/reference/cli/uninject.md index 9ad619698a..6f43c3cf0a 100644 --- a/linkerd.io/content/2.11/reference/cli/uninject.md +++ b/linkerd.io/content/2.11/reference/cli/uninject.md @@ -2,8 +2,8 @@ title: uninject --- -{{< docs/cli-description "uninject" >}} +{{< cli-description "uninject" >}} -{{< docs/cli-examples "uninject" >}} +{{< cli-examples "uninject" >}} -{{< docs/cli-flags "uninject" >}} +{{< cli-flags "uninject" >}} diff --git a/linkerd.io/content/2.11/reference/cli/uninstall.md b/linkerd.io/content/2.11/reference/cli/uninstall.md index d5e00031ed..d62dd11612 100644 --- a/linkerd.io/content/2.11/reference/cli/uninstall.md +++ b/linkerd.io/content/2.11/reference/cli/uninstall.md @@ -2,8 +2,8 @@ title: uninstall --- -{{< docs/cli-description "uninstall" >}} +{{< cli-description "uninstall" >}} -{{< docs/cli-examples "uninstall" >}} +{{< cli-examples "uninstall" >}} -{{< docs/cli-flags "uninstall" >}} +{{< cli-flags "uninstall" >}} diff --git a/linkerd.io/content/2.11/reference/cli/upgrade.md b/linkerd.io/content/2.11/reference/cli/upgrade.md index 521cc84d67..a0cd538fa0 100644 --- a/linkerd.io/content/2.11/reference/cli/upgrade.md +++ b/linkerd.io/content/2.11/reference/cli/upgrade.md @@ -2,11 +2,11 @@ title: upgrade --- -{{< docs/cli-description "upgrade" >}} +{{< cli-description "upgrade" >}} -{{< docs/cli-examples "upgrade" >}} +{{< cli-examples "upgrade" >}} -{{< docs/cli-flags "upgrade" >}} +{{< cli-flags "upgrade" >}} ## Subcommands @@ -15,16 +15,16 @@ Upgrade supports subcommands as part of the ### config -{{< docs/cli-description "upgrade config" >}} +{{< cli-description "upgrade config" >}} -{{< docs/cli-examples "upgrade config" >}} +{{< cli-examples "upgrade config" >}} -{{< docs/cli-flags "upgrade config" >}} +{{< cli-flags "upgrade config" >}} ### control-plane -{{< docs/cli-description "upgrade control-plane" >}} +{{< cli-description "upgrade control-plane" >}} -{{< docs/cli-examples "upgrade control-plane" >}} +{{< cli-examples "upgrade control-plane" >}} -{{< docs/cli-flags "upgrade control-plane" >}} +{{< cli-flags "upgrade control-plane" >}} diff --git a/linkerd.io/content/2.11/reference/cli/version.md b/linkerd.io/content/2.11/reference/cli/version.md index 159f0b2f65..d31d7b18e6 100644 --- a/linkerd.io/content/2.11/reference/cli/version.md +++ b/linkerd.io/content/2.11/reference/cli/version.md @@ -2,8 +2,8 @@ title: version --- -{{< docs/cli-description "version" >}} +{{< cli-description "version" >}} -{{< docs/cli-examples "version" >}} +{{< cli-examples "version" >}} -{{< docs/cli-flags "version" >}} +{{< cli-flags "version" >}} diff --git a/linkerd.io/content/2.11/reference/cli/viz.md b/linkerd.io/content/2.11/reference/cli/viz.md index 4dfe37e219..1d014119f7 100644 --- a/linkerd.io/content/2.11/reference/cli/viz.md +++ b/linkerd.io/content/2.11/reference/cli/viz.md @@ -2,34 +2,34 @@ title: viz --- -{{< docs/cli-description "viz" >}} +{{< cli-description "viz" >}} -{{< docs/cli-examples "viz" >}} +{{< cli-examples "viz" >}} -{{< docs/cli-flags "viz" >}} +{{< cli-flags "viz" >}} ## Subcommands -{{< docs/cli-subcommands "viz" >}} +{{< cli-subcommands "viz" >}} ### check -{{< docs/cli-description "viz check" >}} +{{< cli-description "viz check" >}} -{{< docs/cli-examples "viz check" >}} +{{< cli-examples "viz check" >}} -{{< docs/cli-flags "viz check" >}} +{{< cli-flags "viz check" >}} ### dashboard -{{< docs/cli-description "viz dashboard" >}} +{{< cli-description "viz dashboard" >}} Check out the [architecture](../architecture/#dashboard) docs for a more thorough explanation of what this command does. -{{< docs/cli-examples "viz dashboard" >}} +{{< cli-examples "viz dashboard" >}} -{{< docs/cli-flags "viz dashboard" >}} +{{< cli-flags "viz dashboard" >}} (\*) You'll need to tweak the dashboard's `enforced-host` parameter with this value, as explained in @@ -37,35 +37,35 @@ value, as explained in ### edges -{{< docs/cli-description "viz edges" >}} +{{< cli-description "viz edges" >}} -{{< docs/cli-examples "viz edges" >}} +{{< cli-examples "viz edges" >}} -{{< docs/cli-flags "viz edges" >}} +{{< cli-flags "viz edges" >}} ### install -{{< docs/cli-description "viz install" >}} +{{< cli-description "viz install" >}} -{{< docs/cli-examples "viz install" >}} +{{< cli-examples "viz install" >}} -{{< docs/cli-flags "viz install" >}} +{{< cli-flags "viz install" >}} ### list -{{< docs/cli-description "viz list" >}} +{{< cli-description "viz list" >}} -{{< docs/cli-examples "viz list" >}} +{{< cli-examples "viz list" >}} -{{< docs/cli-flags "viz list" >}} +{{< cli-flags "viz list" >}} ### profile -{{< docs/cli-description "viz profile" >}} +{{< cli-description "viz profile" >}} -{{< docs/cli-examples "viz profile" >}} +{{< cli-examples "viz profile" >}} -{{< docs/cli-flags "viz profile" >}} +{{< cli-flags "viz profile" >}} ### routes @@ -124,38 +124,38 @@ information. Because retries are only performed on the _outbound_ (client) side, the `-o wide` flag can only be used when the `--to` flag is specified. -{{< docs/cli-examples "viz routes" >}} +{{< cli-examples "viz routes" >}} -{{< docs/cli-flags "viz routes" >}} +{{< cli-flags "viz routes" >}} ### stat -{{< docs/cli-description "viz stat" >}} +{{< cli-description "viz stat" >}} -{{< docs/cli-examples "viz stat" >}} +{{< cli-examples "viz stat" >}} -{{< docs/cli-flags "viz stat" >}} +{{< cli-flags "viz stat" >}} ### tap -{{< docs/cli-description "viz tap" >}} +{{< cli-description "viz tap" >}} -{{< docs/cli-examples "viz tap" >}} +{{< cli-examples "viz tap" >}} -{{< docs/cli-flags "viz tap" >}} +{{< cli-flags "viz tap" >}} ### top -{{< docs/cli-description "viz top" >}} +{{< cli-description "viz top" >}} -{{< docs/cli-examples "viz top" >}} +{{< cli-examples "viz top" >}} -{{< docs/cli-flags "viz top" >}} +{{< cli-flags "viz top" >}} ### uninstall -{{< docs/cli-description "viz uninstall" >}} +{{< cli-description "viz uninstall" >}} -{{< docs/cli-examples "viz uninstall" >}} +{{< cli-examples "viz uninstall" >}} -{{< docs/cli-flags "viz uninstall" >}} +{{< cli-flags "viz uninstall" >}} diff --git a/linkerd.io/content/2.11/reference/extension-list.md b/linkerd.io/content/2.11/reference/extension-list.md index e6bdad697e..32afc3fd09 100644 --- a/linkerd.io/content/2.11/reference/extension-list.md +++ b/linkerd.io/content/2.11/reference/extension-list.md @@ -9,7 +9,7 @@ Linkerd provides a mix of built-in and third-party [extensions](../tasks/extensions/) to add additional functionality to the base installation. The following is the list of known extensions: -{{< docs/extensions >}} +{{< extensions >}} If you have an extension for Linkerd and it is not on the list, [please edit this page!](https://github.com/linkerd/website/edit/main/linkerd.io/data/extension-list.yaml) diff --git a/linkerd.io/content/2.11/reference/proxy-configuration.md b/linkerd.io/content/2.11/reference/proxy-configuration.md index e5960a8924..f662296cb0 100644 --- a/linkerd.io/content/2.11/reference/proxy-configuration.md +++ b/linkerd.io/content/2.11/reference/proxy-configuration.md @@ -11,7 +11,7 @@ configurations of [auto-injected proxies](../features/proxy-injection/). The following is the list of supported annotations: -{{< docs/cli-annotations "inject" >}} +{{< cli-annotations "inject" >}} For example, to update an auto-injected proxy's CPU and memory resources, we insert the appropriate annotations into the `spec.template.metadata.annotations` diff --git a/linkerd.io/content/2.11/tasks/_index.md b/linkerd.io/content/2.11/tasks/_index.md index cfca319184..19a83aee53 100644 --- a/linkerd.io/content/2.11/tasks/_index.md +++ b/linkerd.io/content/2.11/tasks/_index.md @@ -9,4 +9,4 @@ common tasks that you may need to perform when using Linkerd. ## Common Linkerd tasks -{{< docs/section-toc >}} +{{< section-toc >}} diff --git a/linkerd.io/content/2.11/tasks/automatic-failover.md b/linkerd.io/content/2.11/tasks/automatic-failover.md index 7b0f54e9e9..6156fea717 100644 --- a/linkerd.io/content/2.11/tasks/automatic-failover.md +++ b/linkerd.io/content/2.11/tasks/automatic-failover.md @@ -15,7 +15,7 @@ Emojivoto application on two Kubernetes clusters and simulating a failure in one cluster. We will see the failover controller shift traffic to the other cluster to ensure the service remains available. -{{< docs/production-note >}} +{{< production-note >}} ## Prerequisites diff --git a/linkerd.io/content/2.11/tasks/automatically-rotating-control-plane-tls-credentials.md b/linkerd.io/content/2.11/tasks/automatically-rotating-control-plane-tls-credentials.md index 3304af943d..6b30373634 100644 --- a/linkerd.io/content/2.11/tasks/automatically-rotating-control-plane-tls-credentials.md +++ b/linkerd.io/content/2.11/tasks/automatically-rotating-control-plane-tls-credentials.md @@ -16,7 +16,7 @@ external solution. [must still be manually rotated](manually-rotating-control-plane-tls-credentials/) on long-lived clusters.) -{{< docs/production-note >}} +{{< production-note >}} ## Cert manager diff --git a/linkerd.io/content/2.11/tasks/automatically-rotating-webhook-tls-credentials.md b/linkerd.io/content/2.11/tasks/automatically-rotating-webhook-tls-credentials.md index 67b2f050c8..016928394d 100644 --- a/linkerd.io/content/2.11/tasks/automatically-rotating-webhook-tls-credentials.md +++ b/linkerd.io/content/2.11/tasks/automatically-rotating-webhook-tls-credentials.md @@ -22,7 +22,7 @@ This workflow is suitable for most users. However, if you need these webhook certificates to be rotated automatically on a regular basis, it is possible to use cert-manager to automatically manage them. -{{< docs/production-note >}} +{{< production-note >}} ## Install Cert manager diff --git a/linkerd.io/content/2.11/tasks/canary-release.md b/linkerd.io/content/2.11/tasks/canary-release.md index 6a8905d8e2..5b4991758c 100644 --- a/linkerd.io/content/2.11/tasks/canary-release.md +++ b/linkerd.io/content/2.11/tasks/canary-release.md @@ -23,7 +23,7 @@ In this tutorial, we'll walk you through how to combine Linkerd with metrics and traffic splitting together in a control loop, allowing for fully-automated, metrics-aware canary deployments. -{{< docs/production-note >}} +{{< production-note >}} ## Prerequisites diff --git a/linkerd.io/content/2.11/tasks/customize-install.md b/linkerd.io/content/2.11/tasks/customize-install.md index d1d1038467..43747bb4ff 100644 --- a/linkerd.io/content/2.11/tasks/customize-install.md +++ b/linkerd.io/content/2.11/tasks/customize-install.md @@ -9,7 +9,7 @@ Instead of forking the Linkerd install and upgrade process, `linkerd install` in a consistent way. This allows customization of the install to add functionality specific to installations. -{{< docs/production-note >}} +{{< production-note >}} To get started, save the output of `linkerd install` to a YAML file. This will be the base resource that Kustomize uses to patch and generate what is added to diff --git a/linkerd.io/content/2.11/tasks/exporting-metrics.md b/linkerd.io/content/2.11/tasks/exporting-metrics.md index ed3866c817..5566d1d80a 100644 --- a/linkerd.io/content/2.11/tasks/exporting-metrics.md +++ b/linkerd.io/content/2.11/tasks/exporting-metrics.md @@ -12,7 +12,7 @@ By design, Linkerd only keeps metrics data for a short, fixed window of time (currently, 6 hours). This means that if Linkerd's metrics data is valuable to you, you will probably want to export it into a full-fledged metrics store. -{{< docs/production-note >}} +{{< production-note >}} Internally, Linkerd stores its metrics in a Prometheus instance that runs as part of the Viz extension. The following tutorial requires the viz extension to diff --git a/linkerd.io/content/2.11/tasks/exposing-dashboard.md b/linkerd.io/content/2.11/tasks/exposing-dashboard.md index ae52fe8c7c..93c4af1343 100644 --- a/linkerd.io/content/2.11/tasks/exposing-dashboard.md +++ b/linkerd.io/content/2.11/tasks/exposing-dashboard.md @@ -9,7 +9,7 @@ Instead of using `linkerd viz dashboard` every time you'd like to see what's going on, you can expose the dashboard via an ingress. This will also expose Grafana. -{{< docs/toc >}} +{{< toc >}} ## Nginx @@ -41,7 +41,7 @@ metadata: proxy_hide_header l5d-server-id; nginx.ingress.kubernetes.io/auth-type: basic nginx.ingress.kubernetes.io/auth-secret: web-ingress-auth - nginx.ingress.kubernetes.io/auth-realm: "Authentication Required" + nginx.ingress.kubernetes.io/auth-realm: 'Authentication Required' spec: ingressClassName: nginx rules: diff --git a/linkerd.io/content/2.11/tasks/external-prometheus.md b/linkerd.io/content/2.11/tasks/external-prometheus.md index 9b6e1ab177..607d0fe762 100644 --- a/linkerd.io/content/2.11/tasks/external-prometheus.md +++ b/linkerd.io/content/2.11/tasks/external-prometheus.md @@ -12,7 +12,7 @@ both the control plane as well as the proxy's metrics in a format that is consumable both by a user as well as Linkerd control plane components like web, etc. -{{< docs/production-note >}} +{{< production-note >}} There are two important points to tackle here. diff --git a/linkerd.io/content/2.11/tasks/generate-certificates.md b/linkerd.io/content/2.11/tasks/generate-certificates.md index 646c3bf81e..f3ebf8dce5 100644 --- a/linkerd.io/content/2.11/tasks/generate-certificates.md +++ b/linkerd.io/content/2.11/tasks/generate-certificates.md @@ -23,7 +23,7 @@ algorithm which is the default for `step`. To generate ECDSA P-256 certificates with openssl, you can use the `openssl ecparam -name prime256v1` command. In this tutorial, we'll walk you through how to to use the `step` CLI to do this. -{{< docs/production-note >}} +{{< production-note >}} ## Generating the certificates with `step` diff --git a/linkerd.io/content/2.11/tasks/gitops.md b/linkerd.io/content/2.11/tasks/gitops.md index 22d655999a..ec35cac4d9 100644 --- a/linkerd.io/content/2.11/tasks/gitops.md +++ b/linkerd.io/content/2.11/tasks/gitops.md @@ -12,7 +12,7 @@ This guide will show you how to set up [Argo CD](https://argoproj.github.io/argo-cd/) to manage the installation and upgrade of Linkerd using a GitOps workflow. -{{< docs/production-note >}} +{{< production-note >}} Specifically, this guide provides instructions on how to securely generate and manage Linkerd's mTLS private keys and certificates using diff --git a/linkerd.io/content/2.11/tasks/grafana.md b/linkerd.io/content/2.11/tasks/grafana.md index 0cd4479c97..908f199780 100644 --- a/linkerd.io/content/2.11/tasks/grafana.md +++ b/linkerd.io/content/2.11/tasks/grafana.md @@ -23,7 +23,7 @@ First, you need to install Grafana from a variety of possible sources, and then load the suite of Grafana dashboards that have been pre-configured to consume the metrics exposed by Linkerd. -{{< docs/production-note >}} +{{< production-note >}} ## Install Prometheus diff --git a/linkerd.io/content/2.11/tasks/install-helm.md b/linkerd.io/content/2.11/tasks/install-helm.md index 0143a5c926..15c4c1b502 100644 --- a/linkerd.io/content/2.11/tasks/install-helm.md +++ b/linkerd.io/content/2.11/tasks/install-helm.md @@ -6,7 +6,7 @@ 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. -{{< docs/production-note >}} +{{< production-note >}} ## Prerequisite: generate identity certificates diff --git a/linkerd.io/content/2.11/tasks/install.md b/linkerd.io/content/2.11/tasks/install.md index a6eb1dec0b..3e16de2696 100644 --- a/linkerd.io/content/2.11/tasks/install.md +++ b/linkerd.io/content/2.11/tasks/install.md @@ -11,7 +11,7 @@ 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. -{{< docs/production-note >}} +{{< production-note >}} In either case, we recommend installing the CLI itself so that you can validate the success of the installation. See the diff --git a/linkerd.io/content/2.11/tasks/installing-multicluster.md b/linkerd.io/content/2.11/tasks/installing-multicluster.md index 924e3167ef..c6e0ed843c 100644 --- a/linkerd.io/content/2.11/tasks/installing-multicluster.md +++ b/linkerd.io/content/2.11/tasks/installing-multicluster.md @@ -9,7 +9,7 @@ through this installation and configuration as well as common problems that you may encounter. For a detailed walkthrough and explanation of what's going on, check out [getting started](multicluster/). -{{< docs/production-note >}} +{{< production-note >}} ## Requirements diff --git a/linkerd.io/content/2.11/tasks/setting-up-service-profiles.md b/linkerd.io/content/2.11/tasks/setting-up-service-profiles.md index 704be61323..8108dcbe90 100644 --- a/linkerd.io/content/2.11/tasks/setting-up-service-profiles.md +++ b/linkerd.io/content/2.11/tasks/setting-up-service-profiles.md @@ -56,7 +56,7 @@ demo. There are a couple different ways to use `linkerd profile` to create service profiles. -{{< docs/toc >}} +{{< toc >}} Requests which have been associated with a route will have a `rt_route` annotation. To manually verify if the requests are being associated correctly, diff --git a/linkerd.io/content/2.11/tasks/using-the-debug-container.md b/linkerd.io/content/2.11/tasks/using-the-debug-container.md index 6e40eecd1a..ff7a10bce9 100644 --- a/linkerd.io/content/2.11/tasks/using-the-debug-container.md +++ b/linkerd.io/content/2.11/tasks/using-the-debug-container.md @@ -19,7 +19,7 @@ time. For convenience, the `linkerd inject` command provides an adding this annotation to a pre-existing pod will not work. It must be present at pod _creation_ time.) -{{< docs/production-note >}} +{{< production-note >}} The debug sidecar image contains [`tshark`](https://www.wireshark.org/docs/man-pages/tshark.html), `tcpdump`, diff --git a/linkerd.io/content/2.12/features/_index.md b/linkerd.io/content/2.12/features/_index.md index cf341d4e7e..3eebfe67f4 100644 --- a/linkerd.io/content/2.12/features/_index.md +++ b/linkerd.io/content/2.12/features/_index.md @@ -11,4 +11,4 @@ please see the [Linkerd task docs](../tasks/). For a reference, see the ## Linkerd's features -{{< docs/section-toc >}} +{{< section-toc >}} diff --git a/linkerd.io/content/2.12/reference/_index.md b/linkerd.io/content/2.12/reference/_index.md index f2045c2b56..c066e0b8ee 100644 --- a/linkerd.io/content/2.12/reference/_index.md +++ b/linkerd.io/content/2.12/reference/_index.md @@ -3,4 +3,4 @@ title: Reference weight: 5 --- -{{< docs/section-toc >}} +{{< section-toc >}} diff --git a/linkerd.io/content/2.12/reference/cli/_index.md b/linkerd.io/content/2.12/reference/cli/_index.md index ee36df6287..4d4170ffa7 100644 --- a/linkerd.io/content/2.12/reference/cli/_index.md +++ b/linkerd.io/content/2.12/reference/cli/_index.md @@ -9,10 +9,10 @@ detailed metrics for how your service is performing. As reference, check out the commands below: -{{< docs/cli-commands >}} +{{< cli-commands >}} ## Global flags The following flags are available for _all_ linkerd CLI commands: -{{< docs/cli-global-flags >}} +{{< cli-global-flags >}} diff --git a/linkerd.io/content/2.12/reference/cli/authz.md b/linkerd.io/content/2.12/reference/cli/authz.md index 2a6e55b55d..22df19a41c 100644 --- a/linkerd.io/content/2.12/reference/cli/authz.md +++ b/linkerd.io/content/2.12/reference/cli/authz.md @@ -2,10 +2,10 @@ title: authz --- -{{< docs/cli-description "authz" >}} +{{< cli-description "authz" >}} Check out the [Authorization Policy](../authorization-policy/) and [Restricting Access to Services](../../tasks/restricting-access/) documentation for all the details about authorization policy in Linkerd. -{{< docs/cli-flags "authz" >}} +{{< cli-flags "authz" >}} diff --git a/linkerd.io/content/2.12/reference/cli/check.md b/linkerd.io/content/2.12/reference/cli/check.md index 7cd61cd237..0c18a5da03 100644 --- a/linkerd.io/content/2.12/reference/cli/check.md +++ b/linkerd.io/content/2.12/reference/cli/check.md @@ -2,12 +2,12 @@ title: check --- -{{< docs/cli-description "check" >}} +{{< cli-description "check" >}} Take a look at the [troubleshooting](../../tasks/troubleshooting/) documentation for a full list of all the possible checks, what they do and how to fix them. -{{< docs/cli-examples "check" >}} +{{< cli-examples "check" >}} ## Example output @@ -53,4 +53,4 @@ control-plane-version Status check results are √ ``` -{{< docs/cli-flags "check" >}} +{{< cli-flags "check" >}} diff --git a/linkerd.io/content/2.12/reference/cli/completion.md b/linkerd.io/content/2.12/reference/cli/completion.md index 40e8438b72..6007a47fa5 100644 --- a/linkerd.io/content/2.12/reference/cli/completion.md +++ b/linkerd.io/content/2.12/reference/cli/completion.md @@ -2,8 +2,8 @@ title: completion --- -{{< docs/cli-description "completion" >}} +{{< cli-description "completion" >}} -{{< docs/cli-examples "completion" >}} +{{< cli-examples "completion" >}} -{{< docs/cli-flags "completion" >}} +{{< cli-flags "completion" >}} diff --git a/linkerd.io/content/2.12/reference/cli/diagnostics.md b/linkerd.io/content/2.12/reference/cli/diagnostics.md index ffa45c39be..8e4e36d234 100644 --- a/linkerd.io/content/2.12/reference/cli/diagnostics.md +++ b/linkerd.io/content/2.12/reference/cli/diagnostics.md @@ -2,44 +2,44 @@ title: diagnostics --- -{{< docs/cli-description "diagnostics" >}} +{{< cli-description "diagnostics" >}} -{{< docs/cli-examples "diagnostics" >}} +{{< cli-examples "diagnostics" >}} -{{< docs/cli-flags "diagnostics" >}} +{{< cli-flags "diagnostics" >}} ## Subcommands -{{< docs/cli-subcommands "diagnostics" >}} +{{< cli-subcommands "diagnostics" >}} ### controller-metrics -{{< docs/cli-description "diagnostics controller-metrics" >}} +{{< cli-description "diagnostics controller-metrics" >}} -{{< docs/cli-examples "diagnostics controller-metrics" >}} +{{< cli-examples "diagnostics controller-metrics" >}} -{{< docs/cli-flags "diagnostics controller-metrics" >}} +{{< cli-flags "diagnostics controller-metrics" >}} ### endpoints -{{< docs/cli-description "diagnostics endpoints" >}} +{{< cli-description "diagnostics endpoints" >}} -{{< docs/cli-examples "diagnostics endpoints" >}} +{{< cli-examples "diagnostics endpoints" >}} -{{< docs/cli-flags "diagnostics endpoints" >}} +{{< cli-flags "diagnostics endpoints" >}} ### install-sp -{{< docs/cli-description "diagnostics install-sp" >}} +{{< cli-description "diagnostics install-sp" >}} -{{< docs/cli-examples "diagnostics install-sp" >}} +{{< cli-examples "diagnostics install-sp" >}} -{{< docs/cli-flags "diagnostics install-sp" >}} +{{< cli-flags "diagnostics install-sp" >}} ### proxy-metrics -{{< docs/cli-description "diagnostics proxy-metrics" >}} +{{< cli-description "diagnostics proxy-metrics" >}} -{{< docs/cli-examples "diagnostics proxy-metrics" >}} +{{< cli-examples "diagnostics proxy-metrics" >}} -{{< docs/cli-flags "diagnostics proxy-metrics" >}} +{{< cli-flags "diagnostics proxy-metrics" >}} diff --git a/linkerd.io/content/2.12/reference/cli/identity.md b/linkerd.io/content/2.12/reference/cli/identity.md index 576d175930..c7962e8027 100644 --- a/linkerd.io/content/2.12/reference/cli/identity.md +++ b/linkerd.io/content/2.12/reference/cli/identity.md @@ -2,8 +2,8 @@ title: identity --- -{{< docs/cli-description "identity" >}} +{{< cli-description "identity" >}} -{{< docs/cli-examples "identity" >}} +{{< cli-examples "identity" >}} -{{< docs/cli-flags "identity" >}} +{{< cli-flags "identity" >}} diff --git a/linkerd.io/content/2.12/reference/cli/inject.md b/linkerd.io/content/2.12/reference/cli/inject.md index aafdacdb29..92fc0ca3cb 100644 --- a/linkerd.io/content/2.12/reference/cli/inject.md +++ b/linkerd.io/content/2.12/reference/cli/inject.md @@ -19,6 +19,6 @@ Alternatively, this command can also perform the full injection purely on the client side, by enabling with the `--manual` flag. (Prior to Linkerd 2.4, this was the default behavior.) -{{< docs/cli-examples "inject" >}} +{{< cli-examples "inject" >}} -{{< docs/cli-flags "inject" >}} +{{< cli-flags "inject" >}} diff --git a/linkerd.io/content/2.12/reference/cli/install-cni.md b/linkerd.io/content/2.12/reference/cli/install-cni.md index c7c457a6f1..d0577e3d3b 100644 --- a/linkerd.io/content/2.12/reference/cli/install-cni.md +++ b/linkerd.io/content/2.12/reference/cli/install-cni.md @@ -2,8 +2,8 @@ title: install-cni --- -{{< docs/cli-description "install-cni" >}} +{{< cli-description "install-cni" >}} -{{< docs/cli-examples "install-cni" >}} +{{< cli-examples "install-cni" >}} -{{< docs/cli-flags "install-cni" >}} +{{< cli-flags "install-cni" >}} diff --git a/linkerd.io/content/2.12/reference/cli/install.md b/linkerd.io/content/2.12/reference/cli/install.md index ab0dde824e..5fea59d7eb 100644 --- a/linkerd.io/content/2.12/reference/cli/install.md +++ b/linkerd.io/content/2.12/reference/cli/install.md @@ -2,11 +2,11 @@ title: install --- -{{< docs/cli-description "install" >}} +{{< cli-description "install" >}} For further details on how to install Linkerd onto your own cluster, check out the [install documentation](../../tasks/install/). -{{< docs/cli-examples "install" >}} +{{< cli-examples "install" >}} -{{< docs/cli-flags "install" >}} +{{< cli-flags "install" >}} diff --git a/linkerd.io/content/2.12/reference/cli/jaeger.md b/linkerd.io/content/2.12/reference/cli/jaeger.md index 1301361532..820ad6489c 100644 --- a/linkerd.io/content/2.12/reference/cli/jaeger.md +++ b/linkerd.io/content/2.12/reference/cli/jaeger.md @@ -2,52 +2,52 @@ title: jaeger --- -{{< docs/cli-description "jaeger" >}} +{{< cli-description "jaeger" >}} -{{< docs/cli-examples "jaeger" >}} +{{< cli-examples "jaeger" >}} -{{< docs/cli-flags "jaeger" >}} +{{< cli-flags "jaeger" >}} ## Subcommands -{{< docs/cli-subcommands "jaeger" >}} +{{< cli-subcommands "jaeger" >}} ### check -{{< docs/cli-description "jaeger check" >}} +{{< cli-description "jaeger check" >}} -{{< docs/cli-examples "jaeger check" >}} +{{< cli-examples "jaeger check" >}} -{{< docs/cli-flags "jaeger check" >}} +{{< cli-flags "jaeger check" >}} ### dashboard -{{< docs/cli-description "jaeger dashboard" >}} +{{< cli-description "jaeger dashboard" >}} -{{< docs/cli-examples "jaeger dashboard" >}} +{{< cli-examples "jaeger dashboard" >}} -{{< docs/cli-flags "jaeger dashboard" >}} +{{< cli-flags "jaeger dashboard" >}} ### install -{{< docs/cli-description "jaeger install" >}} +{{< cli-description "jaeger install" >}} -{{< docs/cli-examples "jaeger install" >}} +{{< cli-examples "jaeger install" >}} -{{< docs/cli-flags "jaeger install" >}} +{{< cli-flags "jaeger install" >}} ### list -{{< docs/cli-description "jaeger list" >}} +{{< cli-description "jaeger list" >}} -{{< docs/cli-examples "jaeger list" >}} +{{< cli-examples "jaeger list" >}} -{{< docs/cli-flags "jaeger list" >}} +{{< cli-flags "jaeger list" >}} ### uninstall -{{< docs/cli-description "jaeger uninstall" >}} +{{< cli-description "jaeger uninstall" >}} -{{< docs/cli-examples "jaeger uninstall" >}} +{{< cli-examples "jaeger uninstall" >}} -{{< docs/cli-flags "jaeger uninstall" >}} +{{< cli-flags "jaeger uninstall" >}} diff --git a/linkerd.io/content/2.12/reference/cli/multicluster.md b/linkerd.io/content/2.12/reference/cli/multicluster.md index 519ba5b57e..72c9ac0a4f 100644 --- a/linkerd.io/content/2.12/reference/cli/multicluster.md +++ b/linkerd.io/content/2.12/reference/cli/multicluster.md @@ -2,68 +2,68 @@ title: multicluster --- -{{< docs/cli-description "multicluster" >}} +{{< cli-description "multicluster" >}} -{{< docs/cli-examples "multicluster" >}} +{{< cli-examples "multicluster" >}} -{{< docs/cli-flags "multicluster" >}} +{{< cli-flags "multicluster" >}} ## Subcommands -{{< docs/cli-subcommands "multicluster" >}} +{{< cli-subcommands "multicluster" >}} ### allow -{{< docs/cli-description "multicluster allow" >}} +{{< cli-description "multicluster allow" >}} -{{< docs/cli-examples "multicluster allow" >}} +{{< cli-examples "multicluster allow" >}} -{{< docs/cli-flags "multicluster allow" >}} +{{< cli-flags "multicluster allow" >}} ### check -{{< docs/cli-description "multicluster check" >}} +{{< cli-description "multicluster check" >}} -{{< docs/cli-examples "multicluster check" >}} +{{< cli-examples "multicluster check" >}} -{{< docs/cli-flags "multicluster check" >}} +{{< cli-flags "multicluster check" >}} ### gateways -{{< docs/cli-description "multicluster gateways" >}} +{{< cli-description "multicluster gateways" >}} -{{< docs/cli-examples "multicluster gateways" >}} +{{< cli-examples "multicluster gateways" >}} -{{< docs/cli-flags "multicluster gateways" >}} +{{< cli-flags "multicluster gateways" >}} ### install -{{< docs/cli-description "multicluster install" >}} +{{< cli-description "multicluster install" >}} -{{< docs/cli-examples "multicluster install" >}} +{{< cli-examples "multicluster install" >}} -{{< docs/cli-flags "multicluster install" >}} +{{< cli-flags "multicluster install" >}} ### link -{{< docs/cli-description "multicluster link" >}} +{{< cli-description "multicluster link" >}} -{{< docs/cli-examples "multicluster link" >}} +{{< cli-examples "multicluster link" >}} -{{< docs/cli-flags "multicluster link" >}} +{{< cli-flags "multicluster link" >}} ### uninstall -{{< docs/cli-description "multicluster uninstall" >}} +{{< cli-description "multicluster uninstall" >}} -{{< docs/cli-examples "multicluster uninstall" >}} +{{< cli-examples "multicluster uninstall" >}} -{{< docs/cli-flags "multicluster uninstall" >}} +{{< cli-flags "multicluster uninstall" >}} ### unlink -{{< docs/cli-description "multicluster unlink" >}} +{{< cli-description "multicluster unlink" >}} -{{< docs/cli-examples "multicluster unlink" >}} +{{< cli-examples "multicluster unlink" >}} -{{< docs/cli-flags "multicluster unlink" >}} +{{< cli-flags "multicluster unlink" >}} diff --git a/linkerd.io/content/2.12/reference/cli/profile.md b/linkerd.io/content/2.12/reference/cli/profile.md index 5cc919b876..bf2545c313 100644 --- a/linkerd.io/content/2.12/reference/cli/profile.md +++ b/linkerd.io/content/2.12/reference/cli/profile.md @@ -2,12 +2,12 @@ title: profile --- -{{< docs/cli-description "profile" >}} +{{< cli-description "profile" >}} Check out the [service profile](../../features/service-profiles/) documentation for more details on what this command does and what you can do with service profiles. -{{< docs/cli-examples "profile" >}} +{{< cli-examples "profile" >}} -{{< docs/cli-flags "profile" >}} +{{< cli-flags "profile" >}} diff --git a/linkerd.io/content/2.12/reference/cli/uninject.md b/linkerd.io/content/2.12/reference/cli/uninject.md index 9ad619698a..6f43c3cf0a 100644 --- a/linkerd.io/content/2.12/reference/cli/uninject.md +++ b/linkerd.io/content/2.12/reference/cli/uninject.md @@ -2,8 +2,8 @@ title: uninject --- -{{< docs/cli-description "uninject" >}} +{{< cli-description "uninject" >}} -{{< docs/cli-examples "uninject" >}} +{{< cli-examples "uninject" >}} -{{< docs/cli-flags "uninject" >}} +{{< cli-flags "uninject" >}} diff --git a/linkerd.io/content/2.12/reference/cli/uninstall.md b/linkerd.io/content/2.12/reference/cli/uninstall.md index d5e00031ed..d62dd11612 100644 --- a/linkerd.io/content/2.12/reference/cli/uninstall.md +++ b/linkerd.io/content/2.12/reference/cli/uninstall.md @@ -2,8 +2,8 @@ title: uninstall --- -{{< docs/cli-description "uninstall" >}} +{{< cli-description "uninstall" >}} -{{< docs/cli-examples "uninstall" >}} +{{< cli-examples "uninstall" >}} -{{< docs/cli-flags "uninstall" >}} +{{< cli-flags "uninstall" >}} diff --git a/linkerd.io/content/2.12/reference/cli/upgrade.md b/linkerd.io/content/2.12/reference/cli/upgrade.md index c4422b57c9..70b3296d8a 100644 --- a/linkerd.io/content/2.12/reference/cli/upgrade.md +++ b/linkerd.io/content/2.12/reference/cli/upgrade.md @@ -2,8 +2,8 @@ title: upgrade --- -{{< docs/cli-description "upgrade" >}} +{{< cli-description "upgrade" >}} -{{< docs/cli-examples "upgrade" >}} +{{< cli-examples "upgrade" >}} -{{< docs/cli-flags "upgrade" >}} +{{< cli-flags "upgrade" >}} diff --git a/linkerd.io/content/2.12/reference/cli/version.md b/linkerd.io/content/2.12/reference/cli/version.md index 159f0b2f65..d31d7b18e6 100644 --- a/linkerd.io/content/2.12/reference/cli/version.md +++ b/linkerd.io/content/2.12/reference/cli/version.md @@ -2,8 +2,8 @@ title: version --- -{{< docs/cli-description "version" >}} +{{< cli-description "version" >}} -{{< docs/cli-examples "version" >}} +{{< cli-examples "version" >}} -{{< docs/cli-flags "version" >}} +{{< cli-flags "version" >}} diff --git a/linkerd.io/content/2.12/reference/cli/viz.md b/linkerd.io/content/2.12/reference/cli/viz.md index 2477e875ba..9a11e245d9 100644 --- a/linkerd.io/content/2.12/reference/cli/viz.md +++ b/linkerd.io/content/2.12/reference/cli/viz.md @@ -2,50 +2,50 @@ title: viz --- -{{< docs/cli-description "viz" >}} +{{< cli-description "viz" >}} -{{< docs/cli-examples "viz" >}} +{{< cli-examples "viz" >}} -{{< docs/cli-flags "viz" >}} +{{< cli-flags "viz" >}} ## Subcommands -{{< docs/cli-subcommands "viz" >}} +{{< cli-subcommands "viz" >}} ### allow-scrapes -{{< docs/cli-description "viz allow-scrapes" >}} +{{< cli-description "viz allow-scrapes" >}} -{{< docs/cli-examples "viz allow-scrapes" >}} +{{< cli-examples "viz allow-scrapes" >}} -{{< docs/cli-flags "viz allow-scrapes" >}} +{{< cli-flags "viz allow-scrapes" >}} ### authz -{{< docs/cli-description "viz authz" >}} +{{< cli-description "viz authz" >}} -{{< docs/cli-examples "viz authz" >}} +{{< cli-examples "viz authz" >}} -{{< docs/cli-flags "viz authz" >}} +{{< cli-flags "viz authz" >}} ### check -{{< docs/cli-description "viz check" >}} +{{< cli-description "viz check" >}} -{{< docs/cli-examples "viz check" >}} +{{< cli-examples "viz check" >}} -{{< docs/cli-flags "viz check" >}} +{{< cli-flags "viz check" >}} ### dashboard -{{< docs/cli-description "viz dashboard" >}} +{{< cli-description "viz dashboard" >}} Check out the [architecture](../architecture/#dashboard) docs for a more thorough explanation of what this command does. -{{< docs/cli-examples "viz dashboard" >}} +{{< cli-examples "viz dashboard" >}} -{{< docs/cli-flags "viz dashboard" >}} +{{< cli-flags "viz dashboard" >}} (\*) You'll need to tweak the dashboard's `enforced-host` parameter with this value, as explained in @@ -53,35 +53,35 @@ value, as explained in ### edges -{{< docs/cli-description "viz edges" >}} +{{< cli-description "viz edges" >}} -{{< docs/cli-examples "viz edges" >}} +{{< cli-examples "viz edges" >}} -{{< docs/cli-flags "viz edges" >}} +{{< cli-flags "viz edges" >}} ### install -{{< docs/cli-description "viz install" >}} +{{< cli-description "viz install" >}} -{{< docs/cli-examples "viz install" >}} +{{< cli-examples "viz install" >}} -{{< docs/cli-flags "viz install" >}} +{{< cli-flags "viz install" >}} ### list -{{< docs/cli-description "viz list" >}} +{{< cli-description "viz list" >}} -{{< docs/cli-examples "viz list" >}} +{{< cli-examples "viz list" >}} -{{< docs/cli-flags "viz list" >}} +{{< cli-flags "viz list" >}} ### profile -{{< docs/cli-description "viz profile" >}} +{{< cli-description "viz profile" >}} -{{< docs/cli-examples "viz profile" >}} +{{< cli-examples "viz profile" >}} -{{< docs/cli-flags "viz profile" >}} +{{< cli-flags "viz profile" >}} ### routes @@ -140,38 +140,38 @@ information. Because retries are only performed on the _outbound_ (client) side, the `-o wide` flag can only be used when the `--to` flag is specified. -{{< docs/cli-examples "viz routes" >}} +{{< cli-examples "viz routes" >}} -{{< docs/cli-flags "viz routes" >}} +{{< cli-flags "viz routes" >}} ### stat -{{< docs/cli-description "viz stat" >}} +{{< cli-description "viz stat" >}} -{{< docs/cli-examples "viz stat" >}} +{{< cli-examples "viz stat" >}} -{{< docs/cli-flags "viz stat" >}} +{{< cli-flags "viz stat" >}} ### tap -{{< docs/cli-description "viz tap" >}} +{{< cli-description "viz tap" >}} -{{< docs/cli-examples "viz tap" >}} +{{< cli-examples "viz tap" >}} -{{< docs/cli-flags "viz tap" >}} +{{< cli-flags "viz tap" >}} ### top -{{< docs/cli-description "viz top" >}} +{{< cli-description "viz top" >}} -{{< docs/cli-examples "viz top" >}} +{{< cli-examples "viz top" >}} -{{< docs/cli-flags "viz top" >}} +{{< cli-flags "viz top" >}} ### uninstall -{{< docs/cli-description "viz uninstall" >}} +{{< cli-description "viz uninstall" >}} -{{< docs/cli-examples "viz uninstall" >}} +{{< cli-examples "viz uninstall" >}} -{{< docs/cli-flags "viz uninstall" >}} +{{< cli-flags "viz uninstall" >}} diff --git a/linkerd.io/content/2.12/reference/extension-list.md b/linkerd.io/content/2.12/reference/extension-list.md index e6bdad697e..32afc3fd09 100644 --- a/linkerd.io/content/2.12/reference/extension-list.md +++ b/linkerd.io/content/2.12/reference/extension-list.md @@ -9,7 +9,7 @@ Linkerd provides a mix of built-in and third-party [extensions](../tasks/extensions/) to add additional functionality to the base installation. The following is the list of known extensions: -{{< docs/extensions >}} +{{< extensions >}} If you have an extension for Linkerd and it is not on the list, [please edit this page!](https://github.com/linkerd/website/edit/main/linkerd.io/data/extension-list.yaml) diff --git a/linkerd.io/content/2.12/reference/proxy-configuration.md b/linkerd.io/content/2.12/reference/proxy-configuration.md index 80b471f88b..847b0a53d4 100644 --- a/linkerd.io/content/2.12/reference/proxy-configuration.md +++ b/linkerd.io/content/2.12/reference/proxy-configuration.md @@ -11,7 +11,7 @@ configurations of [auto-injected proxies](../features/proxy-injection/). The following is the list of supported annotations: -{{< docs/cli-annotations "inject" >}} +{{< cli-annotations "inject" >}} For example, to update an auto-injected proxy's CPU and memory resources, we insert the appropriate annotations into the `spec.template.metadata.annotations` diff --git a/linkerd.io/content/2.12/tasks/_index.md b/linkerd.io/content/2.12/tasks/_index.md index cfca319184..19a83aee53 100644 --- a/linkerd.io/content/2.12/tasks/_index.md +++ b/linkerd.io/content/2.12/tasks/_index.md @@ -9,4 +9,4 @@ common tasks that you may need to perform when using Linkerd. ## Common Linkerd tasks -{{< docs/section-toc >}} +{{< section-toc >}} diff --git a/linkerd.io/content/2.12/tasks/automatic-failover.md b/linkerd.io/content/2.12/tasks/automatic-failover.md index ba405d784c..10d0862184 100644 --- a/linkerd.io/content/2.12/tasks/automatic-failover.md +++ b/linkerd.io/content/2.12/tasks/automatic-failover.md @@ -15,7 +15,7 @@ Emojivoto application on two Kubernetes clusters and simulating a failure in one cluster. We will see the failover controller shift traffic to the other cluster to ensure the service remains available. -{{< docs/production-note >}} +{{< production-note >}} ## Prerequisites diff --git a/linkerd.io/content/2.12/tasks/automatically-rotating-control-plane-tls-credentials.md b/linkerd.io/content/2.12/tasks/automatically-rotating-control-plane-tls-credentials.md index 4c07ceaedd..1a3cbf8c37 100644 --- a/linkerd.io/content/2.12/tasks/automatically-rotating-control-plane-tls-credentials.md +++ b/linkerd.io/content/2.12/tasks/automatically-rotating-control-plane-tls-credentials.md @@ -15,7 +15,7 @@ rotate the issuer certificate. In this doc, we'll describe how to set up automatic rotation of the issuer certificate and its corresponding private key using the cert-manager project. -{{< docs/production-note >}} +{{< production-note >}} ## Cert manager diff --git a/linkerd.io/content/2.12/tasks/automatically-rotating-webhook-tls-credentials.md b/linkerd.io/content/2.12/tasks/automatically-rotating-webhook-tls-credentials.md index 563014c122..556448912c 100644 --- a/linkerd.io/content/2.12/tasks/automatically-rotating-webhook-tls-credentials.md +++ b/linkerd.io/content/2.12/tasks/automatically-rotating-webhook-tls-credentials.md @@ -22,7 +22,7 @@ This workflow is suitable for most users. However, if you need these webhook certificates to be rotated automatically on a regular basis, it is possible to use cert-manager to automatically manage them. -{{< docs/production-note >}} +{{< production-note >}} ## Install Cert manager diff --git a/linkerd.io/content/2.12/tasks/canary-release.md b/linkerd.io/content/2.12/tasks/canary-release.md index 6c1e83a1a2..d6bbf7c3f6 100644 --- a/linkerd.io/content/2.12/tasks/canary-release.md +++ b/linkerd.io/content/2.12/tasks/canary-release.md @@ -23,7 +23,7 @@ In this tutorial, we'll walk you through how to combine Linkerd with metrics and traffic splitting together in a control loop, allowing for fully-automated, metrics-aware canary deployments. -{{< docs/production-note >}} +{{< production-note >}} ## Prerequisites diff --git a/linkerd.io/content/2.12/tasks/customize-install.md b/linkerd.io/content/2.12/tasks/customize-install.md index dc71604c3c..512bb3629d 100644 --- a/linkerd.io/content/2.12/tasks/customize-install.md +++ b/linkerd.io/content/2.12/tasks/customize-install.md @@ -9,7 +9,7 @@ Instead of forking the Linkerd install and upgrade process, `linkerd install` in a consistent way. This allows customization of the install to add functionality specific to installations. -{{< docs/production-note >}} +{{< production-note >}} To get started, save the output of `linkerd install` to a YAML file. This will be the base resource that Kustomize uses to patch and generate what is added to diff --git a/linkerd.io/content/2.12/tasks/exporting-metrics.md b/linkerd.io/content/2.12/tasks/exporting-metrics.md index 877aedf5a2..efd60daab3 100644 --- a/linkerd.io/content/2.12/tasks/exporting-metrics.md +++ b/linkerd.io/content/2.12/tasks/exporting-metrics.md @@ -13,7 +13,7 @@ each proxy only provides a portion of the full picture. Instead, a separate tool is used to collect metrics from all proxies and aggregate them together for consumption. -{{< docs/production-note >}} +{{< production-note >}} One easy option is the [linkerd-viz](../features/dashboard/) extension, which will create an on-cluster Prometheus instance as well as dashboards and CLI diff --git a/linkerd.io/content/2.12/tasks/exposing-dashboard.md b/linkerd.io/content/2.12/tasks/exposing-dashboard.md index fe8cf24afe..e161095597 100644 --- a/linkerd.io/content/2.12/tasks/exposing-dashboard.md +++ b/linkerd.io/content/2.12/tasks/exposing-dashboard.md @@ -10,7 +10,7 @@ going on, you can expose the dashboard via an ingress. This will also expose Grafana, if you have it linked against Linkerd viz through the `grafana.url` setting. -{{< docs/toc >}} +{{< toc >}} ## Nginx @@ -42,7 +42,7 @@ metadata: proxy_hide_header l5d-server-id; nginx.ingress.kubernetes.io/auth-type: basic nginx.ingress.kubernetes.io/auth-secret: web-ingress-auth - nginx.ingress.kubernetes.io/auth-realm: "Authentication Required" + nginx.ingress.kubernetes.io/auth-realm: 'Authentication Required' spec: ingressClassName: nginx rules: diff --git a/linkerd.io/content/2.12/tasks/external-prometheus.md b/linkerd.io/content/2.12/tasks/external-prometheus.md index 825f640e80..4901c5a51b 100644 --- a/linkerd.io/content/2.12/tasks/external-prometheus.md +++ b/linkerd.io/content/2.12/tasks/external-prometheus.md @@ -12,7 +12,7 @@ both the control plane as well as the proxy's metrics in a format that is consumable both by a user as well as Linkerd control plane components like web, etc. -{{< docs/production-note >}} +{{< production-note >}} There are two important points to tackle here. diff --git a/linkerd.io/content/2.12/tasks/generate-certificates.md b/linkerd.io/content/2.12/tasks/generate-certificates.md index 35013ac056..33dd6751d1 100644 --- a/linkerd.io/content/2.12/tasks/generate-certificates.md +++ b/linkerd.io/content/2.12/tasks/generate-certificates.md @@ -23,7 +23,7 @@ algorithm which is the default for `step`. To generate ECDSA P-256 certificates with openssl, you can use the `openssl ecparam -name prime256v1` command. In this tutorial, we'll walk you through how to to use the `step` CLI to do this. -{{< docs/production-note >}} +{{< production-note >}} ## Generating the certificates with `step` diff --git a/linkerd.io/content/2.12/tasks/gitops.md b/linkerd.io/content/2.12/tasks/gitops.md index 88f391b3bc..84a72c4c74 100644 --- a/linkerd.io/content/2.12/tasks/gitops.md +++ b/linkerd.io/content/2.12/tasks/gitops.md @@ -12,7 +12,7 @@ This guide will show you how to set up [Argo CD](https://argoproj.github.io/argo-cd/) to manage the installation and upgrade of Linkerd using a GitOps workflow. -{{< docs/production-note >}} +{{< production-note >}} Specifically, this guide provides instructions on how to securely generate and manage Linkerd's mTLS private keys and certificates using diff --git a/linkerd.io/content/2.12/tasks/grafana.md b/linkerd.io/content/2.12/tasks/grafana.md index 8a23c8b056..d1c77b336e 100644 --- a/linkerd.io/content/2.12/tasks/grafana.md +++ b/linkerd.io/content/2.12/tasks/grafana.md @@ -13,7 +13,7 @@ First, you need to install Grafana from a variety of possible sources, and then load the suite of Grafana dashboards that have been pre-configured to consume the metrics exposed by Linkerd. -{{< docs/production-note >}} +{{< production-note >}} ## Install Prometheus diff --git a/linkerd.io/content/2.12/tasks/install-helm.md b/linkerd.io/content/2.12/tasks/install-helm.md index c251132fe1..5df22b05c2 100644 --- a/linkerd.io/content/2.12/tasks/install-helm.md +++ b/linkerd.io/content/2.12/tasks/install-helm.md @@ -6,7 +6,7 @@ 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. -{{< docs/production-note >}} +{{< production-note >}} ## Prerequisite: generate identity certificates diff --git a/linkerd.io/content/2.12/tasks/install.md b/linkerd.io/content/2.12/tasks/install.md index 19e82b18cb..be571c39ef 100644 --- a/linkerd.io/content/2.12/tasks/install.md +++ b/linkerd.io/content/2.12/tasks/install.md @@ -11,7 +11,7 @@ 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. -{{< docs/production-note >}} +{{< production-note >}} In either case, we recommend installing the CLI itself so that you can validate the success of the installation. See the diff --git a/linkerd.io/content/2.12/tasks/installing-multicluster.md b/linkerd.io/content/2.12/tasks/installing-multicluster.md index 1b6309922c..f2cf276cb9 100644 --- a/linkerd.io/content/2.12/tasks/installing-multicluster.md +++ b/linkerd.io/content/2.12/tasks/installing-multicluster.md @@ -9,7 +9,7 @@ through this installation and configuration as well as common problems that you may encounter. For a detailed walkthrough and explanation of what's going on, check out [getting started](multicluster/). -{{< docs/production-note >}} +{{< production-note >}} ## Requirements diff --git a/linkerd.io/content/2.12/tasks/setting-up-service-profiles.md b/linkerd.io/content/2.12/tasks/setting-up-service-profiles.md index 704be61323..8108dcbe90 100644 --- a/linkerd.io/content/2.12/tasks/setting-up-service-profiles.md +++ b/linkerd.io/content/2.12/tasks/setting-up-service-profiles.md @@ -56,7 +56,7 @@ demo. There are a couple different ways to use `linkerd profile` to create service profiles. -{{< docs/toc >}} +{{< toc >}} Requests which have been associated with a route will have a `rt_route` annotation. To manually verify if the requests are being associated correctly, diff --git a/linkerd.io/content/2.12/tasks/using-the-debug-container.md b/linkerd.io/content/2.12/tasks/using-the-debug-container.md index 6e40eecd1a..ff7a10bce9 100644 --- a/linkerd.io/content/2.12/tasks/using-the-debug-container.md +++ b/linkerd.io/content/2.12/tasks/using-the-debug-container.md @@ -19,7 +19,7 @@ time. For convenience, the `linkerd inject` command provides an adding this annotation to a pre-existing pod will not work. It must be present at pod _creation_ time.) -{{< docs/production-note >}} +{{< production-note >}} The debug sidecar image contains [`tshark`](https://www.wireshark.org/docs/man-pages/tshark.html), `tcpdump`, diff --git a/linkerd.io/content/2.13/features/_index.md b/linkerd.io/content/2.13/features/_index.md index cf341d4e7e..3eebfe67f4 100644 --- a/linkerd.io/content/2.13/features/_index.md +++ b/linkerd.io/content/2.13/features/_index.md @@ -11,4 +11,4 @@ please see the [Linkerd task docs](../tasks/). For a reference, see the ## Linkerd's features -{{< docs/section-toc >}} +{{< section-toc >}} diff --git a/linkerd.io/content/2.13/reference/_index.md b/linkerd.io/content/2.13/reference/_index.md index f2045c2b56..c066e0b8ee 100644 --- a/linkerd.io/content/2.13/reference/_index.md +++ b/linkerd.io/content/2.13/reference/_index.md @@ -3,4 +3,4 @@ title: Reference weight: 5 --- -{{< docs/section-toc >}} +{{< section-toc >}} diff --git a/linkerd.io/content/2.13/reference/cli/_index.md b/linkerd.io/content/2.13/reference/cli/_index.md index ee36df6287..4d4170ffa7 100644 --- a/linkerd.io/content/2.13/reference/cli/_index.md +++ b/linkerd.io/content/2.13/reference/cli/_index.md @@ -9,10 +9,10 @@ detailed metrics for how your service is performing. As reference, check out the commands below: -{{< docs/cli-commands >}} +{{< cli-commands >}} ## Global flags The following flags are available for _all_ linkerd CLI commands: -{{< docs/cli-global-flags >}} +{{< cli-global-flags >}} diff --git a/linkerd.io/content/2.13/reference/cli/authz.md b/linkerd.io/content/2.13/reference/cli/authz.md index 2a6e55b55d..22df19a41c 100644 --- a/linkerd.io/content/2.13/reference/cli/authz.md +++ b/linkerd.io/content/2.13/reference/cli/authz.md @@ -2,10 +2,10 @@ title: authz --- -{{< docs/cli-description "authz" >}} +{{< cli-description "authz" >}} Check out the [Authorization Policy](../authorization-policy/) and [Restricting Access to Services](../../tasks/restricting-access/) documentation for all the details about authorization policy in Linkerd. -{{< docs/cli-flags "authz" >}} +{{< cli-flags "authz" >}} diff --git a/linkerd.io/content/2.13/reference/cli/check.md b/linkerd.io/content/2.13/reference/cli/check.md index 7cd61cd237..0c18a5da03 100644 --- a/linkerd.io/content/2.13/reference/cli/check.md +++ b/linkerd.io/content/2.13/reference/cli/check.md @@ -2,12 +2,12 @@ title: check --- -{{< docs/cli-description "check" >}} +{{< cli-description "check" >}} Take a look at the [troubleshooting](../../tasks/troubleshooting/) documentation for a full list of all the possible checks, what they do and how to fix them. -{{< docs/cli-examples "check" >}} +{{< cli-examples "check" >}} ## Example output @@ -53,4 +53,4 @@ control-plane-version Status check results are √ ``` -{{< docs/cli-flags "check" >}} +{{< cli-flags "check" >}} diff --git a/linkerd.io/content/2.13/reference/cli/completion.md b/linkerd.io/content/2.13/reference/cli/completion.md index 40e8438b72..6007a47fa5 100644 --- a/linkerd.io/content/2.13/reference/cli/completion.md +++ b/linkerd.io/content/2.13/reference/cli/completion.md @@ -2,8 +2,8 @@ title: completion --- -{{< docs/cli-description "completion" >}} +{{< cli-description "completion" >}} -{{< docs/cli-examples "completion" >}} +{{< cli-examples "completion" >}} -{{< docs/cli-flags "completion" >}} +{{< cli-flags "completion" >}} diff --git a/linkerd.io/content/2.13/reference/cli/diagnostics.md b/linkerd.io/content/2.13/reference/cli/diagnostics.md index ffa45c39be..8e4e36d234 100644 --- a/linkerd.io/content/2.13/reference/cli/diagnostics.md +++ b/linkerd.io/content/2.13/reference/cli/diagnostics.md @@ -2,44 +2,44 @@ title: diagnostics --- -{{< docs/cli-description "diagnostics" >}} +{{< cli-description "diagnostics" >}} -{{< docs/cli-examples "diagnostics" >}} +{{< cli-examples "diagnostics" >}} -{{< docs/cli-flags "diagnostics" >}} +{{< cli-flags "diagnostics" >}} ## Subcommands -{{< docs/cli-subcommands "diagnostics" >}} +{{< cli-subcommands "diagnostics" >}} ### controller-metrics -{{< docs/cli-description "diagnostics controller-metrics" >}} +{{< cli-description "diagnostics controller-metrics" >}} -{{< docs/cli-examples "diagnostics controller-metrics" >}} +{{< cli-examples "diagnostics controller-metrics" >}} -{{< docs/cli-flags "diagnostics controller-metrics" >}} +{{< cli-flags "diagnostics controller-metrics" >}} ### endpoints -{{< docs/cli-description "diagnostics endpoints" >}} +{{< cli-description "diagnostics endpoints" >}} -{{< docs/cli-examples "diagnostics endpoints" >}} +{{< cli-examples "diagnostics endpoints" >}} -{{< docs/cli-flags "diagnostics endpoints" >}} +{{< cli-flags "diagnostics endpoints" >}} ### install-sp -{{< docs/cli-description "diagnostics install-sp" >}} +{{< cli-description "diagnostics install-sp" >}} -{{< docs/cli-examples "diagnostics install-sp" >}} +{{< cli-examples "diagnostics install-sp" >}} -{{< docs/cli-flags "diagnostics install-sp" >}} +{{< cli-flags "diagnostics install-sp" >}} ### proxy-metrics -{{< docs/cli-description "diagnostics proxy-metrics" >}} +{{< cli-description "diagnostics proxy-metrics" >}} -{{< docs/cli-examples "diagnostics proxy-metrics" >}} +{{< cli-examples "diagnostics proxy-metrics" >}} -{{< docs/cli-flags "diagnostics proxy-metrics" >}} +{{< cli-flags "diagnostics proxy-metrics" >}} diff --git a/linkerd.io/content/2.13/reference/cli/identity.md b/linkerd.io/content/2.13/reference/cli/identity.md index 576d175930..c7962e8027 100644 --- a/linkerd.io/content/2.13/reference/cli/identity.md +++ b/linkerd.io/content/2.13/reference/cli/identity.md @@ -2,8 +2,8 @@ title: identity --- -{{< docs/cli-description "identity" >}} +{{< cli-description "identity" >}} -{{< docs/cli-examples "identity" >}} +{{< cli-examples "identity" >}} -{{< docs/cli-flags "identity" >}} +{{< cli-flags "identity" >}} diff --git a/linkerd.io/content/2.13/reference/cli/inject.md b/linkerd.io/content/2.13/reference/cli/inject.md index aafdacdb29..92fc0ca3cb 100644 --- a/linkerd.io/content/2.13/reference/cli/inject.md +++ b/linkerd.io/content/2.13/reference/cli/inject.md @@ -19,6 +19,6 @@ Alternatively, this command can also perform the full injection purely on the client side, by enabling with the `--manual` flag. (Prior to Linkerd 2.4, this was the default behavior.) -{{< docs/cli-examples "inject" >}} +{{< cli-examples "inject" >}} -{{< docs/cli-flags "inject" >}} +{{< cli-flags "inject" >}} diff --git a/linkerd.io/content/2.13/reference/cli/install-cni.md b/linkerd.io/content/2.13/reference/cli/install-cni.md index c7c457a6f1..d0577e3d3b 100644 --- a/linkerd.io/content/2.13/reference/cli/install-cni.md +++ b/linkerd.io/content/2.13/reference/cli/install-cni.md @@ -2,8 +2,8 @@ title: install-cni --- -{{< docs/cli-description "install-cni" >}} +{{< cli-description "install-cni" >}} -{{< docs/cli-examples "install-cni" >}} +{{< cli-examples "install-cni" >}} -{{< docs/cli-flags "install-cni" >}} +{{< cli-flags "install-cni" >}} diff --git a/linkerd.io/content/2.13/reference/cli/install.md b/linkerd.io/content/2.13/reference/cli/install.md index ab0dde824e..5fea59d7eb 100644 --- a/linkerd.io/content/2.13/reference/cli/install.md +++ b/linkerd.io/content/2.13/reference/cli/install.md @@ -2,11 +2,11 @@ title: install --- -{{< docs/cli-description "install" >}} +{{< cli-description "install" >}} For further details on how to install Linkerd onto your own cluster, check out the [install documentation](../../tasks/install/). -{{< docs/cli-examples "install" >}} +{{< cli-examples "install" >}} -{{< docs/cli-flags "install" >}} +{{< cli-flags "install" >}} diff --git a/linkerd.io/content/2.13/reference/cli/jaeger.md b/linkerd.io/content/2.13/reference/cli/jaeger.md index 1301361532..820ad6489c 100644 --- a/linkerd.io/content/2.13/reference/cli/jaeger.md +++ b/linkerd.io/content/2.13/reference/cli/jaeger.md @@ -2,52 +2,52 @@ title: jaeger --- -{{< docs/cli-description "jaeger" >}} +{{< cli-description "jaeger" >}} -{{< docs/cli-examples "jaeger" >}} +{{< cli-examples "jaeger" >}} -{{< docs/cli-flags "jaeger" >}} +{{< cli-flags "jaeger" >}} ## Subcommands -{{< docs/cli-subcommands "jaeger" >}} +{{< cli-subcommands "jaeger" >}} ### check -{{< docs/cli-description "jaeger check" >}} +{{< cli-description "jaeger check" >}} -{{< docs/cli-examples "jaeger check" >}} +{{< cli-examples "jaeger check" >}} -{{< docs/cli-flags "jaeger check" >}} +{{< cli-flags "jaeger check" >}} ### dashboard -{{< docs/cli-description "jaeger dashboard" >}} +{{< cli-description "jaeger dashboard" >}} -{{< docs/cli-examples "jaeger dashboard" >}} +{{< cli-examples "jaeger dashboard" >}} -{{< docs/cli-flags "jaeger dashboard" >}} +{{< cli-flags "jaeger dashboard" >}} ### install -{{< docs/cli-description "jaeger install" >}} +{{< cli-description "jaeger install" >}} -{{< docs/cli-examples "jaeger install" >}} +{{< cli-examples "jaeger install" >}} -{{< docs/cli-flags "jaeger install" >}} +{{< cli-flags "jaeger install" >}} ### list -{{< docs/cli-description "jaeger list" >}} +{{< cli-description "jaeger list" >}} -{{< docs/cli-examples "jaeger list" >}} +{{< cli-examples "jaeger list" >}} -{{< docs/cli-flags "jaeger list" >}} +{{< cli-flags "jaeger list" >}} ### uninstall -{{< docs/cli-description "jaeger uninstall" >}} +{{< cli-description "jaeger uninstall" >}} -{{< docs/cli-examples "jaeger uninstall" >}} +{{< cli-examples "jaeger uninstall" >}} -{{< docs/cli-flags "jaeger uninstall" >}} +{{< cli-flags "jaeger uninstall" >}} diff --git a/linkerd.io/content/2.13/reference/cli/multicluster.md b/linkerd.io/content/2.13/reference/cli/multicluster.md index 519ba5b57e..72c9ac0a4f 100644 --- a/linkerd.io/content/2.13/reference/cli/multicluster.md +++ b/linkerd.io/content/2.13/reference/cli/multicluster.md @@ -2,68 +2,68 @@ title: multicluster --- -{{< docs/cli-description "multicluster" >}} +{{< cli-description "multicluster" >}} -{{< docs/cli-examples "multicluster" >}} +{{< cli-examples "multicluster" >}} -{{< docs/cli-flags "multicluster" >}} +{{< cli-flags "multicluster" >}} ## Subcommands -{{< docs/cli-subcommands "multicluster" >}} +{{< cli-subcommands "multicluster" >}} ### allow -{{< docs/cli-description "multicluster allow" >}} +{{< cli-description "multicluster allow" >}} -{{< docs/cli-examples "multicluster allow" >}} +{{< cli-examples "multicluster allow" >}} -{{< docs/cli-flags "multicluster allow" >}} +{{< cli-flags "multicluster allow" >}} ### check -{{< docs/cli-description "multicluster check" >}} +{{< cli-description "multicluster check" >}} -{{< docs/cli-examples "multicluster check" >}} +{{< cli-examples "multicluster check" >}} -{{< docs/cli-flags "multicluster check" >}} +{{< cli-flags "multicluster check" >}} ### gateways -{{< docs/cli-description "multicluster gateways" >}} +{{< cli-description "multicluster gateways" >}} -{{< docs/cli-examples "multicluster gateways" >}} +{{< cli-examples "multicluster gateways" >}} -{{< docs/cli-flags "multicluster gateways" >}} +{{< cli-flags "multicluster gateways" >}} ### install -{{< docs/cli-description "multicluster install" >}} +{{< cli-description "multicluster install" >}} -{{< docs/cli-examples "multicluster install" >}} +{{< cli-examples "multicluster install" >}} -{{< docs/cli-flags "multicluster install" >}} +{{< cli-flags "multicluster install" >}} ### link -{{< docs/cli-description "multicluster link" >}} +{{< cli-description "multicluster link" >}} -{{< docs/cli-examples "multicluster link" >}} +{{< cli-examples "multicluster link" >}} -{{< docs/cli-flags "multicluster link" >}} +{{< cli-flags "multicluster link" >}} ### uninstall -{{< docs/cli-description "multicluster uninstall" >}} +{{< cli-description "multicluster uninstall" >}} -{{< docs/cli-examples "multicluster uninstall" >}} +{{< cli-examples "multicluster uninstall" >}} -{{< docs/cli-flags "multicluster uninstall" >}} +{{< cli-flags "multicluster uninstall" >}} ### unlink -{{< docs/cli-description "multicluster unlink" >}} +{{< cli-description "multicluster unlink" >}} -{{< docs/cli-examples "multicluster unlink" >}} +{{< cli-examples "multicluster unlink" >}} -{{< docs/cli-flags "multicluster unlink" >}} +{{< cli-flags "multicluster unlink" >}} diff --git a/linkerd.io/content/2.13/reference/cli/profile.md b/linkerd.io/content/2.13/reference/cli/profile.md index 5cc919b876..bf2545c313 100644 --- a/linkerd.io/content/2.13/reference/cli/profile.md +++ b/linkerd.io/content/2.13/reference/cli/profile.md @@ -2,12 +2,12 @@ title: profile --- -{{< docs/cli-description "profile" >}} +{{< cli-description "profile" >}} Check out the [service profile](../../features/service-profiles/) documentation for more details on what this command does and what you can do with service profiles. -{{< docs/cli-examples "profile" >}} +{{< cli-examples "profile" >}} -{{< docs/cli-flags "profile" >}} +{{< cli-flags "profile" >}} diff --git a/linkerd.io/content/2.13/reference/cli/prune.md b/linkerd.io/content/2.13/reference/cli/prune.md index 68675991ed..1ec604588f 100644 --- a/linkerd.io/content/2.13/reference/cli/prune.md +++ b/linkerd.io/content/2.13/reference/cli/prune.md @@ -2,8 +2,8 @@ title: prune --- -{{< docs/cli-description "prune" >}} +{{< cli-description "prune" >}} -{{< docs/cli-examples "prune" >}} +{{< cli-examples "prune" >}} -{{< docs/cli-flags "prune" >}} +{{< cli-flags "prune" >}} diff --git a/linkerd.io/content/2.13/reference/cli/uninject.md b/linkerd.io/content/2.13/reference/cli/uninject.md index 9ad619698a..6f43c3cf0a 100644 --- a/linkerd.io/content/2.13/reference/cli/uninject.md +++ b/linkerd.io/content/2.13/reference/cli/uninject.md @@ -2,8 +2,8 @@ title: uninject --- -{{< docs/cli-description "uninject" >}} +{{< cli-description "uninject" >}} -{{< docs/cli-examples "uninject" >}} +{{< cli-examples "uninject" >}} -{{< docs/cli-flags "uninject" >}} +{{< cli-flags "uninject" >}} diff --git a/linkerd.io/content/2.13/reference/cli/uninstall.md b/linkerd.io/content/2.13/reference/cli/uninstall.md index d5e00031ed..d62dd11612 100644 --- a/linkerd.io/content/2.13/reference/cli/uninstall.md +++ b/linkerd.io/content/2.13/reference/cli/uninstall.md @@ -2,8 +2,8 @@ title: uninstall --- -{{< docs/cli-description "uninstall" >}} +{{< cli-description "uninstall" >}} -{{< docs/cli-examples "uninstall" >}} +{{< cli-examples "uninstall" >}} -{{< docs/cli-flags "uninstall" >}} +{{< cli-flags "uninstall" >}} diff --git a/linkerd.io/content/2.13/reference/cli/upgrade.md b/linkerd.io/content/2.13/reference/cli/upgrade.md index c4422b57c9..70b3296d8a 100644 --- a/linkerd.io/content/2.13/reference/cli/upgrade.md +++ b/linkerd.io/content/2.13/reference/cli/upgrade.md @@ -2,8 +2,8 @@ title: upgrade --- -{{< docs/cli-description "upgrade" >}} +{{< cli-description "upgrade" >}} -{{< docs/cli-examples "upgrade" >}} +{{< cli-examples "upgrade" >}} -{{< docs/cli-flags "upgrade" >}} +{{< cli-flags "upgrade" >}} diff --git a/linkerd.io/content/2.13/reference/cli/version.md b/linkerd.io/content/2.13/reference/cli/version.md index 159f0b2f65..d31d7b18e6 100644 --- a/linkerd.io/content/2.13/reference/cli/version.md +++ b/linkerd.io/content/2.13/reference/cli/version.md @@ -2,8 +2,8 @@ title: version --- -{{< docs/cli-description "version" >}} +{{< cli-description "version" >}} -{{< docs/cli-examples "version" >}} +{{< cli-examples "version" >}} -{{< docs/cli-flags "version" >}} +{{< cli-flags "version" >}} diff --git a/linkerd.io/content/2.13/reference/cli/viz.md b/linkerd.io/content/2.13/reference/cli/viz.md index 2477e875ba..9a11e245d9 100644 --- a/linkerd.io/content/2.13/reference/cli/viz.md +++ b/linkerd.io/content/2.13/reference/cli/viz.md @@ -2,50 +2,50 @@ title: viz --- -{{< docs/cli-description "viz" >}} +{{< cli-description "viz" >}} -{{< docs/cli-examples "viz" >}} +{{< cli-examples "viz" >}} -{{< docs/cli-flags "viz" >}} +{{< cli-flags "viz" >}} ## Subcommands -{{< docs/cli-subcommands "viz" >}} +{{< cli-subcommands "viz" >}} ### allow-scrapes -{{< docs/cli-description "viz allow-scrapes" >}} +{{< cli-description "viz allow-scrapes" >}} -{{< docs/cli-examples "viz allow-scrapes" >}} +{{< cli-examples "viz allow-scrapes" >}} -{{< docs/cli-flags "viz allow-scrapes" >}} +{{< cli-flags "viz allow-scrapes" >}} ### authz -{{< docs/cli-description "viz authz" >}} +{{< cli-description "viz authz" >}} -{{< docs/cli-examples "viz authz" >}} +{{< cli-examples "viz authz" >}} -{{< docs/cli-flags "viz authz" >}} +{{< cli-flags "viz authz" >}} ### check -{{< docs/cli-description "viz check" >}} +{{< cli-description "viz check" >}} -{{< docs/cli-examples "viz check" >}} +{{< cli-examples "viz check" >}} -{{< docs/cli-flags "viz check" >}} +{{< cli-flags "viz check" >}} ### dashboard -{{< docs/cli-description "viz dashboard" >}} +{{< cli-description "viz dashboard" >}} Check out the [architecture](../architecture/#dashboard) docs for a more thorough explanation of what this command does. -{{< docs/cli-examples "viz dashboard" >}} +{{< cli-examples "viz dashboard" >}} -{{< docs/cli-flags "viz dashboard" >}} +{{< cli-flags "viz dashboard" >}} (\*) You'll need to tweak the dashboard's `enforced-host` parameter with this value, as explained in @@ -53,35 +53,35 @@ value, as explained in ### edges -{{< docs/cli-description "viz edges" >}} +{{< cli-description "viz edges" >}} -{{< docs/cli-examples "viz edges" >}} +{{< cli-examples "viz edges" >}} -{{< docs/cli-flags "viz edges" >}} +{{< cli-flags "viz edges" >}} ### install -{{< docs/cli-description "viz install" >}} +{{< cli-description "viz install" >}} -{{< docs/cli-examples "viz install" >}} +{{< cli-examples "viz install" >}} -{{< docs/cli-flags "viz install" >}} +{{< cli-flags "viz install" >}} ### list -{{< docs/cli-description "viz list" >}} +{{< cli-description "viz list" >}} -{{< docs/cli-examples "viz list" >}} +{{< cli-examples "viz list" >}} -{{< docs/cli-flags "viz list" >}} +{{< cli-flags "viz list" >}} ### profile -{{< docs/cli-description "viz profile" >}} +{{< cli-description "viz profile" >}} -{{< docs/cli-examples "viz profile" >}} +{{< cli-examples "viz profile" >}} -{{< docs/cli-flags "viz profile" >}} +{{< cli-flags "viz profile" >}} ### routes @@ -140,38 +140,38 @@ information. Because retries are only performed on the _outbound_ (client) side, the `-o wide` flag can only be used when the `--to` flag is specified. -{{< docs/cli-examples "viz routes" >}} +{{< cli-examples "viz routes" >}} -{{< docs/cli-flags "viz routes" >}} +{{< cli-flags "viz routes" >}} ### stat -{{< docs/cli-description "viz stat" >}} +{{< cli-description "viz stat" >}} -{{< docs/cli-examples "viz stat" >}} +{{< cli-examples "viz stat" >}} -{{< docs/cli-flags "viz stat" >}} +{{< cli-flags "viz stat" >}} ### tap -{{< docs/cli-description "viz tap" >}} +{{< cli-description "viz tap" >}} -{{< docs/cli-examples "viz tap" >}} +{{< cli-examples "viz tap" >}} -{{< docs/cli-flags "viz tap" >}} +{{< cli-flags "viz tap" >}} ### top -{{< docs/cli-description "viz top" >}} +{{< cli-description "viz top" >}} -{{< docs/cli-examples "viz top" >}} +{{< cli-examples "viz top" >}} -{{< docs/cli-flags "viz top" >}} +{{< cli-flags "viz top" >}} ### uninstall -{{< docs/cli-description "viz uninstall" >}} +{{< cli-description "viz uninstall" >}} -{{< docs/cli-examples "viz uninstall" >}} +{{< cli-examples "viz uninstall" >}} -{{< docs/cli-flags "viz uninstall" >}} +{{< cli-flags "viz uninstall" >}} diff --git a/linkerd.io/content/2.13/reference/extension-list.md b/linkerd.io/content/2.13/reference/extension-list.md index e6bdad697e..32afc3fd09 100644 --- a/linkerd.io/content/2.13/reference/extension-list.md +++ b/linkerd.io/content/2.13/reference/extension-list.md @@ -9,7 +9,7 @@ Linkerd provides a mix of built-in and third-party [extensions](../tasks/extensions/) to add additional functionality to the base installation. The following is the list of known extensions: -{{< docs/extensions >}} +{{< extensions >}} If you have an extension for Linkerd and it is not on the list, [please edit this page!](https://github.com/linkerd/website/edit/main/linkerd.io/data/extension-list.yaml) diff --git a/linkerd.io/content/2.13/reference/proxy-configuration.md b/linkerd.io/content/2.13/reference/proxy-configuration.md index 80b471f88b..847b0a53d4 100644 --- a/linkerd.io/content/2.13/reference/proxy-configuration.md +++ b/linkerd.io/content/2.13/reference/proxy-configuration.md @@ -11,7 +11,7 @@ configurations of [auto-injected proxies](../features/proxy-injection/). The following is the list of supported annotations: -{{< docs/cli-annotations "inject" >}} +{{< cli-annotations "inject" >}} For example, to update an auto-injected proxy's CPU and memory resources, we insert the appropriate annotations into the `spec.template.metadata.annotations` diff --git a/linkerd.io/content/2.13/tasks/_index.md b/linkerd.io/content/2.13/tasks/_index.md index cfca319184..19a83aee53 100644 --- a/linkerd.io/content/2.13/tasks/_index.md +++ b/linkerd.io/content/2.13/tasks/_index.md @@ -9,4 +9,4 @@ common tasks that you may need to perform when using Linkerd. ## Common Linkerd tasks -{{< docs/section-toc >}} +{{< section-toc >}} diff --git a/linkerd.io/content/2.13/tasks/automatic-failover.md b/linkerd.io/content/2.13/tasks/automatic-failover.md index ba405d784c..10d0862184 100644 --- a/linkerd.io/content/2.13/tasks/automatic-failover.md +++ b/linkerd.io/content/2.13/tasks/automatic-failover.md @@ -15,7 +15,7 @@ Emojivoto application on two Kubernetes clusters and simulating a failure in one cluster. We will see the failover controller shift traffic to the other cluster to ensure the service remains available. -{{< docs/production-note >}} +{{< production-note >}} ## Prerequisites diff --git a/linkerd.io/content/2.13/tasks/automatically-rotating-control-plane-tls-credentials.md b/linkerd.io/content/2.13/tasks/automatically-rotating-control-plane-tls-credentials.md index 4c07ceaedd..1a3cbf8c37 100644 --- a/linkerd.io/content/2.13/tasks/automatically-rotating-control-plane-tls-credentials.md +++ b/linkerd.io/content/2.13/tasks/automatically-rotating-control-plane-tls-credentials.md @@ -15,7 +15,7 @@ rotate the issuer certificate. In this doc, we'll describe how to set up automatic rotation of the issuer certificate and its corresponding private key using the cert-manager project. -{{< docs/production-note >}} +{{< production-note >}} ## Cert manager diff --git a/linkerd.io/content/2.13/tasks/automatically-rotating-webhook-tls-credentials.md b/linkerd.io/content/2.13/tasks/automatically-rotating-webhook-tls-credentials.md index 563014c122..556448912c 100644 --- a/linkerd.io/content/2.13/tasks/automatically-rotating-webhook-tls-credentials.md +++ b/linkerd.io/content/2.13/tasks/automatically-rotating-webhook-tls-credentials.md @@ -22,7 +22,7 @@ This workflow is suitable for most users. However, if you need these webhook certificates to be rotated automatically on a regular basis, it is possible to use cert-manager to automatically manage them. -{{< docs/production-note >}} +{{< production-note >}} ## Install Cert manager diff --git a/linkerd.io/content/2.13/tasks/circuit-breakers.md b/linkerd.io/content/2.13/tasks/circuit-breakers.md index 13425e16dd..d038ccf382 100644 --- a/linkerd.io/content/2.13/tasks/circuit-breakers.md +++ b/linkerd.io/content/2.13/tasks/circuit-breakers.md @@ -13,7 +13,7 @@ improve client success rate when a backend replica is unhealthy. See the [reference documentation](../reference/circuit-breaking/) for more details on how Linkerd implements circuit breaking. -{{< docs/production-note >}} +{{< production-note >}} ## Prerequisites diff --git a/linkerd.io/content/2.13/tasks/customize-install.md b/linkerd.io/content/2.13/tasks/customize-install.md index dc71604c3c..512bb3629d 100644 --- a/linkerd.io/content/2.13/tasks/customize-install.md +++ b/linkerd.io/content/2.13/tasks/customize-install.md @@ -9,7 +9,7 @@ Instead of forking the Linkerd install and upgrade process, `linkerd install` in a consistent way. This allows customization of the install to add functionality specific to installations. -{{< docs/production-note >}} +{{< production-note >}} To get started, save the output of `linkerd install` to a YAML file. This will be the base resource that Kustomize uses to patch and generate what is added to diff --git a/linkerd.io/content/2.13/tasks/exporting-metrics.md b/linkerd.io/content/2.13/tasks/exporting-metrics.md index 877aedf5a2..efd60daab3 100644 --- a/linkerd.io/content/2.13/tasks/exporting-metrics.md +++ b/linkerd.io/content/2.13/tasks/exporting-metrics.md @@ -13,7 +13,7 @@ each proxy only provides a portion of the full picture. Instead, a separate tool is used to collect metrics from all proxies and aggregate them together for consumption. -{{< docs/production-note >}} +{{< production-note >}} One easy option is the [linkerd-viz](../features/dashboard/) extension, which will create an on-cluster Prometheus instance as well as dashboards and CLI diff --git a/linkerd.io/content/2.13/tasks/exposing-dashboard.md b/linkerd.io/content/2.13/tasks/exposing-dashboard.md index fe8cf24afe..e161095597 100644 --- a/linkerd.io/content/2.13/tasks/exposing-dashboard.md +++ b/linkerd.io/content/2.13/tasks/exposing-dashboard.md @@ -10,7 +10,7 @@ going on, you can expose the dashboard via an ingress. This will also expose Grafana, if you have it linked against Linkerd viz through the `grafana.url` setting. -{{< docs/toc >}} +{{< toc >}} ## Nginx @@ -42,7 +42,7 @@ metadata: proxy_hide_header l5d-server-id; nginx.ingress.kubernetes.io/auth-type: basic nginx.ingress.kubernetes.io/auth-secret: web-ingress-auth - nginx.ingress.kubernetes.io/auth-realm: "Authentication Required" + nginx.ingress.kubernetes.io/auth-realm: 'Authentication Required' spec: ingressClassName: nginx rules: diff --git a/linkerd.io/content/2.13/tasks/external-prometheus.md b/linkerd.io/content/2.13/tasks/external-prometheus.md index c663e92c17..1ee6994f1a 100644 --- a/linkerd.io/content/2.13/tasks/external-prometheus.md +++ b/linkerd.io/content/2.13/tasks/external-prometheus.md @@ -12,7 +12,7 @@ both the control plane as well as the proxy's metrics in a format that is consumable both by a user as well as Linkerd control plane components like web, etc. -{{< docs/production-note >}} +{{< production-note >}} There are two important points to tackle here. diff --git a/linkerd.io/content/2.13/tasks/flagger.md b/linkerd.io/content/2.13/tasks/flagger.md index 0dccc00bb4..694d198c21 100644 --- a/linkerd.io/content/2.13/tasks/flagger.md +++ b/linkerd.io/content/2.13/tasks/flagger.md @@ -23,7 +23,7 @@ In this tutorial, we'll walk you through how to combine Linkerd with metrics and traffic splitting together in a control loop, allowing for fully-automated, metrics-aware canary deployments. -{{< docs/production-note >}} +{{< production-note >}} ## Prerequisites diff --git a/linkerd.io/content/2.13/tasks/generate-certificates.md b/linkerd.io/content/2.13/tasks/generate-certificates.md index 35013ac056..33dd6751d1 100644 --- a/linkerd.io/content/2.13/tasks/generate-certificates.md +++ b/linkerd.io/content/2.13/tasks/generate-certificates.md @@ -23,7 +23,7 @@ algorithm which is the default for `step`. To generate ECDSA P-256 certificates with openssl, you can use the `openssl ecparam -name prime256v1` command. In this tutorial, we'll walk you through how to to use the `step` CLI to do this. -{{< docs/production-note >}} +{{< production-note >}} ## Generating the certificates with `step` diff --git a/linkerd.io/content/2.13/tasks/gitops.md b/linkerd.io/content/2.13/tasks/gitops.md index 715eda20a4..09459c89c5 100644 --- a/linkerd.io/content/2.13/tasks/gitops.md +++ b/linkerd.io/content/2.13/tasks/gitops.md @@ -12,7 +12,7 @@ This guide will show you how to set up [Argo CD](https://argoproj.github.io/argo-cd/) to manage the installation and upgrade of Linkerd using a GitOps workflow. -{{< docs/production-note >}} +{{< production-note >}} Specifically, this guide provides instructions on how to securely generate and manage Linkerd's mTLS private keys and certificates using diff --git a/linkerd.io/content/2.13/tasks/grafana.md b/linkerd.io/content/2.13/tasks/grafana.md index b37b01af71..a30d3792e5 100644 --- a/linkerd.io/content/2.13/tasks/grafana.md +++ b/linkerd.io/content/2.13/tasks/grafana.md @@ -13,7 +13,7 @@ First, you need to install Grafana from a variety of possible sources, and then load the suite of Grafana dashboards that have been pre-configured to consume the metrics exposed by Linkerd. -{{< docs/production-note >}} +{{< production-note >}} ## Install Prometheus diff --git a/linkerd.io/content/2.13/tasks/install-helm.md b/linkerd.io/content/2.13/tasks/install-helm.md index c251132fe1..5df22b05c2 100644 --- a/linkerd.io/content/2.13/tasks/install-helm.md +++ b/linkerd.io/content/2.13/tasks/install-helm.md @@ -6,7 +6,7 @@ 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. -{{< docs/production-note >}} +{{< production-note >}} ## Prerequisite: generate identity certificates diff --git a/linkerd.io/content/2.13/tasks/install.md b/linkerd.io/content/2.13/tasks/install.md index 19e82b18cb..be571c39ef 100644 --- a/linkerd.io/content/2.13/tasks/install.md +++ b/linkerd.io/content/2.13/tasks/install.md @@ -11,7 +11,7 @@ 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. -{{< docs/production-note >}} +{{< production-note >}} In either case, we recommend installing the CLI itself so that you can validate the success of the installation. See the diff --git a/linkerd.io/content/2.13/tasks/installing-multicluster.md b/linkerd.io/content/2.13/tasks/installing-multicluster.md index 1b6309922c..f2cf276cb9 100644 --- a/linkerd.io/content/2.13/tasks/installing-multicluster.md +++ b/linkerd.io/content/2.13/tasks/installing-multicluster.md @@ -9,7 +9,7 @@ through this installation and configuration as well as common problems that you may encounter. For a detailed walkthrough and explanation of what's going on, check out [getting started](multicluster/). -{{< docs/production-note >}} +{{< production-note >}} ## Requirements diff --git a/linkerd.io/content/2.13/tasks/setting-up-service-profiles.md b/linkerd.io/content/2.13/tasks/setting-up-service-profiles.md index 704be61323..8108dcbe90 100644 --- a/linkerd.io/content/2.13/tasks/setting-up-service-profiles.md +++ b/linkerd.io/content/2.13/tasks/setting-up-service-profiles.md @@ -56,7 +56,7 @@ demo. There are a couple different ways to use `linkerd profile` to create service profiles. -{{< docs/toc >}} +{{< toc >}} Requests which have been associated with a route will have a `rt_route` annotation. To manually verify if the requests are being associated correctly, diff --git a/linkerd.io/content/2.13/tasks/traffic-shifting.md b/linkerd.io/content/2.13/tasks/traffic-shifting.md index 7503220fcc..916ae6506a 100644 --- a/linkerd.io/content/2.13/tasks/traffic-shifting.md +++ b/linkerd.io/content/2.13/tasks/traffic-shifting.md @@ -16,7 +16,7 @@ Linkerd natively supports. While certain integrations such as [Flagger](flagger/) rely on the SMI and `TrafficSplit` approach, using `HTTPRoute` is the preferred method going forward. -{{< docs/production-note >}} +{{< production-note >}} ## Prerequisites diff --git a/linkerd.io/content/2.13/tasks/using-the-debug-container.md b/linkerd.io/content/2.13/tasks/using-the-debug-container.md index 6e40eecd1a..ff7a10bce9 100644 --- a/linkerd.io/content/2.13/tasks/using-the-debug-container.md +++ b/linkerd.io/content/2.13/tasks/using-the-debug-container.md @@ -19,7 +19,7 @@ time. For convenience, the `linkerd inject` command provides an adding this annotation to a pre-existing pod will not work. It must be present at pod _creation_ time.) -{{< docs/production-note >}} +{{< production-note >}} The debug sidecar image contains [`tshark`](https://www.wireshark.org/docs/man-pages/tshark.html), `tcpdump`, diff --git a/linkerd.io/content/2.14/features/_index.md b/linkerd.io/content/2.14/features/_index.md index cf341d4e7e..3eebfe67f4 100644 --- a/linkerd.io/content/2.14/features/_index.md +++ b/linkerd.io/content/2.14/features/_index.md @@ -11,4 +11,4 @@ please see the [Linkerd task docs](../tasks/). For a reference, see the ## Linkerd's features -{{< docs/section-toc >}} +{{< section-toc >}} diff --git a/linkerd.io/content/2.14/reference/_index.md b/linkerd.io/content/2.14/reference/_index.md index f2045c2b56..c066e0b8ee 100644 --- a/linkerd.io/content/2.14/reference/_index.md +++ b/linkerd.io/content/2.14/reference/_index.md @@ -3,4 +3,4 @@ title: Reference weight: 5 --- -{{< docs/section-toc >}} +{{< section-toc >}} diff --git a/linkerd.io/content/2.14/reference/cli/_index.md b/linkerd.io/content/2.14/reference/cli/_index.md index ee36df6287..4d4170ffa7 100644 --- a/linkerd.io/content/2.14/reference/cli/_index.md +++ b/linkerd.io/content/2.14/reference/cli/_index.md @@ -9,10 +9,10 @@ detailed metrics for how your service is performing. As reference, check out the commands below: -{{< docs/cli-commands >}} +{{< cli-commands >}} ## Global flags The following flags are available for _all_ linkerd CLI commands: -{{< docs/cli-global-flags >}} +{{< cli-global-flags >}} diff --git a/linkerd.io/content/2.14/reference/cli/authz.md b/linkerd.io/content/2.14/reference/cli/authz.md index 2a6e55b55d..22df19a41c 100644 --- a/linkerd.io/content/2.14/reference/cli/authz.md +++ b/linkerd.io/content/2.14/reference/cli/authz.md @@ -2,10 +2,10 @@ title: authz --- -{{< docs/cli-description "authz" >}} +{{< cli-description "authz" >}} Check out the [Authorization Policy](../authorization-policy/) and [Restricting Access to Services](../../tasks/restricting-access/) documentation for all the details about authorization policy in Linkerd. -{{< docs/cli-flags "authz" >}} +{{< cli-flags "authz" >}} diff --git a/linkerd.io/content/2.14/reference/cli/check.md b/linkerd.io/content/2.14/reference/cli/check.md index 7cd61cd237..0c18a5da03 100644 --- a/linkerd.io/content/2.14/reference/cli/check.md +++ b/linkerd.io/content/2.14/reference/cli/check.md @@ -2,12 +2,12 @@ title: check --- -{{< docs/cli-description "check" >}} +{{< cli-description "check" >}} Take a look at the [troubleshooting](../../tasks/troubleshooting/) documentation for a full list of all the possible checks, what they do and how to fix them. -{{< docs/cli-examples "check" >}} +{{< cli-examples "check" >}} ## Example output @@ -53,4 +53,4 @@ control-plane-version Status check results are √ ``` -{{< docs/cli-flags "check" >}} +{{< cli-flags "check" >}} diff --git a/linkerd.io/content/2.14/reference/cli/completion.md b/linkerd.io/content/2.14/reference/cli/completion.md index 40e8438b72..6007a47fa5 100644 --- a/linkerd.io/content/2.14/reference/cli/completion.md +++ b/linkerd.io/content/2.14/reference/cli/completion.md @@ -2,8 +2,8 @@ title: completion --- -{{< docs/cli-description "completion" >}} +{{< cli-description "completion" >}} -{{< docs/cli-examples "completion" >}} +{{< cli-examples "completion" >}} -{{< docs/cli-flags "completion" >}} +{{< cli-flags "completion" >}} diff --git a/linkerd.io/content/2.14/reference/cli/diagnostics.md b/linkerd.io/content/2.14/reference/cli/diagnostics.md index ffa45c39be..8e4e36d234 100644 --- a/linkerd.io/content/2.14/reference/cli/diagnostics.md +++ b/linkerd.io/content/2.14/reference/cli/diagnostics.md @@ -2,44 +2,44 @@ title: diagnostics --- -{{< docs/cli-description "diagnostics" >}} +{{< cli-description "diagnostics" >}} -{{< docs/cli-examples "diagnostics" >}} +{{< cli-examples "diagnostics" >}} -{{< docs/cli-flags "diagnostics" >}} +{{< cli-flags "diagnostics" >}} ## Subcommands -{{< docs/cli-subcommands "diagnostics" >}} +{{< cli-subcommands "diagnostics" >}} ### controller-metrics -{{< docs/cli-description "diagnostics controller-metrics" >}} +{{< cli-description "diagnostics controller-metrics" >}} -{{< docs/cli-examples "diagnostics controller-metrics" >}} +{{< cli-examples "diagnostics controller-metrics" >}} -{{< docs/cli-flags "diagnostics controller-metrics" >}} +{{< cli-flags "diagnostics controller-metrics" >}} ### endpoints -{{< docs/cli-description "diagnostics endpoints" >}} +{{< cli-description "diagnostics endpoints" >}} -{{< docs/cli-examples "diagnostics endpoints" >}} +{{< cli-examples "diagnostics endpoints" >}} -{{< docs/cli-flags "diagnostics endpoints" >}} +{{< cli-flags "diagnostics endpoints" >}} ### install-sp -{{< docs/cli-description "diagnostics install-sp" >}} +{{< cli-description "diagnostics install-sp" >}} -{{< docs/cli-examples "diagnostics install-sp" >}} +{{< cli-examples "diagnostics install-sp" >}} -{{< docs/cli-flags "diagnostics install-sp" >}} +{{< cli-flags "diagnostics install-sp" >}} ### proxy-metrics -{{< docs/cli-description "diagnostics proxy-metrics" >}} +{{< cli-description "diagnostics proxy-metrics" >}} -{{< docs/cli-examples "diagnostics proxy-metrics" >}} +{{< cli-examples "diagnostics proxy-metrics" >}} -{{< docs/cli-flags "diagnostics proxy-metrics" >}} +{{< cli-flags "diagnostics proxy-metrics" >}} diff --git a/linkerd.io/content/2.14/reference/cli/identity.md b/linkerd.io/content/2.14/reference/cli/identity.md index 576d175930..c7962e8027 100644 --- a/linkerd.io/content/2.14/reference/cli/identity.md +++ b/linkerd.io/content/2.14/reference/cli/identity.md @@ -2,8 +2,8 @@ title: identity --- -{{< docs/cli-description "identity" >}} +{{< cli-description "identity" >}} -{{< docs/cli-examples "identity" >}} +{{< cli-examples "identity" >}} -{{< docs/cli-flags "identity" >}} +{{< cli-flags "identity" >}} diff --git a/linkerd.io/content/2.14/reference/cli/inject.md b/linkerd.io/content/2.14/reference/cli/inject.md index aafdacdb29..92fc0ca3cb 100644 --- a/linkerd.io/content/2.14/reference/cli/inject.md +++ b/linkerd.io/content/2.14/reference/cli/inject.md @@ -19,6 +19,6 @@ Alternatively, this command can also perform the full injection purely on the client side, by enabling with the `--manual` flag. (Prior to Linkerd 2.4, this was the default behavior.) -{{< docs/cli-examples "inject" >}} +{{< cli-examples "inject" >}} -{{< docs/cli-flags "inject" >}} +{{< cli-flags "inject" >}} diff --git a/linkerd.io/content/2.14/reference/cli/install-cni.md b/linkerd.io/content/2.14/reference/cli/install-cni.md index c7c457a6f1..d0577e3d3b 100644 --- a/linkerd.io/content/2.14/reference/cli/install-cni.md +++ b/linkerd.io/content/2.14/reference/cli/install-cni.md @@ -2,8 +2,8 @@ title: install-cni --- -{{< docs/cli-description "install-cni" >}} +{{< cli-description "install-cni" >}} -{{< docs/cli-examples "install-cni" >}} +{{< cli-examples "install-cni" >}} -{{< docs/cli-flags "install-cni" >}} +{{< cli-flags "install-cni" >}} diff --git a/linkerd.io/content/2.14/reference/cli/install.md b/linkerd.io/content/2.14/reference/cli/install.md index ab0dde824e..5fea59d7eb 100644 --- a/linkerd.io/content/2.14/reference/cli/install.md +++ b/linkerd.io/content/2.14/reference/cli/install.md @@ -2,11 +2,11 @@ title: install --- -{{< docs/cli-description "install" >}} +{{< cli-description "install" >}} For further details on how to install Linkerd onto your own cluster, check out the [install documentation](../../tasks/install/). -{{< docs/cli-examples "install" >}} +{{< cli-examples "install" >}} -{{< docs/cli-flags "install" >}} +{{< cli-flags "install" >}} diff --git a/linkerd.io/content/2.14/reference/cli/jaeger.md b/linkerd.io/content/2.14/reference/cli/jaeger.md index 1301361532..820ad6489c 100644 --- a/linkerd.io/content/2.14/reference/cli/jaeger.md +++ b/linkerd.io/content/2.14/reference/cli/jaeger.md @@ -2,52 +2,52 @@ title: jaeger --- -{{< docs/cli-description "jaeger" >}} +{{< cli-description "jaeger" >}} -{{< docs/cli-examples "jaeger" >}} +{{< cli-examples "jaeger" >}} -{{< docs/cli-flags "jaeger" >}} +{{< cli-flags "jaeger" >}} ## Subcommands -{{< docs/cli-subcommands "jaeger" >}} +{{< cli-subcommands "jaeger" >}} ### check -{{< docs/cli-description "jaeger check" >}} +{{< cli-description "jaeger check" >}} -{{< docs/cli-examples "jaeger check" >}} +{{< cli-examples "jaeger check" >}} -{{< docs/cli-flags "jaeger check" >}} +{{< cli-flags "jaeger check" >}} ### dashboard -{{< docs/cli-description "jaeger dashboard" >}} +{{< cli-description "jaeger dashboard" >}} -{{< docs/cli-examples "jaeger dashboard" >}} +{{< cli-examples "jaeger dashboard" >}} -{{< docs/cli-flags "jaeger dashboard" >}} +{{< cli-flags "jaeger dashboard" >}} ### install -{{< docs/cli-description "jaeger install" >}} +{{< cli-description "jaeger install" >}} -{{< docs/cli-examples "jaeger install" >}} +{{< cli-examples "jaeger install" >}} -{{< docs/cli-flags "jaeger install" >}} +{{< cli-flags "jaeger install" >}} ### list -{{< docs/cli-description "jaeger list" >}} +{{< cli-description "jaeger list" >}} -{{< docs/cli-examples "jaeger list" >}} +{{< cli-examples "jaeger list" >}} -{{< docs/cli-flags "jaeger list" >}} +{{< cli-flags "jaeger list" >}} ### uninstall -{{< docs/cli-description "jaeger uninstall" >}} +{{< cli-description "jaeger uninstall" >}} -{{< docs/cli-examples "jaeger uninstall" >}} +{{< cli-examples "jaeger uninstall" >}} -{{< docs/cli-flags "jaeger uninstall" >}} +{{< cli-flags "jaeger uninstall" >}} diff --git a/linkerd.io/content/2.14/reference/cli/multicluster.md b/linkerd.io/content/2.14/reference/cli/multicluster.md index 519ba5b57e..72c9ac0a4f 100644 --- a/linkerd.io/content/2.14/reference/cli/multicluster.md +++ b/linkerd.io/content/2.14/reference/cli/multicluster.md @@ -2,68 +2,68 @@ title: multicluster --- -{{< docs/cli-description "multicluster" >}} +{{< cli-description "multicluster" >}} -{{< docs/cli-examples "multicluster" >}} +{{< cli-examples "multicluster" >}} -{{< docs/cli-flags "multicluster" >}} +{{< cli-flags "multicluster" >}} ## Subcommands -{{< docs/cli-subcommands "multicluster" >}} +{{< cli-subcommands "multicluster" >}} ### allow -{{< docs/cli-description "multicluster allow" >}} +{{< cli-description "multicluster allow" >}} -{{< docs/cli-examples "multicluster allow" >}} +{{< cli-examples "multicluster allow" >}} -{{< docs/cli-flags "multicluster allow" >}} +{{< cli-flags "multicluster allow" >}} ### check -{{< docs/cli-description "multicluster check" >}} +{{< cli-description "multicluster check" >}} -{{< docs/cli-examples "multicluster check" >}} +{{< cli-examples "multicluster check" >}} -{{< docs/cli-flags "multicluster check" >}} +{{< cli-flags "multicluster check" >}} ### gateways -{{< docs/cli-description "multicluster gateways" >}} +{{< cli-description "multicluster gateways" >}} -{{< docs/cli-examples "multicluster gateways" >}} +{{< cli-examples "multicluster gateways" >}} -{{< docs/cli-flags "multicluster gateways" >}} +{{< cli-flags "multicluster gateways" >}} ### install -{{< docs/cli-description "multicluster install" >}} +{{< cli-description "multicluster install" >}} -{{< docs/cli-examples "multicluster install" >}} +{{< cli-examples "multicluster install" >}} -{{< docs/cli-flags "multicluster install" >}} +{{< cli-flags "multicluster install" >}} ### link -{{< docs/cli-description "multicluster link" >}} +{{< cli-description "multicluster link" >}} -{{< docs/cli-examples "multicluster link" >}} +{{< cli-examples "multicluster link" >}} -{{< docs/cli-flags "multicluster link" >}} +{{< cli-flags "multicluster link" >}} ### uninstall -{{< docs/cli-description "multicluster uninstall" >}} +{{< cli-description "multicluster uninstall" >}} -{{< docs/cli-examples "multicluster uninstall" >}} +{{< cli-examples "multicluster uninstall" >}} -{{< docs/cli-flags "multicluster uninstall" >}} +{{< cli-flags "multicluster uninstall" >}} ### unlink -{{< docs/cli-description "multicluster unlink" >}} +{{< cli-description "multicluster unlink" >}} -{{< docs/cli-examples "multicluster unlink" >}} +{{< cli-examples "multicluster unlink" >}} -{{< docs/cli-flags "multicluster unlink" >}} +{{< cli-flags "multicluster unlink" >}} diff --git a/linkerd.io/content/2.14/reference/cli/profile.md b/linkerd.io/content/2.14/reference/cli/profile.md index 5cc919b876..bf2545c313 100644 --- a/linkerd.io/content/2.14/reference/cli/profile.md +++ b/linkerd.io/content/2.14/reference/cli/profile.md @@ -2,12 +2,12 @@ title: profile --- -{{< docs/cli-description "profile" >}} +{{< cli-description "profile" >}} Check out the [service profile](../../features/service-profiles/) documentation for more details on what this command does and what you can do with service profiles. -{{< docs/cli-examples "profile" >}} +{{< cli-examples "profile" >}} -{{< docs/cli-flags "profile" >}} +{{< cli-flags "profile" >}} diff --git a/linkerd.io/content/2.14/reference/cli/prune.md b/linkerd.io/content/2.14/reference/cli/prune.md index 68675991ed..1ec604588f 100644 --- a/linkerd.io/content/2.14/reference/cli/prune.md +++ b/linkerd.io/content/2.14/reference/cli/prune.md @@ -2,8 +2,8 @@ title: prune --- -{{< docs/cli-description "prune" >}} +{{< cli-description "prune" >}} -{{< docs/cli-examples "prune" >}} +{{< cli-examples "prune" >}} -{{< docs/cli-flags "prune" >}} +{{< cli-flags "prune" >}} diff --git a/linkerd.io/content/2.14/reference/cli/uninject.md b/linkerd.io/content/2.14/reference/cli/uninject.md index 9ad619698a..6f43c3cf0a 100644 --- a/linkerd.io/content/2.14/reference/cli/uninject.md +++ b/linkerd.io/content/2.14/reference/cli/uninject.md @@ -2,8 +2,8 @@ title: uninject --- -{{< docs/cli-description "uninject" >}} +{{< cli-description "uninject" >}} -{{< docs/cli-examples "uninject" >}} +{{< cli-examples "uninject" >}} -{{< docs/cli-flags "uninject" >}} +{{< cli-flags "uninject" >}} diff --git a/linkerd.io/content/2.14/reference/cli/uninstall.md b/linkerd.io/content/2.14/reference/cli/uninstall.md index d5e00031ed..d62dd11612 100644 --- a/linkerd.io/content/2.14/reference/cli/uninstall.md +++ b/linkerd.io/content/2.14/reference/cli/uninstall.md @@ -2,8 +2,8 @@ title: uninstall --- -{{< docs/cli-description "uninstall" >}} +{{< cli-description "uninstall" >}} -{{< docs/cli-examples "uninstall" >}} +{{< cli-examples "uninstall" >}} -{{< docs/cli-flags "uninstall" >}} +{{< cli-flags "uninstall" >}} diff --git a/linkerd.io/content/2.14/reference/cli/upgrade.md b/linkerd.io/content/2.14/reference/cli/upgrade.md index c4422b57c9..70b3296d8a 100644 --- a/linkerd.io/content/2.14/reference/cli/upgrade.md +++ b/linkerd.io/content/2.14/reference/cli/upgrade.md @@ -2,8 +2,8 @@ title: upgrade --- -{{< docs/cli-description "upgrade" >}} +{{< cli-description "upgrade" >}} -{{< docs/cli-examples "upgrade" >}} +{{< cli-examples "upgrade" >}} -{{< docs/cli-flags "upgrade" >}} +{{< cli-flags "upgrade" >}} diff --git a/linkerd.io/content/2.14/reference/cli/version.md b/linkerd.io/content/2.14/reference/cli/version.md index 159f0b2f65..d31d7b18e6 100644 --- a/linkerd.io/content/2.14/reference/cli/version.md +++ b/linkerd.io/content/2.14/reference/cli/version.md @@ -2,8 +2,8 @@ title: version --- -{{< docs/cli-description "version" >}} +{{< cli-description "version" >}} -{{< docs/cli-examples "version" >}} +{{< cli-examples "version" >}} -{{< docs/cli-flags "version" >}} +{{< cli-flags "version" >}} diff --git a/linkerd.io/content/2.14/reference/cli/viz.md b/linkerd.io/content/2.14/reference/cli/viz.md index 2477e875ba..9a11e245d9 100644 --- a/linkerd.io/content/2.14/reference/cli/viz.md +++ b/linkerd.io/content/2.14/reference/cli/viz.md @@ -2,50 +2,50 @@ title: viz --- -{{< docs/cli-description "viz" >}} +{{< cli-description "viz" >}} -{{< docs/cli-examples "viz" >}} +{{< cli-examples "viz" >}} -{{< docs/cli-flags "viz" >}} +{{< cli-flags "viz" >}} ## Subcommands -{{< docs/cli-subcommands "viz" >}} +{{< cli-subcommands "viz" >}} ### allow-scrapes -{{< docs/cli-description "viz allow-scrapes" >}} +{{< cli-description "viz allow-scrapes" >}} -{{< docs/cli-examples "viz allow-scrapes" >}} +{{< cli-examples "viz allow-scrapes" >}} -{{< docs/cli-flags "viz allow-scrapes" >}} +{{< cli-flags "viz allow-scrapes" >}} ### authz -{{< docs/cli-description "viz authz" >}} +{{< cli-description "viz authz" >}} -{{< docs/cli-examples "viz authz" >}} +{{< cli-examples "viz authz" >}} -{{< docs/cli-flags "viz authz" >}} +{{< cli-flags "viz authz" >}} ### check -{{< docs/cli-description "viz check" >}} +{{< cli-description "viz check" >}} -{{< docs/cli-examples "viz check" >}} +{{< cli-examples "viz check" >}} -{{< docs/cli-flags "viz check" >}} +{{< cli-flags "viz check" >}} ### dashboard -{{< docs/cli-description "viz dashboard" >}} +{{< cli-description "viz dashboard" >}} Check out the [architecture](../architecture/#dashboard) docs for a more thorough explanation of what this command does. -{{< docs/cli-examples "viz dashboard" >}} +{{< cli-examples "viz dashboard" >}} -{{< docs/cli-flags "viz dashboard" >}} +{{< cli-flags "viz dashboard" >}} (\*) You'll need to tweak the dashboard's `enforced-host` parameter with this value, as explained in @@ -53,35 +53,35 @@ value, as explained in ### edges -{{< docs/cli-description "viz edges" >}} +{{< cli-description "viz edges" >}} -{{< docs/cli-examples "viz edges" >}} +{{< cli-examples "viz edges" >}} -{{< docs/cli-flags "viz edges" >}} +{{< cli-flags "viz edges" >}} ### install -{{< docs/cli-description "viz install" >}} +{{< cli-description "viz install" >}} -{{< docs/cli-examples "viz install" >}} +{{< cli-examples "viz install" >}} -{{< docs/cli-flags "viz install" >}} +{{< cli-flags "viz install" >}} ### list -{{< docs/cli-description "viz list" >}} +{{< cli-description "viz list" >}} -{{< docs/cli-examples "viz list" >}} +{{< cli-examples "viz list" >}} -{{< docs/cli-flags "viz list" >}} +{{< cli-flags "viz list" >}} ### profile -{{< docs/cli-description "viz profile" >}} +{{< cli-description "viz profile" >}} -{{< docs/cli-examples "viz profile" >}} +{{< cli-examples "viz profile" >}} -{{< docs/cli-flags "viz profile" >}} +{{< cli-flags "viz profile" >}} ### routes @@ -140,38 +140,38 @@ information. Because retries are only performed on the _outbound_ (client) side, the `-o wide` flag can only be used when the `--to` flag is specified. -{{< docs/cli-examples "viz routes" >}} +{{< cli-examples "viz routes" >}} -{{< docs/cli-flags "viz routes" >}} +{{< cli-flags "viz routes" >}} ### stat -{{< docs/cli-description "viz stat" >}} +{{< cli-description "viz stat" >}} -{{< docs/cli-examples "viz stat" >}} +{{< cli-examples "viz stat" >}} -{{< docs/cli-flags "viz stat" >}} +{{< cli-flags "viz stat" >}} ### tap -{{< docs/cli-description "viz tap" >}} +{{< cli-description "viz tap" >}} -{{< docs/cli-examples "viz tap" >}} +{{< cli-examples "viz tap" >}} -{{< docs/cli-flags "viz tap" >}} +{{< cli-flags "viz tap" >}} ### top -{{< docs/cli-description "viz top" >}} +{{< cli-description "viz top" >}} -{{< docs/cli-examples "viz top" >}} +{{< cli-examples "viz top" >}} -{{< docs/cli-flags "viz top" >}} +{{< cli-flags "viz top" >}} ### uninstall -{{< docs/cli-description "viz uninstall" >}} +{{< cli-description "viz uninstall" >}} -{{< docs/cli-examples "viz uninstall" >}} +{{< cli-examples "viz uninstall" >}} -{{< docs/cli-flags "viz uninstall" >}} +{{< cli-flags "viz uninstall" >}} diff --git a/linkerd.io/content/2.14/reference/extension-list.md b/linkerd.io/content/2.14/reference/extension-list.md index e6bdad697e..32afc3fd09 100644 --- a/linkerd.io/content/2.14/reference/extension-list.md +++ b/linkerd.io/content/2.14/reference/extension-list.md @@ -9,7 +9,7 @@ Linkerd provides a mix of built-in and third-party [extensions](../tasks/extensions/) to add additional functionality to the base installation. The following is the list of known extensions: -{{< docs/extensions >}} +{{< extensions >}} If you have an extension for Linkerd and it is not on the list, [please edit this page!](https://github.com/linkerd/website/edit/main/linkerd.io/data/extension-list.yaml) diff --git a/linkerd.io/content/2.14/reference/proxy-configuration.md b/linkerd.io/content/2.14/reference/proxy-configuration.md index 80b471f88b..847b0a53d4 100644 --- a/linkerd.io/content/2.14/reference/proxy-configuration.md +++ b/linkerd.io/content/2.14/reference/proxy-configuration.md @@ -11,7 +11,7 @@ configurations of [auto-injected proxies](../features/proxy-injection/). The following is the list of supported annotations: -{{< docs/cli-annotations "inject" >}} +{{< cli-annotations "inject" >}} For example, to update an auto-injected proxy's CPU and memory resources, we insert the appropriate annotations into the `spec.template.metadata.annotations` diff --git a/linkerd.io/content/2.14/tasks/_index.md b/linkerd.io/content/2.14/tasks/_index.md index cfca319184..19a83aee53 100644 --- a/linkerd.io/content/2.14/tasks/_index.md +++ b/linkerd.io/content/2.14/tasks/_index.md @@ -9,4 +9,4 @@ common tasks that you may need to perform when using Linkerd. ## Common Linkerd tasks -{{< docs/section-toc >}} +{{< section-toc >}} diff --git a/linkerd.io/content/2.14/tasks/automatic-failover.md b/linkerd.io/content/2.14/tasks/automatic-failover.md index ba405d784c..10d0862184 100644 --- a/linkerd.io/content/2.14/tasks/automatic-failover.md +++ b/linkerd.io/content/2.14/tasks/automatic-failover.md @@ -15,7 +15,7 @@ Emojivoto application on two Kubernetes clusters and simulating a failure in one cluster. We will see the failover controller shift traffic to the other cluster to ensure the service remains available. -{{< docs/production-note >}} +{{< production-note >}} ## Prerequisites diff --git a/linkerd.io/content/2.14/tasks/automatically-rotating-control-plane-tls-credentials.md b/linkerd.io/content/2.14/tasks/automatically-rotating-control-plane-tls-credentials.md index fb3c874952..425dd65dad 100644 --- a/linkerd.io/content/2.14/tasks/automatically-rotating-control-plane-tls-credentials.md +++ b/linkerd.io/content/2.14/tasks/automatically-rotating-control-plane-tls-credentials.md @@ -27,7 +27,7 @@ with a validity of one year but require manual rotation by the user to prevent expiry. While this setup is convenient for quick start testing, it's not advisable nor recommended for production environments. -{{< docs/production-note >}} +{{< production-note >}} ## Automating Certificate Management with cert-manager and trust-manager @@ -244,18 +244,18 @@ EOF {{< warning >}} The default value of the `rotationPolicy` in the Certificate's `privateKey` -section is dependent on your version of cert-manager. In version 1.17 and -below, the default value was `Never`. With this configuration, cert-manager -**will not** actually rotate the trust anchor: instead, it will update the -validity timestamps but **not** generate a new private key. -**This is definitely not as secure as rotating the private key**. +section is dependent on your version of cert-manager. In version 1.17 and below, +the default value was `Never`. With this configuration, cert-manager **will +not** actually rotate the trust anchor: instead, it will update the validity +timestamps but **not** generate a new private key. **This is definitely not as +secure as rotating the private key**. If you are upgrading cert-manager from version 1.17 or below to version 1.18 or above, be aware that this new default will change the `rotationPolicy` if you are not explicitly setting it in your Certificate resource manifest. -To avoid ambiguity, we recommend always setting `rotationPolicy: Always` for -any certificate that cert-manager is managing. +To avoid ambiguity, we recommend always setting `rotationPolicy: Always` for any +certificate that cert-manager is managing. {{< /warning >}} @@ -360,18 +360,18 @@ EOF {{< warning >}} The default value of the `rotationPolicy` in the Certificate's `privateKey` -section is dependent on your version of cert-manager. In version 1.17 and -below, the default value was `Never`. With this configuration, cert-manager -**will not** actually rotate the trust anchor: instead, it will update the -validity timestamps but **not** generate a new private key. -**This is definitely not as secure as rotating the private key**. +section is dependent on your version of cert-manager. In version 1.17 and below, +the default value was `Never`. With this configuration, cert-manager **will +not** actually rotate the trust anchor: instead, it will update the validity +timestamps but **not** generate a new private key. **This is definitely not as +secure as rotating the private key**. If you are upgrading cert-manager from version 1.17 or below to version 1.18 or above, be aware that this new default will change the `rotationPolicy` if you are not explicitly setting it in your Certificate resource manifest. -To avoid ambiguity, we recommend always setting `rotationPolicy: Always` for -any certificate that cert-manager is managing. +To avoid ambiguity, we recommend always setting `rotationPolicy: Always` for any +certificate that cert-manager is managing. {{< /warning >}} @@ -777,10 +777,10 @@ _requires_ manual intervention, because while cert-manager can handle the hard work of actually rotating the trust anchor, it can't trigger the needed restarts. -This means that the simplest way to handle trust anchor rotation is -to _trigger the rotation manually_ whenever it's convenient for you so that -you can manage the trust bundle and restarts while letting cert-manager manage -the trust anchor certificate. +This means that the simplest way to handle trust anchor rotation is to _trigger +the rotation manually_ whenever it's convenient for you so that you can manage +the trust bundle and restarts while letting cert-manager manage the trust anchor +certificate. The process of actually doing this is straightforward, but again, there are several steps: @@ -830,8 +830,8 @@ kubectl get secret -n cert-manager linkerd-previous-anchor \ | base64 -d | inspect_cert ``` -Verify that the `linkerd-identity-trust-roots` ConfigMap now contains -the Subject keys from both Secrets. +Verify that the `linkerd-identity-trust-roots` ConfigMap now contains the +Subject keys from both Secrets. ```bash kubectl get configmap -n linkerd linkerd-identity-trust-roots \ @@ -858,9 +858,9 @@ This will cause the control plane to pick up the new trust anchor bundle. #### 3. Restart the data plane At this point, you'll need to restart your workloads as well, to force the -proxies to have the new trust anchor bundle. The exact mechanism to do this -will depend on your workloads, but it's often just `kubectl rollout restart` for -each of your application namespaces. +proxies to have the new trust anchor bundle. The exact mechanism to do this will +depend on your workloads, but it's often just `kubectl rollout restart` for each +of your application namespaces. #### 4. Triggering identity issuer rotation @@ -905,10 +905,10 @@ issuer. #### 6. Restart the data plane -Again, you'll need to restart your workloads, to force the -proxies to switch to the new identity issuer signed by the new trust anchor. -The exact mechanism to do this will depend on your workloads, but it's often -just `kubectl rollout restart` for each of your application namespaces. +Again, you'll need to restart your workloads, to force the proxies to switch to +the new identity issuer signed by the new trust anchor. The exact mechanism to +do this will depend on your workloads, but it's often just +`kubectl rollout restart` for each of your application namespaces. #### 7. Remove the old anchor from the trust bundle diff --git a/linkerd.io/content/2.14/tasks/automatically-rotating-webhook-tls-credentials.md b/linkerd.io/content/2.14/tasks/automatically-rotating-webhook-tls-credentials.md index 563014c122..556448912c 100644 --- a/linkerd.io/content/2.14/tasks/automatically-rotating-webhook-tls-credentials.md +++ b/linkerd.io/content/2.14/tasks/automatically-rotating-webhook-tls-credentials.md @@ -22,7 +22,7 @@ This workflow is suitable for most users. However, if you need these webhook certificates to be rotated automatically on a regular basis, it is possible to use cert-manager to automatically manage them. -{{< docs/production-note >}} +{{< production-note >}} ## Install Cert manager diff --git a/linkerd.io/content/2.14/tasks/circuit-breakers.md b/linkerd.io/content/2.14/tasks/circuit-breakers.md index 13425e16dd..d038ccf382 100644 --- a/linkerd.io/content/2.14/tasks/circuit-breakers.md +++ b/linkerd.io/content/2.14/tasks/circuit-breakers.md @@ -13,7 +13,7 @@ improve client success rate when a backend replica is unhealthy. See the [reference documentation](../reference/circuit-breaking/) for more details on how Linkerd implements circuit breaking. -{{< docs/production-note >}} +{{< production-note >}} ## Prerequisites diff --git a/linkerd.io/content/2.14/tasks/customize-install.md b/linkerd.io/content/2.14/tasks/customize-install.md index dc71604c3c..512bb3629d 100644 --- a/linkerd.io/content/2.14/tasks/customize-install.md +++ b/linkerd.io/content/2.14/tasks/customize-install.md @@ -9,7 +9,7 @@ Instead of forking the Linkerd install and upgrade process, `linkerd install` in a consistent way. This allows customization of the install to add functionality specific to installations. -{{< docs/production-note >}} +{{< production-note >}} To get started, save the output of `linkerd install` to a YAML file. This will be the base resource that Kustomize uses to patch and generate what is added to diff --git a/linkerd.io/content/2.14/tasks/exporting-metrics.md b/linkerd.io/content/2.14/tasks/exporting-metrics.md index 877aedf5a2..96fc7f24f0 100644 --- a/linkerd.io/content/2.14/tasks/exporting-metrics.md +++ b/linkerd.io/content/2.14/tasks/exporting-metrics.md @@ -13,7 +13,7 @@ each proxy only provides a portion of the full picture. Instead, a separate tool is used to collect metrics from all proxies and aggregate them together for consumption. -{{< docs/production-note >}} +{{< production-note >}} One easy option is the [linkerd-viz](../features/dashboard/) extension, which will create an on-cluster Prometheus instance as well as dashboards and CLI @@ -74,7 +74,7 @@ metadata: k8s-app: linkerd-prometheus release: monitoring name: linkerd-federate - namespace: {{.Namespace}} + namespace: { { .Namespace } } spec: endpoints: - interval: 30s @@ -94,7 +94,7 @@ spec: jobLabel: app namespaceSelector: matchNames: - - {{.Namespace}} + - { { .Namespace } } selector: matchLabels: component: prometheus diff --git a/linkerd.io/content/2.14/tasks/exposing-dashboard.md b/linkerd.io/content/2.14/tasks/exposing-dashboard.md index fe8cf24afe..0f0d9ef682 100644 --- a/linkerd.io/content/2.14/tasks/exposing-dashboard.md +++ b/linkerd.io/content/2.14/tasks/exposing-dashboard.md @@ -10,7 +10,7 @@ going on, you can expose the dashboard via an ingress. This will also expose Grafana, if you have it linked against Linkerd viz through the `grafana.url` setting. -{{< docs/toc >}} +{{< toc >}} ## Nginx diff --git a/linkerd.io/content/2.14/tasks/external-prometheus.md b/linkerd.io/content/2.14/tasks/external-prometheus.md index c663e92c17..1ee6994f1a 100644 --- a/linkerd.io/content/2.14/tasks/external-prometheus.md +++ b/linkerd.io/content/2.14/tasks/external-prometheus.md @@ -12,7 +12,7 @@ both the control plane as well as the proxy's metrics in a format that is consumable both by a user as well as Linkerd control plane components like web, etc. -{{< docs/production-note >}} +{{< production-note >}} There are two important points to tackle here. diff --git a/linkerd.io/content/2.14/tasks/flagger.md b/linkerd.io/content/2.14/tasks/flagger.md index 3f775f9b7a..b2ac2034cb 100644 --- a/linkerd.io/content/2.14/tasks/flagger.md +++ b/linkerd.io/content/2.14/tasks/flagger.md @@ -23,7 +23,7 @@ tools: [Flagger](https://flagger.app/) and metrics and request routing together in a control loop, allowing for fully-automated, metrics-aware canary deployments. -{{< docs/production-note >}} +{{< production-note >}} ## Prerequisites diff --git a/linkerd.io/content/2.14/tasks/generate-certificates.md b/linkerd.io/content/2.14/tasks/generate-certificates.md index 35013ac056..33dd6751d1 100644 --- a/linkerd.io/content/2.14/tasks/generate-certificates.md +++ b/linkerd.io/content/2.14/tasks/generate-certificates.md @@ -23,7 +23,7 @@ algorithm which is the default for `step`. To generate ECDSA P-256 certificates with openssl, you can use the `openssl ecparam -name prime256v1` command. In this tutorial, we'll walk you through how to to use the `step` CLI to do this. -{{< docs/production-note >}} +{{< production-note >}} ## Generating the certificates with `step` diff --git a/linkerd.io/content/2.14/tasks/gitops.md b/linkerd.io/content/2.14/tasks/gitops.md index 0a36fe704a..d07530d7b2 100644 --- a/linkerd.io/content/2.14/tasks/gitops.md +++ b/linkerd.io/content/2.14/tasks/gitops.md @@ -12,7 +12,7 @@ This guide will show you how to set up [Argo CD](https://argoproj.github.io/argo-cd/) to manage the installation and upgrade of Linkerd using a GitOps workflow. -{{< docs/production-note >}} +{{< production-note >}} Specifically, this guide provides instructions on how to securely generate and manage Linkerd's mTLS private keys and certificates using diff --git a/linkerd.io/content/2.14/tasks/grafana.md b/linkerd.io/content/2.14/tasks/grafana.md index b37b01af71..a30d3792e5 100644 --- a/linkerd.io/content/2.14/tasks/grafana.md +++ b/linkerd.io/content/2.14/tasks/grafana.md @@ -13,7 +13,7 @@ First, you need to install Grafana from a variety of possible sources, and then load the suite of Grafana dashboards that have been pre-configured to consume the metrics exposed by Linkerd. -{{< docs/production-note >}} +{{< production-note >}} ## Install Prometheus diff --git a/linkerd.io/content/2.14/tasks/install-helm.md b/linkerd.io/content/2.14/tasks/install-helm.md index c251132fe1..5df22b05c2 100644 --- a/linkerd.io/content/2.14/tasks/install-helm.md +++ b/linkerd.io/content/2.14/tasks/install-helm.md @@ -6,7 +6,7 @@ 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. -{{< docs/production-note >}} +{{< production-note >}} ## Prerequisite: generate identity certificates diff --git a/linkerd.io/content/2.14/tasks/install.md b/linkerd.io/content/2.14/tasks/install.md index a00c44fe4a..0923182020 100644 --- a/linkerd.io/content/2.14/tasks/install.md +++ b/linkerd.io/content/2.14/tasks/install.md @@ -11,7 +11,7 @@ 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. -{{< docs/production-note >}} +{{< production-note >}} In either case, we recommend installing the CLI itself so that you can validate the success of the installation. See the diff --git a/linkerd.io/content/2.14/tasks/installing-multicluster.md b/linkerd.io/content/2.14/tasks/installing-multicluster.md index 1b6309922c..f2cf276cb9 100644 --- a/linkerd.io/content/2.14/tasks/installing-multicluster.md +++ b/linkerd.io/content/2.14/tasks/installing-multicluster.md @@ -9,7 +9,7 @@ through this installation and configuration as well as common problems that you may encounter. For a detailed walkthrough and explanation of what's going on, check out [getting started](multicluster/). -{{< docs/production-note >}} +{{< production-note >}} ## Requirements diff --git a/linkerd.io/content/2.14/tasks/setting-up-service-profiles.md b/linkerd.io/content/2.14/tasks/setting-up-service-profiles.md index 704be61323..8108dcbe90 100644 --- a/linkerd.io/content/2.14/tasks/setting-up-service-profiles.md +++ b/linkerd.io/content/2.14/tasks/setting-up-service-profiles.md @@ -56,7 +56,7 @@ demo. There are a couple different ways to use `linkerd profile` to create service profiles. -{{< docs/toc >}} +{{< toc >}} Requests which have been associated with a route will have a `rt_route` annotation. To manually verify if the requests are being associated correctly, diff --git a/linkerd.io/content/2.14/tasks/traffic-shifting.md b/linkerd.io/content/2.14/tasks/traffic-shifting.md index cfcb372c4d..fc57d0795b 100644 --- a/linkerd.io/content/2.14/tasks/traffic-shifting.md +++ b/linkerd.io/content/2.14/tasks/traffic-shifting.md @@ -16,7 +16,7 @@ Linkerd natively supports. While certain integrations such as [Flagger](flagger/) rely on the SMI and `TrafficSplit` approach, using `HTTPRoute` is the preferred method going forward. -{{< docs/production-note >}} +{{< production-note >}} ## Prerequisites diff --git a/linkerd.io/content/2.14/tasks/using-the-debug-container.md b/linkerd.io/content/2.14/tasks/using-the-debug-container.md index 6e40eecd1a..ff7a10bce9 100644 --- a/linkerd.io/content/2.14/tasks/using-the-debug-container.md +++ b/linkerd.io/content/2.14/tasks/using-the-debug-container.md @@ -19,7 +19,7 @@ time. For convenience, the `linkerd inject` command provides an adding this annotation to a pre-existing pod will not work. It must be present at pod _creation_ time.) -{{< docs/production-note >}} +{{< production-note >}} The debug sidecar image contains [`tshark`](https://www.wireshark.org/docs/man-pages/tshark.html), `tcpdump`, diff --git a/linkerd.io/content/2.15/common-errors/_index.md b/linkerd.io/content/2.15/common-errors/_index.md index 68771bf652..a57718ba55 100644 --- a/linkerd.io/content/2.15/common-errors/_index.md +++ b/linkerd.io/content/2.15/common-errors/_index.md @@ -18,4 +18,4 @@ this command is. ## Common Errors -{{< docs/section-toc >}} +{{< section-toc >}} diff --git a/linkerd.io/content/2.15/features/_index.md b/linkerd.io/content/2.15/features/_index.md index cf341d4e7e..3eebfe67f4 100644 --- a/linkerd.io/content/2.15/features/_index.md +++ b/linkerd.io/content/2.15/features/_index.md @@ -11,4 +11,4 @@ please see the [Linkerd task docs](../tasks/). For a reference, see the ## Linkerd's features -{{< docs/section-toc >}} +{{< section-toc >}} diff --git a/linkerd.io/content/2.15/getting-started/_index.md b/linkerd.io/content/2.15/getting-started/_index.md index e0fc522542..8bd6ebe324 100644 --- a/linkerd.io/content/2.15/getting-started/_index.md +++ b/linkerd.io/content/2.15/getting-started/_index.md @@ -16,7 +16,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. -{{< docs/edge-note >}} +{{< edge-note >}} ## Step 0: Setup diff --git a/linkerd.io/content/2.15/reference/_index.md b/linkerd.io/content/2.15/reference/_index.md index f2045c2b56..c066e0b8ee 100644 --- a/linkerd.io/content/2.15/reference/_index.md +++ b/linkerd.io/content/2.15/reference/_index.md @@ -3,4 +3,4 @@ title: Reference weight: 5 --- -{{< docs/section-toc >}} +{{< section-toc >}} diff --git a/linkerd.io/content/2.15/reference/cli/_index.md b/linkerd.io/content/2.15/reference/cli/_index.md index ee36df6287..4d4170ffa7 100644 --- a/linkerd.io/content/2.15/reference/cli/_index.md +++ b/linkerd.io/content/2.15/reference/cli/_index.md @@ -9,10 +9,10 @@ detailed metrics for how your service is performing. As reference, check out the commands below: -{{< docs/cli-commands >}} +{{< cli-commands >}} ## Global flags The following flags are available for _all_ linkerd CLI commands: -{{< docs/cli-global-flags >}} +{{< cli-global-flags >}} diff --git a/linkerd.io/content/2.15/reference/cli/authz.md b/linkerd.io/content/2.15/reference/cli/authz.md index 2a6e55b55d..22df19a41c 100644 --- a/linkerd.io/content/2.15/reference/cli/authz.md +++ b/linkerd.io/content/2.15/reference/cli/authz.md @@ -2,10 +2,10 @@ title: authz --- -{{< docs/cli-description "authz" >}} +{{< cli-description "authz" >}} Check out the [Authorization Policy](../authorization-policy/) and [Restricting Access to Services](../../tasks/restricting-access/) documentation for all the details about authorization policy in Linkerd. -{{< docs/cli-flags "authz" >}} +{{< cli-flags "authz" >}} diff --git a/linkerd.io/content/2.15/reference/cli/check.md b/linkerd.io/content/2.15/reference/cli/check.md index 7cd61cd237..0c18a5da03 100644 --- a/linkerd.io/content/2.15/reference/cli/check.md +++ b/linkerd.io/content/2.15/reference/cli/check.md @@ -2,12 +2,12 @@ title: check --- -{{< docs/cli-description "check" >}} +{{< cli-description "check" >}} Take a look at the [troubleshooting](../../tasks/troubleshooting/) documentation for a full list of all the possible checks, what they do and how to fix them. -{{< docs/cli-examples "check" >}} +{{< cli-examples "check" >}} ## Example output @@ -53,4 +53,4 @@ control-plane-version Status check results are √ ``` -{{< docs/cli-flags "check" >}} +{{< cli-flags "check" >}} diff --git a/linkerd.io/content/2.15/reference/cli/completion.md b/linkerd.io/content/2.15/reference/cli/completion.md index 40e8438b72..6007a47fa5 100644 --- a/linkerd.io/content/2.15/reference/cli/completion.md +++ b/linkerd.io/content/2.15/reference/cli/completion.md @@ -2,8 +2,8 @@ title: completion --- -{{< docs/cli-description "completion" >}} +{{< cli-description "completion" >}} -{{< docs/cli-examples "completion" >}} +{{< cli-examples "completion" >}} -{{< docs/cli-flags "completion" >}} +{{< cli-flags "completion" >}} diff --git a/linkerd.io/content/2.15/reference/cli/diagnostics.md b/linkerd.io/content/2.15/reference/cli/diagnostics.md index ffa45c39be..8e4e36d234 100644 --- a/linkerd.io/content/2.15/reference/cli/diagnostics.md +++ b/linkerd.io/content/2.15/reference/cli/diagnostics.md @@ -2,44 +2,44 @@ title: diagnostics --- -{{< docs/cli-description "diagnostics" >}} +{{< cli-description "diagnostics" >}} -{{< docs/cli-examples "diagnostics" >}} +{{< cli-examples "diagnostics" >}} -{{< docs/cli-flags "diagnostics" >}} +{{< cli-flags "diagnostics" >}} ## Subcommands -{{< docs/cli-subcommands "diagnostics" >}} +{{< cli-subcommands "diagnostics" >}} ### controller-metrics -{{< docs/cli-description "diagnostics controller-metrics" >}} +{{< cli-description "diagnostics controller-metrics" >}} -{{< docs/cli-examples "diagnostics controller-metrics" >}} +{{< cli-examples "diagnostics controller-metrics" >}} -{{< docs/cli-flags "diagnostics controller-metrics" >}} +{{< cli-flags "diagnostics controller-metrics" >}} ### endpoints -{{< docs/cli-description "diagnostics endpoints" >}} +{{< cli-description "diagnostics endpoints" >}} -{{< docs/cli-examples "diagnostics endpoints" >}} +{{< cli-examples "diagnostics endpoints" >}} -{{< docs/cli-flags "diagnostics endpoints" >}} +{{< cli-flags "diagnostics endpoints" >}} ### install-sp -{{< docs/cli-description "diagnostics install-sp" >}} +{{< cli-description "diagnostics install-sp" >}} -{{< docs/cli-examples "diagnostics install-sp" >}} +{{< cli-examples "diagnostics install-sp" >}} -{{< docs/cli-flags "diagnostics install-sp" >}} +{{< cli-flags "diagnostics install-sp" >}} ### proxy-metrics -{{< docs/cli-description "diagnostics proxy-metrics" >}} +{{< cli-description "diagnostics proxy-metrics" >}} -{{< docs/cli-examples "diagnostics proxy-metrics" >}} +{{< cli-examples "diagnostics proxy-metrics" >}} -{{< docs/cli-flags "diagnostics proxy-metrics" >}} +{{< cli-flags "diagnostics proxy-metrics" >}} diff --git a/linkerd.io/content/2.15/reference/cli/identity.md b/linkerd.io/content/2.15/reference/cli/identity.md index 576d175930..c7962e8027 100644 --- a/linkerd.io/content/2.15/reference/cli/identity.md +++ b/linkerd.io/content/2.15/reference/cli/identity.md @@ -2,8 +2,8 @@ title: identity --- -{{< docs/cli-description "identity" >}} +{{< cli-description "identity" >}} -{{< docs/cli-examples "identity" >}} +{{< cli-examples "identity" >}} -{{< docs/cli-flags "identity" >}} +{{< cli-flags "identity" >}} diff --git a/linkerd.io/content/2.15/reference/cli/inject.md b/linkerd.io/content/2.15/reference/cli/inject.md index aafdacdb29..92fc0ca3cb 100644 --- a/linkerd.io/content/2.15/reference/cli/inject.md +++ b/linkerd.io/content/2.15/reference/cli/inject.md @@ -19,6 +19,6 @@ Alternatively, this command can also perform the full injection purely on the client side, by enabling with the `--manual` flag. (Prior to Linkerd 2.4, this was the default behavior.) -{{< docs/cli-examples "inject" >}} +{{< cli-examples "inject" >}} -{{< docs/cli-flags "inject" >}} +{{< cli-flags "inject" >}} diff --git a/linkerd.io/content/2.15/reference/cli/install-cni.md b/linkerd.io/content/2.15/reference/cli/install-cni.md index c7c457a6f1..d0577e3d3b 100644 --- a/linkerd.io/content/2.15/reference/cli/install-cni.md +++ b/linkerd.io/content/2.15/reference/cli/install-cni.md @@ -2,8 +2,8 @@ title: install-cni --- -{{< docs/cli-description "install-cni" >}} +{{< cli-description "install-cni" >}} -{{< docs/cli-examples "install-cni" >}} +{{< cli-examples "install-cni" >}} -{{< docs/cli-flags "install-cni" >}} +{{< cli-flags "install-cni" >}} diff --git a/linkerd.io/content/2.15/reference/cli/install.md b/linkerd.io/content/2.15/reference/cli/install.md index ab0dde824e..5fea59d7eb 100644 --- a/linkerd.io/content/2.15/reference/cli/install.md +++ b/linkerd.io/content/2.15/reference/cli/install.md @@ -2,11 +2,11 @@ title: install --- -{{< docs/cli-description "install" >}} +{{< cli-description "install" >}} For further details on how to install Linkerd onto your own cluster, check out the [install documentation](../../tasks/install/). -{{< docs/cli-examples "install" >}} +{{< cli-examples "install" >}} -{{< docs/cli-flags "install" >}} +{{< cli-flags "install" >}} diff --git a/linkerd.io/content/2.15/reference/cli/jaeger.md b/linkerd.io/content/2.15/reference/cli/jaeger.md index 1301361532..820ad6489c 100644 --- a/linkerd.io/content/2.15/reference/cli/jaeger.md +++ b/linkerd.io/content/2.15/reference/cli/jaeger.md @@ -2,52 +2,52 @@ title: jaeger --- -{{< docs/cli-description "jaeger" >}} +{{< cli-description "jaeger" >}} -{{< docs/cli-examples "jaeger" >}} +{{< cli-examples "jaeger" >}} -{{< docs/cli-flags "jaeger" >}} +{{< cli-flags "jaeger" >}} ## Subcommands -{{< docs/cli-subcommands "jaeger" >}} +{{< cli-subcommands "jaeger" >}} ### check -{{< docs/cli-description "jaeger check" >}} +{{< cli-description "jaeger check" >}} -{{< docs/cli-examples "jaeger check" >}} +{{< cli-examples "jaeger check" >}} -{{< docs/cli-flags "jaeger check" >}} +{{< cli-flags "jaeger check" >}} ### dashboard -{{< docs/cli-description "jaeger dashboard" >}} +{{< cli-description "jaeger dashboard" >}} -{{< docs/cli-examples "jaeger dashboard" >}} +{{< cli-examples "jaeger dashboard" >}} -{{< docs/cli-flags "jaeger dashboard" >}} +{{< cli-flags "jaeger dashboard" >}} ### install -{{< docs/cli-description "jaeger install" >}} +{{< cli-description "jaeger install" >}} -{{< docs/cli-examples "jaeger install" >}} +{{< cli-examples "jaeger install" >}} -{{< docs/cli-flags "jaeger install" >}} +{{< cli-flags "jaeger install" >}} ### list -{{< docs/cli-description "jaeger list" >}} +{{< cli-description "jaeger list" >}} -{{< docs/cli-examples "jaeger list" >}} +{{< cli-examples "jaeger list" >}} -{{< docs/cli-flags "jaeger list" >}} +{{< cli-flags "jaeger list" >}} ### uninstall -{{< docs/cli-description "jaeger uninstall" >}} +{{< cli-description "jaeger uninstall" >}} -{{< docs/cli-examples "jaeger uninstall" >}} +{{< cli-examples "jaeger uninstall" >}} -{{< docs/cli-flags "jaeger uninstall" >}} +{{< cli-flags "jaeger uninstall" >}} diff --git a/linkerd.io/content/2.15/reference/cli/multicluster.md b/linkerd.io/content/2.15/reference/cli/multicluster.md index 519ba5b57e..72c9ac0a4f 100644 --- a/linkerd.io/content/2.15/reference/cli/multicluster.md +++ b/linkerd.io/content/2.15/reference/cli/multicluster.md @@ -2,68 +2,68 @@ title: multicluster --- -{{< docs/cli-description "multicluster" >}} +{{< cli-description "multicluster" >}} -{{< docs/cli-examples "multicluster" >}} +{{< cli-examples "multicluster" >}} -{{< docs/cli-flags "multicluster" >}} +{{< cli-flags "multicluster" >}} ## Subcommands -{{< docs/cli-subcommands "multicluster" >}} +{{< cli-subcommands "multicluster" >}} ### allow -{{< docs/cli-description "multicluster allow" >}} +{{< cli-description "multicluster allow" >}} -{{< docs/cli-examples "multicluster allow" >}} +{{< cli-examples "multicluster allow" >}} -{{< docs/cli-flags "multicluster allow" >}} +{{< cli-flags "multicluster allow" >}} ### check -{{< docs/cli-description "multicluster check" >}} +{{< cli-description "multicluster check" >}} -{{< docs/cli-examples "multicluster check" >}} +{{< cli-examples "multicluster check" >}} -{{< docs/cli-flags "multicluster check" >}} +{{< cli-flags "multicluster check" >}} ### gateways -{{< docs/cli-description "multicluster gateways" >}} +{{< cli-description "multicluster gateways" >}} -{{< docs/cli-examples "multicluster gateways" >}} +{{< cli-examples "multicluster gateways" >}} -{{< docs/cli-flags "multicluster gateways" >}} +{{< cli-flags "multicluster gateways" >}} ### install -{{< docs/cli-description "multicluster install" >}} +{{< cli-description "multicluster install" >}} -{{< docs/cli-examples "multicluster install" >}} +{{< cli-examples "multicluster install" >}} -{{< docs/cli-flags "multicluster install" >}} +{{< cli-flags "multicluster install" >}} ### link -{{< docs/cli-description "multicluster link" >}} +{{< cli-description "multicluster link" >}} -{{< docs/cli-examples "multicluster link" >}} +{{< cli-examples "multicluster link" >}} -{{< docs/cli-flags "multicluster link" >}} +{{< cli-flags "multicluster link" >}} ### uninstall -{{< docs/cli-description "multicluster uninstall" >}} +{{< cli-description "multicluster uninstall" >}} -{{< docs/cli-examples "multicluster uninstall" >}} +{{< cli-examples "multicluster uninstall" >}} -{{< docs/cli-flags "multicluster uninstall" >}} +{{< cli-flags "multicluster uninstall" >}} ### unlink -{{< docs/cli-description "multicluster unlink" >}} +{{< cli-description "multicluster unlink" >}} -{{< docs/cli-examples "multicluster unlink" >}} +{{< cli-examples "multicluster unlink" >}} -{{< docs/cli-flags "multicluster unlink" >}} +{{< cli-flags "multicluster unlink" >}} diff --git a/linkerd.io/content/2.15/reference/cli/profile.md b/linkerd.io/content/2.15/reference/cli/profile.md index 5cc919b876..bf2545c313 100644 --- a/linkerd.io/content/2.15/reference/cli/profile.md +++ b/linkerd.io/content/2.15/reference/cli/profile.md @@ -2,12 +2,12 @@ title: profile --- -{{< docs/cli-description "profile" >}} +{{< cli-description "profile" >}} Check out the [service profile](../../features/service-profiles/) documentation for more details on what this command does and what you can do with service profiles. -{{< docs/cli-examples "profile" >}} +{{< cli-examples "profile" >}} -{{< docs/cli-flags "profile" >}} +{{< cli-flags "profile" >}} diff --git a/linkerd.io/content/2.15/reference/cli/prune.md b/linkerd.io/content/2.15/reference/cli/prune.md index 68675991ed..1ec604588f 100644 --- a/linkerd.io/content/2.15/reference/cli/prune.md +++ b/linkerd.io/content/2.15/reference/cli/prune.md @@ -2,8 +2,8 @@ title: prune --- -{{< docs/cli-description "prune" >}} +{{< cli-description "prune" >}} -{{< docs/cli-examples "prune" >}} +{{< cli-examples "prune" >}} -{{< docs/cli-flags "prune" >}} +{{< cli-flags "prune" >}} diff --git a/linkerd.io/content/2.15/reference/cli/uninject.md b/linkerd.io/content/2.15/reference/cli/uninject.md index 9ad619698a..6f43c3cf0a 100644 --- a/linkerd.io/content/2.15/reference/cli/uninject.md +++ b/linkerd.io/content/2.15/reference/cli/uninject.md @@ -2,8 +2,8 @@ title: uninject --- -{{< docs/cli-description "uninject" >}} +{{< cli-description "uninject" >}} -{{< docs/cli-examples "uninject" >}} +{{< cli-examples "uninject" >}} -{{< docs/cli-flags "uninject" >}} +{{< cli-flags "uninject" >}} diff --git a/linkerd.io/content/2.15/reference/cli/uninstall.md b/linkerd.io/content/2.15/reference/cli/uninstall.md index d5e00031ed..d62dd11612 100644 --- a/linkerd.io/content/2.15/reference/cli/uninstall.md +++ b/linkerd.io/content/2.15/reference/cli/uninstall.md @@ -2,8 +2,8 @@ title: uninstall --- -{{< docs/cli-description "uninstall" >}} +{{< cli-description "uninstall" >}} -{{< docs/cli-examples "uninstall" >}} +{{< cli-examples "uninstall" >}} -{{< docs/cli-flags "uninstall" >}} +{{< cli-flags "uninstall" >}} diff --git a/linkerd.io/content/2.15/reference/cli/upgrade.md b/linkerd.io/content/2.15/reference/cli/upgrade.md index c4422b57c9..70b3296d8a 100644 --- a/linkerd.io/content/2.15/reference/cli/upgrade.md +++ b/linkerd.io/content/2.15/reference/cli/upgrade.md @@ -2,8 +2,8 @@ title: upgrade --- -{{< docs/cli-description "upgrade" >}} +{{< cli-description "upgrade" >}} -{{< docs/cli-examples "upgrade" >}} +{{< cli-examples "upgrade" >}} -{{< docs/cli-flags "upgrade" >}} +{{< cli-flags "upgrade" >}} diff --git a/linkerd.io/content/2.15/reference/cli/version.md b/linkerd.io/content/2.15/reference/cli/version.md index 159f0b2f65..d31d7b18e6 100644 --- a/linkerd.io/content/2.15/reference/cli/version.md +++ b/linkerd.io/content/2.15/reference/cli/version.md @@ -2,8 +2,8 @@ title: version --- -{{< docs/cli-description "version" >}} +{{< cli-description "version" >}} -{{< docs/cli-examples "version" >}} +{{< cli-examples "version" >}} -{{< docs/cli-flags "version" >}} +{{< cli-flags "version" >}} diff --git a/linkerd.io/content/2.15/reference/cli/viz.md b/linkerd.io/content/2.15/reference/cli/viz.md index 2477e875ba..9a11e245d9 100644 --- a/linkerd.io/content/2.15/reference/cli/viz.md +++ b/linkerd.io/content/2.15/reference/cli/viz.md @@ -2,50 +2,50 @@ title: viz --- -{{< docs/cli-description "viz" >}} +{{< cli-description "viz" >}} -{{< docs/cli-examples "viz" >}} +{{< cli-examples "viz" >}} -{{< docs/cli-flags "viz" >}} +{{< cli-flags "viz" >}} ## Subcommands -{{< docs/cli-subcommands "viz" >}} +{{< cli-subcommands "viz" >}} ### allow-scrapes -{{< docs/cli-description "viz allow-scrapes" >}} +{{< cli-description "viz allow-scrapes" >}} -{{< docs/cli-examples "viz allow-scrapes" >}} +{{< cli-examples "viz allow-scrapes" >}} -{{< docs/cli-flags "viz allow-scrapes" >}} +{{< cli-flags "viz allow-scrapes" >}} ### authz -{{< docs/cli-description "viz authz" >}} +{{< cli-description "viz authz" >}} -{{< docs/cli-examples "viz authz" >}} +{{< cli-examples "viz authz" >}} -{{< docs/cli-flags "viz authz" >}} +{{< cli-flags "viz authz" >}} ### check -{{< docs/cli-description "viz check" >}} +{{< cli-description "viz check" >}} -{{< docs/cli-examples "viz check" >}} +{{< cli-examples "viz check" >}} -{{< docs/cli-flags "viz check" >}} +{{< cli-flags "viz check" >}} ### dashboard -{{< docs/cli-description "viz dashboard" >}} +{{< cli-description "viz dashboard" >}} Check out the [architecture](../architecture/#dashboard) docs for a more thorough explanation of what this command does. -{{< docs/cli-examples "viz dashboard" >}} +{{< cli-examples "viz dashboard" >}} -{{< docs/cli-flags "viz dashboard" >}} +{{< cli-flags "viz dashboard" >}} (\*) You'll need to tweak the dashboard's `enforced-host` parameter with this value, as explained in @@ -53,35 +53,35 @@ value, as explained in ### edges -{{< docs/cli-description "viz edges" >}} +{{< cli-description "viz edges" >}} -{{< docs/cli-examples "viz edges" >}} +{{< cli-examples "viz edges" >}} -{{< docs/cli-flags "viz edges" >}} +{{< cli-flags "viz edges" >}} ### install -{{< docs/cli-description "viz install" >}} +{{< cli-description "viz install" >}} -{{< docs/cli-examples "viz install" >}} +{{< cli-examples "viz install" >}} -{{< docs/cli-flags "viz install" >}} +{{< cli-flags "viz install" >}} ### list -{{< docs/cli-description "viz list" >}} +{{< cli-description "viz list" >}} -{{< docs/cli-examples "viz list" >}} +{{< cli-examples "viz list" >}} -{{< docs/cli-flags "viz list" >}} +{{< cli-flags "viz list" >}} ### profile -{{< docs/cli-description "viz profile" >}} +{{< cli-description "viz profile" >}} -{{< docs/cli-examples "viz profile" >}} +{{< cli-examples "viz profile" >}} -{{< docs/cli-flags "viz profile" >}} +{{< cli-flags "viz profile" >}} ### routes @@ -140,38 +140,38 @@ information. Because retries are only performed on the _outbound_ (client) side, the `-o wide` flag can only be used when the `--to` flag is specified. -{{< docs/cli-examples "viz routes" >}} +{{< cli-examples "viz routes" >}} -{{< docs/cli-flags "viz routes" >}} +{{< cli-flags "viz routes" >}} ### stat -{{< docs/cli-description "viz stat" >}} +{{< cli-description "viz stat" >}} -{{< docs/cli-examples "viz stat" >}} +{{< cli-examples "viz stat" >}} -{{< docs/cli-flags "viz stat" >}} +{{< cli-flags "viz stat" >}} ### tap -{{< docs/cli-description "viz tap" >}} +{{< cli-description "viz tap" >}} -{{< docs/cli-examples "viz tap" >}} +{{< cli-examples "viz tap" >}} -{{< docs/cli-flags "viz tap" >}} +{{< cli-flags "viz tap" >}} ### top -{{< docs/cli-description "viz top" >}} +{{< cli-description "viz top" >}} -{{< docs/cli-examples "viz top" >}} +{{< cli-examples "viz top" >}} -{{< docs/cli-flags "viz top" >}} +{{< cli-flags "viz top" >}} ### uninstall -{{< docs/cli-description "viz uninstall" >}} +{{< cli-description "viz uninstall" >}} -{{< docs/cli-examples "viz uninstall" >}} +{{< cli-examples "viz uninstall" >}} -{{< docs/cli-flags "viz uninstall" >}} +{{< cli-flags "viz uninstall" >}} diff --git a/linkerd.io/content/2.15/reference/extension-list.md b/linkerd.io/content/2.15/reference/extension-list.md index e6bdad697e..32afc3fd09 100644 --- a/linkerd.io/content/2.15/reference/extension-list.md +++ b/linkerd.io/content/2.15/reference/extension-list.md @@ -9,7 +9,7 @@ Linkerd provides a mix of built-in and third-party [extensions](../tasks/extensions/) to add additional functionality to the base installation. The following is the list of known extensions: -{{< docs/extensions >}} +{{< extensions >}} If you have an extension for Linkerd and it is not on the list, [please edit this page!](https://github.com/linkerd/website/edit/main/linkerd.io/data/extension-list.yaml) diff --git a/linkerd.io/content/2.15/reference/proxy-configuration.md b/linkerd.io/content/2.15/reference/proxy-configuration.md index 80b471f88b..847b0a53d4 100644 --- a/linkerd.io/content/2.15/reference/proxy-configuration.md +++ b/linkerd.io/content/2.15/reference/proxy-configuration.md @@ -11,7 +11,7 @@ configurations of [auto-injected proxies](../features/proxy-injection/). The following is the list of supported annotations: -{{< docs/cli-annotations "inject" >}} +{{< cli-annotations "inject" >}} For example, to update an auto-injected proxy's CPU and memory resources, we insert the appropriate annotations into the `spec.template.metadata.annotations` diff --git a/linkerd.io/content/2.15/tasks/_index.md b/linkerd.io/content/2.15/tasks/_index.md index cfca319184..19a83aee53 100644 --- a/linkerd.io/content/2.15/tasks/_index.md +++ b/linkerd.io/content/2.15/tasks/_index.md @@ -9,4 +9,4 @@ common tasks that you may need to perform when using Linkerd. ## Common Linkerd tasks -{{< docs/section-toc >}} +{{< section-toc >}} diff --git a/linkerd.io/content/2.15/tasks/automatic-failover.md b/linkerd.io/content/2.15/tasks/automatic-failover.md index ba405d784c..10d0862184 100644 --- a/linkerd.io/content/2.15/tasks/automatic-failover.md +++ b/linkerd.io/content/2.15/tasks/automatic-failover.md @@ -15,7 +15,7 @@ Emojivoto application on two Kubernetes clusters and simulating a failure in one cluster. We will see the failover controller shift traffic to the other cluster to ensure the service remains available. -{{< docs/production-note >}} +{{< production-note >}} ## Prerequisites diff --git a/linkerd.io/content/2.15/tasks/automatically-rotating-control-plane-tls-credentials.md b/linkerd.io/content/2.15/tasks/automatically-rotating-control-plane-tls-credentials.md index fb3c874952..425dd65dad 100644 --- a/linkerd.io/content/2.15/tasks/automatically-rotating-control-plane-tls-credentials.md +++ b/linkerd.io/content/2.15/tasks/automatically-rotating-control-plane-tls-credentials.md @@ -27,7 +27,7 @@ with a validity of one year but require manual rotation by the user to prevent expiry. While this setup is convenient for quick start testing, it's not advisable nor recommended for production environments. -{{< docs/production-note >}} +{{< production-note >}} ## Automating Certificate Management with cert-manager and trust-manager @@ -244,18 +244,18 @@ EOF {{< warning >}} The default value of the `rotationPolicy` in the Certificate's `privateKey` -section is dependent on your version of cert-manager. In version 1.17 and -below, the default value was `Never`. With this configuration, cert-manager -**will not** actually rotate the trust anchor: instead, it will update the -validity timestamps but **not** generate a new private key. -**This is definitely not as secure as rotating the private key**. +section is dependent on your version of cert-manager. In version 1.17 and below, +the default value was `Never`. With this configuration, cert-manager **will +not** actually rotate the trust anchor: instead, it will update the validity +timestamps but **not** generate a new private key. **This is definitely not as +secure as rotating the private key**. If you are upgrading cert-manager from version 1.17 or below to version 1.18 or above, be aware that this new default will change the `rotationPolicy` if you are not explicitly setting it in your Certificate resource manifest. -To avoid ambiguity, we recommend always setting `rotationPolicy: Always` for -any certificate that cert-manager is managing. +To avoid ambiguity, we recommend always setting `rotationPolicy: Always` for any +certificate that cert-manager is managing. {{< /warning >}} @@ -360,18 +360,18 @@ EOF {{< warning >}} The default value of the `rotationPolicy` in the Certificate's `privateKey` -section is dependent on your version of cert-manager. In version 1.17 and -below, the default value was `Never`. With this configuration, cert-manager -**will not** actually rotate the trust anchor: instead, it will update the -validity timestamps but **not** generate a new private key. -**This is definitely not as secure as rotating the private key**. +section is dependent on your version of cert-manager. In version 1.17 and below, +the default value was `Never`. With this configuration, cert-manager **will +not** actually rotate the trust anchor: instead, it will update the validity +timestamps but **not** generate a new private key. **This is definitely not as +secure as rotating the private key**. If you are upgrading cert-manager from version 1.17 or below to version 1.18 or above, be aware that this new default will change the `rotationPolicy` if you are not explicitly setting it in your Certificate resource manifest. -To avoid ambiguity, we recommend always setting `rotationPolicy: Always` for -any certificate that cert-manager is managing. +To avoid ambiguity, we recommend always setting `rotationPolicy: Always` for any +certificate that cert-manager is managing. {{< /warning >}} @@ -777,10 +777,10 @@ _requires_ manual intervention, because while cert-manager can handle the hard work of actually rotating the trust anchor, it can't trigger the needed restarts. -This means that the simplest way to handle trust anchor rotation is -to _trigger the rotation manually_ whenever it's convenient for you so that -you can manage the trust bundle and restarts while letting cert-manager manage -the trust anchor certificate. +This means that the simplest way to handle trust anchor rotation is to _trigger +the rotation manually_ whenever it's convenient for you so that you can manage +the trust bundle and restarts while letting cert-manager manage the trust anchor +certificate. The process of actually doing this is straightforward, but again, there are several steps: @@ -830,8 +830,8 @@ kubectl get secret -n cert-manager linkerd-previous-anchor \ | base64 -d | inspect_cert ``` -Verify that the `linkerd-identity-trust-roots` ConfigMap now contains -the Subject keys from both Secrets. +Verify that the `linkerd-identity-trust-roots` ConfigMap now contains the +Subject keys from both Secrets. ```bash kubectl get configmap -n linkerd linkerd-identity-trust-roots \ @@ -858,9 +858,9 @@ This will cause the control plane to pick up the new trust anchor bundle. #### 3. Restart the data plane At this point, you'll need to restart your workloads as well, to force the -proxies to have the new trust anchor bundle. The exact mechanism to do this -will depend on your workloads, but it's often just `kubectl rollout restart` for -each of your application namespaces. +proxies to have the new trust anchor bundle. The exact mechanism to do this will +depend on your workloads, but it's often just `kubectl rollout restart` for each +of your application namespaces. #### 4. Triggering identity issuer rotation @@ -905,10 +905,10 @@ issuer. #### 6. Restart the data plane -Again, you'll need to restart your workloads, to force the -proxies to switch to the new identity issuer signed by the new trust anchor. -The exact mechanism to do this will depend on your workloads, but it's often -just `kubectl rollout restart` for each of your application namespaces. +Again, you'll need to restart your workloads, to force the proxies to switch to +the new identity issuer signed by the new trust anchor. The exact mechanism to +do this will depend on your workloads, but it's often just +`kubectl rollout restart` for each of your application namespaces. #### 7. Remove the old anchor from the trust bundle diff --git a/linkerd.io/content/2.15/tasks/automatically-rotating-webhook-tls-credentials.md b/linkerd.io/content/2.15/tasks/automatically-rotating-webhook-tls-credentials.md index 563014c122..556448912c 100644 --- a/linkerd.io/content/2.15/tasks/automatically-rotating-webhook-tls-credentials.md +++ b/linkerd.io/content/2.15/tasks/automatically-rotating-webhook-tls-credentials.md @@ -22,7 +22,7 @@ This workflow is suitable for most users. However, if you need these webhook certificates to be rotated automatically on a regular basis, it is possible to use cert-manager to automatically manage them. -{{< docs/production-note >}} +{{< production-note >}} ## Install Cert manager diff --git a/linkerd.io/content/2.15/tasks/circuit-breakers.md b/linkerd.io/content/2.15/tasks/circuit-breakers.md index 13425e16dd..d038ccf382 100644 --- a/linkerd.io/content/2.15/tasks/circuit-breakers.md +++ b/linkerd.io/content/2.15/tasks/circuit-breakers.md @@ -13,7 +13,7 @@ improve client success rate when a backend replica is unhealthy. See the [reference documentation](../reference/circuit-breaking/) for more details on how Linkerd implements circuit breaking. -{{< docs/production-note >}} +{{< production-note >}} ## Prerequisites diff --git a/linkerd.io/content/2.15/tasks/customize-install.md b/linkerd.io/content/2.15/tasks/customize-install.md index dc71604c3c..512bb3629d 100644 --- a/linkerd.io/content/2.15/tasks/customize-install.md +++ b/linkerd.io/content/2.15/tasks/customize-install.md @@ -9,7 +9,7 @@ Instead of forking the Linkerd install and upgrade process, `linkerd install` in a consistent way. This allows customization of the install to add functionality specific to installations. -{{< docs/production-note >}} +{{< production-note >}} To get started, save the output of `linkerd install` to a YAML file. This will be the base resource that Kustomize uses to patch and generate what is added to diff --git a/linkerd.io/content/2.15/tasks/exporting-metrics.md b/linkerd.io/content/2.15/tasks/exporting-metrics.md index 877aedf5a2..96fc7f24f0 100644 --- a/linkerd.io/content/2.15/tasks/exporting-metrics.md +++ b/linkerd.io/content/2.15/tasks/exporting-metrics.md @@ -13,7 +13,7 @@ each proxy only provides a portion of the full picture. Instead, a separate tool is used to collect metrics from all proxies and aggregate them together for consumption. -{{< docs/production-note >}} +{{< production-note >}} One easy option is the [linkerd-viz](../features/dashboard/) extension, which will create an on-cluster Prometheus instance as well as dashboards and CLI @@ -74,7 +74,7 @@ metadata: k8s-app: linkerd-prometheus release: monitoring name: linkerd-federate - namespace: {{.Namespace}} + namespace: { { .Namespace } } spec: endpoints: - interval: 30s @@ -94,7 +94,7 @@ spec: jobLabel: app namespaceSelector: matchNames: - - {{.Namespace}} + - { { .Namespace } } selector: matchLabels: component: prometheus diff --git a/linkerd.io/content/2.15/tasks/exposing-dashboard.md b/linkerd.io/content/2.15/tasks/exposing-dashboard.md index fe8cf24afe..0f0d9ef682 100644 --- a/linkerd.io/content/2.15/tasks/exposing-dashboard.md +++ b/linkerd.io/content/2.15/tasks/exposing-dashboard.md @@ -10,7 +10,7 @@ going on, you can expose the dashboard via an ingress. This will also expose Grafana, if you have it linked against Linkerd viz through the `grafana.url` setting. -{{< docs/toc >}} +{{< toc >}} ## Nginx diff --git a/linkerd.io/content/2.15/tasks/external-prometheus.md b/linkerd.io/content/2.15/tasks/external-prometheus.md index c663e92c17..1ee6994f1a 100644 --- a/linkerd.io/content/2.15/tasks/external-prometheus.md +++ b/linkerd.io/content/2.15/tasks/external-prometheus.md @@ -12,7 +12,7 @@ both the control plane as well as the proxy's metrics in a format that is consumable both by a user as well as Linkerd control plane components like web, etc. -{{< docs/production-note >}} +{{< production-note >}} There are two important points to tackle here. diff --git a/linkerd.io/content/2.15/tasks/flagger.md b/linkerd.io/content/2.15/tasks/flagger.md index 356ac3b38e..a8a03f093e 100644 --- a/linkerd.io/content/2.15/tasks/flagger.md +++ b/linkerd.io/content/2.15/tasks/flagger.md @@ -23,7 +23,7 @@ tools: [Flagger](https://flagger.app/) and metrics and request routing together in a control loop, allowing for fully-automated, metrics-aware canary deployments. -{{< docs/production-note >}} +{{< production-note >}} ## Prerequisites diff --git a/linkerd.io/content/2.15/tasks/generate-certificates.md b/linkerd.io/content/2.15/tasks/generate-certificates.md index 35013ac056..33dd6751d1 100644 --- a/linkerd.io/content/2.15/tasks/generate-certificates.md +++ b/linkerd.io/content/2.15/tasks/generate-certificates.md @@ -23,7 +23,7 @@ algorithm which is the default for `step`. To generate ECDSA P-256 certificates with openssl, you can use the `openssl ecparam -name prime256v1` command. In this tutorial, we'll walk you through how to to use the `step` CLI to do this. -{{< docs/production-note >}} +{{< production-note >}} ## Generating the certificates with `step` diff --git a/linkerd.io/content/2.15/tasks/gitops.md b/linkerd.io/content/2.15/tasks/gitops.md index 51328396a3..70c2346f70 100644 --- a/linkerd.io/content/2.15/tasks/gitops.md +++ b/linkerd.io/content/2.15/tasks/gitops.md @@ -12,7 +12,7 @@ This guide will show you how to set up [Argo CD](https://argoproj.github.io/argo-cd/) to manage the installation and upgrade of Linkerd using a GitOps workflow. -{{< docs/production-note >}} +{{< production-note >}} Specifically, this guide provides instructions on how to securely generate and manage Linkerd's mTLS private keys and certificates using diff --git a/linkerd.io/content/2.15/tasks/grafana.md b/linkerd.io/content/2.15/tasks/grafana.md index b37b01af71..9be0209fbb 100644 --- a/linkerd.io/content/2.15/tasks/grafana.md +++ b/linkerd.io/content/2.15/tasks/grafana.md @@ -13,7 +13,7 @@ First, you need to install Grafana from a variety of possible sources, and then load the suite of Grafana dashboards that have been pre-configured to consume the metrics exposed by Linkerd. -{{< docs/production-note >}} +{{< production-note >}} ## Install Prometheus @@ -85,7 +85,7 @@ is set up, as shown in the sample `grafana/values.yaml` file: ```yaml grafana.ini: server: - root_url: "%(protocol)s://%(domain)s:/grafana/" + root_url: '%(protocol)s://%(domain)s:/grafana/' ``` Then refer the location of your Grafana service in the Linkerd Viz `values.yaml` diff --git a/linkerd.io/content/2.15/tasks/install-helm.md b/linkerd.io/content/2.15/tasks/install-helm.md index dbb001c949..d9ae6e768b 100644 --- a/linkerd.io/content/2.15/tasks/install-helm.md +++ b/linkerd.io/content/2.15/tasks/install-helm.md @@ -6,7 +6,7 @@ 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. -{{< docs/edge-note >}} +{{< edge-note >}} ## Prerequisite: generate mTLS certificates diff --git a/linkerd.io/content/2.15/tasks/installing-multicluster.md b/linkerd.io/content/2.15/tasks/installing-multicluster.md index 8f36ce199e..32662be4a4 100644 --- a/linkerd.io/content/2.15/tasks/installing-multicluster.md +++ b/linkerd.io/content/2.15/tasks/installing-multicluster.md @@ -9,7 +9,7 @@ through this installation and configuration as well as common problems that you may encounter. For a detailed walkthrough and explanation of what's going on, check out [getting started](multicluster/). -{{< docs/production-note >}} +{{< production-note >}} ## Requirements diff --git a/linkerd.io/content/2.15/tasks/setting-up-service-profiles.md b/linkerd.io/content/2.15/tasks/setting-up-service-profiles.md index 704be61323..8108dcbe90 100644 --- a/linkerd.io/content/2.15/tasks/setting-up-service-profiles.md +++ b/linkerd.io/content/2.15/tasks/setting-up-service-profiles.md @@ -56,7 +56,7 @@ demo. There are a couple different ways to use `linkerd profile` to create service profiles. -{{< docs/toc >}} +{{< toc >}} Requests which have been associated with a route will have a `rt_route` annotation. To manually verify if the requests are being associated correctly, diff --git a/linkerd.io/content/2.15/tasks/traffic-shifting.md b/linkerd.io/content/2.15/tasks/traffic-shifting.md index cfcb372c4d..fc57d0795b 100644 --- a/linkerd.io/content/2.15/tasks/traffic-shifting.md +++ b/linkerd.io/content/2.15/tasks/traffic-shifting.md @@ -16,7 +16,7 @@ Linkerd natively supports. While certain integrations such as [Flagger](flagger/) rely on the SMI and `TrafficSplit` approach, using `HTTPRoute` is the preferred method going forward. -{{< docs/production-note >}} +{{< production-note >}} ## Prerequisites diff --git a/linkerd.io/content/2.15/tasks/using-the-debug-container.md b/linkerd.io/content/2.15/tasks/using-the-debug-container.md index 6e40eecd1a..ff7a10bce9 100644 --- a/linkerd.io/content/2.15/tasks/using-the-debug-container.md +++ b/linkerd.io/content/2.15/tasks/using-the-debug-container.md @@ -19,7 +19,7 @@ time. For convenience, the `linkerd inject` command provides an adding this annotation to a pre-existing pod will not work. It must be present at pod _creation_ time.) -{{< docs/production-note >}} +{{< production-note >}} The debug sidecar image contains [`tshark`](https://www.wireshark.org/docs/man-pages/tshark.html), `tcpdump`, diff --git a/linkerd.io/content/2.16/common-errors/_index.md b/linkerd.io/content/2.16/common-errors/_index.md index 68771bf652..a57718ba55 100644 --- a/linkerd.io/content/2.16/common-errors/_index.md +++ b/linkerd.io/content/2.16/common-errors/_index.md @@ -18,4 +18,4 @@ this command is. ## Common Errors -{{< docs/section-toc >}} +{{< section-toc >}} diff --git a/linkerd.io/content/2.16/features/_index.md b/linkerd.io/content/2.16/features/_index.md index cf341d4e7e..3eebfe67f4 100644 --- a/linkerd.io/content/2.16/features/_index.md +++ b/linkerd.io/content/2.16/features/_index.md @@ -11,4 +11,4 @@ please see the [Linkerd task docs](../tasks/). For a reference, see the ## Linkerd's features -{{< docs/section-toc >}} +{{< section-toc >}} diff --git a/linkerd.io/content/2.16/getting-started/_index.md b/linkerd.io/content/2.16/getting-started/_index.md index e0fc522542..8bd6ebe324 100644 --- a/linkerd.io/content/2.16/getting-started/_index.md +++ b/linkerd.io/content/2.16/getting-started/_index.md @@ -16,7 +16,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. -{{< docs/edge-note >}} +{{< edge-note >}} ## Step 0: Setup diff --git a/linkerd.io/content/2.16/reference/_index.md b/linkerd.io/content/2.16/reference/_index.md index f2045c2b56..c066e0b8ee 100644 --- a/linkerd.io/content/2.16/reference/_index.md +++ b/linkerd.io/content/2.16/reference/_index.md @@ -3,4 +3,4 @@ title: Reference weight: 5 --- -{{< docs/section-toc >}} +{{< section-toc >}} diff --git a/linkerd.io/content/2.16/reference/cli/_index.md b/linkerd.io/content/2.16/reference/cli/_index.md index ee36df6287..4d4170ffa7 100644 --- a/linkerd.io/content/2.16/reference/cli/_index.md +++ b/linkerd.io/content/2.16/reference/cli/_index.md @@ -9,10 +9,10 @@ detailed metrics for how your service is performing. As reference, check out the commands below: -{{< docs/cli-commands >}} +{{< cli-commands >}} ## Global flags The following flags are available for _all_ linkerd CLI commands: -{{< docs/cli-global-flags >}} +{{< cli-global-flags >}} diff --git a/linkerd.io/content/2.16/reference/cli/authz.md b/linkerd.io/content/2.16/reference/cli/authz.md index 2a6e55b55d..22df19a41c 100644 --- a/linkerd.io/content/2.16/reference/cli/authz.md +++ b/linkerd.io/content/2.16/reference/cli/authz.md @@ -2,10 +2,10 @@ title: authz --- -{{< docs/cli-description "authz" >}} +{{< cli-description "authz" >}} Check out the [Authorization Policy](../authorization-policy/) and [Restricting Access to Services](../../tasks/restricting-access/) documentation for all the details about authorization policy in Linkerd. -{{< docs/cli-flags "authz" >}} +{{< cli-flags "authz" >}} diff --git a/linkerd.io/content/2.16/reference/cli/check.md b/linkerd.io/content/2.16/reference/cli/check.md index 7cd61cd237..0c18a5da03 100644 --- a/linkerd.io/content/2.16/reference/cli/check.md +++ b/linkerd.io/content/2.16/reference/cli/check.md @@ -2,12 +2,12 @@ title: check --- -{{< docs/cli-description "check" >}} +{{< cli-description "check" >}} Take a look at the [troubleshooting](../../tasks/troubleshooting/) documentation for a full list of all the possible checks, what they do and how to fix them. -{{< docs/cli-examples "check" >}} +{{< cli-examples "check" >}} ## Example output @@ -53,4 +53,4 @@ control-plane-version Status check results are √ ``` -{{< docs/cli-flags "check" >}} +{{< cli-flags "check" >}} diff --git a/linkerd.io/content/2.16/reference/cli/completion.md b/linkerd.io/content/2.16/reference/cli/completion.md index 40e8438b72..6007a47fa5 100644 --- a/linkerd.io/content/2.16/reference/cli/completion.md +++ b/linkerd.io/content/2.16/reference/cli/completion.md @@ -2,8 +2,8 @@ title: completion --- -{{< docs/cli-description "completion" >}} +{{< cli-description "completion" >}} -{{< docs/cli-examples "completion" >}} +{{< cli-examples "completion" >}} -{{< docs/cli-flags "completion" >}} +{{< cli-flags "completion" >}} diff --git a/linkerd.io/content/2.16/reference/cli/diagnostics.md b/linkerd.io/content/2.16/reference/cli/diagnostics.md index ffa45c39be..8e4e36d234 100644 --- a/linkerd.io/content/2.16/reference/cli/diagnostics.md +++ b/linkerd.io/content/2.16/reference/cli/diagnostics.md @@ -2,44 +2,44 @@ title: diagnostics --- -{{< docs/cli-description "diagnostics" >}} +{{< cli-description "diagnostics" >}} -{{< docs/cli-examples "diagnostics" >}} +{{< cli-examples "diagnostics" >}} -{{< docs/cli-flags "diagnostics" >}} +{{< cli-flags "diagnostics" >}} ## Subcommands -{{< docs/cli-subcommands "diagnostics" >}} +{{< cli-subcommands "diagnostics" >}} ### controller-metrics -{{< docs/cli-description "diagnostics controller-metrics" >}} +{{< cli-description "diagnostics controller-metrics" >}} -{{< docs/cli-examples "diagnostics controller-metrics" >}} +{{< cli-examples "diagnostics controller-metrics" >}} -{{< docs/cli-flags "diagnostics controller-metrics" >}} +{{< cli-flags "diagnostics controller-metrics" >}} ### endpoints -{{< docs/cli-description "diagnostics endpoints" >}} +{{< cli-description "diagnostics endpoints" >}} -{{< docs/cli-examples "diagnostics endpoints" >}} +{{< cli-examples "diagnostics endpoints" >}} -{{< docs/cli-flags "diagnostics endpoints" >}} +{{< cli-flags "diagnostics endpoints" >}} ### install-sp -{{< docs/cli-description "diagnostics install-sp" >}} +{{< cli-description "diagnostics install-sp" >}} -{{< docs/cli-examples "diagnostics install-sp" >}} +{{< cli-examples "diagnostics install-sp" >}} -{{< docs/cli-flags "diagnostics install-sp" >}} +{{< cli-flags "diagnostics install-sp" >}} ### proxy-metrics -{{< docs/cli-description "diagnostics proxy-metrics" >}} +{{< cli-description "diagnostics proxy-metrics" >}} -{{< docs/cli-examples "diagnostics proxy-metrics" >}} +{{< cli-examples "diagnostics proxy-metrics" >}} -{{< docs/cli-flags "diagnostics proxy-metrics" >}} +{{< cli-flags "diagnostics proxy-metrics" >}} diff --git a/linkerd.io/content/2.16/reference/cli/identity.md b/linkerd.io/content/2.16/reference/cli/identity.md index 576d175930..c7962e8027 100644 --- a/linkerd.io/content/2.16/reference/cli/identity.md +++ b/linkerd.io/content/2.16/reference/cli/identity.md @@ -2,8 +2,8 @@ title: identity --- -{{< docs/cli-description "identity" >}} +{{< cli-description "identity" >}} -{{< docs/cli-examples "identity" >}} +{{< cli-examples "identity" >}} -{{< docs/cli-flags "identity" >}} +{{< cli-flags "identity" >}} diff --git a/linkerd.io/content/2.16/reference/cli/inject.md b/linkerd.io/content/2.16/reference/cli/inject.md index aafdacdb29..92fc0ca3cb 100644 --- a/linkerd.io/content/2.16/reference/cli/inject.md +++ b/linkerd.io/content/2.16/reference/cli/inject.md @@ -19,6 +19,6 @@ Alternatively, this command can also perform the full injection purely on the client side, by enabling with the `--manual` flag. (Prior to Linkerd 2.4, this was the default behavior.) -{{< docs/cli-examples "inject" >}} +{{< cli-examples "inject" >}} -{{< docs/cli-flags "inject" >}} +{{< cli-flags "inject" >}} diff --git a/linkerd.io/content/2.16/reference/cli/install-cni.md b/linkerd.io/content/2.16/reference/cli/install-cni.md index c7c457a6f1..d0577e3d3b 100644 --- a/linkerd.io/content/2.16/reference/cli/install-cni.md +++ b/linkerd.io/content/2.16/reference/cli/install-cni.md @@ -2,8 +2,8 @@ title: install-cni --- -{{< docs/cli-description "install-cni" >}} +{{< cli-description "install-cni" >}} -{{< docs/cli-examples "install-cni" >}} +{{< cli-examples "install-cni" >}} -{{< docs/cli-flags "install-cni" >}} +{{< cli-flags "install-cni" >}} diff --git a/linkerd.io/content/2.16/reference/cli/install.md b/linkerd.io/content/2.16/reference/cli/install.md index ab0dde824e..5fea59d7eb 100644 --- a/linkerd.io/content/2.16/reference/cli/install.md +++ b/linkerd.io/content/2.16/reference/cli/install.md @@ -2,11 +2,11 @@ title: install --- -{{< docs/cli-description "install" >}} +{{< cli-description "install" >}} For further details on how to install Linkerd onto your own cluster, check out the [install documentation](../../tasks/install/). -{{< docs/cli-examples "install" >}} +{{< cli-examples "install" >}} -{{< docs/cli-flags "install" >}} +{{< cli-flags "install" >}} diff --git a/linkerd.io/content/2.16/reference/cli/jaeger.md b/linkerd.io/content/2.16/reference/cli/jaeger.md index 1301361532..820ad6489c 100644 --- a/linkerd.io/content/2.16/reference/cli/jaeger.md +++ b/linkerd.io/content/2.16/reference/cli/jaeger.md @@ -2,52 +2,52 @@ title: jaeger --- -{{< docs/cli-description "jaeger" >}} +{{< cli-description "jaeger" >}} -{{< docs/cli-examples "jaeger" >}} +{{< cli-examples "jaeger" >}} -{{< docs/cli-flags "jaeger" >}} +{{< cli-flags "jaeger" >}} ## Subcommands -{{< docs/cli-subcommands "jaeger" >}} +{{< cli-subcommands "jaeger" >}} ### check -{{< docs/cli-description "jaeger check" >}} +{{< cli-description "jaeger check" >}} -{{< docs/cli-examples "jaeger check" >}} +{{< cli-examples "jaeger check" >}} -{{< docs/cli-flags "jaeger check" >}} +{{< cli-flags "jaeger check" >}} ### dashboard -{{< docs/cli-description "jaeger dashboard" >}} +{{< cli-description "jaeger dashboard" >}} -{{< docs/cli-examples "jaeger dashboard" >}} +{{< cli-examples "jaeger dashboard" >}} -{{< docs/cli-flags "jaeger dashboard" >}} +{{< cli-flags "jaeger dashboard" >}} ### install -{{< docs/cli-description "jaeger install" >}} +{{< cli-description "jaeger install" >}} -{{< docs/cli-examples "jaeger install" >}} +{{< cli-examples "jaeger install" >}} -{{< docs/cli-flags "jaeger install" >}} +{{< cli-flags "jaeger install" >}} ### list -{{< docs/cli-description "jaeger list" >}} +{{< cli-description "jaeger list" >}} -{{< docs/cli-examples "jaeger list" >}} +{{< cli-examples "jaeger list" >}} -{{< docs/cli-flags "jaeger list" >}} +{{< cli-flags "jaeger list" >}} ### uninstall -{{< docs/cli-description "jaeger uninstall" >}} +{{< cli-description "jaeger uninstall" >}} -{{< docs/cli-examples "jaeger uninstall" >}} +{{< cli-examples "jaeger uninstall" >}} -{{< docs/cli-flags "jaeger uninstall" >}} +{{< cli-flags "jaeger uninstall" >}} diff --git a/linkerd.io/content/2.16/reference/cli/multicluster.md b/linkerd.io/content/2.16/reference/cli/multicluster.md index 519ba5b57e..72c9ac0a4f 100644 --- a/linkerd.io/content/2.16/reference/cli/multicluster.md +++ b/linkerd.io/content/2.16/reference/cli/multicluster.md @@ -2,68 +2,68 @@ title: multicluster --- -{{< docs/cli-description "multicluster" >}} +{{< cli-description "multicluster" >}} -{{< docs/cli-examples "multicluster" >}} +{{< cli-examples "multicluster" >}} -{{< docs/cli-flags "multicluster" >}} +{{< cli-flags "multicluster" >}} ## Subcommands -{{< docs/cli-subcommands "multicluster" >}} +{{< cli-subcommands "multicluster" >}} ### allow -{{< docs/cli-description "multicluster allow" >}} +{{< cli-description "multicluster allow" >}} -{{< docs/cli-examples "multicluster allow" >}} +{{< cli-examples "multicluster allow" >}} -{{< docs/cli-flags "multicluster allow" >}} +{{< cli-flags "multicluster allow" >}} ### check -{{< docs/cli-description "multicluster check" >}} +{{< cli-description "multicluster check" >}} -{{< docs/cli-examples "multicluster check" >}} +{{< cli-examples "multicluster check" >}} -{{< docs/cli-flags "multicluster check" >}} +{{< cli-flags "multicluster check" >}} ### gateways -{{< docs/cli-description "multicluster gateways" >}} +{{< cli-description "multicluster gateways" >}} -{{< docs/cli-examples "multicluster gateways" >}} +{{< cli-examples "multicluster gateways" >}} -{{< docs/cli-flags "multicluster gateways" >}} +{{< cli-flags "multicluster gateways" >}} ### install -{{< docs/cli-description "multicluster install" >}} +{{< cli-description "multicluster install" >}} -{{< docs/cli-examples "multicluster install" >}} +{{< cli-examples "multicluster install" >}} -{{< docs/cli-flags "multicluster install" >}} +{{< cli-flags "multicluster install" >}} ### link -{{< docs/cli-description "multicluster link" >}} +{{< cli-description "multicluster link" >}} -{{< docs/cli-examples "multicluster link" >}} +{{< cli-examples "multicluster link" >}} -{{< docs/cli-flags "multicluster link" >}} +{{< cli-flags "multicluster link" >}} ### uninstall -{{< docs/cli-description "multicluster uninstall" >}} +{{< cli-description "multicluster uninstall" >}} -{{< docs/cli-examples "multicluster uninstall" >}} +{{< cli-examples "multicluster uninstall" >}} -{{< docs/cli-flags "multicluster uninstall" >}} +{{< cli-flags "multicluster uninstall" >}} ### unlink -{{< docs/cli-description "multicluster unlink" >}} +{{< cli-description "multicluster unlink" >}} -{{< docs/cli-examples "multicluster unlink" >}} +{{< cli-examples "multicluster unlink" >}} -{{< docs/cli-flags "multicluster unlink" >}} +{{< cli-flags "multicluster unlink" >}} diff --git a/linkerd.io/content/2.16/reference/cli/profile.md b/linkerd.io/content/2.16/reference/cli/profile.md index 5cc919b876..bf2545c313 100644 --- a/linkerd.io/content/2.16/reference/cli/profile.md +++ b/linkerd.io/content/2.16/reference/cli/profile.md @@ -2,12 +2,12 @@ title: profile --- -{{< docs/cli-description "profile" >}} +{{< cli-description "profile" >}} Check out the [service profile](../../features/service-profiles/) documentation for more details on what this command does and what you can do with service profiles. -{{< docs/cli-examples "profile" >}} +{{< cli-examples "profile" >}} -{{< docs/cli-flags "profile" >}} +{{< cli-flags "profile" >}} diff --git a/linkerd.io/content/2.16/reference/cli/prune.md b/linkerd.io/content/2.16/reference/cli/prune.md index 68675991ed..1ec604588f 100644 --- a/linkerd.io/content/2.16/reference/cli/prune.md +++ b/linkerd.io/content/2.16/reference/cli/prune.md @@ -2,8 +2,8 @@ title: prune --- -{{< docs/cli-description "prune" >}} +{{< cli-description "prune" >}} -{{< docs/cli-examples "prune" >}} +{{< cli-examples "prune" >}} -{{< docs/cli-flags "prune" >}} +{{< cli-flags "prune" >}} diff --git a/linkerd.io/content/2.16/reference/cli/uninject.md b/linkerd.io/content/2.16/reference/cli/uninject.md index 9ad619698a..6f43c3cf0a 100644 --- a/linkerd.io/content/2.16/reference/cli/uninject.md +++ b/linkerd.io/content/2.16/reference/cli/uninject.md @@ -2,8 +2,8 @@ title: uninject --- -{{< docs/cli-description "uninject" >}} +{{< cli-description "uninject" >}} -{{< docs/cli-examples "uninject" >}} +{{< cli-examples "uninject" >}} -{{< docs/cli-flags "uninject" >}} +{{< cli-flags "uninject" >}} diff --git a/linkerd.io/content/2.16/reference/cli/uninstall.md b/linkerd.io/content/2.16/reference/cli/uninstall.md index d5e00031ed..d62dd11612 100644 --- a/linkerd.io/content/2.16/reference/cli/uninstall.md +++ b/linkerd.io/content/2.16/reference/cli/uninstall.md @@ -2,8 +2,8 @@ title: uninstall --- -{{< docs/cli-description "uninstall" >}} +{{< cli-description "uninstall" >}} -{{< docs/cli-examples "uninstall" >}} +{{< cli-examples "uninstall" >}} -{{< docs/cli-flags "uninstall" >}} +{{< cli-flags "uninstall" >}} diff --git a/linkerd.io/content/2.16/reference/cli/upgrade.md b/linkerd.io/content/2.16/reference/cli/upgrade.md index c4422b57c9..70b3296d8a 100644 --- a/linkerd.io/content/2.16/reference/cli/upgrade.md +++ b/linkerd.io/content/2.16/reference/cli/upgrade.md @@ -2,8 +2,8 @@ title: upgrade --- -{{< docs/cli-description "upgrade" >}} +{{< cli-description "upgrade" >}} -{{< docs/cli-examples "upgrade" >}} +{{< cli-examples "upgrade" >}} -{{< docs/cli-flags "upgrade" >}} +{{< cli-flags "upgrade" >}} diff --git a/linkerd.io/content/2.16/reference/cli/version.md b/linkerd.io/content/2.16/reference/cli/version.md index 159f0b2f65..d31d7b18e6 100644 --- a/linkerd.io/content/2.16/reference/cli/version.md +++ b/linkerd.io/content/2.16/reference/cli/version.md @@ -2,8 +2,8 @@ title: version --- -{{< docs/cli-description "version" >}} +{{< cli-description "version" >}} -{{< docs/cli-examples "version" >}} +{{< cli-examples "version" >}} -{{< docs/cli-flags "version" >}} +{{< cli-flags "version" >}} diff --git a/linkerd.io/content/2.16/reference/cli/viz.md b/linkerd.io/content/2.16/reference/cli/viz.md index 2477e875ba..9a11e245d9 100644 --- a/linkerd.io/content/2.16/reference/cli/viz.md +++ b/linkerd.io/content/2.16/reference/cli/viz.md @@ -2,50 +2,50 @@ title: viz --- -{{< docs/cli-description "viz" >}} +{{< cli-description "viz" >}} -{{< docs/cli-examples "viz" >}} +{{< cli-examples "viz" >}} -{{< docs/cli-flags "viz" >}} +{{< cli-flags "viz" >}} ## Subcommands -{{< docs/cli-subcommands "viz" >}} +{{< cli-subcommands "viz" >}} ### allow-scrapes -{{< docs/cli-description "viz allow-scrapes" >}} +{{< cli-description "viz allow-scrapes" >}} -{{< docs/cli-examples "viz allow-scrapes" >}} +{{< cli-examples "viz allow-scrapes" >}} -{{< docs/cli-flags "viz allow-scrapes" >}} +{{< cli-flags "viz allow-scrapes" >}} ### authz -{{< docs/cli-description "viz authz" >}} +{{< cli-description "viz authz" >}} -{{< docs/cli-examples "viz authz" >}} +{{< cli-examples "viz authz" >}} -{{< docs/cli-flags "viz authz" >}} +{{< cli-flags "viz authz" >}} ### check -{{< docs/cli-description "viz check" >}} +{{< cli-description "viz check" >}} -{{< docs/cli-examples "viz check" >}} +{{< cli-examples "viz check" >}} -{{< docs/cli-flags "viz check" >}} +{{< cli-flags "viz check" >}} ### dashboard -{{< docs/cli-description "viz dashboard" >}} +{{< cli-description "viz dashboard" >}} Check out the [architecture](../architecture/#dashboard) docs for a more thorough explanation of what this command does. -{{< docs/cli-examples "viz dashboard" >}} +{{< cli-examples "viz dashboard" >}} -{{< docs/cli-flags "viz dashboard" >}} +{{< cli-flags "viz dashboard" >}} (\*) You'll need to tweak the dashboard's `enforced-host` parameter with this value, as explained in @@ -53,35 +53,35 @@ value, as explained in ### edges -{{< docs/cli-description "viz edges" >}} +{{< cli-description "viz edges" >}} -{{< docs/cli-examples "viz edges" >}} +{{< cli-examples "viz edges" >}} -{{< docs/cli-flags "viz edges" >}} +{{< cli-flags "viz edges" >}} ### install -{{< docs/cli-description "viz install" >}} +{{< cli-description "viz install" >}} -{{< docs/cli-examples "viz install" >}} +{{< cli-examples "viz install" >}} -{{< docs/cli-flags "viz install" >}} +{{< cli-flags "viz install" >}} ### list -{{< docs/cli-description "viz list" >}} +{{< cli-description "viz list" >}} -{{< docs/cli-examples "viz list" >}} +{{< cli-examples "viz list" >}} -{{< docs/cli-flags "viz list" >}} +{{< cli-flags "viz list" >}} ### profile -{{< docs/cli-description "viz profile" >}} +{{< cli-description "viz profile" >}} -{{< docs/cli-examples "viz profile" >}} +{{< cli-examples "viz profile" >}} -{{< docs/cli-flags "viz profile" >}} +{{< cli-flags "viz profile" >}} ### routes @@ -140,38 +140,38 @@ information. Because retries are only performed on the _outbound_ (client) side, the `-o wide` flag can only be used when the `--to` flag is specified. -{{< docs/cli-examples "viz routes" >}} +{{< cli-examples "viz routes" >}} -{{< docs/cli-flags "viz routes" >}} +{{< cli-flags "viz routes" >}} ### stat -{{< docs/cli-description "viz stat" >}} +{{< cli-description "viz stat" >}} -{{< docs/cli-examples "viz stat" >}} +{{< cli-examples "viz stat" >}} -{{< docs/cli-flags "viz stat" >}} +{{< cli-flags "viz stat" >}} ### tap -{{< docs/cli-description "viz tap" >}} +{{< cli-description "viz tap" >}} -{{< docs/cli-examples "viz tap" >}} +{{< cli-examples "viz tap" >}} -{{< docs/cli-flags "viz tap" >}} +{{< cli-flags "viz tap" >}} ### top -{{< docs/cli-description "viz top" >}} +{{< cli-description "viz top" >}} -{{< docs/cli-examples "viz top" >}} +{{< cli-examples "viz top" >}} -{{< docs/cli-flags "viz top" >}} +{{< cli-flags "viz top" >}} ### uninstall -{{< docs/cli-description "viz uninstall" >}} +{{< cli-description "viz uninstall" >}} -{{< docs/cli-examples "viz uninstall" >}} +{{< cli-examples "viz uninstall" >}} -{{< docs/cli-flags "viz uninstall" >}} +{{< cli-flags "viz uninstall" >}} diff --git a/linkerd.io/content/2.16/reference/extension-list.md b/linkerd.io/content/2.16/reference/extension-list.md index e6bdad697e..32afc3fd09 100644 --- a/linkerd.io/content/2.16/reference/extension-list.md +++ b/linkerd.io/content/2.16/reference/extension-list.md @@ -9,7 +9,7 @@ Linkerd provides a mix of built-in and third-party [extensions](../tasks/extensions/) to add additional functionality to the base installation. The following is the list of known extensions: -{{< docs/extensions >}} +{{< extensions >}} If you have an extension for Linkerd and it is not on the list, [please edit this page!](https://github.com/linkerd/website/edit/main/linkerd.io/data/extension-list.yaml) diff --git a/linkerd.io/content/2.16/reference/proxy-configuration.md b/linkerd.io/content/2.16/reference/proxy-configuration.md index 80b471f88b..847b0a53d4 100644 --- a/linkerd.io/content/2.16/reference/proxy-configuration.md +++ b/linkerd.io/content/2.16/reference/proxy-configuration.md @@ -11,7 +11,7 @@ configurations of [auto-injected proxies](../features/proxy-injection/). The following is the list of supported annotations: -{{< docs/cli-annotations "inject" >}} +{{< cli-annotations "inject" >}} For example, to update an auto-injected proxy's CPU and memory resources, we insert the appropriate annotations into the `spec.template.metadata.annotations` diff --git a/linkerd.io/content/2.16/tasks/_index.md b/linkerd.io/content/2.16/tasks/_index.md index cfca319184..19a83aee53 100644 --- a/linkerd.io/content/2.16/tasks/_index.md +++ b/linkerd.io/content/2.16/tasks/_index.md @@ -9,4 +9,4 @@ common tasks that you may need to perform when using Linkerd. ## Common Linkerd tasks -{{< docs/section-toc >}} +{{< section-toc >}} diff --git a/linkerd.io/content/2.16/tasks/automatic-failover.md b/linkerd.io/content/2.16/tasks/automatic-failover.md index ba405d784c..10d0862184 100644 --- a/linkerd.io/content/2.16/tasks/automatic-failover.md +++ b/linkerd.io/content/2.16/tasks/automatic-failover.md @@ -15,7 +15,7 @@ Emojivoto application on two Kubernetes clusters and simulating a failure in one cluster. We will see the failover controller shift traffic to the other cluster to ensure the service remains available. -{{< docs/production-note >}} +{{< production-note >}} ## Prerequisites diff --git a/linkerd.io/content/2.16/tasks/automatically-rotating-control-plane-tls-credentials.md b/linkerd.io/content/2.16/tasks/automatically-rotating-control-plane-tls-credentials.md index fb3c874952..be6105ac54 100644 --- a/linkerd.io/content/2.16/tasks/automatically-rotating-control-plane-tls-credentials.md +++ b/linkerd.io/content/2.16/tasks/automatically-rotating-control-plane-tls-credentials.md @@ -27,7 +27,7 @@ with a validity of one year but require manual rotation by the user to prevent expiry. While this setup is convenient for quick start testing, it's not advisable nor recommended for production environments. -{{< docs/production-note >}} +{{< production-note >}} ## Automating Certificate Management with cert-manager and trust-manager diff --git a/linkerd.io/content/2.16/tasks/automatically-rotating-webhook-tls-credentials.md b/linkerd.io/content/2.16/tasks/automatically-rotating-webhook-tls-credentials.md index 563014c122..556448912c 100644 --- a/linkerd.io/content/2.16/tasks/automatically-rotating-webhook-tls-credentials.md +++ b/linkerd.io/content/2.16/tasks/automatically-rotating-webhook-tls-credentials.md @@ -22,7 +22,7 @@ This workflow is suitable for most users. However, if you need these webhook certificates to be rotated automatically on a regular basis, it is possible to use cert-manager to automatically manage them. -{{< docs/production-note >}} +{{< production-note >}} ## Install Cert manager diff --git a/linkerd.io/content/2.16/tasks/circuit-breakers.md b/linkerd.io/content/2.16/tasks/circuit-breakers.md index 13425e16dd..d038ccf382 100644 --- a/linkerd.io/content/2.16/tasks/circuit-breakers.md +++ b/linkerd.io/content/2.16/tasks/circuit-breakers.md @@ -13,7 +13,7 @@ improve client success rate when a backend replica is unhealthy. See the [reference documentation](../reference/circuit-breaking/) for more details on how Linkerd implements circuit breaking. -{{< docs/production-note >}} +{{< production-note >}} ## Prerequisites diff --git a/linkerd.io/content/2.16/tasks/customize-install.md b/linkerd.io/content/2.16/tasks/customize-install.md index dc71604c3c..512bb3629d 100644 --- a/linkerd.io/content/2.16/tasks/customize-install.md +++ b/linkerd.io/content/2.16/tasks/customize-install.md @@ -9,7 +9,7 @@ Instead of forking the Linkerd install and upgrade process, `linkerd install` in a consistent way. This allows customization of the install to add functionality specific to installations. -{{< docs/production-note >}} +{{< production-note >}} To get started, save the output of `linkerd install` to a YAML file. This will be the base resource that Kustomize uses to patch and generate what is added to diff --git a/linkerd.io/content/2.16/tasks/exporting-metrics.md b/linkerd.io/content/2.16/tasks/exporting-metrics.md index 877aedf5a2..efd60daab3 100644 --- a/linkerd.io/content/2.16/tasks/exporting-metrics.md +++ b/linkerd.io/content/2.16/tasks/exporting-metrics.md @@ -13,7 +13,7 @@ each proxy only provides a portion of the full picture. Instead, a separate tool is used to collect metrics from all proxies and aggregate them together for consumption. -{{< docs/production-note >}} +{{< production-note >}} One easy option is the [linkerd-viz](../features/dashboard/) extension, which will create an on-cluster Prometheus instance as well as dashboards and CLI diff --git a/linkerd.io/content/2.16/tasks/exposing-dashboard.md b/linkerd.io/content/2.16/tasks/exposing-dashboard.md index fe8cf24afe..e161095597 100644 --- a/linkerd.io/content/2.16/tasks/exposing-dashboard.md +++ b/linkerd.io/content/2.16/tasks/exposing-dashboard.md @@ -10,7 +10,7 @@ going on, you can expose the dashboard via an ingress. This will also expose Grafana, if you have it linked against Linkerd viz through the `grafana.url` setting. -{{< docs/toc >}} +{{< toc >}} ## Nginx @@ -42,7 +42,7 @@ metadata: proxy_hide_header l5d-server-id; nginx.ingress.kubernetes.io/auth-type: basic nginx.ingress.kubernetes.io/auth-secret: web-ingress-auth - nginx.ingress.kubernetes.io/auth-realm: "Authentication Required" + nginx.ingress.kubernetes.io/auth-realm: 'Authentication Required' spec: ingressClassName: nginx rules: diff --git a/linkerd.io/content/2.16/tasks/external-prometheus.md b/linkerd.io/content/2.16/tasks/external-prometheus.md index c663e92c17..1ee6994f1a 100644 --- a/linkerd.io/content/2.16/tasks/external-prometheus.md +++ b/linkerd.io/content/2.16/tasks/external-prometheus.md @@ -12,7 +12,7 @@ both the control plane as well as the proxy's metrics in a format that is consumable both by a user as well as Linkerd control plane components like web, etc. -{{< docs/production-note >}} +{{< production-note >}} There are two important points to tackle here. diff --git a/linkerd.io/content/2.16/tasks/flagger.md b/linkerd.io/content/2.16/tasks/flagger.md index 356ac3b38e..a8a03f093e 100644 --- a/linkerd.io/content/2.16/tasks/flagger.md +++ b/linkerd.io/content/2.16/tasks/flagger.md @@ -23,7 +23,7 @@ tools: [Flagger](https://flagger.app/) and metrics and request routing together in a control loop, allowing for fully-automated, metrics-aware canary deployments. -{{< docs/production-note >}} +{{< production-note >}} ## Prerequisites diff --git a/linkerd.io/content/2.16/tasks/generate-certificates.md b/linkerd.io/content/2.16/tasks/generate-certificates.md index 35013ac056..33dd6751d1 100644 --- a/linkerd.io/content/2.16/tasks/generate-certificates.md +++ b/linkerd.io/content/2.16/tasks/generate-certificates.md @@ -23,7 +23,7 @@ algorithm which is the default for `step`. To generate ECDSA P-256 certificates with openssl, you can use the `openssl ecparam -name prime256v1` command. In this tutorial, we'll walk you through how to to use the `step` CLI to do this. -{{< docs/production-note >}} +{{< production-note >}} ## Generating the certificates with `step` diff --git a/linkerd.io/content/2.16/tasks/gitops.md b/linkerd.io/content/2.16/tasks/gitops.md index 51328396a3..70c2346f70 100644 --- a/linkerd.io/content/2.16/tasks/gitops.md +++ b/linkerd.io/content/2.16/tasks/gitops.md @@ -12,7 +12,7 @@ This guide will show you how to set up [Argo CD](https://argoproj.github.io/argo-cd/) to manage the installation and upgrade of Linkerd using a GitOps workflow. -{{< docs/production-note >}} +{{< production-note >}} Specifically, this guide provides instructions on how to securely generate and manage Linkerd's mTLS private keys and certificates using diff --git a/linkerd.io/content/2.16/tasks/grafana.md b/linkerd.io/content/2.16/tasks/grafana.md index b37b01af71..a30d3792e5 100644 --- a/linkerd.io/content/2.16/tasks/grafana.md +++ b/linkerd.io/content/2.16/tasks/grafana.md @@ -13,7 +13,7 @@ First, you need to install Grafana from a variety of possible sources, and then load the suite of Grafana dashboards that have been pre-configured to consume the metrics exposed by Linkerd. -{{< docs/production-note >}} +{{< production-note >}} ## Install Prometheus diff --git a/linkerd.io/content/2.16/tasks/install-helm.md b/linkerd.io/content/2.16/tasks/install-helm.md index dbb001c949..d9ae6e768b 100644 --- a/linkerd.io/content/2.16/tasks/install-helm.md +++ b/linkerd.io/content/2.16/tasks/install-helm.md @@ -6,7 +6,7 @@ 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. -{{< docs/edge-note >}} +{{< edge-note >}} ## Prerequisite: generate mTLS certificates diff --git a/linkerd.io/content/2.16/tasks/installing-multicluster.md b/linkerd.io/content/2.16/tasks/installing-multicluster.md index 8f36ce199e..32662be4a4 100644 --- a/linkerd.io/content/2.16/tasks/installing-multicluster.md +++ b/linkerd.io/content/2.16/tasks/installing-multicluster.md @@ -9,7 +9,7 @@ through this installation and configuration as well as common problems that you may encounter. For a detailed walkthrough and explanation of what's going on, check out [getting started](multicluster/). -{{< docs/production-note >}} +{{< production-note >}} ## Requirements diff --git a/linkerd.io/content/2.16/tasks/setting-up-service-profiles.md b/linkerd.io/content/2.16/tasks/setting-up-service-profiles.md index 25f6084bea..be9284058e 100644 --- a/linkerd.io/content/2.16/tasks/setting-up-service-profiles.md +++ b/linkerd.io/content/2.16/tasks/setting-up-service-profiles.md @@ -63,7 +63,7 @@ demo. There are a couple different ways to use `linkerd profile` to create service profiles. -{{< docs/toc >}} +{{< toc >}} Requests which have been associated with a route will have a `rt_route` annotation. To manually verify if the requests are being associated correctly, diff --git a/linkerd.io/content/2.16/tasks/traffic-shifting.md b/linkerd.io/content/2.16/tasks/traffic-shifting.md index 3c1bcdec9f..1091aa6198 100644 --- a/linkerd.io/content/2.16/tasks/traffic-shifting.md +++ b/linkerd.io/content/2.16/tasks/traffic-shifting.md @@ -20,7 +20,7 @@ development. {{< /note >}} -{{< docs/production-note >}} +{{< production-note >}} ## Prerequisites diff --git a/linkerd.io/content/2.16/tasks/using-the-debug-container.md b/linkerd.io/content/2.16/tasks/using-the-debug-container.md index 6e40eecd1a..ff7a10bce9 100644 --- a/linkerd.io/content/2.16/tasks/using-the-debug-container.md +++ b/linkerd.io/content/2.16/tasks/using-the-debug-container.md @@ -19,7 +19,7 @@ time. For convenience, the `linkerd inject` command provides an adding this annotation to a pre-existing pod will not work. It must be present at pod _creation_ time.) -{{< docs/production-note >}} +{{< production-note >}} The debug sidecar image contains [`tshark`](https://www.wireshark.org/docs/man-pages/tshark.html), `tcpdump`, diff --git a/linkerd.io/content/2.17/common-errors/_index.md b/linkerd.io/content/2.17/common-errors/_index.md index 68771bf652..a57718ba55 100644 --- a/linkerd.io/content/2.17/common-errors/_index.md +++ b/linkerd.io/content/2.17/common-errors/_index.md @@ -18,4 +18,4 @@ this command is. ## Common Errors -{{< docs/section-toc >}} +{{< section-toc >}} diff --git a/linkerd.io/content/2.17/features/_index.md b/linkerd.io/content/2.17/features/_index.md index cf341d4e7e..3eebfe67f4 100644 --- a/linkerd.io/content/2.17/features/_index.md +++ b/linkerd.io/content/2.17/features/_index.md @@ -11,4 +11,4 @@ please see the [Linkerd task docs](../tasks/). For a reference, see the ## Linkerd's features -{{< docs/section-toc >}} +{{< section-toc >}} diff --git a/linkerd.io/content/2.17/getting-started/_index.md b/linkerd.io/content/2.17/getting-started/_index.md index e0fc522542..8bd6ebe324 100644 --- a/linkerd.io/content/2.17/getting-started/_index.md +++ b/linkerd.io/content/2.17/getting-started/_index.md @@ -16,7 +16,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. -{{< docs/edge-note >}} +{{< edge-note >}} ## Step 0: Setup diff --git a/linkerd.io/content/2.17/reference/_index.md b/linkerd.io/content/2.17/reference/_index.md index f2045c2b56..c066e0b8ee 100644 --- a/linkerd.io/content/2.17/reference/_index.md +++ b/linkerd.io/content/2.17/reference/_index.md @@ -3,4 +3,4 @@ title: Reference weight: 5 --- -{{< docs/section-toc >}} +{{< section-toc >}} diff --git a/linkerd.io/content/2.17/reference/cli/_index.md b/linkerd.io/content/2.17/reference/cli/_index.md index ee36df6287..4d4170ffa7 100644 --- a/linkerd.io/content/2.17/reference/cli/_index.md +++ b/linkerd.io/content/2.17/reference/cli/_index.md @@ -9,10 +9,10 @@ detailed metrics for how your service is performing. As reference, check out the commands below: -{{< docs/cli-commands >}} +{{< cli-commands >}} ## Global flags The following flags are available for _all_ linkerd CLI commands: -{{< docs/cli-global-flags >}} +{{< cli-global-flags >}} diff --git a/linkerd.io/content/2.17/reference/cli/authz.md b/linkerd.io/content/2.17/reference/cli/authz.md index 2a6e55b55d..22df19a41c 100644 --- a/linkerd.io/content/2.17/reference/cli/authz.md +++ b/linkerd.io/content/2.17/reference/cli/authz.md @@ -2,10 +2,10 @@ title: authz --- -{{< docs/cli-description "authz" >}} +{{< cli-description "authz" >}} Check out the [Authorization Policy](../authorization-policy/) and [Restricting Access to Services](../../tasks/restricting-access/) documentation for all the details about authorization policy in Linkerd. -{{< docs/cli-flags "authz" >}} +{{< cli-flags "authz" >}} diff --git a/linkerd.io/content/2.17/reference/cli/check.md b/linkerd.io/content/2.17/reference/cli/check.md index 7cd61cd237..0c18a5da03 100644 --- a/linkerd.io/content/2.17/reference/cli/check.md +++ b/linkerd.io/content/2.17/reference/cli/check.md @@ -2,12 +2,12 @@ title: check --- -{{< docs/cli-description "check" >}} +{{< cli-description "check" >}} Take a look at the [troubleshooting](../../tasks/troubleshooting/) documentation for a full list of all the possible checks, what they do and how to fix them. -{{< docs/cli-examples "check" >}} +{{< cli-examples "check" >}} ## Example output @@ -53,4 +53,4 @@ control-plane-version Status check results are √ ``` -{{< docs/cli-flags "check" >}} +{{< cli-flags "check" >}} diff --git a/linkerd.io/content/2.17/reference/cli/completion.md b/linkerd.io/content/2.17/reference/cli/completion.md index 40e8438b72..6007a47fa5 100644 --- a/linkerd.io/content/2.17/reference/cli/completion.md +++ b/linkerd.io/content/2.17/reference/cli/completion.md @@ -2,8 +2,8 @@ title: completion --- -{{< docs/cli-description "completion" >}} +{{< cli-description "completion" >}} -{{< docs/cli-examples "completion" >}} +{{< cli-examples "completion" >}} -{{< docs/cli-flags "completion" >}} +{{< cli-flags "completion" >}} diff --git a/linkerd.io/content/2.17/reference/cli/diagnostics.md b/linkerd.io/content/2.17/reference/cli/diagnostics.md index ffa45c39be..8e4e36d234 100644 --- a/linkerd.io/content/2.17/reference/cli/diagnostics.md +++ b/linkerd.io/content/2.17/reference/cli/diagnostics.md @@ -2,44 +2,44 @@ title: diagnostics --- -{{< docs/cli-description "diagnostics" >}} +{{< cli-description "diagnostics" >}} -{{< docs/cli-examples "diagnostics" >}} +{{< cli-examples "diagnostics" >}} -{{< docs/cli-flags "diagnostics" >}} +{{< cli-flags "diagnostics" >}} ## Subcommands -{{< docs/cli-subcommands "diagnostics" >}} +{{< cli-subcommands "diagnostics" >}} ### controller-metrics -{{< docs/cli-description "diagnostics controller-metrics" >}} +{{< cli-description "diagnostics controller-metrics" >}} -{{< docs/cli-examples "diagnostics controller-metrics" >}} +{{< cli-examples "diagnostics controller-metrics" >}} -{{< docs/cli-flags "diagnostics controller-metrics" >}} +{{< cli-flags "diagnostics controller-metrics" >}} ### endpoints -{{< docs/cli-description "diagnostics endpoints" >}} +{{< cli-description "diagnostics endpoints" >}} -{{< docs/cli-examples "diagnostics endpoints" >}} +{{< cli-examples "diagnostics endpoints" >}} -{{< docs/cli-flags "diagnostics endpoints" >}} +{{< cli-flags "diagnostics endpoints" >}} ### install-sp -{{< docs/cli-description "diagnostics install-sp" >}} +{{< cli-description "diagnostics install-sp" >}} -{{< docs/cli-examples "diagnostics install-sp" >}} +{{< cli-examples "diagnostics install-sp" >}} -{{< docs/cli-flags "diagnostics install-sp" >}} +{{< cli-flags "diagnostics install-sp" >}} ### proxy-metrics -{{< docs/cli-description "diagnostics proxy-metrics" >}} +{{< cli-description "diagnostics proxy-metrics" >}} -{{< docs/cli-examples "diagnostics proxy-metrics" >}} +{{< cli-examples "diagnostics proxy-metrics" >}} -{{< docs/cli-flags "diagnostics proxy-metrics" >}} +{{< cli-flags "diagnostics proxy-metrics" >}} diff --git a/linkerd.io/content/2.17/reference/cli/identity.md b/linkerd.io/content/2.17/reference/cli/identity.md index 576d175930..c7962e8027 100644 --- a/linkerd.io/content/2.17/reference/cli/identity.md +++ b/linkerd.io/content/2.17/reference/cli/identity.md @@ -2,8 +2,8 @@ title: identity --- -{{< docs/cli-description "identity" >}} +{{< cli-description "identity" >}} -{{< docs/cli-examples "identity" >}} +{{< cli-examples "identity" >}} -{{< docs/cli-flags "identity" >}} +{{< cli-flags "identity" >}} diff --git a/linkerd.io/content/2.17/reference/cli/inject.md b/linkerd.io/content/2.17/reference/cli/inject.md index aafdacdb29..92fc0ca3cb 100644 --- a/linkerd.io/content/2.17/reference/cli/inject.md +++ b/linkerd.io/content/2.17/reference/cli/inject.md @@ -19,6 +19,6 @@ Alternatively, this command can also perform the full injection purely on the client side, by enabling with the `--manual` flag. (Prior to Linkerd 2.4, this was the default behavior.) -{{< docs/cli-examples "inject" >}} +{{< cli-examples "inject" >}} -{{< docs/cli-flags "inject" >}} +{{< cli-flags "inject" >}} diff --git a/linkerd.io/content/2.17/reference/cli/install-cni.md b/linkerd.io/content/2.17/reference/cli/install-cni.md index c7c457a6f1..d0577e3d3b 100644 --- a/linkerd.io/content/2.17/reference/cli/install-cni.md +++ b/linkerd.io/content/2.17/reference/cli/install-cni.md @@ -2,8 +2,8 @@ title: install-cni --- -{{< docs/cli-description "install-cni" >}} +{{< cli-description "install-cni" >}} -{{< docs/cli-examples "install-cni" >}} +{{< cli-examples "install-cni" >}} -{{< docs/cli-flags "install-cni" >}} +{{< cli-flags "install-cni" >}} diff --git a/linkerd.io/content/2.17/reference/cli/install.md b/linkerd.io/content/2.17/reference/cli/install.md index ab0dde824e..5fea59d7eb 100644 --- a/linkerd.io/content/2.17/reference/cli/install.md +++ b/linkerd.io/content/2.17/reference/cli/install.md @@ -2,11 +2,11 @@ title: install --- -{{< docs/cli-description "install" >}} +{{< cli-description "install" >}} For further details on how to install Linkerd onto your own cluster, check out the [install documentation](../../tasks/install/). -{{< docs/cli-examples "install" >}} +{{< cli-examples "install" >}} -{{< docs/cli-flags "install" >}} +{{< cli-flags "install" >}} diff --git a/linkerd.io/content/2.17/reference/cli/jaeger.md b/linkerd.io/content/2.17/reference/cli/jaeger.md index 1301361532..820ad6489c 100644 --- a/linkerd.io/content/2.17/reference/cli/jaeger.md +++ b/linkerd.io/content/2.17/reference/cli/jaeger.md @@ -2,52 +2,52 @@ title: jaeger --- -{{< docs/cli-description "jaeger" >}} +{{< cli-description "jaeger" >}} -{{< docs/cli-examples "jaeger" >}} +{{< cli-examples "jaeger" >}} -{{< docs/cli-flags "jaeger" >}} +{{< cli-flags "jaeger" >}} ## Subcommands -{{< docs/cli-subcommands "jaeger" >}} +{{< cli-subcommands "jaeger" >}} ### check -{{< docs/cli-description "jaeger check" >}} +{{< cli-description "jaeger check" >}} -{{< docs/cli-examples "jaeger check" >}} +{{< cli-examples "jaeger check" >}} -{{< docs/cli-flags "jaeger check" >}} +{{< cli-flags "jaeger check" >}} ### dashboard -{{< docs/cli-description "jaeger dashboard" >}} +{{< cli-description "jaeger dashboard" >}} -{{< docs/cli-examples "jaeger dashboard" >}} +{{< cli-examples "jaeger dashboard" >}} -{{< docs/cli-flags "jaeger dashboard" >}} +{{< cli-flags "jaeger dashboard" >}} ### install -{{< docs/cli-description "jaeger install" >}} +{{< cli-description "jaeger install" >}} -{{< docs/cli-examples "jaeger install" >}} +{{< cli-examples "jaeger install" >}} -{{< docs/cli-flags "jaeger install" >}} +{{< cli-flags "jaeger install" >}} ### list -{{< docs/cli-description "jaeger list" >}} +{{< cli-description "jaeger list" >}} -{{< docs/cli-examples "jaeger list" >}} +{{< cli-examples "jaeger list" >}} -{{< docs/cli-flags "jaeger list" >}} +{{< cli-flags "jaeger list" >}} ### uninstall -{{< docs/cli-description "jaeger uninstall" >}} +{{< cli-description "jaeger uninstall" >}} -{{< docs/cli-examples "jaeger uninstall" >}} +{{< cli-examples "jaeger uninstall" >}} -{{< docs/cli-flags "jaeger uninstall" >}} +{{< cli-flags "jaeger uninstall" >}} diff --git a/linkerd.io/content/2.17/reference/cli/multicluster.md b/linkerd.io/content/2.17/reference/cli/multicluster.md index 519ba5b57e..72c9ac0a4f 100644 --- a/linkerd.io/content/2.17/reference/cli/multicluster.md +++ b/linkerd.io/content/2.17/reference/cli/multicluster.md @@ -2,68 +2,68 @@ title: multicluster --- -{{< docs/cli-description "multicluster" >}} +{{< cli-description "multicluster" >}} -{{< docs/cli-examples "multicluster" >}} +{{< cli-examples "multicluster" >}} -{{< docs/cli-flags "multicluster" >}} +{{< cli-flags "multicluster" >}} ## Subcommands -{{< docs/cli-subcommands "multicluster" >}} +{{< cli-subcommands "multicluster" >}} ### allow -{{< docs/cli-description "multicluster allow" >}} +{{< cli-description "multicluster allow" >}} -{{< docs/cli-examples "multicluster allow" >}} +{{< cli-examples "multicluster allow" >}} -{{< docs/cli-flags "multicluster allow" >}} +{{< cli-flags "multicluster allow" >}} ### check -{{< docs/cli-description "multicluster check" >}} +{{< cli-description "multicluster check" >}} -{{< docs/cli-examples "multicluster check" >}} +{{< cli-examples "multicluster check" >}} -{{< docs/cli-flags "multicluster check" >}} +{{< cli-flags "multicluster check" >}} ### gateways -{{< docs/cli-description "multicluster gateways" >}} +{{< cli-description "multicluster gateways" >}} -{{< docs/cli-examples "multicluster gateways" >}} +{{< cli-examples "multicluster gateways" >}} -{{< docs/cli-flags "multicluster gateways" >}} +{{< cli-flags "multicluster gateways" >}} ### install -{{< docs/cli-description "multicluster install" >}} +{{< cli-description "multicluster install" >}} -{{< docs/cli-examples "multicluster install" >}} +{{< cli-examples "multicluster install" >}} -{{< docs/cli-flags "multicluster install" >}} +{{< cli-flags "multicluster install" >}} ### link -{{< docs/cli-description "multicluster link" >}} +{{< cli-description "multicluster link" >}} -{{< docs/cli-examples "multicluster link" >}} +{{< cli-examples "multicluster link" >}} -{{< docs/cli-flags "multicluster link" >}} +{{< cli-flags "multicluster link" >}} ### uninstall -{{< docs/cli-description "multicluster uninstall" >}} +{{< cli-description "multicluster uninstall" >}} -{{< docs/cli-examples "multicluster uninstall" >}} +{{< cli-examples "multicluster uninstall" >}} -{{< docs/cli-flags "multicluster uninstall" >}} +{{< cli-flags "multicluster uninstall" >}} ### unlink -{{< docs/cli-description "multicluster unlink" >}} +{{< cli-description "multicluster unlink" >}} -{{< docs/cli-examples "multicluster unlink" >}} +{{< cli-examples "multicluster unlink" >}} -{{< docs/cli-flags "multicluster unlink" >}} +{{< cli-flags "multicluster unlink" >}} diff --git a/linkerd.io/content/2.17/reference/cli/profile.md b/linkerd.io/content/2.17/reference/cli/profile.md index 5cc919b876..bf2545c313 100644 --- a/linkerd.io/content/2.17/reference/cli/profile.md +++ b/linkerd.io/content/2.17/reference/cli/profile.md @@ -2,12 +2,12 @@ title: profile --- -{{< docs/cli-description "profile" >}} +{{< cli-description "profile" >}} Check out the [service profile](../../features/service-profiles/) documentation for more details on what this command does and what you can do with service profiles. -{{< docs/cli-examples "profile" >}} +{{< cli-examples "profile" >}} -{{< docs/cli-flags "profile" >}} +{{< cli-flags "profile" >}} diff --git a/linkerd.io/content/2.17/reference/cli/prune.md b/linkerd.io/content/2.17/reference/cli/prune.md index 68675991ed..1ec604588f 100644 --- a/linkerd.io/content/2.17/reference/cli/prune.md +++ b/linkerd.io/content/2.17/reference/cli/prune.md @@ -2,8 +2,8 @@ title: prune --- -{{< docs/cli-description "prune" >}} +{{< cli-description "prune" >}} -{{< docs/cli-examples "prune" >}} +{{< cli-examples "prune" >}} -{{< docs/cli-flags "prune" >}} +{{< cli-flags "prune" >}} diff --git a/linkerd.io/content/2.17/reference/cli/uninject.md b/linkerd.io/content/2.17/reference/cli/uninject.md index 9ad619698a..6f43c3cf0a 100644 --- a/linkerd.io/content/2.17/reference/cli/uninject.md +++ b/linkerd.io/content/2.17/reference/cli/uninject.md @@ -2,8 +2,8 @@ title: uninject --- -{{< docs/cli-description "uninject" >}} +{{< cli-description "uninject" >}} -{{< docs/cli-examples "uninject" >}} +{{< cli-examples "uninject" >}} -{{< docs/cli-flags "uninject" >}} +{{< cli-flags "uninject" >}} diff --git a/linkerd.io/content/2.17/reference/cli/uninstall.md b/linkerd.io/content/2.17/reference/cli/uninstall.md index d5e00031ed..d62dd11612 100644 --- a/linkerd.io/content/2.17/reference/cli/uninstall.md +++ b/linkerd.io/content/2.17/reference/cli/uninstall.md @@ -2,8 +2,8 @@ title: uninstall --- -{{< docs/cli-description "uninstall" >}} +{{< cli-description "uninstall" >}} -{{< docs/cli-examples "uninstall" >}} +{{< cli-examples "uninstall" >}} -{{< docs/cli-flags "uninstall" >}} +{{< cli-flags "uninstall" >}} diff --git a/linkerd.io/content/2.17/reference/cli/upgrade.md b/linkerd.io/content/2.17/reference/cli/upgrade.md index c4422b57c9..70b3296d8a 100644 --- a/linkerd.io/content/2.17/reference/cli/upgrade.md +++ b/linkerd.io/content/2.17/reference/cli/upgrade.md @@ -2,8 +2,8 @@ title: upgrade --- -{{< docs/cli-description "upgrade" >}} +{{< cli-description "upgrade" >}} -{{< docs/cli-examples "upgrade" >}} +{{< cli-examples "upgrade" >}} -{{< docs/cli-flags "upgrade" >}} +{{< cli-flags "upgrade" >}} diff --git a/linkerd.io/content/2.17/reference/cli/version.md b/linkerd.io/content/2.17/reference/cli/version.md index 159f0b2f65..d31d7b18e6 100644 --- a/linkerd.io/content/2.17/reference/cli/version.md +++ b/linkerd.io/content/2.17/reference/cli/version.md @@ -2,8 +2,8 @@ title: version --- -{{< docs/cli-description "version" >}} +{{< cli-description "version" >}} -{{< docs/cli-examples "version" >}} +{{< cli-examples "version" >}} -{{< docs/cli-flags "version" >}} +{{< cli-flags "version" >}} diff --git a/linkerd.io/content/2.17/reference/cli/viz.md b/linkerd.io/content/2.17/reference/cli/viz.md index 2477e875ba..9a11e245d9 100644 --- a/linkerd.io/content/2.17/reference/cli/viz.md +++ b/linkerd.io/content/2.17/reference/cli/viz.md @@ -2,50 +2,50 @@ title: viz --- -{{< docs/cli-description "viz" >}} +{{< cli-description "viz" >}} -{{< docs/cli-examples "viz" >}} +{{< cli-examples "viz" >}} -{{< docs/cli-flags "viz" >}} +{{< cli-flags "viz" >}} ## Subcommands -{{< docs/cli-subcommands "viz" >}} +{{< cli-subcommands "viz" >}} ### allow-scrapes -{{< docs/cli-description "viz allow-scrapes" >}} +{{< cli-description "viz allow-scrapes" >}} -{{< docs/cli-examples "viz allow-scrapes" >}} +{{< cli-examples "viz allow-scrapes" >}} -{{< docs/cli-flags "viz allow-scrapes" >}} +{{< cli-flags "viz allow-scrapes" >}} ### authz -{{< docs/cli-description "viz authz" >}} +{{< cli-description "viz authz" >}} -{{< docs/cli-examples "viz authz" >}} +{{< cli-examples "viz authz" >}} -{{< docs/cli-flags "viz authz" >}} +{{< cli-flags "viz authz" >}} ### check -{{< docs/cli-description "viz check" >}} +{{< cli-description "viz check" >}} -{{< docs/cli-examples "viz check" >}} +{{< cli-examples "viz check" >}} -{{< docs/cli-flags "viz check" >}} +{{< cli-flags "viz check" >}} ### dashboard -{{< docs/cli-description "viz dashboard" >}} +{{< cli-description "viz dashboard" >}} Check out the [architecture](../architecture/#dashboard) docs for a more thorough explanation of what this command does. -{{< docs/cli-examples "viz dashboard" >}} +{{< cli-examples "viz dashboard" >}} -{{< docs/cli-flags "viz dashboard" >}} +{{< cli-flags "viz dashboard" >}} (\*) You'll need to tweak the dashboard's `enforced-host` parameter with this value, as explained in @@ -53,35 +53,35 @@ value, as explained in ### edges -{{< docs/cli-description "viz edges" >}} +{{< cli-description "viz edges" >}} -{{< docs/cli-examples "viz edges" >}} +{{< cli-examples "viz edges" >}} -{{< docs/cli-flags "viz edges" >}} +{{< cli-flags "viz edges" >}} ### install -{{< docs/cli-description "viz install" >}} +{{< cli-description "viz install" >}} -{{< docs/cli-examples "viz install" >}} +{{< cli-examples "viz install" >}} -{{< docs/cli-flags "viz install" >}} +{{< cli-flags "viz install" >}} ### list -{{< docs/cli-description "viz list" >}} +{{< cli-description "viz list" >}} -{{< docs/cli-examples "viz list" >}} +{{< cli-examples "viz list" >}} -{{< docs/cli-flags "viz list" >}} +{{< cli-flags "viz list" >}} ### profile -{{< docs/cli-description "viz profile" >}} +{{< cli-description "viz profile" >}} -{{< docs/cli-examples "viz profile" >}} +{{< cli-examples "viz profile" >}} -{{< docs/cli-flags "viz profile" >}} +{{< cli-flags "viz profile" >}} ### routes @@ -140,38 +140,38 @@ information. Because retries are only performed on the _outbound_ (client) side, the `-o wide` flag can only be used when the `--to` flag is specified. -{{< docs/cli-examples "viz routes" >}} +{{< cli-examples "viz routes" >}} -{{< docs/cli-flags "viz routes" >}} +{{< cli-flags "viz routes" >}} ### stat -{{< docs/cli-description "viz stat" >}} +{{< cli-description "viz stat" >}} -{{< docs/cli-examples "viz stat" >}} +{{< cli-examples "viz stat" >}} -{{< docs/cli-flags "viz stat" >}} +{{< cli-flags "viz stat" >}} ### tap -{{< docs/cli-description "viz tap" >}} +{{< cli-description "viz tap" >}} -{{< docs/cli-examples "viz tap" >}} +{{< cli-examples "viz tap" >}} -{{< docs/cli-flags "viz tap" >}} +{{< cli-flags "viz tap" >}} ### top -{{< docs/cli-description "viz top" >}} +{{< cli-description "viz top" >}} -{{< docs/cli-examples "viz top" >}} +{{< cli-examples "viz top" >}} -{{< docs/cli-flags "viz top" >}} +{{< cli-flags "viz top" >}} ### uninstall -{{< docs/cli-description "viz uninstall" >}} +{{< cli-description "viz uninstall" >}} -{{< docs/cli-examples "viz uninstall" >}} +{{< cli-examples "viz uninstall" >}} -{{< docs/cli-flags "viz uninstall" >}} +{{< cli-flags "viz uninstall" >}} diff --git a/linkerd.io/content/2.17/reference/extension-list.md b/linkerd.io/content/2.17/reference/extension-list.md index e6bdad697e..32afc3fd09 100644 --- a/linkerd.io/content/2.17/reference/extension-list.md +++ b/linkerd.io/content/2.17/reference/extension-list.md @@ -9,7 +9,7 @@ Linkerd provides a mix of built-in and third-party [extensions](../tasks/extensions/) to add additional functionality to the base installation. The following is the list of known extensions: -{{< docs/extensions >}} +{{< extensions >}} If you have an extension for Linkerd and it is not on the list, [please edit this page!](https://github.com/linkerd/website/edit/main/linkerd.io/data/extension-list.yaml) diff --git a/linkerd.io/content/2.17/reference/proxy-configuration.md b/linkerd.io/content/2.17/reference/proxy-configuration.md index 80b471f88b..847b0a53d4 100644 --- a/linkerd.io/content/2.17/reference/proxy-configuration.md +++ b/linkerd.io/content/2.17/reference/proxy-configuration.md @@ -11,7 +11,7 @@ configurations of [auto-injected proxies](../features/proxy-injection/). The following is the list of supported annotations: -{{< docs/cli-annotations "inject" >}} +{{< cli-annotations "inject" >}} For example, to update an auto-injected proxy's CPU and memory resources, we insert the appropriate annotations into the `spec.template.metadata.annotations` diff --git a/linkerd.io/content/2.17/tasks/_index.md b/linkerd.io/content/2.17/tasks/_index.md index cfca319184..19a83aee53 100644 --- a/linkerd.io/content/2.17/tasks/_index.md +++ b/linkerd.io/content/2.17/tasks/_index.md @@ -9,4 +9,4 @@ common tasks that you may need to perform when using Linkerd. ## Common Linkerd tasks -{{< docs/section-toc >}} +{{< section-toc >}} diff --git a/linkerd.io/content/2.17/tasks/automatic-failover.md b/linkerd.io/content/2.17/tasks/automatic-failover.md index f45c66d817..233764e38f 100644 --- a/linkerd.io/content/2.17/tasks/automatic-failover.md +++ b/linkerd.io/content/2.17/tasks/automatic-failover.md @@ -25,7 +25,7 @@ Emojivoto application on two Kubernetes clusters and simulating a failure in one cluster. We will see the failover controller shift traffic to the other cluster to ensure the service remains available. -{{< docs/production-note >}} +{{< production-note >}} ## Prerequisites diff --git a/linkerd.io/content/2.17/tasks/automatically-rotating-control-plane-tls-credentials.md b/linkerd.io/content/2.17/tasks/automatically-rotating-control-plane-tls-credentials.md index fb3c874952..425dd65dad 100644 --- a/linkerd.io/content/2.17/tasks/automatically-rotating-control-plane-tls-credentials.md +++ b/linkerd.io/content/2.17/tasks/automatically-rotating-control-plane-tls-credentials.md @@ -27,7 +27,7 @@ with a validity of one year but require manual rotation by the user to prevent expiry. While this setup is convenient for quick start testing, it's not advisable nor recommended for production environments. -{{< docs/production-note >}} +{{< production-note >}} ## Automating Certificate Management with cert-manager and trust-manager @@ -244,18 +244,18 @@ EOF {{< warning >}} The default value of the `rotationPolicy` in the Certificate's `privateKey` -section is dependent on your version of cert-manager. In version 1.17 and -below, the default value was `Never`. With this configuration, cert-manager -**will not** actually rotate the trust anchor: instead, it will update the -validity timestamps but **not** generate a new private key. -**This is definitely not as secure as rotating the private key**. +section is dependent on your version of cert-manager. In version 1.17 and below, +the default value was `Never`. With this configuration, cert-manager **will +not** actually rotate the trust anchor: instead, it will update the validity +timestamps but **not** generate a new private key. **This is definitely not as +secure as rotating the private key**. If you are upgrading cert-manager from version 1.17 or below to version 1.18 or above, be aware that this new default will change the `rotationPolicy` if you are not explicitly setting it in your Certificate resource manifest. -To avoid ambiguity, we recommend always setting `rotationPolicy: Always` for -any certificate that cert-manager is managing. +To avoid ambiguity, we recommend always setting `rotationPolicy: Always` for any +certificate that cert-manager is managing. {{< /warning >}} @@ -360,18 +360,18 @@ EOF {{< warning >}} The default value of the `rotationPolicy` in the Certificate's `privateKey` -section is dependent on your version of cert-manager. In version 1.17 and -below, the default value was `Never`. With this configuration, cert-manager -**will not** actually rotate the trust anchor: instead, it will update the -validity timestamps but **not** generate a new private key. -**This is definitely not as secure as rotating the private key**. +section is dependent on your version of cert-manager. In version 1.17 and below, +the default value was `Never`. With this configuration, cert-manager **will +not** actually rotate the trust anchor: instead, it will update the validity +timestamps but **not** generate a new private key. **This is definitely not as +secure as rotating the private key**. If you are upgrading cert-manager from version 1.17 or below to version 1.18 or above, be aware that this new default will change the `rotationPolicy` if you are not explicitly setting it in your Certificate resource manifest. -To avoid ambiguity, we recommend always setting `rotationPolicy: Always` for -any certificate that cert-manager is managing. +To avoid ambiguity, we recommend always setting `rotationPolicy: Always` for any +certificate that cert-manager is managing. {{< /warning >}} @@ -777,10 +777,10 @@ _requires_ manual intervention, because while cert-manager can handle the hard work of actually rotating the trust anchor, it can't trigger the needed restarts. -This means that the simplest way to handle trust anchor rotation is -to _trigger the rotation manually_ whenever it's convenient for you so that -you can manage the trust bundle and restarts while letting cert-manager manage -the trust anchor certificate. +This means that the simplest way to handle trust anchor rotation is to _trigger +the rotation manually_ whenever it's convenient for you so that you can manage +the trust bundle and restarts while letting cert-manager manage the trust anchor +certificate. The process of actually doing this is straightforward, but again, there are several steps: @@ -830,8 +830,8 @@ kubectl get secret -n cert-manager linkerd-previous-anchor \ | base64 -d | inspect_cert ``` -Verify that the `linkerd-identity-trust-roots` ConfigMap now contains -the Subject keys from both Secrets. +Verify that the `linkerd-identity-trust-roots` ConfigMap now contains the +Subject keys from both Secrets. ```bash kubectl get configmap -n linkerd linkerd-identity-trust-roots \ @@ -858,9 +858,9 @@ This will cause the control plane to pick up the new trust anchor bundle. #### 3. Restart the data plane At this point, you'll need to restart your workloads as well, to force the -proxies to have the new trust anchor bundle. The exact mechanism to do this -will depend on your workloads, but it's often just `kubectl rollout restart` for -each of your application namespaces. +proxies to have the new trust anchor bundle. The exact mechanism to do this will +depend on your workloads, but it's often just `kubectl rollout restart` for each +of your application namespaces. #### 4. Triggering identity issuer rotation @@ -905,10 +905,10 @@ issuer. #### 6. Restart the data plane -Again, you'll need to restart your workloads, to force the -proxies to switch to the new identity issuer signed by the new trust anchor. -The exact mechanism to do this will depend on your workloads, but it's often -just `kubectl rollout restart` for each of your application namespaces. +Again, you'll need to restart your workloads, to force the proxies to switch to +the new identity issuer signed by the new trust anchor. The exact mechanism to +do this will depend on your workloads, but it's often just +`kubectl rollout restart` for each of your application namespaces. #### 7. Remove the old anchor from the trust bundle diff --git a/linkerd.io/content/2.17/tasks/automatically-rotating-webhook-tls-credentials.md b/linkerd.io/content/2.17/tasks/automatically-rotating-webhook-tls-credentials.md index 295aaa202d..da18a33094 100644 --- a/linkerd.io/content/2.17/tasks/automatically-rotating-webhook-tls-credentials.md +++ b/linkerd.io/content/2.17/tasks/automatically-rotating-webhook-tls-credentials.md @@ -22,7 +22,7 @@ This workflow is suitable for most users. However, if you need these webhook certificates to be rotated automatically on a regular basis, it is possible to use cert-manager to automatically manage them. -{{< docs/production-note >}} +{{< production-note >}} ## Install Cert manager diff --git a/linkerd.io/content/2.17/tasks/circuit-breakers.md b/linkerd.io/content/2.17/tasks/circuit-breakers.md index 13425e16dd..d038ccf382 100644 --- a/linkerd.io/content/2.17/tasks/circuit-breakers.md +++ b/linkerd.io/content/2.17/tasks/circuit-breakers.md @@ -13,7 +13,7 @@ improve client success rate when a backend replica is unhealthy. See the [reference documentation](../reference/circuit-breaking/) for more details on how Linkerd implements circuit breaking. -{{< docs/production-note >}} +{{< production-note >}} ## Prerequisites diff --git a/linkerd.io/content/2.17/tasks/customize-install.md b/linkerd.io/content/2.17/tasks/customize-install.md index dc71604c3c..512bb3629d 100644 --- a/linkerd.io/content/2.17/tasks/customize-install.md +++ b/linkerd.io/content/2.17/tasks/customize-install.md @@ -9,7 +9,7 @@ Instead of forking the Linkerd install and upgrade process, `linkerd install` in a consistent way. This allows customization of the install to add functionality specific to installations. -{{< docs/production-note >}} +{{< production-note >}} To get started, save the output of `linkerd install` to a YAML file. This will be the base resource that Kustomize uses to patch and generate what is added to diff --git a/linkerd.io/content/2.17/tasks/exporting-metrics.md b/linkerd.io/content/2.17/tasks/exporting-metrics.md index 877aedf5a2..efd60daab3 100644 --- a/linkerd.io/content/2.17/tasks/exporting-metrics.md +++ b/linkerd.io/content/2.17/tasks/exporting-metrics.md @@ -13,7 +13,7 @@ each proxy only provides a portion of the full picture. Instead, a separate tool is used to collect metrics from all proxies and aggregate them together for consumption. -{{< docs/production-note >}} +{{< production-note >}} One easy option is the [linkerd-viz](../features/dashboard/) extension, which will create an on-cluster Prometheus instance as well as dashboards and CLI diff --git a/linkerd.io/content/2.17/tasks/exposing-dashboard.md b/linkerd.io/content/2.17/tasks/exposing-dashboard.md index fe8cf24afe..0f0d9ef682 100644 --- a/linkerd.io/content/2.17/tasks/exposing-dashboard.md +++ b/linkerd.io/content/2.17/tasks/exposing-dashboard.md @@ -10,7 +10,7 @@ going on, you can expose the dashboard via an ingress. This will also expose Grafana, if you have it linked against Linkerd viz through the `grafana.url` setting. -{{< docs/toc >}} +{{< toc >}} ## Nginx diff --git a/linkerd.io/content/2.17/tasks/external-prometheus.md b/linkerd.io/content/2.17/tasks/external-prometheus.md index ccd0434d2d..4bc0dc59e6 100644 --- a/linkerd.io/content/2.17/tasks/external-prometheus.md +++ b/linkerd.io/content/2.17/tasks/external-prometheus.md @@ -12,7 +12,7 @@ both the control plane as well as the proxy's metrics in a format that is consumable both by a user as well as Linkerd control plane components like web, etc. -{{< docs/production-note >}} +{{< production-note >}} There are two important points to tackle here. diff --git a/linkerd.io/content/2.17/tasks/flagger.md b/linkerd.io/content/2.17/tasks/flagger.md index 356ac3b38e..a8a03f093e 100644 --- a/linkerd.io/content/2.17/tasks/flagger.md +++ b/linkerd.io/content/2.17/tasks/flagger.md @@ -23,7 +23,7 @@ tools: [Flagger](https://flagger.app/) and metrics and request routing together in a control loop, allowing for fully-automated, metrics-aware canary deployments. -{{< docs/production-note >}} +{{< production-note >}} ## Prerequisites diff --git a/linkerd.io/content/2.17/tasks/generate-certificates.md b/linkerd.io/content/2.17/tasks/generate-certificates.md index 35013ac056..33dd6751d1 100644 --- a/linkerd.io/content/2.17/tasks/generate-certificates.md +++ b/linkerd.io/content/2.17/tasks/generate-certificates.md @@ -23,7 +23,7 @@ algorithm which is the default for `step`. To generate ECDSA P-256 certificates with openssl, you can use the `openssl ecparam -name prime256v1` command. In this tutorial, we'll walk you through how to to use the `step` CLI to do this. -{{< docs/production-note >}} +{{< production-note >}} ## Generating the certificates with `step` diff --git a/linkerd.io/content/2.17/tasks/gitops.md b/linkerd.io/content/2.17/tasks/gitops.md index 51328396a3..70c2346f70 100644 --- a/linkerd.io/content/2.17/tasks/gitops.md +++ b/linkerd.io/content/2.17/tasks/gitops.md @@ -12,7 +12,7 @@ This guide will show you how to set up [Argo CD](https://argoproj.github.io/argo-cd/) to manage the installation and upgrade of Linkerd using a GitOps workflow. -{{< docs/production-note >}} +{{< production-note >}} Specifically, this guide provides instructions on how to securely generate and manage Linkerd's mTLS private keys and certificates using diff --git a/linkerd.io/content/2.17/tasks/grafana.md b/linkerd.io/content/2.17/tasks/grafana.md index b37b01af71..a30d3792e5 100644 --- a/linkerd.io/content/2.17/tasks/grafana.md +++ b/linkerd.io/content/2.17/tasks/grafana.md @@ -13,7 +13,7 @@ First, you need to install Grafana from a variety of possible sources, and then load the suite of Grafana dashboards that have been pre-configured to consume the metrics exposed by Linkerd. -{{< docs/production-note >}} +{{< production-note >}} ## Install Prometheus diff --git a/linkerd.io/content/2.17/tasks/install-helm.md b/linkerd.io/content/2.17/tasks/install-helm.md index dbb001c949..d9ae6e768b 100644 --- a/linkerd.io/content/2.17/tasks/install-helm.md +++ b/linkerd.io/content/2.17/tasks/install-helm.md @@ -6,7 +6,7 @@ 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. -{{< docs/edge-note >}} +{{< edge-note >}} ## Prerequisite: generate mTLS certificates diff --git a/linkerd.io/content/2.17/tasks/installing-multicluster.md b/linkerd.io/content/2.17/tasks/installing-multicluster.md index 8f36ce199e..32662be4a4 100644 --- a/linkerd.io/content/2.17/tasks/installing-multicluster.md +++ b/linkerd.io/content/2.17/tasks/installing-multicluster.md @@ -9,7 +9,7 @@ through this installation and configuration as well as common problems that you may encounter. For a detailed walkthrough and explanation of what's going on, check out [getting started](multicluster/). -{{< docs/production-note >}} +{{< production-note >}} ## Requirements diff --git a/linkerd.io/content/2.17/tasks/setting-up-service-profiles.md b/linkerd.io/content/2.17/tasks/setting-up-service-profiles.md index 25f6084bea..be9284058e 100644 --- a/linkerd.io/content/2.17/tasks/setting-up-service-profiles.md +++ b/linkerd.io/content/2.17/tasks/setting-up-service-profiles.md @@ -63,7 +63,7 @@ demo. There are a couple different ways to use `linkerd profile` to create service profiles. -{{< docs/toc >}} +{{< toc >}} Requests which have been associated with a route will have a `rt_route` annotation. To manually verify if the requests are being associated correctly, diff --git a/linkerd.io/content/2.17/tasks/traffic-shifting.md b/linkerd.io/content/2.17/tasks/traffic-shifting.md index 3c1bcdec9f..1091aa6198 100644 --- a/linkerd.io/content/2.17/tasks/traffic-shifting.md +++ b/linkerd.io/content/2.17/tasks/traffic-shifting.md @@ -20,7 +20,7 @@ development. {{< /note >}} -{{< docs/production-note >}} +{{< production-note >}} ## Prerequisites diff --git a/linkerd.io/content/2.17/tasks/using-the-debug-container.md b/linkerd.io/content/2.17/tasks/using-the-debug-container.md index 6e40eecd1a..ff7a10bce9 100644 --- a/linkerd.io/content/2.17/tasks/using-the-debug-container.md +++ b/linkerd.io/content/2.17/tasks/using-the-debug-container.md @@ -19,7 +19,7 @@ time. For convenience, the `linkerd inject` command provides an adding this annotation to a pre-existing pod will not work. It must be present at pod _creation_ time.) -{{< docs/production-note >}} +{{< production-note >}} The debug sidecar image contains [`tshark`](https://www.wireshark.org/docs/man-pages/tshark.html), `tcpdump`, diff --git a/linkerd.io/content/2.18/common-errors/_index.md b/linkerd.io/content/2.18/common-errors/_index.md index 68771bf652..a57718ba55 100644 --- a/linkerd.io/content/2.18/common-errors/_index.md +++ b/linkerd.io/content/2.18/common-errors/_index.md @@ -18,4 +18,4 @@ this command is. ## Common Errors -{{< docs/section-toc >}} +{{< section-toc >}} diff --git a/linkerd.io/content/2.18/features/_index.md b/linkerd.io/content/2.18/features/_index.md index cf341d4e7e..3eebfe67f4 100644 --- a/linkerd.io/content/2.18/features/_index.md +++ b/linkerd.io/content/2.18/features/_index.md @@ -11,4 +11,4 @@ please see the [Linkerd task docs](../tasks/). For a reference, see the ## Linkerd's features -{{< docs/section-toc >}} +{{< section-toc >}} diff --git a/linkerd.io/content/2.18/getting-started/_index.md b/linkerd.io/content/2.18/getting-started/_index.md index 1b00784931..7595fc0bf7 100644 --- a/linkerd.io/content/2.18/getting-started/_index.md +++ b/linkerd.io/content/2.18/getting-started/_index.md @@ -16,7 +16,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. -{{< docs/edge-note >}} +{{< edge-note >}} ## Step 0: Setup diff --git a/linkerd.io/content/2.18/reference/_index.md b/linkerd.io/content/2.18/reference/_index.md index f2045c2b56..c066e0b8ee 100644 --- a/linkerd.io/content/2.18/reference/_index.md +++ b/linkerd.io/content/2.18/reference/_index.md @@ -3,4 +3,4 @@ title: Reference weight: 5 --- -{{< docs/section-toc >}} +{{< section-toc >}} diff --git a/linkerd.io/content/2.18/reference/cli/_index.md b/linkerd.io/content/2.18/reference/cli/_index.md index ee36df6287..4d4170ffa7 100644 --- a/linkerd.io/content/2.18/reference/cli/_index.md +++ b/linkerd.io/content/2.18/reference/cli/_index.md @@ -9,10 +9,10 @@ detailed metrics for how your service is performing. As reference, check out the commands below: -{{< docs/cli-commands >}} +{{< cli-commands >}} ## Global flags The following flags are available for _all_ linkerd CLI commands: -{{< docs/cli-global-flags >}} +{{< cli-global-flags >}} diff --git a/linkerd.io/content/2.18/reference/cli/authz.md b/linkerd.io/content/2.18/reference/cli/authz.md index 2a6e55b55d..22df19a41c 100644 --- a/linkerd.io/content/2.18/reference/cli/authz.md +++ b/linkerd.io/content/2.18/reference/cli/authz.md @@ -2,10 +2,10 @@ title: authz --- -{{< docs/cli-description "authz" >}} +{{< cli-description "authz" >}} Check out the [Authorization Policy](../authorization-policy/) and [Restricting Access to Services](../../tasks/restricting-access/) documentation for all the details about authorization policy in Linkerd. -{{< docs/cli-flags "authz" >}} +{{< cli-flags "authz" >}} diff --git a/linkerd.io/content/2.18/reference/cli/check.md b/linkerd.io/content/2.18/reference/cli/check.md index 7cd61cd237..0c18a5da03 100644 --- a/linkerd.io/content/2.18/reference/cli/check.md +++ b/linkerd.io/content/2.18/reference/cli/check.md @@ -2,12 +2,12 @@ title: check --- -{{< docs/cli-description "check" >}} +{{< cli-description "check" >}} Take a look at the [troubleshooting](../../tasks/troubleshooting/) documentation for a full list of all the possible checks, what they do and how to fix them. -{{< docs/cli-examples "check" >}} +{{< cli-examples "check" >}} ## Example output @@ -53,4 +53,4 @@ control-plane-version Status check results are √ ``` -{{< docs/cli-flags "check" >}} +{{< cli-flags "check" >}} diff --git a/linkerd.io/content/2.18/reference/cli/completion.md b/linkerd.io/content/2.18/reference/cli/completion.md index 40e8438b72..6007a47fa5 100644 --- a/linkerd.io/content/2.18/reference/cli/completion.md +++ b/linkerd.io/content/2.18/reference/cli/completion.md @@ -2,8 +2,8 @@ title: completion --- -{{< docs/cli-description "completion" >}} +{{< cli-description "completion" >}} -{{< docs/cli-examples "completion" >}} +{{< cli-examples "completion" >}} -{{< docs/cli-flags "completion" >}} +{{< cli-flags "completion" >}} diff --git a/linkerd.io/content/2.18/reference/cli/diagnostics.md b/linkerd.io/content/2.18/reference/cli/diagnostics.md index ffa45c39be..8e4e36d234 100644 --- a/linkerd.io/content/2.18/reference/cli/diagnostics.md +++ b/linkerd.io/content/2.18/reference/cli/diagnostics.md @@ -2,44 +2,44 @@ title: diagnostics --- -{{< docs/cli-description "diagnostics" >}} +{{< cli-description "diagnostics" >}} -{{< docs/cli-examples "diagnostics" >}} +{{< cli-examples "diagnostics" >}} -{{< docs/cli-flags "diagnostics" >}} +{{< cli-flags "diagnostics" >}} ## Subcommands -{{< docs/cli-subcommands "diagnostics" >}} +{{< cli-subcommands "diagnostics" >}} ### controller-metrics -{{< docs/cli-description "diagnostics controller-metrics" >}} +{{< cli-description "diagnostics controller-metrics" >}} -{{< docs/cli-examples "diagnostics controller-metrics" >}} +{{< cli-examples "diagnostics controller-metrics" >}} -{{< docs/cli-flags "diagnostics controller-metrics" >}} +{{< cli-flags "diagnostics controller-metrics" >}} ### endpoints -{{< docs/cli-description "diagnostics endpoints" >}} +{{< cli-description "diagnostics endpoints" >}} -{{< docs/cli-examples "diagnostics endpoints" >}} +{{< cli-examples "diagnostics endpoints" >}} -{{< docs/cli-flags "diagnostics endpoints" >}} +{{< cli-flags "diagnostics endpoints" >}} ### install-sp -{{< docs/cli-description "diagnostics install-sp" >}} +{{< cli-description "diagnostics install-sp" >}} -{{< docs/cli-examples "diagnostics install-sp" >}} +{{< cli-examples "diagnostics install-sp" >}} -{{< docs/cli-flags "diagnostics install-sp" >}} +{{< cli-flags "diagnostics install-sp" >}} ### proxy-metrics -{{< docs/cli-description "diagnostics proxy-metrics" >}} +{{< cli-description "diagnostics proxy-metrics" >}} -{{< docs/cli-examples "diagnostics proxy-metrics" >}} +{{< cli-examples "diagnostics proxy-metrics" >}} -{{< docs/cli-flags "diagnostics proxy-metrics" >}} +{{< cli-flags "diagnostics proxy-metrics" >}} diff --git a/linkerd.io/content/2.18/reference/cli/identity.md b/linkerd.io/content/2.18/reference/cli/identity.md index 576d175930..c7962e8027 100644 --- a/linkerd.io/content/2.18/reference/cli/identity.md +++ b/linkerd.io/content/2.18/reference/cli/identity.md @@ -2,8 +2,8 @@ title: identity --- -{{< docs/cli-description "identity" >}} +{{< cli-description "identity" >}} -{{< docs/cli-examples "identity" >}} +{{< cli-examples "identity" >}} -{{< docs/cli-flags "identity" >}} +{{< cli-flags "identity" >}} diff --git a/linkerd.io/content/2.18/reference/cli/inject.md b/linkerd.io/content/2.18/reference/cli/inject.md index aafdacdb29..92fc0ca3cb 100644 --- a/linkerd.io/content/2.18/reference/cli/inject.md +++ b/linkerd.io/content/2.18/reference/cli/inject.md @@ -19,6 +19,6 @@ Alternatively, this command can also perform the full injection purely on the client side, by enabling with the `--manual` flag. (Prior to Linkerd 2.4, this was the default behavior.) -{{< docs/cli-examples "inject" >}} +{{< cli-examples "inject" >}} -{{< docs/cli-flags "inject" >}} +{{< cli-flags "inject" >}} diff --git a/linkerd.io/content/2.18/reference/cli/install-cni.md b/linkerd.io/content/2.18/reference/cli/install-cni.md index c7c457a6f1..d0577e3d3b 100644 --- a/linkerd.io/content/2.18/reference/cli/install-cni.md +++ b/linkerd.io/content/2.18/reference/cli/install-cni.md @@ -2,8 +2,8 @@ title: install-cni --- -{{< docs/cli-description "install-cni" >}} +{{< cli-description "install-cni" >}} -{{< docs/cli-examples "install-cni" >}} +{{< cli-examples "install-cni" >}} -{{< docs/cli-flags "install-cni" >}} +{{< cli-flags "install-cni" >}} diff --git a/linkerd.io/content/2.18/reference/cli/install.md b/linkerd.io/content/2.18/reference/cli/install.md index ab0dde824e..5fea59d7eb 100644 --- a/linkerd.io/content/2.18/reference/cli/install.md +++ b/linkerd.io/content/2.18/reference/cli/install.md @@ -2,11 +2,11 @@ title: install --- -{{< docs/cli-description "install" >}} +{{< cli-description "install" >}} For further details on how to install Linkerd onto your own cluster, check out the [install documentation](../../tasks/install/). -{{< docs/cli-examples "install" >}} +{{< cli-examples "install" >}} -{{< docs/cli-flags "install" >}} +{{< cli-flags "install" >}} diff --git a/linkerd.io/content/2.18/reference/cli/jaeger.md b/linkerd.io/content/2.18/reference/cli/jaeger.md index 1301361532..820ad6489c 100644 --- a/linkerd.io/content/2.18/reference/cli/jaeger.md +++ b/linkerd.io/content/2.18/reference/cli/jaeger.md @@ -2,52 +2,52 @@ title: jaeger --- -{{< docs/cli-description "jaeger" >}} +{{< cli-description "jaeger" >}} -{{< docs/cli-examples "jaeger" >}} +{{< cli-examples "jaeger" >}} -{{< docs/cli-flags "jaeger" >}} +{{< cli-flags "jaeger" >}} ## Subcommands -{{< docs/cli-subcommands "jaeger" >}} +{{< cli-subcommands "jaeger" >}} ### check -{{< docs/cli-description "jaeger check" >}} +{{< cli-description "jaeger check" >}} -{{< docs/cli-examples "jaeger check" >}} +{{< cli-examples "jaeger check" >}} -{{< docs/cli-flags "jaeger check" >}} +{{< cli-flags "jaeger check" >}} ### dashboard -{{< docs/cli-description "jaeger dashboard" >}} +{{< cli-description "jaeger dashboard" >}} -{{< docs/cli-examples "jaeger dashboard" >}} +{{< cli-examples "jaeger dashboard" >}} -{{< docs/cli-flags "jaeger dashboard" >}} +{{< cli-flags "jaeger dashboard" >}} ### install -{{< docs/cli-description "jaeger install" >}} +{{< cli-description "jaeger install" >}} -{{< docs/cli-examples "jaeger install" >}} +{{< cli-examples "jaeger install" >}} -{{< docs/cli-flags "jaeger install" >}} +{{< cli-flags "jaeger install" >}} ### list -{{< docs/cli-description "jaeger list" >}} +{{< cli-description "jaeger list" >}} -{{< docs/cli-examples "jaeger list" >}} +{{< cli-examples "jaeger list" >}} -{{< docs/cli-flags "jaeger list" >}} +{{< cli-flags "jaeger list" >}} ### uninstall -{{< docs/cli-description "jaeger uninstall" >}} +{{< cli-description "jaeger uninstall" >}} -{{< docs/cli-examples "jaeger uninstall" >}} +{{< cli-examples "jaeger uninstall" >}} -{{< docs/cli-flags "jaeger uninstall" >}} +{{< cli-flags "jaeger uninstall" >}} diff --git a/linkerd.io/content/2.18/reference/cli/multicluster.md b/linkerd.io/content/2.18/reference/cli/multicluster.md index 523191d82b..134d809f01 100644 --- a/linkerd.io/content/2.18/reference/cli/multicluster.md +++ b/linkerd.io/content/2.18/reference/cli/multicluster.md @@ -2,60 +2,60 @@ title: multicluster --- -{{< docs/cli-description "multicluster" >}} +{{< cli-description "multicluster" >}} -{{< docs/cli-examples "multicluster" >}} +{{< cli-examples "multicluster" >}} -{{< docs/cli-flags "multicluster" >}} +{{< cli-flags "multicluster" >}} ## Subcommands -{{< docs/cli-subcommands "multicluster" >}} +{{< cli-subcommands "multicluster" >}} ### allow -{{< docs/cli-description "multicluster allow" >}} +{{< cli-description "multicluster allow" >}} -{{< docs/cli-examples "multicluster allow" >}} +{{< cli-examples "multicluster allow" >}} -{{< docs/cli-flags "multicluster allow" >}} +{{< cli-flags "multicluster allow" >}} ### check -{{< docs/cli-description "multicluster check" >}} +{{< cli-description "multicluster check" >}} -{{< docs/cli-examples "multicluster check" >}} +{{< cli-examples "multicluster check" >}} -{{< docs/cli-flags "multicluster check" >}} +{{< cli-flags "multicluster check" >}} ### gateways -{{< docs/cli-description "multicluster gateways" >}} +{{< cli-description "multicluster gateways" >}} -{{< docs/cli-examples "multicluster gateways" >}} +{{< cli-examples "multicluster gateways" >}} -{{< docs/cli-flags "multicluster gateways" >}} +{{< cli-flags "multicluster gateways" >}} ### install -{{< docs/cli-description "multicluster install" >}} +{{< cli-description "multicluster install" >}} -{{< docs/cli-examples "multicluster install" >}} +{{< cli-examples "multicluster install" >}} -{{< docs/cli-flags "multicluster install" >}} +{{< cli-flags "multicluster install" >}} ### link-gen -{{< docs/cli-description "multicluster link-gen" >}} +{{< cli-description "multicluster link-gen" >}} -{{< docs/cli-examples "multicluster link-gen" >}} +{{< cli-examples "multicluster link-gen" >}} -{{< docs/cli-flags "multicluster link-gen" >}} +{{< cli-flags "multicluster link-gen" >}} ### uninstall -{{< docs/cli-description "multicluster uninstall" >}} +{{< cli-description "multicluster uninstall" >}} -{{< docs/cli-examples "multicluster uninstall" >}} +{{< cli-examples "multicluster uninstall" >}} -{{< docs/cli-flags "multicluster uninstall" >}} +{{< cli-flags "multicluster uninstall" >}} diff --git a/linkerd.io/content/2.18/reference/cli/profile.md b/linkerd.io/content/2.18/reference/cli/profile.md index 5cc919b876..bf2545c313 100644 --- a/linkerd.io/content/2.18/reference/cli/profile.md +++ b/linkerd.io/content/2.18/reference/cli/profile.md @@ -2,12 +2,12 @@ title: profile --- -{{< docs/cli-description "profile" >}} +{{< cli-description "profile" >}} Check out the [service profile](../../features/service-profiles/) documentation for more details on what this command does and what you can do with service profiles. -{{< docs/cli-examples "profile" >}} +{{< cli-examples "profile" >}} -{{< docs/cli-flags "profile" >}} +{{< cli-flags "profile" >}} diff --git a/linkerd.io/content/2.18/reference/cli/prune.md b/linkerd.io/content/2.18/reference/cli/prune.md index 68675991ed..1ec604588f 100644 --- a/linkerd.io/content/2.18/reference/cli/prune.md +++ b/linkerd.io/content/2.18/reference/cli/prune.md @@ -2,8 +2,8 @@ title: prune --- -{{< docs/cli-description "prune" >}} +{{< cli-description "prune" >}} -{{< docs/cli-examples "prune" >}} +{{< cli-examples "prune" >}} -{{< docs/cli-flags "prune" >}} +{{< cli-flags "prune" >}} diff --git a/linkerd.io/content/2.18/reference/cli/uninject.md b/linkerd.io/content/2.18/reference/cli/uninject.md index 9ad619698a..6f43c3cf0a 100644 --- a/linkerd.io/content/2.18/reference/cli/uninject.md +++ b/linkerd.io/content/2.18/reference/cli/uninject.md @@ -2,8 +2,8 @@ title: uninject --- -{{< docs/cli-description "uninject" >}} +{{< cli-description "uninject" >}} -{{< docs/cli-examples "uninject" >}} +{{< cli-examples "uninject" >}} -{{< docs/cli-flags "uninject" >}} +{{< cli-flags "uninject" >}} diff --git a/linkerd.io/content/2.18/reference/cli/uninstall.md b/linkerd.io/content/2.18/reference/cli/uninstall.md index d5e00031ed..d62dd11612 100644 --- a/linkerd.io/content/2.18/reference/cli/uninstall.md +++ b/linkerd.io/content/2.18/reference/cli/uninstall.md @@ -2,8 +2,8 @@ title: uninstall --- -{{< docs/cli-description "uninstall" >}} +{{< cli-description "uninstall" >}} -{{< docs/cli-examples "uninstall" >}} +{{< cli-examples "uninstall" >}} -{{< docs/cli-flags "uninstall" >}} +{{< cli-flags "uninstall" >}} diff --git a/linkerd.io/content/2.18/reference/cli/upgrade.md b/linkerd.io/content/2.18/reference/cli/upgrade.md index c4422b57c9..70b3296d8a 100644 --- a/linkerd.io/content/2.18/reference/cli/upgrade.md +++ b/linkerd.io/content/2.18/reference/cli/upgrade.md @@ -2,8 +2,8 @@ title: upgrade --- -{{< docs/cli-description "upgrade" >}} +{{< cli-description "upgrade" >}} -{{< docs/cli-examples "upgrade" >}} +{{< cli-examples "upgrade" >}} -{{< docs/cli-flags "upgrade" >}} +{{< cli-flags "upgrade" >}} diff --git a/linkerd.io/content/2.18/reference/cli/version.md b/linkerd.io/content/2.18/reference/cli/version.md index 159f0b2f65..d31d7b18e6 100644 --- a/linkerd.io/content/2.18/reference/cli/version.md +++ b/linkerd.io/content/2.18/reference/cli/version.md @@ -2,8 +2,8 @@ title: version --- -{{< docs/cli-description "version" >}} +{{< cli-description "version" >}} -{{< docs/cli-examples "version" >}} +{{< cli-examples "version" >}} -{{< docs/cli-flags "version" >}} +{{< cli-flags "version" >}} diff --git a/linkerd.io/content/2.18/reference/cli/viz.md b/linkerd.io/content/2.18/reference/cli/viz.md index 2477e875ba..9a11e245d9 100644 --- a/linkerd.io/content/2.18/reference/cli/viz.md +++ b/linkerd.io/content/2.18/reference/cli/viz.md @@ -2,50 +2,50 @@ title: viz --- -{{< docs/cli-description "viz" >}} +{{< cli-description "viz" >}} -{{< docs/cli-examples "viz" >}} +{{< cli-examples "viz" >}} -{{< docs/cli-flags "viz" >}} +{{< cli-flags "viz" >}} ## Subcommands -{{< docs/cli-subcommands "viz" >}} +{{< cli-subcommands "viz" >}} ### allow-scrapes -{{< docs/cli-description "viz allow-scrapes" >}} +{{< cli-description "viz allow-scrapes" >}} -{{< docs/cli-examples "viz allow-scrapes" >}} +{{< cli-examples "viz allow-scrapes" >}} -{{< docs/cli-flags "viz allow-scrapes" >}} +{{< cli-flags "viz allow-scrapes" >}} ### authz -{{< docs/cli-description "viz authz" >}} +{{< cli-description "viz authz" >}} -{{< docs/cli-examples "viz authz" >}} +{{< cli-examples "viz authz" >}} -{{< docs/cli-flags "viz authz" >}} +{{< cli-flags "viz authz" >}} ### check -{{< docs/cli-description "viz check" >}} +{{< cli-description "viz check" >}} -{{< docs/cli-examples "viz check" >}} +{{< cli-examples "viz check" >}} -{{< docs/cli-flags "viz check" >}} +{{< cli-flags "viz check" >}} ### dashboard -{{< docs/cli-description "viz dashboard" >}} +{{< cli-description "viz dashboard" >}} Check out the [architecture](../architecture/#dashboard) docs for a more thorough explanation of what this command does. -{{< docs/cli-examples "viz dashboard" >}} +{{< cli-examples "viz dashboard" >}} -{{< docs/cli-flags "viz dashboard" >}} +{{< cli-flags "viz dashboard" >}} (\*) You'll need to tweak the dashboard's `enforced-host` parameter with this value, as explained in @@ -53,35 +53,35 @@ value, as explained in ### edges -{{< docs/cli-description "viz edges" >}} +{{< cli-description "viz edges" >}} -{{< docs/cli-examples "viz edges" >}} +{{< cli-examples "viz edges" >}} -{{< docs/cli-flags "viz edges" >}} +{{< cli-flags "viz edges" >}} ### install -{{< docs/cli-description "viz install" >}} +{{< cli-description "viz install" >}} -{{< docs/cli-examples "viz install" >}} +{{< cli-examples "viz install" >}} -{{< docs/cli-flags "viz install" >}} +{{< cli-flags "viz install" >}} ### list -{{< docs/cli-description "viz list" >}} +{{< cli-description "viz list" >}} -{{< docs/cli-examples "viz list" >}} +{{< cli-examples "viz list" >}} -{{< docs/cli-flags "viz list" >}} +{{< cli-flags "viz list" >}} ### profile -{{< docs/cli-description "viz profile" >}} +{{< cli-description "viz profile" >}} -{{< docs/cli-examples "viz profile" >}} +{{< cli-examples "viz profile" >}} -{{< docs/cli-flags "viz profile" >}} +{{< cli-flags "viz profile" >}} ### routes @@ -140,38 +140,38 @@ information. Because retries are only performed on the _outbound_ (client) side, the `-o wide` flag can only be used when the `--to` flag is specified. -{{< docs/cli-examples "viz routes" >}} +{{< cli-examples "viz routes" >}} -{{< docs/cli-flags "viz routes" >}} +{{< cli-flags "viz routes" >}} ### stat -{{< docs/cli-description "viz stat" >}} +{{< cli-description "viz stat" >}} -{{< docs/cli-examples "viz stat" >}} +{{< cli-examples "viz stat" >}} -{{< docs/cli-flags "viz stat" >}} +{{< cli-flags "viz stat" >}} ### tap -{{< docs/cli-description "viz tap" >}} +{{< cli-description "viz tap" >}} -{{< docs/cli-examples "viz tap" >}} +{{< cli-examples "viz tap" >}} -{{< docs/cli-flags "viz tap" >}} +{{< cli-flags "viz tap" >}} ### top -{{< docs/cli-description "viz top" >}} +{{< cli-description "viz top" >}} -{{< docs/cli-examples "viz top" >}} +{{< cli-examples "viz top" >}} -{{< docs/cli-flags "viz top" >}} +{{< cli-flags "viz top" >}} ### uninstall -{{< docs/cli-description "viz uninstall" >}} +{{< cli-description "viz uninstall" >}} -{{< docs/cli-examples "viz uninstall" >}} +{{< cli-examples "viz uninstall" >}} -{{< docs/cli-flags "viz uninstall" >}} +{{< cli-flags "viz uninstall" >}} diff --git a/linkerd.io/content/2.18/reference/extension-list.md b/linkerd.io/content/2.18/reference/extension-list.md index e6bdad697e..32afc3fd09 100644 --- a/linkerd.io/content/2.18/reference/extension-list.md +++ b/linkerd.io/content/2.18/reference/extension-list.md @@ -9,7 +9,7 @@ Linkerd provides a mix of built-in and third-party [extensions](../tasks/extensions/) to add additional functionality to the base installation. The following is the list of known extensions: -{{< docs/extensions >}} +{{< extensions >}} If you have an extension for Linkerd and it is not on the list, [please edit this page!](https://github.com/linkerd/website/edit/main/linkerd.io/data/extension-list.yaml) diff --git a/linkerd.io/content/2.18/reference/proxy-configuration.md b/linkerd.io/content/2.18/reference/proxy-configuration.md index 80b471f88b..847b0a53d4 100644 --- a/linkerd.io/content/2.18/reference/proxy-configuration.md +++ b/linkerd.io/content/2.18/reference/proxy-configuration.md @@ -11,7 +11,7 @@ configurations of [auto-injected proxies](../features/proxy-injection/). The following is the list of supported annotations: -{{< docs/cli-annotations "inject" >}} +{{< cli-annotations "inject" >}} For example, to update an auto-injected proxy's CPU and memory resources, we insert the appropriate annotations into the `spec.template.metadata.annotations` diff --git a/linkerd.io/content/2.18/tasks/_index.md b/linkerd.io/content/2.18/tasks/_index.md index cfca319184..19a83aee53 100644 --- a/linkerd.io/content/2.18/tasks/_index.md +++ b/linkerd.io/content/2.18/tasks/_index.md @@ -9,4 +9,4 @@ common tasks that you may need to perform when using Linkerd. ## Common Linkerd tasks -{{< docs/section-toc >}} +{{< section-toc >}} diff --git a/linkerd.io/content/2.18/tasks/automatic-failover.md b/linkerd.io/content/2.18/tasks/automatic-failover.md index f45c66d817..233764e38f 100644 --- a/linkerd.io/content/2.18/tasks/automatic-failover.md +++ b/linkerd.io/content/2.18/tasks/automatic-failover.md @@ -25,7 +25,7 @@ Emojivoto application on two Kubernetes clusters and simulating a failure in one cluster. We will see the failover controller shift traffic to the other cluster to ensure the service remains available. -{{< docs/production-note >}} +{{< production-note >}} ## Prerequisites diff --git a/linkerd.io/content/2.18/tasks/automatically-rotating-control-plane-tls-credentials.md b/linkerd.io/content/2.18/tasks/automatically-rotating-control-plane-tls-credentials.md index fb3c874952..425dd65dad 100644 --- a/linkerd.io/content/2.18/tasks/automatically-rotating-control-plane-tls-credentials.md +++ b/linkerd.io/content/2.18/tasks/automatically-rotating-control-plane-tls-credentials.md @@ -27,7 +27,7 @@ with a validity of one year but require manual rotation by the user to prevent expiry. While this setup is convenient for quick start testing, it's not advisable nor recommended for production environments. -{{< docs/production-note >}} +{{< production-note >}} ## Automating Certificate Management with cert-manager and trust-manager @@ -244,18 +244,18 @@ EOF {{< warning >}} The default value of the `rotationPolicy` in the Certificate's `privateKey` -section is dependent on your version of cert-manager. In version 1.17 and -below, the default value was `Never`. With this configuration, cert-manager -**will not** actually rotate the trust anchor: instead, it will update the -validity timestamps but **not** generate a new private key. -**This is definitely not as secure as rotating the private key**. +section is dependent on your version of cert-manager. In version 1.17 and below, +the default value was `Never`. With this configuration, cert-manager **will +not** actually rotate the trust anchor: instead, it will update the validity +timestamps but **not** generate a new private key. **This is definitely not as +secure as rotating the private key**. If you are upgrading cert-manager from version 1.17 or below to version 1.18 or above, be aware that this new default will change the `rotationPolicy` if you are not explicitly setting it in your Certificate resource manifest. -To avoid ambiguity, we recommend always setting `rotationPolicy: Always` for -any certificate that cert-manager is managing. +To avoid ambiguity, we recommend always setting `rotationPolicy: Always` for any +certificate that cert-manager is managing. {{< /warning >}} @@ -360,18 +360,18 @@ EOF {{< warning >}} The default value of the `rotationPolicy` in the Certificate's `privateKey` -section is dependent on your version of cert-manager. In version 1.17 and -below, the default value was `Never`. With this configuration, cert-manager -**will not** actually rotate the trust anchor: instead, it will update the -validity timestamps but **not** generate a new private key. -**This is definitely not as secure as rotating the private key**. +section is dependent on your version of cert-manager. In version 1.17 and below, +the default value was `Never`. With this configuration, cert-manager **will +not** actually rotate the trust anchor: instead, it will update the validity +timestamps but **not** generate a new private key. **This is definitely not as +secure as rotating the private key**. If you are upgrading cert-manager from version 1.17 or below to version 1.18 or above, be aware that this new default will change the `rotationPolicy` if you are not explicitly setting it in your Certificate resource manifest. -To avoid ambiguity, we recommend always setting `rotationPolicy: Always` for -any certificate that cert-manager is managing. +To avoid ambiguity, we recommend always setting `rotationPolicy: Always` for any +certificate that cert-manager is managing. {{< /warning >}} @@ -777,10 +777,10 @@ _requires_ manual intervention, because while cert-manager can handle the hard work of actually rotating the trust anchor, it can't trigger the needed restarts. -This means that the simplest way to handle trust anchor rotation is -to _trigger the rotation manually_ whenever it's convenient for you so that -you can manage the trust bundle and restarts while letting cert-manager manage -the trust anchor certificate. +This means that the simplest way to handle trust anchor rotation is to _trigger +the rotation manually_ whenever it's convenient for you so that you can manage +the trust bundle and restarts while letting cert-manager manage the trust anchor +certificate. The process of actually doing this is straightforward, but again, there are several steps: @@ -830,8 +830,8 @@ kubectl get secret -n cert-manager linkerd-previous-anchor \ | base64 -d | inspect_cert ``` -Verify that the `linkerd-identity-trust-roots` ConfigMap now contains -the Subject keys from both Secrets. +Verify that the `linkerd-identity-trust-roots` ConfigMap now contains the +Subject keys from both Secrets. ```bash kubectl get configmap -n linkerd linkerd-identity-trust-roots \ @@ -858,9 +858,9 @@ This will cause the control plane to pick up the new trust anchor bundle. #### 3. Restart the data plane At this point, you'll need to restart your workloads as well, to force the -proxies to have the new trust anchor bundle. The exact mechanism to do this -will depend on your workloads, but it's often just `kubectl rollout restart` for -each of your application namespaces. +proxies to have the new trust anchor bundle. The exact mechanism to do this will +depend on your workloads, but it's often just `kubectl rollout restart` for each +of your application namespaces. #### 4. Triggering identity issuer rotation @@ -905,10 +905,10 @@ issuer. #### 6. Restart the data plane -Again, you'll need to restart your workloads, to force the -proxies to switch to the new identity issuer signed by the new trust anchor. -The exact mechanism to do this will depend on your workloads, but it's often -just `kubectl rollout restart` for each of your application namespaces. +Again, you'll need to restart your workloads, to force the proxies to switch to +the new identity issuer signed by the new trust anchor. The exact mechanism to +do this will depend on your workloads, but it's often just +`kubectl rollout restart` for each of your application namespaces. #### 7. Remove the old anchor from the trust bundle diff --git a/linkerd.io/content/2.18/tasks/automatically-rotating-webhook-tls-credentials.md b/linkerd.io/content/2.18/tasks/automatically-rotating-webhook-tls-credentials.md index 295aaa202d..da18a33094 100644 --- a/linkerd.io/content/2.18/tasks/automatically-rotating-webhook-tls-credentials.md +++ b/linkerd.io/content/2.18/tasks/automatically-rotating-webhook-tls-credentials.md @@ -22,7 +22,7 @@ This workflow is suitable for most users. However, if you need these webhook certificates to be rotated automatically on a regular basis, it is possible to use cert-manager to automatically manage them. -{{< docs/production-note >}} +{{< production-note >}} ## Install Cert manager diff --git a/linkerd.io/content/2.18/tasks/circuit-breakers.md b/linkerd.io/content/2.18/tasks/circuit-breakers.md index 13425e16dd..d038ccf382 100644 --- a/linkerd.io/content/2.18/tasks/circuit-breakers.md +++ b/linkerd.io/content/2.18/tasks/circuit-breakers.md @@ -13,7 +13,7 @@ improve client success rate when a backend replica is unhealthy. See the [reference documentation](../reference/circuit-breaking/) for more details on how Linkerd implements circuit breaking. -{{< docs/production-note >}} +{{< production-note >}} ## Prerequisites diff --git a/linkerd.io/content/2.18/tasks/customize-install.md b/linkerd.io/content/2.18/tasks/customize-install.md index dc71604c3c..512bb3629d 100644 --- a/linkerd.io/content/2.18/tasks/customize-install.md +++ b/linkerd.io/content/2.18/tasks/customize-install.md @@ -9,7 +9,7 @@ Instead of forking the Linkerd install and upgrade process, `linkerd install` in a consistent way. This allows customization of the install to add functionality specific to installations. -{{< docs/production-note >}} +{{< production-note >}} To get started, save the output of `linkerd install` to a YAML file. This will be the base resource that Kustomize uses to patch and generate what is added to diff --git a/linkerd.io/content/2.18/tasks/exporting-metrics.md b/linkerd.io/content/2.18/tasks/exporting-metrics.md index 877aedf5a2..96fc7f24f0 100644 --- a/linkerd.io/content/2.18/tasks/exporting-metrics.md +++ b/linkerd.io/content/2.18/tasks/exporting-metrics.md @@ -13,7 +13,7 @@ each proxy only provides a portion of the full picture. Instead, a separate tool is used to collect metrics from all proxies and aggregate them together for consumption. -{{< docs/production-note >}} +{{< production-note >}} One easy option is the [linkerd-viz](../features/dashboard/) extension, which will create an on-cluster Prometheus instance as well as dashboards and CLI @@ -74,7 +74,7 @@ metadata: k8s-app: linkerd-prometheus release: monitoring name: linkerd-federate - namespace: {{.Namespace}} + namespace: { { .Namespace } } spec: endpoints: - interval: 30s @@ -94,7 +94,7 @@ spec: jobLabel: app namespaceSelector: matchNames: - - {{.Namespace}} + - { { .Namespace } } selector: matchLabels: component: prometheus diff --git a/linkerd.io/content/2.18/tasks/exposing-dashboard.md b/linkerd.io/content/2.18/tasks/exposing-dashboard.md index fe8cf24afe..0f0d9ef682 100644 --- a/linkerd.io/content/2.18/tasks/exposing-dashboard.md +++ b/linkerd.io/content/2.18/tasks/exposing-dashboard.md @@ -10,7 +10,7 @@ going on, you can expose the dashboard via an ingress. This will also expose Grafana, if you have it linked against Linkerd viz through the `grafana.url` setting. -{{< docs/toc >}} +{{< toc >}} ## Nginx diff --git a/linkerd.io/content/2.18/tasks/external-prometheus.md b/linkerd.io/content/2.18/tasks/external-prometheus.md index ccd0434d2d..4bc0dc59e6 100644 --- a/linkerd.io/content/2.18/tasks/external-prometheus.md +++ b/linkerd.io/content/2.18/tasks/external-prometheus.md @@ -12,7 +12,7 @@ both the control plane as well as the proxy's metrics in a format that is consumable both by a user as well as Linkerd control plane components like web, etc. -{{< docs/production-note >}} +{{< production-note >}} There are two important points to tackle here. diff --git a/linkerd.io/content/2.18/tasks/flagger.md b/linkerd.io/content/2.18/tasks/flagger.md index 356ac3b38e..a8a03f093e 100644 --- a/linkerd.io/content/2.18/tasks/flagger.md +++ b/linkerd.io/content/2.18/tasks/flagger.md @@ -23,7 +23,7 @@ tools: [Flagger](https://flagger.app/) and metrics and request routing together in a control loop, allowing for fully-automated, metrics-aware canary deployments. -{{< docs/production-note >}} +{{< production-note >}} ## Prerequisites diff --git a/linkerd.io/content/2.18/tasks/generate-certificates.md b/linkerd.io/content/2.18/tasks/generate-certificates.md index 35013ac056..33dd6751d1 100644 --- a/linkerd.io/content/2.18/tasks/generate-certificates.md +++ b/linkerd.io/content/2.18/tasks/generate-certificates.md @@ -23,7 +23,7 @@ algorithm which is the default for `step`. To generate ECDSA P-256 certificates with openssl, you can use the `openssl ecparam -name prime256v1` command. In this tutorial, we'll walk you through how to to use the `step` CLI to do this. -{{< docs/production-note >}} +{{< production-note >}} ## Generating the certificates with `step` diff --git a/linkerd.io/content/2.18/tasks/gitops.md b/linkerd.io/content/2.18/tasks/gitops.md index 51328396a3..70c2346f70 100644 --- a/linkerd.io/content/2.18/tasks/gitops.md +++ b/linkerd.io/content/2.18/tasks/gitops.md @@ -12,7 +12,7 @@ This guide will show you how to set up [Argo CD](https://argoproj.github.io/argo-cd/) to manage the installation and upgrade of Linkerd using a GitOps workflow. -{{< docs/production-note >}} +{{< production-note >}} Specifically, this guide provides instructions on how to securely generate and manage Linkerd's mTLS private keys and certificates using diff --git a/linkerd.io/content/2.18/tasks/grafana.md b/linkerd.io/content/2.18/tasks/grafana.md index b37b01af71..9be0209fbb 100644 --- a/linkerd.io/content/2.18/tasks/grafana.md +++ b/linkerd.io/content/2.18/tasks/grafana.md @@ -13,7 +13,7 @@ First, you need to install Grafana from a variety of possible sources, and then load the suite of Grafana dashboards that have been pre-configured to consume the metrics exposed by Linkerd. -{{< docs/production-note >}} +{{< production-note >}} ## Install Prometheus @@ -85,7 +85,7 @@ is set up, as shown in the sample `grafana/values.yaml` file: ```yaml grafana.ini: server: - root_url: "%(protocol)s://%(domain)s:/grafana/" + root_url: '%(protocol)s://%(domain)s:/grafana/' ``` Then refer the location of your Grafana service in the Linkerd Viz `values.yaml` diff --git a/linkerd.io/content/2.18/tasks/install-helm.md b/linkerd.io/content/2.18/tasks/install-helm.md index 322b53fd41..46970a8825 100644 --- a/linkerd.io/content/2.18/tasks/install-helm.md +++ b/linkerd.io/content/2.18/tasks/install-helm.md @@ -6,7 +6,7 @@ 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. -{{< docs/edge-note >}} +{{< edge-note >}} ## Prerequisite: generate mTLS certificates diff --git a/linkerd.io/content/2.18/tasks/installing-multicluster.md b/linkerd.io/content/2.18/tasks/installing-multicluster.md index 2323119ef8..d3e47ded8e 100644 --- a/linkerd.io/content/2.18/tasks/installing-multicluster.md +++ b/linkerd.io/content/2.18/tasks/installing-multicluster.md @@ -9,7 +9,7 @@ through this installation and configuration as well as common problems that you may encounter. For a detailed walkthrough and explanation of what's going on, check out [getting started](multicluster/). -{{< docs/production-note >}} +{{< production-note >}} ## Requirements diff --git a/linkerd.io/content/2.18/tasks/setting-up-service-profiles.md b/linkerd.io/content/2.18/tasks/setting-up-service-profiles.md index 25f6084bea..be9284058e 100644 --- a/linkerd.io/content/2.18/tasks/setting-up-service-profiles.md +++ b/linkerd.io/content/2.18/tasks/setting-up-service-profiles.md @@ -63,7 +63,7 @@ demo. There are a couple different ways to use `linkerd profile` to create service profiles. -{{< docs/toc >}} +{{< toc >}} Requests which have been associated with a route will have a `rt_route` annotation. To manually verify if the requests are being associated correctly, diff --git a/linkerd.io/content/2.18/tasks/traffic-shifting.md b/linkerd.io/content/2.18/tasks/traffic-shifting.md index 3c1bcdec9f..1091aa6198 100644 --- a/linkerd.io/content/2.18/tasks/traffic-shifting.md +++ b/linkerd.io/content/2.18/tasks/traffic-shifting.md @@ -20,7 +20,7 @@ development. {{< /note >}} -{{< docs/production-note >}} +{{< production-note >}} ## Prerequisites diff --git a/linkerd.io/content/2.18/tasks/using-the-debug-container.md b/linkerd.io/content/2.18/tasks/using-the-debug-container.md index 6e40eecd1a..ff7a10bce9 100644 --- a/linkerd.io/content/2.18/tasks/using-the-debug-container.md +++ b/linkerd.io/content/2.18/tasks/using-the-debug-container.md @@ -19,7 +19,7 @@ time. For convenience, the `linkerd inject` command provides an adding this annotation to a pre-existing pod will not work. It must be present at pod _creation_ time.) -{{< docs/production-note >}} +{{< production-note >}} The debug sidecar image contains [`tshark`](https://www.wireshark.org/docs/man-pages/tshark.html), `tcpdump`, diff --git a/linkerd.io/content/2.19/common-errors/_index.md b/linkerd.io/content/2.19/common-errors/_index.md index 68771bf652..a57718ba55 100644 --- a/linkerd.io/content/2.19/common-errors/_index.md +++ b/linkerd.io/content/2.19/common-errors/_index.md @@ -18,4 +18,4 @@ this command is. ## Common Errors -{{< docs/section-toc >}} +{{< section-toc >}} diff --git a/linkerd.io/content/2.19/features/_index.md b/linkerd.io/content/2.19/features/_index.md index cf341d4e7e..3eebfe67f4 100644 --- a/linkerd.io/content/2.19/features/_index.md +++ b/linkerd.io/content/2.19/features/_index.md @@ -11,4 +11,4 @@ please see the [Linkerd task docs](../tasks/). For a reference, see the ## Linkerd's features -{{< docs/section-toc >}} +{{< section-toc >}} diff --git a/linkerd.io/content/2.19/getting-started/_index.md b/linkerd.io/content/2.19/getting-started/_index.md index 5e3af75210..d58cceee52 100644 --- a/linkerd.io/content/2.19/getting-started/_index.md +++ b/linkerd.io/content/2.19/getting-started/_index.md @@ -16,7 +16,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. -{{< docs/edge-note >}} +{{< edge-note >}} ## Step 0: Setup diff --git a/linkerd.io/content/2.19/reference/_index.md b/linkerd.io/content/2.19/reference/_index.md index f2045c2b56..c066e0b8ee 100644 --- a/linkerd.io/content/2.19/reference/_index.md +++ b/linkerd.io/content/2.19/reference/_index.md @@ -3,4 +3,4 @@ title: Reference weight: 5 --- -{{< docs/section-toc >}} +{{< section-toc >}} diff --git a/linkerd.io/content/2.19/reference/cli/_index.md b/linkerd.io/content/2.19/reference/cli/_index.md index ee36df6287..4d4170ffa7 100644 --- a/linkerd.io/content/2.19/reference/cli/_index.md +++ b/linkerd.io/content/2.19/reference/cli/_index.md @@ -9,10 +9,10 @@ detailed metrics for how your service is performing. As reference, check out the commands below: -{{< docs/cli-commands >}} +{{< cli-commands >}} ## Global flags The following flags are available for _all_ linkerd CLI commands: -{{< docs/cli-global-flags >}} +{{< cli-global-flags >}} diff --git a/linkerd.io/content/2.19/reference/cli/authz.md b/linkerd.io/content/2.19/reference/cli/authz.md index 2a6e55b55d..22df19a41c 100644 --- a/linkerd.io/content/2.19/reference/cli/authz.md +++ b/linkerd.io/content/2.19/reference/cli/authz.md @@ -2,10 +2,10 @@ title: authz --- -{{< docs/cli-description "authz" >}} +{{< cli-description "authz" >}} Check out the [Authorization Policy](../authorization-policy/) and [Restricting Access to Services](../../tasks/restricting-access/) documentation for all the details about authorization policy in Linkerd. -{{< docs/cli-flags "authz" >}} +{{< cli-flags "authz" >}} diff --git a/linkerd.io/content/2.19/reference/cli/check.md b/linkerd.io/content/2.19/reference/cli/check.md index 7cd61cd237..0c18a5da03 100644 --- a/linkerd.io/content/2.19/reference/cli/check.md +++ b/linkerd.io/content/2.19/reference/cli/check.md @@ -2,12 +2,12 @@ title: check --- -{{< docs/cli-description "check" >}} +{{< cli-description "check" >}} Take a look at the [troubleshooting](../../tasks/troubleshooting/) documentation for a full list of all the possible checks, what they do and how to fix them. -{{< docs/cli-examples "check" >}} +{{< cli-examples "check" >}} ## Example output @@ -53,4 +53,4 @@ control-plane-version Status check results are √ ``` -{{< docs/cli-flags "check" >}} +{{< cli-flags "check" >}} diff --git a/linkerd.io/content/2.19/reference/cli/completion.md b/linkerd.io/content/2.19/reference/cli/completion.md index 40e8438b72..6007a47fa5 100644 --- a/linkerd.io/content/2.19/reference/cli/completion.md +++ b/linkerd.io/content/2.19/reference/cli/completion.md @@ -2,8 +2,8 @@ title: completion --- -{{< docs/cli-description "completion" >}} +{{< cli-description "completion" >}} -{{< docs/cli-examples "completion" >}} +{{< cli-examples "completion" >}} -{{< docs/cli-flags "completion" >}} +{{< cli-flags "completion" >}} diff --git a/linkerd.io/content/2.19/reference/cli/diagnostics.md b/linkerd.io/content/2.19/reference/cli/diagnostics.md index ffa45c39be..8e4e36d234 100644 --- a/linkerd.io/content/2.19/reference/cli/diagnostics.md +++ b/linkerd.io/content/2.19/reference/cli/diagnostics.md @@ -2,44 +2,44 @@ title: diagnostics --- -{{< docs/cli-description "diagnostics" >}} +{{< cli-description "diagnostics" >}} -{{< docs/cli-examples "diagnostics" >}} +{{< cli-examples "diagnostics" >}} -{{< docs/cli-flags "diagnostics" >}} +{{< cli-flags "diagnostics" >}} ## Subcommands -{{< docs/cli-subcommands "diagnostics" >}} +{{< cli-subcommands "diagnostics" >}} ### controller-metrics -{{< docs/cli-description "diagnostics controller-metrics" >}} +{{< cli-description "diagnostics controller-metrics" >}} -{{< docs/cli-examples "diagnostics controller-metrics" >}} +{{< cli-examples "diagnostics controller-metrics" >}} -{{< docs/cli-flags "diagnostics controller-metrics" >}} +{{< cli-flags "diagnostics controller-metrics" >}} ### endpoints -{{< docs/cli-description "diagnostics endpoints" >}} +{{< cli-description "diagnostics endpoints" >}} -{{< docs/cli-examples "diagnostics endpoints" >}} +{{< cli-examples "diagnostics endpoints" >}} -{{< docs/cli-flags "diagnostics endpoints" >}} +{{< cli-flags "diagnostics endpoints" >}} ### install-sp -{{< docs/cli-description "diagnostics install-sp" >}} +{{< cli-description "diagnostics install-sp" >}} -{{< docs/cli-examples "diagnostics install-sp" >}} +{{< cli-examples "diagnostics install-sp" >}} -{{< docs/cli-flags "diagnostics install-sp" >}} +{{< cli-flags "diagnostics install-sp" >}} ### proxy-metrics -{{< docs/cli-description "diagnostics proxy-metrics" >}} +{{< cli-description "diagnostics proxy-metrics" >}} -{{< docs/cli-examples "diagnostics proxy-metrics" >}} +{{< cli-examples "diagnostics proxy-metrics" >}} -{{< docs/cli-flags "diagnostics proxy-metrics" >}} +{{< cli-flags "diagnostics proxy-metrics" >}} diff --git a/linkerd.io/content/2.19/reference/cli/identity.md b/linkerd.io/content/2.19/reference/cli/identity.md index 576d175930..c7962e8027 100644 --- a/linkerd.io/content/2.19/reference/cli/identity.md +++ b/linkerd.io/content/2.19/reference/cli/identity.md @@ -2,8 +2,8 @@ title: identity --- -{{< docs/cli-description "identity" >}} +{{< cli-description "identity" >}} -{{< docs/cli-examples "identity" >}} +{{< cli-examples "identity" >}} -{{< docs/cli-flags "identity" >}} +{{< cli-flags "identity" >}} diff --git a/linkerd.io/content/2.19/reference/cli/inject.md b/linkerd.io/content/2.19/reference/cli/inject.md index aafdacdb29..92fc0ca3cb 100644 --- a/linkerd.io/content/2.19/reference/cli/inject.md +++ b/linkerd.io/content/2.19/reference/cli/inject.md @@ -19,6 +19,6 @@ Alternatively, this command can also perform the full injection purely on the client side, by enabling with the `--manual` flag. (Prior to Linkerd 2.4, this was the default behavior.) -{{< docs/cli-examples "inject" >}} +{{< cli-examples "inject" >}} -{{< docs/cli-flags "inject" >}} +{{< cli-flags "inject" >}} diff --git a/linkerd.io/content/2.19/reference/cli/install-cni.md b/linkerd.io/content/2.19/reference/cli/install-cni.md index c7c457a6f1..d0577e3d3b 100644 --- a/linkerd.io/content/2.19/reference/cli/install-cni.md +++ b/linkerd.io/content/2.19/reference/cli/install-cni.md @@ -2,8 +2,8 @@ title: install-cni --- -{{< docs/cli-description "install-cni" >}} +{{< cli-description "install-cni" >}} -{{< docs/cli-examples "install-cni" >}} +{{< cli-examples "install-cni" >}} -{{< docs/cli-flags "install-cni" >}} +{{< cli-flags "install-cni" >}} diff --git a/linkerd.io/content/2.19/reference/cli/install.md b/linkerd.io/content/2.19/reference/cli/install.md index ab0dde824e..5fea59d7eb 100644 --- a/linkerd.io/content/2.19/reference/cli/install.md +++ b/linkerd.io/content/2.19/reference/cli/install.md @@ -2,11 +2,11 @@ title: install --- -{{< docs/cli-description "install" >}} +{{< cli-description "install" >}} For further details on how to install Linkerd onto your own cluster, check out the [install documentation](../../tasks/install/). -{{< docs/cli-examples "install" >}} +{{< cli-examples "install" >}} -{{< docs/cli-flags "install" >}} +{{< cli-flags "install" >}} diff --git a/linkerd.io/content/2.19/reference/cli/multicluster.md b/linkerd.io/content/2.19/reference/cli/multicluster.md index 523191d82b..134d809f01 100644 --- a/linkerd.io/content/2.19/reference/cli/multicluster.md +++ b/linkerd.io/content/2.19/reference/cli/multicluster.md @@ -2,60 +2,60 @@ title: multicluster --- -{{< docs/cli-description "multicluster" >}} +{{< cli-description "multicluster" >}} -{{< docs/cli-examples "multicluster" >}} +{{< cli-examples "multicluster" >}} -{{< docs/cli-flags "multicluster" >}} +{{< cli-flags "multicluster" >}} ## Subcommands -{{< docs/cli-subcommands "multicluster" >}} +{{< cli-subcommands "multicluster" >}} ### allow -{{< docs/cli-description "multicluster allow" >}} +{{< cli-description "multicluster allow" >}} -{{< docs/cli-examples "multicluster allow" >}} +{{< cli-examples "multicluster allow" >}} -{{< docs/cli-flags "multicluster allow" >}} +{{< cli-flags "multicluster allow" >}} ### check -{{< docs/cli-description "multicluster check" >}} +{{< cli-description "multicluster check" >}} -{{< docs/cli-examples "multicluster check" >}} +{{< cli-examples "multicluster check" >}} -{{< docs/cli-flags "multicluster check" >}} +{{< cli-flags "multicluster check" >}} ### gateways -{{< docs/cli-description "multicluster gateways" >}} +{{< cli-description "multicluster gateways" >}} -{{< docs/cli-examples "multicluster gateways" >}} +{{< cli-examples "multicluster gateways" >}} -{{< docs/cli-flags "multicluster gateways" >}} +{{< cli-flags "multicluster gateways" >}} ### install -{{< docs/cli-description "multicluster install" >}} +{{< cli-description "multicluster install" >}} -{{< docs/cli-examples "multicluster install" >}} +{{< cli-examples "multicluster install" >}} -{{< docs/cli-flags "multicluster install" >}} +{{< cli-flags "multicluster install" >}} ### link-gen -{{< docs/cli-description "multicluster link-gen" >}} +{{< cli-description "multicluster link-gen" >}} -{{< docs/cli-examples "multicluster link-gen" >}} +{{< cli-examples "multicluster link-gen" >}} -{{< docs/cli-flags "multicluster link-gen" >}} +{{< cli-flags "multicluster link-gen" >}} ### uninstall -{{< docs/cli-description "multicluster uninstall" >}} +{{< cli-description "multicluster uninstall" >}} -{{< docs/cli-examples "multicluster uninstall" >}} +{{< cli-examples "multicluster uninstall" >}} -{{< docs/cli-flags "multicluster uninstall" >}} +{{< cli-flags "multicluster uninstall" >}} diff --git a/linkerd.io/content/2.19/reference/cli/profile.md b/linkerd.io/content/2.19/reference/cli/profile.md index 5cc919b876..bf2545c313 100644 --- a/linkerd.io/content/2.19/reference/cli/profile.md +++ b/linkerd.io/content/2.19/reference/cli/profile.md @@ -2,12 +2,12 @@ title: profile --- -{{< docs/cli-description "profile" >}} +{{< cli-description "profile" >}} Check out the [service profile](../../features/service-profiles/) documentation for more details on what this command does and what you can do with service profiles. -{{< docs/cli-examples "profile" >}} +{{< cli-examples "profile" >}} -{{< docs/cli-flags "profile" >}} +{{< cli-flags "profile" >}} diff --git a/linkerd.io/content/2.19/reference/cli/prune.md b/linkerd.io/content/2.19/reference/cli/prune.md index 68675991ed..1ec604588f 100644 --- a/linkerd.io/content/2.19/reference/cli/prune.md +++ b/linkerd.io/content/2.19/reference/cli/prune.md @@ -2,8 +2,8 @@ title: prune --- -{{< docs/cli-description "prune" >}} +{{< cli-description "prune" >}} -{{< docs/cli-examples "prune" >}} +{{< cli-examples "prune" >}} -{{< docs/cli-flags "prune" >}} +{{< cli-flags "prune" >}} diff --git a/linkerd.io/content/2.19/reference/cli/uninject.md b/linkerd.io/content/2.19/reference/cli/uninject.md index 9ad619698a..6f43c3cf0a 100644 --- a/linkerd.io/content/2.19/reference/cli/uninject.md +++ b/linkerd.io/content/2.19/reference/cli/uninject.md @@ -2,8 +2,8 @@ title: uninject --- -{{< docs/cli-description "uninject" >}} +{{< cli-description "uninject" >}} -{{< docs/cli-examples "uninject" >}} +{{< cli-examples "uninject" >}} -{{< docs/cli-flags "uninject" >}} +{{< cli-flags "uninject" >}} diff --git a/linkerd.io/content/2.19/reference/cli/uninstall.md b/linkerd.io/content/2.19/reference/cli/uninstall.md index d5e00031ed..d62dd11612 100644 --- a/linkerd.io/content/2.19/reference/cli/uninstall.md +++ b/linkerd.io/content/2.19/reference/cli/uninstall.md @@ -2,8 +2,8 @@ title: uninstall --- -{{< docs/cli-description "uninstall" >}} +{{< cli-description "uninstall" >}} -{{< docs/cli-examples "uninstall" >}} +{{< cli-examples "uninstall" >}} -{{< docs/cli-flags "uninstall" >}} +{{< cli-flags "uninstall" >}} diff --git a/linkerd.io/content/2.19/reference/cli/upgrade.md b/linkerd.io/content/2.19/reference/cli/upgrade.md index c4422b57c9..70b3296d8a 100644 --- a/linkerd.io/content/2.19/reference/cli/upgrade.md +++ b/linkerd.io/content/2.19/reference/cli/upgrade.md @@ -2,8 +2,8 @@ title: upgrade --- -{{< docs/cli-description "upgrade" >}} +{{< cli-description "upgrade" >}} -{{< docs/cli-examples "upgrade" >}} +{{< cli-examples "upgrade" >}} -{{< docs/cli-flags "upgrade" >}} +{{< cli-flags "upgrade" >}} diff --git a/linkerd.io/content/2.19/reference/cli/version.md b/linkerd.io/content/2.19/reference/cli/version.md index 159f0b2f65..d31d7b18e6 100644 --- a/linkerd.io/content/2.19/reference/cli/version.md +++ b/linkerd.io/content/2.19/reference/cli/version.md @@ -2,8 +2,8 @@ title: version --- -{{< docs/cli-description "version" >}} +{{< cli-description "version" >}} -{{< docs/cli-examples "version" >}} +{{< cli-examples "version" >}} -{{< docs/cli-flags "version" >}} +{{< cli-flags "version" >}} diff --git a/linkerd.io/content/2.19/reference/cli/viz.md b/linkerd.io/content/2.19/reference/cli/viz.md index 642bad742d..da24ef2e19 100644 --- a/linkerd.io/content/2.19/reference/cli/viz.md +++ b/linkerd.io/content/2.19/reference/cli/viz.md @@ -2,50 +2,50 @@ title: viz --- -{{< docs/cli-description "viz" >}} +{{< cli-description "viz" >}} -{{< docs/cli-examples "viz" >}} +{{< cli-examples "viz" >}} -{{< docs/cli-flags "viz" >}} +{{< cli-flags "viz" >}} ## Subcommands -{{< docs/cli-subcommands "viz" >}} +{{< cli-subcommands "viz" >}} ### allow-scrapes -{{< docs/cli-description "viz allow-scrapes" >}} +{{< cli-description "viz allow-scrapes" >}} -{{< docs/cli-examples "viz allow-scrapes" >}} +{{< cli-examples "viz allow-scrapes" >}} -{{< docs/cli-flags "viz allow-scrapes" >}} +{{< cli-flags "viz allow-scrapes" >}} ### authz -{{< docs/cli-description "viz authz" >}} +{{< cli-description "viz authz" >}} -{{< docs/cli-examples "viz authz" >}} +{{< cli-examples "viz authz" >}} -{{< docs/cli-flags "viz authz" >}} +{{< cli-flags "viz authz" >}} ### check -{{< docs/cli-description "viz check" >}} +{{< cli-description "viz check" >}} -{{< docs/cli-examples "viz check" >}} +{{< cli-examples "viz check" >}} -{{< docs/cli-flags "viz check" >}} +{{< cli-flags "viz check" >}} ### dashboard -{{< docs/cli-description "viz dashboard" >}} +{{< cli-description "viz dashboard" >}} Check out the [architecture](../architecture/#dashboard) docs for a more thorough explanation of what this command does. -{{< docs/cli-examples "viz dashboard" >}} +{{< cli-examples "viz dashboard" >}} -{{< docs/cli-flags "viz dashboard" >}} +{{< cli-flags "viz dashboard" >}} (\*) You'll need to tweak the dashboard's `enforced-host` parameter with this value, as explained in @@ -53,35 +53,35 @@ value, as explained in ### edges -{{< docs/cli-description "viz edges" >}} +{{< cli-description "viz edges" >}} -{{< docs/cli-examples "viz edges" >}} +{{< cli-examples "viz edges" >}} -{{< docs/cli-flags "viz edges" >}} +{{< cli-flags "viz edges" >}} ### install -{{< docs/cli-description "viz install" >}} +{{< cli-description "viz install" >}} -{{< docs/cli-examples "viz install" >}} +{{< cli-examples "viz install" >}} -{{< docs/cli-flags "viz install" >}} +{{< cli-flags "viz install" >}} ### list -{{< docs/cli-description "viz list" >}} +{{< cli-description "viz list" >}} -{{< docs/cli-examples "viz list" >}} +{{< cli-examples "viz list" >}} -{{< docs/cli-flags "viz list" >}} +{{< cli-flags "viz list" >}} ### profile -{{< docs/cli-description "viz profile" >}} +{{< cli-description "viz profile" >}} -{{< docs/cli-examples "viz profile" >}} +{{< cli-examples "viz profile" >}} -{{< docs/cli-flags "viz profile" >}} +{{< cli-flags "viz profile" >}} ### routes @@ -140,21 +140,21 @@ information. Because retries are only performed on the _outbound_ (client) side, the `-o wide` flag can only be used when the `--to` flag is specified. -{{< docs/cli-examples "viz routes" >}} +{{< cli-examples "viz routes" >}} -{{< docs/cli-flags "viz routes" >}} +{{< cli-flags "viz routes" >}} ### stat -{{< docs/cli-description "viz stat" >}} +{{< cli-description "viz stat" >}} -{{< docs/cli-examples "viz stat" >}} +{{< cli-examples "viz stat" >}} -{{< docs/cli-flags "viz stat" >}} +{{< cli-flags "viz stat" >}} ### tap -{{< docs/cli-description "viz tap" >}} +{{< cli-description "viz tap" >}} {{< note >}}If a pod is configured with the annotations `config.linkerd.io/skip-inbound-ports` or @@ -162,22 +162,22 @@ Because retries are only performed on the _outbound_ (client) side, the Linkerd proxy. Because `linkerd tap` observes traffic through the proxy, **traffic on skipped ports cannot be tapped**.{{< /note >}} -{{< docs/cli-examples "viz tap" >}} +{{< cli-examples "viz tap" >}} -{{< docs/cli-flags "viz tap" >}} +{{< cli-flags "viz tap" >}} ### top -{{< docs/cli-description "viz top" >}} +{{< cli-description "viz top" >}} -{{< docs/cli-examples "viz top" >}} +{{< cli-examples "viz top" >}} -{{< docs/cli-flags "viz top" >}} +{{< cli-flags "viz top" >}} ### uninstall -{{< docs/cli-description "viz uninstall" >}} +{{< cli-description "viz uninstall" >}} -{{< docs/cli-examples "viz uninstall" >}} +{{< cli-examples "viz uninstall" >}} -{{< docs/cli-flags "viz uninstall" >}} +{{< cli-flags "viz uninstall" >}} diff --git a/linkerd.io/content/2.19/reference/extension-list.md b/linkerd.io/content/2.19/reference/extension-list.md index e6bdad697e..32afc3fd09 100644 --- a/linkerd.io/content/2.19/reference/extension-list.md +++ b/linkerd.io/content/2.19/reference/extension-list.md @@ -9,7 +9,7 @@ Linkerd provides a mix of built-in and third-party [extensions](../tasks/extensions/) to add additional functionality to the base installation. The following is the list of known extensions: -{{< docs/extensions >}} +{{< extensions >}} If you have an extension for Linkerd and it is not on the list, [please edit this page!](https://github.com/linkerd/website/edit/main/linkerd.io/data/extension-list.yaml) diff --git a/linkerd.io/content/2.19/reference/proxy-configuration.md b/linkerd.io/content/2.19/reference/proxy-configuration.md index 80b471f88b..847b0a53d4 100644 --- a/linkerd.io/content/2.19/reference/proxy-configuration.md +++ b/linkerd.io/content/2.19/reference/proxy-configuration.md @@ -11,7 +11,7 @@ configurations of [auto-injected proxies](../features/proxy-injection/). The following is the list of supported annotations: -{{< docs/cli-annotations "inject" >}} +{{< cli-annotations "inject" >}} For example, to update an auto-injected proxy's CPU and memory resources, we insert the appropriate annotations into the `spec.template.metadata.annotations` diff --git a/linkerd.io/content/2.19/tasks/_index.md b/linkerd.io/content/2.19/tasks/_index.md index cfca319184..19a83aee53 100644 --- a/linkerd.io/content/2.19/tasks/_index.md +++ b/linkerd.io/content/2.19/tasks/_index.md @@ -9,4 +9,4 @@ common tasks that you may need to perform when using Linkerd. ## Common Linkerd tasks -{{< docs/section-toc >}} +{{< section-toc >}} diff --git a/linkerd.io/content/2.19/tasks/automatic-failover.md b/linkerd.io/content/2.19/tasks/automatic-failover.md index f45c66d817..233764e38f 100644 --- a/linkerd.io/content/2.19/tasks/automatic-failover.md +++ b/linkerd.io/content/2.19/tasks/automatic-failover.md @@ -25,7 +25,7 @@ Emojivoto application on two Kubernetes clusters and simulating a failure in one cluster. We will see the failover controller shift traffic to the other cluster to ensure the service remains available. -{{< docs/production-note >}} +{{< production-note >}} ## Prerequisites diff --git a/linkerd.io/content/2.19/tasks/automatically-rotating-control-plane-tls-credentials.md b/linkerd.io/content/2.19/tasks/automatically-rotating-control-plane-tls-credentials.md index fb3c874952..425dd65dad 100644 --- a/linkerd.io/content/2.19/tasks/automatically-rotating-control-plane-tls-credentials.md +++ b/linkerd.io/content/2.19/tasks/automatically-rotating-control-plane-tls-credentials.md @@ -27,7 +27,7 @@ with a validity of one year but require manual rotation by the user to prevent expiry. While this setup is convenient for quick start testing, it's not advisable nor recommended for production environments. -{{< docs/production-note >}} +{{< production-note >}} ## Automating Certificate Management with cert-manager and trust-manager @@ -244,18 +244,18 @@ EOF {{< warning >}} The default value of the `rotationPolicy` in the Certificate's `privateKey` -section is dependent on your version of cert-manager. In version 1.17 and -below, the default value was `Never`. With this configuration, cert-manager -**will not** actually rotate the trust anchor: instead, it will update the -validity timestamps but **not** generate a new private key. -**This is definitely not as secure as rotating the private key**. +section is dependent on your version of cert-manager. In version 1.17 and below, +the default value was `Never`. With this configuration, cert-manager **will +not** actually rotate the trust anchor: instead, it will update the validity +timestamps but **not** generate a new private key. **This is definitely not as +secure as rotating the private key**. If you are upgrading cert-manager from version 1.17 or below to version 1.18 or above, be aware that this new default will change the `rotationPolicy` if you are not explicitly setting it in your Certificate resource manifest. -To avoid ambiguity, we recommend always setting `rotationPolicy: Always` for -any certificate that cert-manager is managing. +To avoid ambiguity, we recommend always setting `rotationPolicy: Always` for any +certificate that cert-manager is managing. {{< /warning >}} @@ -360,18 +360,18 @@ EOF {{< warning >}} The default value of the `rotationPolicy` in the Certificate's `privateKey` -section is dependent on your version of cert-manager. In version 1.17 and -below, the default value was `Never`. With this configuration, cert-manager -**will not** actually rotate the trust anchor: instead, it will update the -validity timestamps but **not** generate a new private key. -**This is definitely not as secure as rotating the private key**. +section is dependent on your version of cert-manager. In version 1.17 and below, +the default value was `Never`. With this configuration, cert-manager **will +not** actually rotate the trust anchor: instead, it will update the validity +timestamps but **not** generate a new private key. **This is definitely not as +secure as rotating the private key**. If you are upgrading cert-manager from version 1.17 or below to version 1.18 or above, be aware that this new default will change the `rotationPolicy` if you are not explicitly setting it in your Certificate resource manifest. -To avoid ambiguity, we recommend always setting `rotationPolicy: Always` for -any certificate that cert-manager is managing. +To avoid ambiguity, we recommend always setting `rotationPolicy: Always` for any +certificate that cert-manager is managing. {{< /warning >}} @@ -777,10 +777,10 @@ _requires_ manual intervention, because while cert-manager can handle the hard work of actually rotating the trust anchor, it can't trigger the needed restarts. -This means that the simplest way to handle trust anchor rotation is -to _trigger the rotation manually_ whenever it's convenient for you so that -you can manage the trust bundle and restarts while letting cert-manager manage -the trust anchor certificate. +This means that the simplest way to handle trust anchor rotation is to _trigger +the rotation manually_ whenever it's convenient for you so that you can manage +the trust bundle and restarts while letting cert-manager manage the trust anchor +certificate. The process of actually doing this is straightforward, but again, there are several steps: @@ -830,8 +830,8 @@ kubectl get secret -n cert-manager linkerd-previous-anchor \ | base64 -d | inspect_cert ``` -Verify that the `linkerd-identity-trust-roots` ConfigMap now contains -the Subject keys from both Secrets. +Verify that the `linkerd-identity-trust-roots` ConfigMap now contains the +Subject keys from both Secrets. ```bash kubectl get configmap -n linkerd linkerd-identity-trust-roots \ @@ -858,9 +858,9 @@ This will cause the control plane to pick up the new trust anchor bundle. #### 3. Restart the data plane At this point, you'll need to restart your workloads as well, to force the -proxies to have the new trust anchor bundle. The exact mechanism to do this -will depend on your workloads, but it's often just `kubectl rollout restart` for -each of your application namespaces. +proxies to have the new trust anchor bundle. The exact mechanism to do this will +depend on your workloads, but it's often just `kubectl rollout restart` for each +of your application namespaces. #### 4. Triggering identity issuer rotation @@ -905,10 +905,10 @@ issuer. #### 6. Restart the data plane -Again, you'll need to restart your workloads, to force the -proxies to switch to the new identity issuer signed by the new trust anchor. -The exact mechanism to do this will depend on your workloads, but it's often -just `kubectl rollout restart` for each of your application namespaces. +Again, you'll need to restart your workloads, to force the proxies to switch to +the new identity issuer signed by the new trust anchor. The exact mechanism to +do this will depend on your workloads, but it's often just +`kubectl rollout restart` for each of your application namespaces. #### 7. Remove the old anchor from the trust bundle diff --git a/linkerd.io/content/2.19/tasks/automatically-rotating-webhook-tls-credentials.md b/linkerd.io/content/2.19/tasks/automatically-rotating-webhook-tls-credentials.md index b6368510c0..9d96cddce9 100644 --- a/linkerd.io/content/2.19/tasks/automatically-rotating-webhook-tls-credentials.md +++ b/linkerd.io/content/2.19/tasks/automatically-rotating-webhook-tls-credentials.md @@ -22,7 +22,7 @@ This workflow is suitable for most users. However, if you need these webhook certificates to be rotated automatically on a regular basis, it is possible to use cert-manager to automatically manage them. -{{< docs/production-note >}} +{{< production-note >}} ## Install Cert manager diff --git a/linkerd.io/content/2.19/tasks/circuit-breakers.md b/linkerd.io/content/2.19/tasks/circuit-breakers.md index 13425e16dd..d038ccf382 100644 --- a/linkerd.io/content/2.19/tasks/circuit-breakers.md +++ b/linkerd.io/content/2.19/tasks/circuit-breakers.md @@ -13,7 +13,7 @@ improve client success rate when a backend replica is unhealthy. See the [reference documentation](../reference/circuit-breaking/) for more details on how Linkerd implements circuit breaking. -{{< docs/production-note >}} +{{< production-note >}} ## Prerequisites diff --git a/linkerd.io/content/2.19/tasks/customize-install.md b/linkerd.io/content/2.19/tasks/customize-install.md index dc71604c3c..512bb3629d 100644 --- a/linkerd.io/content/2.19/tasks/customize-install.md +++ b/linkerd.io/content/2.19/tasks/customize-install.md @@ -9,7 +9,7 @@ Instead of forking the Linkerd install and upgrade process, `linkerd install` in a consistent way. This allows customization of the install to add functionality specific to installations. -{{< docs/production-note >}} +{{< production-note >}} To get started, save the output of `linkerd install` to a YAML file. This will be the base resource that Kustomize uses to patch and generate what is added to diff --git a/linkerd.io/content/2.19/tasks/exporting-metrics.md b/linkerd.io/content/2.19/tasks/exporting-metrics.md index 877aedf5a2..96fc7f24f0 100644 --- a/linkerd.io/content/2.19/tasks/exporting-metrics.md +++ b/linkerd.io/content/2.19/tasks/exporting-metrics.md @@ -13,7 +13,7 @@ each proxy only provides a portion of the full picture. Instead, a separate tool is used to collect metrics from all proxies and aggregate them together for consumption. -{{< docs/production-note >}} +{{< production-note >}} One easy option is the [linkerd-viz](../features/dashboard/) extension, which will create an on-cluster Prometheus instance as well as dashboards and CLI @@ -74,7 +74,7 @@ metadata: k8s-app: linkerd-prometheus release: monitoring name: linkerd-federate - namespace: {{.Namespace}} + namespace: { { .Namespace } } spec: endpoints: - interval: 30s @@ -94,7 +94,7 @@ spec: jobLabel: app namespaceSelector: matchNames: - - {{.Namespace}} + - { { .Namespace } } selector: matchLabels: component: prometheus diff --git a/linkerd.io/content/2.19/tasks/exposing-dashboard.md b/linkerd.io/content/2.19/tasks/exposing-dashboard.md index fe8cf24afe..0f0d9ef682 100644 --- a/linkerd.io/content/2.19/tasks/exposing-dashboard.md +++ b/linkerd.io/content/2.19/tasks/exposing-dashboard.md @@ -10,7 +10,7 @@ going on, you can expose the dashboard via an ingress. This will also expose Grafana, if you have it linked against Linkerd viz through the `grafana.url` setting. -{{< docs/toc >}} +{{< toc >}} ## Nginx diff --git a/linkerd.io/content/2.19/tasks/external-prometheus.md b/linkerd.io/content/2.19/tasks/external-prometheus.md index ccd0434d2d..4bc0dc59e6 100644 --- a/linkerd.io/content/2.19/tasks/external-prometheus.md +++ b/linkerd.io/content/2.19/tasks/external-prometheus.md @@ -12,7 +12,7 @@ both the control plane as well as the proxy's metrics in a format that is consumable both by a user as well as Linkerd control plane components like web, etc. -{{< docs/production-note >}} +{{< production-note >}} There are two important points to tackle here. diff --git a/linkerd.io/content/2.19/tasks/flagger.md b/linkerd.io/content/2.19/tasks/flagger.md index 356ac3b38e..a8a03f093e 100644 --- a/linkerd.io/content/2.19/tasks/flagger.md +++ b/linkerd.io/content/2.19/tasks/flagger.md @@ -23,7 +23,7 @@ tools: [Flagger](https://flagger.app/) and metrics and request routing together in a control loop, allowing for fully-automated, metrics-aware canary deployments. -{{< docs/production-note >}} +{{< production-note >}} ## Prerequisites diff --git a/linkerd.io/content/2.19/tasks/generate-certificates.md b/linkerd.io/content/2.19/tasks/generate-certificates.md index 35013ac056..33dd6751d1 100644 --- a/linkerd.io/content/2.19/tasks/generate-certificates.md +++ b/linkerd.io/content/2.19/tasks/generate-certificates.md @@ -23,7 +23,7 @@ algorithm which is the default for `step`. To generate ECDSA P-256 certificates with openssl, you can use the `openssl ecparam -name prime256v1` command. In this tutorial, we'll walk you through how to to use the `step` CLI to do this. -{{< docs/production-note >}} +{{< production-note >}} ## Generating the certificates with `step` diff --git a/linkerd.io/content/2.19/tasks/gitops.md b/linkerd.io/content/2.19/tasks/gitops.md index 51328396a3..70c2346f70 100644 --- a/linkerd.io/content/2.19/tasks/gitops.md +++ b/linkerd.io/content/2.19/tasks/gitops.md @@ -12,7 +12,7 @@ This guide will show you how to set up [Argo CD](https://argoproj.github.io/argo-cd/) to manage the installation and upgrade of Linkerd using a GitOps workflow. -{{< docs/production-note >}} +{{< production-note >}} Specifically, this guide provides instructions on how to securely generate and manage Linkerd's mTLS private keys and certificates using diff --git a/linkerd.io/content/2.19/tasks/grafana.md b/linkerd.io/content/2.19/tasks/grafana.md index b37b01af71..9be0209fbb 100644 --- a/linkerd.io/content/2.19/tasks/grafana.md +++ b/linkerd.io/content/2.19/tasks/grafana.md @@ -13,7 +13,7 @@ First, you need to install Grafana from a variety of possible sources, and then load the suite of Grafana dashboards that have been pre-configured to consume the metrics exposed by Linkerd. -{{< docs/production-note >}} +{{< production-note >}} ## Install Prometheus @@ -85,7 +85,7 @@ is set up, as shown in the sample `grafana/values.yaml` file: ```yaml grafana.ini: server: - root_url: "%(protocol)s://%(domain)s:/grafana/" + root_url: '%(protocol)s://%(domain)s:/grafana/' ``` Then refer the location of your Grafana service in the Linkerd Viz `values.yaml` diff --git a/linkerd.io/content/2.19/tasks/install-helm.md b/linkerd.io/content/2.19/tasks/install-helm.md index 1c4082dfe7..5f31f1d3a9 100644 --- a/linkerd.io/content/2.19/tasks/install-helm.md +++ b/linkerd.io/content/2.19/tasks/install-helm.md @@ -6,7 +6,7 @@ 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. -{{< docs/edge-note >}} +{{< edge-note >}} ## Prerequisite: install the Gateway API diff --git a/linkerd.io/content/2.19/tasks/installing-multicluster.md b/linkerd.io/content/2.19/tasks/installing-multicluster.md index 2323119ef8..d3e47ded8e 100644 --- a/linkerd.io/content/2.19/tasks/installing-multicluster.md +++ b/linkerd.io/content/2.19/tasks/installing-multicluster.md @@ -9,7 +9,7 @@ through this installation and configuration as well as common problems that you may encounter. For a detailed walkthrough and explanation of what's going on, check out [getting started](multicluster/). -{{< docs/production-note >}} +{{< production-note >}} ## Requirements diff --git a/linkerd.io/content/2.19/tasks/setting-up-service-profiles.md b/linkerd.io/content/2.19/tasks/setting-up-service-profiles.md index 25f6084bea..be9284058e 100644 --- a/linkerd.io/content/2.19/tasks/setting-up-service-profiles.md +++ b/linkerd.io/content/2.19/tasks/setting-up-service-profiles.md @@ -63,7 +63,7 @@ demo. There are a couple different ways to use `linkerd profile` to create service profiles. -{{< docs/toc >}} +{{< toc >}} Requests which have been associated with a route will have a `rt_route` annotation. To manually verify if the requests are being associated correctly, diff --git a/linkerd.io/content/2.19/tasks/traffic-shifting.md b/linkerd.io/content/2.19/tasks/traffic-shifting.md index 3c1bcdec9f..1091aa6198 100644 --- a/linkerd.io/content/2.19/tasks/traffic-shifting.md +++ b/linkerd.io/content/2.19/tasks/traffic-shifting.md @@ -20,7 +20,7 @@ development. {{< /note >}} -{{< docs/production-note >}} +{{< production-note >}} ## Prerequisites diff --git a/linkerd.io/content/2.19/tasks/using-the-debug-container.md b/linkerd.io/content/2.19/tasks/using-the-debug-container.md index 6e40eecd1a..ff7a10bce9 100644 --- a/linkerd.io/content/2.19/tasks/using-the-debug-container.md +++ b/linkerd.io/content/2.19/tasks/using-the-debug-container.md @@ -19,7 +19,7 @@ time. For convenience, the `linkerd inject` command provides an adding this annotation to a pre-existing pod will not work. It must be present at pod _creation_ time.) -{{< docs/production-note >}} +{{< production-note >}} The debug sidecar image contains [`tshark`](https://www.wireshark.org/docs/man-pages/tshark.html), `tcpdump`, diff --git a/linkerd.io/content/docs/common-errors/_index.md b/linkerd.io/content/docs/common-errors/_index.md index 68771bf652..a57718ba55 100644 --- a/linkerd.io/content/docs/common-errors/_index.md +++ b/linkerd.io/content/docs/common-errors/_index.md @@ -18,4 +18,4 @@ this command is. ## Common Errors -{{< docs/section-toc >}} +{{< section-toc >}} diff --git a/linkerd.io/content/docs/features/_index.md b/linkerd.io/content/docs/features/_index.md index cf341d4e7e..3eebfe67f4 100644 --- a/linkerd.io/content/docs/features/_index.md +++ b/linkerd.io/content/docs/features/_index.md @@ -11,4 +11,4 @@ please see the [Linkerd task docs](../tasks/). For a reference, see the ## Linkerd's features -{{< docs/section-toc >}} +{{< section-toc >}} diff --git a/linkerd.io/content/docs/getting-started/_index.md b/linkerd.io/content/docs/getting-started/_index.md index 5e3af75210..d58cceee52 100644 --- a/linkerd.io/content/docs/getting-started/_index.md +++ b/linkerd.io/content/docs/getting-started/_index.md @@ -16,7 +16,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. -{{< docs/edge-note >}} +{{< edge-note >}} ## Step 0: Setup diff --git a/linkerd.io/content/docs/reference/_index.md b/linkerd.io/content/docs/reference/_index.md index f2045c2b56..c066e0b8ee 100644 --- a/linkerd.io/content/docs/reference/_index.md +++ b/linkerd.io/content/docs/reference/_index.md @@ -3,4 +3,4 @@ title: Reference weight: 5 --- -{{< docs/section-toc >}} +{{< section-toc >}} diff --git a/linkerd.io/content/docs/reference/cli/_index.md b/linkerd.io/content/docs/reference/cli/_index.md index ee36df6287..4d4170ffa7 100644 --- a/linkerd.io/content/docs/reference/cli/_index.md +++ b/linkerd.io/content/docs/reference/cli/_index.md @@ -9,10 +9,10 @@ detailed metrics for how your service is performing. As reference, check out the commands below: -{{< docs/cli-commands >}} +{{< cli-commands >}} ## Global flags The following flags are available for _all_ linkerd CLI commands: -{{< docs/cli-global-flags >}} +{{< cli-global-flags >}} diff --git a/linkerd.io/content/docs/reference/cli/authz.md b/linkerd.io/content/docs/reference/cli/authz.md index 2a6e55b55d..22df19a41c 100644 --- a/linkerd.io/content/docs/reference/cli/authz.md +++ b/linkerd.io/content/docs/reference/cli/authz.md @@ -2,10 +2,10 @@ title: authz --- -{{< docs/cli-description "authz" >}} +{{< cli-description "authz" >}} Check out the [Authorization Policy](../authorization-policy/) and [Restricting Access to Services](../../tasks/restricting-access/) documentation for all the details about authorization policy in Linkerd. -{{< docs/cli-flags "authz" >}} +{{< cli-flags "authz" >}} diff --git a/linkerd.io/content/docs/reference/cli/check.md b/linkerd.io/content/docs/reference/cli/check.md index 7cd61cd237..0c18a5da03 100644 --- a/linkerd.io/content/docs/reference/cli/check.md +++ b/linkerd.io/content/docs/reference/cli/check.md @@ -2,12 +2,12 @@ title: check --- -{{< docs/cli-description "check" >}} +{{< cli-description "check" >}} Take a look at the [troubleshooting](../../tasks/troubleshooting/) documentation for a full list of all the possible checks, what they do and how to fix them. -{{< docs/cli-examples "check" >}} +{{< cli-examples "check" >}} ## Example output @@ -53,4 +53,4 @@ control-plane-version Status check results are √ ``` -{{< docs/cli-flags "check" >}} +{{< cli-flags "check" >}} diff --git a/linkerd.io/content/docs/reference/cli/completion.md b/linkerd.io/content/docs/reference/cli/completion.md index 40e8438b72..6007a47fa5 100644 --- a/linkerd.io/content/docs/reference/cli/completion.md +++ b/linkerd.io/content/docs/reference/cli/completion.md @@ -2,8 +2,8 @@ title: completion --- -{{< docs/cli-description "completion" >}} +{{< cli-description "completion" >}} -{{< docs/cli-examples "completion" >}} +{{< cli-examples "completion" >}} -{{< docs/cli-flags "completion" >}} +{{< cli-flags "completion" >}} diff --git a/linkerd.io/content/docs/reference/cli/diagnostics.md b/linkerd.io/content/docs/reference/cli/diagnostics.md index ffa45c39be..8e4e36d234 100644 --- a/linkerd.io/content/docs/reference/cli/diagnostics.md +++ b/linkerd.io/content/docs/reference/cli/diagnostics.md @@ -2,44 +2,44 @@ title: diagnostics --- -{{< docs/cli-description "diagnostics" >}} +{{< cli-description "diagnostics" >}} -{{< docs/cli-examples "diagnostics" >}} +{{< cli-examples "diagnostics" >}} -{{< docs/cli-flags "diagnostics" >}} +{{< cli-flags "diagnostics" >}} ## Subcommands -{{< docs/cli-subcommands "diagnostics" >}} +{{< cli-subcommands "diagnostics" >}} ### controller-metrics -{{< docs/cli-description "diagnostics controller-metrics" >}} +{{< cli-description "diagnostics controller-metrics" >}} -{{< docs/cli-examples "diagnostics controller-metrics" >}} +{{< cli-examples "diagnostics controller-metrics" >}} -{{< docs/cli-flags "diagnostics controller-metrics" >}} +{{< cli-flags "diagnostics controller-metrics" >}} ### endpoints -{{< docs/cli-description "diagnostics endpoints" >}} +{{< cli-description "diagnostics endpoints" >}} -{{< docs/cli-examples "diagnostics endpoints" >}} +{{< cli-examples "diagnostics endpoints" >}} -{{< docs/cli-flags "diagnostics endpoints" >}} +{{< cli-flags "diagnostics endpoints" >}} ### install-sp -{{< docs/cli-description "diagnostics install-sp" >}} +{{< cli-description "diagnostics install-sp" >}} -{{< docs/cli-examples "diagnostics install-sp" >}} +{{< cli-examples "diagnostics install-sp" >}} -{{< docs/cli-flags "diagnostics install-sp" >}} +{{< cli-flags "diagnostics install-sp" >}} ### proxy-metrics -{{< docs/cli-description "diagnostics proxy-metrics" >}} +{{< cli-description "diagnostics proxy-metrics" >}} -{{< docs/cli-examples "diagnostics proxy-metrics" >}} +{{< cli-examples "diagnostics proxy-metrics" >}} -{{< docs/cli-flags "diagnostics proxy-metrics" >}} +{{< cli-flags "diagnostics proxy-metrics" >}} diff --git a/linkerd.io/content/docs/reference/cli/identity.md b/linkerd.io/content/docs/reference/cli/identity.md index 576d175930..c7962e8027 100644 --- a/linkerd.io/content/docs/reference/cli/identity.md +++ b/linkerd.io/content/docs/reference/cli/identity.md @@ -2,8 +2,8 @@ title: identity --- -{{< docs/cli-description "identity" >}} +{{< cli-description "identity" >}} -{{< docs/cli-examples "identity" >}} +{{< cli-examples "identity" >}} -{{< docs/cli-flags "identity" >}} +{{< cli-flags "identity" >}} diff --git a/linkerd.io/content/docs/reference/cli/inject.md b/linkerd.io/content/docs/reference/cli/inject.md index aafdacdb29..92fc0ca3cb 100644 --- a/linkerd.io/content/docs/reference/cli/inject.md +++ b/linkerd.io/content/docs/reference/cli/inject.md @@ -19,6 +19,6 @@ Alternatively, this command can also perform the full injection purely on the client side, by enabling with the `--manual` flag. (Prior to Linkerd 2.4, this was the default behavior.) -{{< docs/cli-examples "inject" >}} +{{< cli-examples "inject" >}} -{{< docs/cli-flags "inject" >}} +{{< cli-flags "inject" >}} diff --git a/linkerd.io/content/docs/reference/cli/install-cni.md b/linkerd.io/content/docs/reference/cli/install-cni.md index c7c457a6f1..d0577e3d3b 100644 --- a/linkerd.io/content/docs/reference/cli/install-cni.md +++ b/linkerd.io/content/docs/reference/cli/install-cni.md @@ -2,8 +2,8 @@ title: install-cni --- -{{< docs/cli-description "install-cni" >}} +{{< cli-description "install-cni" >}} -{{< docs/cli-examples "install-cni" >}} +{{< cli-examples "install-cni" >}} -{{< docs/cli-flags "install-cni" >}} +{{< cli-flags "install-cni" >}} diff --git a/linkerd.io/content/docs/reference/cli/install.md b/linkerd.io/content/docs/reference/cli/install.md index ab0dde824e..5fea59d7eb 100644 --- a/linkerd.io/content/docs/reference/cli/install.md +++ b/linkerd.io/content/docs/reference/cli/install.md @@ -2,11 +2,11 @@ title: install --- -{{< docs/cli-description "install" >}} +{{< cli-description "install" >}} For further details on how to install Linkerd onto your own cluster, check out the [install documentation](../../tasks/install/). -{{< docs/cli-examples "install" >}} +{{< cli-examples "install" >}} -{{< docs/cli-flags "install" >}} +{{< cli-flags "install" >}} diff --git a/linkerd.io/content/docs/reference/cli/multicluster.md b/linkerd.io/content/docs/reference/cli/multicluster.md index 523191d82b..134d809f01 100644 --- a/linkerd.io/content/docs/reference/cli/multicluster.md +++ b/linkerd.io/content/docs/reference/cli/multicluster.md @@ -2,60 +2,60 @@ title: multicluster --- -{{< docs/cli-description "multicluster" >}} +{{< cli-description "multicluster" >}} -{{< docs/cli-examples "multicluster" >}} +{{< cli-examples "multicluster" >}} -{{< docs/cli-flags "multicluster" >}} +{{< cli-flags "multicluster" >}} ## Subcommands -{{< docs/cli-subcommands "multicluster" >}} +{{< cli-subcommands "multicluster" >}} ### allow -{{< docs/cli-description "multicluster allow" >}} +{{< cli-description "multicluster allow" >}} -{{< docs/cli-examples "multicluster allow" >}} +{{< cli-examples "multicluster allow" >}} -{{< docs/cli-flags "multicluster allow" >}} +{{< cli-flags "multicluster allow" >}} ### check -{{< docs/cli-description "multicluster check" >}} +{{< cli-description "multicluster check" >}} -{{< docs/cli-examples "multicluster check" >}} +{{< cli-examples "multicluster check" >}} -{{< docs/cli-flags "multicluster check" >}} +{{< cli-flags "multicluster check" >}} ### gateways -{{< docs/cli-description "multicluster gateways" >}} +{{< cli-description "multicluster gateways" >}} -{{< docs/cli-examples "multicluster gateways" >}} +{{< cli-examples "multicluster gateways" >}} -{{< docs/cli-flags "multicluster gateways" >}} +{{< cli-flags "multicluster gateways" >}} ### install -{{< docs/cli-description "multicluster install" >}} +{{< cli-description "multicluster install" >}} -{{< docs/cli-examples "multicluster install" >}} +{{< cli-examples "multicluster install" >}} -{{< docs/cli-flags "multicluster install" >}} +{{< cli-flags "multicluster install" >}} ### link-gen -{{< docs/cli-description "multicluster link-gen" >}} +{{< cli-description "multicluster link-gen" >}} -{{< docs/cli-examples "multicluster link-gen" >}} +{{< cli-examples "multicluster link-gen" >}} -{{< docs/cli-flags "multicluster link-gen" >}} +{{< cli-flags "multicluster link-gen" >}} ### uninstall -{{< docs/cli-description "multicluster uninstall" >}} +{{< cli-description "multicluster uninstall" >}} -{{< docs/cli-examples "multicluster uninstall" >}} +{{< cli-examples "multicluster uninstall" >}} -{{< docs/cli-flags "multicluster uninstall" >}} +{{< cli-flags "multicluster uninstall" >}} diff --git a/linkerd.io/content/docs/reference/cli/profile.md b/linkerd.io/content/docs/reference/cli/profile.md index 5cc919b876..bf2545c313 100644 --- a/linkerd.io/content/docs/reference/cli/profile.md +++ b/linkerd.io/content/docs/reference/cli/profile.md @@ -2,12 +2,12 @@ title: profile --- -{{< docs/cli-description "profile" >}} +{{< cli-description "profile" >}} Check out the [service profile](../../features/service-profiles/) documentation for more details on what this command does and what you can do with service profiles. -{{< docs/cli-examples "profile" >}} +{{< cli-examples "profile" >}} -{{< docs/cli-flags "profile" >}} +{{< cli-flags "profile" >}} diff --git a/linkerd.io/content/docs/reference/cli/prune.md b/linkerd.io/content/docs/reference/cli/prune.md index 68675991ed..1ec604588f 100644 --- a/linkerd.io/content/docs/reference/cli/prune.md +++ b/linkerd.io/content/docs/reference/cli/prune.md @@ -2,8 +2,8 @@ title: prune --- -{{< docs/cli-description "prune" >}} +{{< cli-description "prune" >}} -{{< docs/cli-examples "prune" >}} +{{< cli-examples "prune" >}} -{{< docs/cli-flags "prune" >}} +{{< cli-flags "prune" >}} diff --git a/linkerd.io/content/docs/reference/cli/uninject.md b/linkerd.io/content/docs/reference/cli/uninject.md index 9ad619698a..6f43c3cf0a 100644 --- a/linkerd.io/content/docs/reference/cli/uninject.md +++ b/linkerd.io/content/docs/reference/cli/uninject.md @@ -2,8 +2,8 @@ title: uninject --- -{{< docs/cli-description "uninject" >}} +{{< cli-description "uninject" >}} -{{< docs/cli-examples "uninject" >}} +{{< cli-examples "uninject" >}} -{{< docs/cli-flags "uninject" >}} +{{< cli-flags "uninject" >}} diff --git a/linkerd.io/content/docs/reference/cli/uninstall.md b/linkerd.io/content/docs/reference/cli/uninstall.md index d5e00031ed..d62dd11612 100644 --- a/linkerd.io/content/docs/reference/cli/uninstall.md +++ b/linkerd.io/content/docs/reference/cli/uninstall.md @@ -2,8 +2,8 @@ title: uninstall --- -{{< docs/cli-description "uninstall" >}} +{{< cli-description "uninstall" >}} -{{< docs/cli-examples "uninstall" >}} +{{< cli-examples "uninstall" >}} -{{< docs/cli-flags "uninstall" >}} +{{< cli-flags "uninstall" >}} diff --git a/linkerd.io/content/docs/reference/cli/upgrade.md b/linkerd.io/content/docs/reference/cli/upgrade.md index c4422b57c9..70b3296d8a 100644 --- a/linkerd.io/content/docs/reference/cli/upgrade.md +++ b/linkerd.io/content/docs/reference/cli/upgrade.md @@ -2,8 +2,8 @@ title: upgrade --- -{{< docs/cli-description "upgrade" >}} +{{< cli-description "upgrade" >}} -{{< docs/cli-examples "upgrade" >}} +{{< cli-examples "upgrade" >}} -{{< docs/cli-flags "upgrade" >}} +{{< cli-flags "upgrade" >}} diff --git a/linkerd.io/content/docs/reference/cli/version.md b/linkerd.io/content/docs/reference/cli/version.md index 159f0b2f65..d31d7b18e6 100644 --- a/linkerd.io/content/docs/reference/cli/version.md +++ b/linkerd.io/content/docs/reference/cli/version.md @@ -2,8 +2,8 @@ title: version --- -{{< docs/cli-description "version" >}} +{{< cli-description "version" >}} -{{< docs/cli-examples "version" >}} +{{< cli-examples "version" >}} -{{< docs/cli-flags "version" >}} +{{< cli-flags "version" >}} diff --git a/linkerd.io/content/docs/reference/cli/viz.md b/linkerd.io/content/docs/reference/cli/viz.md index 642bad742d..da24ef2e19 100644 --- a/linkerd.io/content/docs/reference/cli/viz.md +++ b/linkerd.io/content/docs/reference/cli/viz.md @@ -2,50 +2,50 @@ title: viz --- -{{< docs/cli-description "viz" >}} +{{< cli-description "viz" >}} -{{< docs/cli-examples "viz" >}} +{{< cli-examples "viz" >}} -{{< docs/cli-flags "viz" >}} +{{< cli-flags "viz" >}} ## Subcommands -{{< docs/cli-subcommands "viz" >}} +{{< cli-subcommands "viz" >}} ### allow-scrapes -{{< docs/cli-description "viz allow-scrapes" >}} +{{< cli-description "viz allow-scrapes" >}} -{{< docs/cli-examples "viz allow-scrapes" >}} +{{< cli-examples "viz allow-scrapes" >}} -{{< docs/cli-flags "viz allow-scrapes" >}} +{{< cli-flags "viz allow-scrapes" >}} ### authz -{{< docs/cli-description "viz authz" >}} +{{< cli-description "viz authz" >}} -{{< docs/cli-examples "viz authz" >}} +{{< cli-examples "viz authz" >}} -{{< docs/cli-flags "viz authz" >}} +{{< cli-flags "viz authz" >}} ### check -{{< docs/cli-description "viz check" >}} +{{< cli-description "viz check" >}} -{{< docs/cli-examples "viz check" >}} +{{< cli-examples "viz check" >}} -{{< docs/cli-flags "viz check" >}} +{{< cli-flags "viz check" >}} ### dashboard -{{< docs/cli-description "viz dashboard" >}} +{{< cli-description "viz dashboard" >}} Check out the [architecture](../architecture/#dashboard) docs for a more thorough explanation of what this command does. -{{< docs/cli-examples "viz dashboard" >}} +{{< cli-examples "viz dashboard" >}} -{{< docs/cli-flags "viz dashboard" >}} +{{< cli-flags "viz dashboard" >}} (\*) You'll need to tweak the dashboard's `enforced-host` parameter with this value, as explained in @@ -53,35 +53,35 @@ value, as explained in ### edges -{{< docs/cli-description "viz edges" >}} +{{< cli-description "viz edges" >}} -{{< docs/cli-examples "viz edges" >}} +{{< cli-examples "viz edges" >}} -{{< docs/cli-flags "viz edges" >}} +{{< cli-flags "viz edges" >}} ### install -{{< docs/cli-description "viz install" >}} +{{< cli-description "viz install" >}} -{{< docs/cli-examples "viz install" >}} +{{< cli-examples "viz install" >}} -{{< docs/cli-flags "viz install" >}} +{{< cli-flags "viz install" >}} ### list -{{< docs/cli-description "viz list" >}} +{{< cli-description "viz list" >}} -{{< docs/cli-examples "viz list" >}} +{{< cli-examples "viz list" >}} -{{< docs/cli-flags "viz list" >}} +{{< cli-flags "viz list" >}} ### profile -{{< docs/cli-description "viz profile" >}} +{{< cli-description "viz profile" >}} -{{< docs/cli-examples "viz profile" >}} +{{< cli-examples "viz profile" >}} -{{< docs/cli-flags "viz profile" >}} +{{< cli-flags "viz profile" >}} ### routes @@ -140,21 +140,21 @@ information. Because retries are only performed on the _outbound_ (client) side, the `-o wide` flag can only be used when the `--to` flag is specified. -{{< docs/cli-examples "viz routes" >}} +{{< cli-examples "viz routes" >}} -{{< docs/cli-flags "viz routes" >}} +{{< cli-flags "viz routes" >}} ### stat -{{< docs/cli-description "viz stat" >}} +{{< cli-description "viz stat" >}} -{{< docs/cli-examples "viz stat" >}} +{{< cli-examples "viz stat" >}} -{{< docs/cli-flags "viz stat" >}} +{{< cli-flags "viz stat" >}} ### tap -{{< docs/cli-description "viz tap" >}} +{{< cli-description "viz tap" >}} {{< note >}}If a pod is configured with the annotations `config.linkerd.io/skip-inbound-ports` or @@ -162,22 +162,22 @@ Because retries are only performed on the _outbound_ (client) side, the Linkerd proxy. Because `linkerd tap` observes traffic through the proxy, **traffic on skipped ports cannot be tapped**.{{< /note >}} -{{< docs/cli-examples "viz tap" >}} +{{< cli-examples "viz tap" >}} -{{< docs/cli-flags "viz tap" >}} +{{< cli-flags "viz tap" >}} ### top -{{< docs/cli-description "viz top" >}} +{{< cli-description "viz top" >}} -{{< docs/cli-examples "viz top" >}} +{{< cli-examples "viz top" >}} -{{< docs/cli-flags "viz top" >}} +{{< cli-flags "viz top" >}} ### uninstall -{{< docs/cli-description "viz uninstall" >}} +{{< cli-description "viz uninstall" >}} -{{< docs/cli-examples "viz uninstall" >}} +{{< cli-examples "viz uninstall" >}} -{{< docs/cli-flags "viz uninstall" >}} +{{< cli-flags "viz uninstall" >}} diff --git a/linkerd.io/content/docs/reference/extension-list.md b/linkerd.io/content/docs/reference/extension-list.md index e6bdad697e..32afc3fd09 100644 --- a/linkerd.io/content/docs/reference/extension-list.md +++ b/linkerd.io/content/docs/reference/extension-list.md @@ -9,7 +9,7 @@ Linkerd provides a mix of built-in and third-party [extensions](../tasks/extensions/) to add additional functionality to the base installation. The following is the list of known extensions: -{{< docs/extensions >}} +{{< extensions >}} If you have an extension for Linkerd and it is not on the list, [please edit this page!](https://github.com/linkerd/website/edit/main/linkerd.io/data/extension-list.yaml) diff --git a/linkerd.io/content/docs/reference/proxy-configuration.md b/linkerd.io/content/docs/reference/proxy-configuration.md index 80b471f88b..847b0a53d4 100644 --- a/linkerd.io/content/docs/reference/proxy-configuration.md +++ b/linkerd.io/content/docs/reference/proxy-configuration.md @@ -11,7 +11,7 @@ configurations of [auto-injected proxies](../features/proxy-injection/). The following is the list of supported annotations: -{{< docs/cli-annotations "inject" >}} +{{< cli-annotations "inject" >}} For example, to update an auto-injected proxy's CPU and memory resources, we insert the appropriate annotations into the `spec.template.metadata.annotations` diff --git a/linkerd.io/content/docs/tasks/_index.md b/linkerd.io/content/docs/tasks/_index.md index cfca319184..19a83aee53 100644 --- a/linkerd.io/content/docs/tasks/_index.md +++ b/linkerd.io/content/docs/tasks/_index.md @@ -9,4 +9,4 @@ common tasks that you may need to perform when using Linkerd. ## Common Linkerd tasks -{{< docs/section-toc >}} +{{< section-toc >}} diff --git a/linkerd.io/content/docs/tasks/automatic-failover.md b/linkerd.io/content/docs/tasks/automatic-failover.md index f45c66d817..233764e38f 100644 --- a/linkerd.io/content/docs/tasks/automatic-failover.md +++ b/linkerd.io/content/docs/tasks/automatic-failover.md @@ -25,7 +25,7 @@ Emojivoto application on two Kubernetes clusters and simulating a failure in one cluster. We will see the failover controller shift traffic to the other cluster to ensure the service remains available. -{{< docs/production-note >}} +{{< production-note >}} ## Prerequisites diff --git a/linkerd.io/content/docs/tasks/automatically-rotating-control-plane-tls-credentials.md b/linkerd.io/content/docs/tasks/automatically-rotating-control-plane-tls-credentials.md index fb3c874952..425dd65dad 100644 --- a/linkerd.io/content/docs/tasks/automatically-rotating-control-plane-tls-credentials.md +++ b/linkerd.io/content/docs/tasks/automatically-rotating-control-plane-tls-credentials.md @@ -27,7 +27,7 @@ with a validity of one year but require manual rotation by the user to prevent expiry. While this setup is convenient for quick start testing, it's not advisable nor recommended for production environments. -{{< docs/production-note >}} +{{< production-note >}} ## Automating Certificate Management with cert-manager and trust-manager @@ -244,18 +244,18 @@ EOF {{< warning >}} The default value of the `rotationPolicy` in the Certificate's `privateKey` -section is dependent on your version of cert-manager. In version 1.17 and -below, the default value was `Never`. With this configuration, cert-manager -**will not** actually rotate the trust anchor: instead, it will update the -validity timestamps but **not** generate a new private key. -**This is definitely not as secure as rotating the private key**. +section is dependent on your version of cert-manager. In version 1.17 and below, +the default value was `Never`. With this configuration, cert-manager **will +not** actually rotate the trust anchor: instead, it will update the validity +timestamps but **not** generate a new private key. **This is definitely not as +secure as rotating the private key**. If you are upgrading cert-manager from version 1.17 or below to version 1.18 or above, be aware that this new default will change the `rotationPolicy` if you are not explicitly setting it in your Certificate resource manifest. -To avoid ambiguity, we recommend always setting `rotationPolicy: Always` for -any certificate that cert-manager is managing. +To avoid ambiguity, we recommend always setting `rotationPolicy: Always` for any +certificate that cert-manager is managing. {{< /warning >}} @@ -360,18 +360,18 @@ EOF {{< warning >}} The default value of the `rotationPolicy` in the Certificate's `privateKey` -section is dependent on your version of cert-manager. In version 1.17 and -below, the default value was `Never`. With this configuration, cert-manager -**will not** actually rotate the trust anchor: instead, it will update the -validity timestamps but **not** generate a new private key. -**This is definitely not as secure as rotating the private key**. +section is dependent on your version of cert-manager. In version 1.17 and below, +the default value was `Never`. With this configuration, cert-manager **will +not** actually rotate the trust anchor: instead, it will update the validity +timestamps but **not** generate a new private key. **This is definitely not as +secure as rotating the private key**. If you are upgrading cert-manager from version 1.17 or below to version 1.18 or above, be aware that this new default will change the `rotationPolicy` if you are not explicitly setting it in your Certificate resource manifest. -To avoid ambiguity, we recommend always setting `rotationPolicy: Always` for -any certificate that cert-manager is managing. +To avoid ambiguity, we recommend always setting `rotationPolicy: Always` for any +certificate that cert-manager is managing. {{< /warning >}} @@ -777,10 +777,10 @@ _requires_ manual intervention, because while cert-manager can handle the hard work of actually rotating the trust anchor, it can't trigger the needed restarts. -This means that the simplest way to handle trust anchor rotation is -to _trigger the rotation manually_ whenever it's convenient for you so that -you can manage the trust bundle and restarts while letting cert-manager manage -the trust anchor certificate. +This means that the simplest way to handle trust anchor rotation is to _trigger +the rotation manually_ whenever it's convenient for you so that you can manage +the trust bundle and restarts while letting cert-manager manage the trust anchor +certificate. The process of actually doing this is straightforward, but again, there are several steps: @@ -830,8 +830,8 @@ kubectl get secret -n cert-manager linkerd-previous-anchor \ | base64 -d | inspect_cert ``` -Verify that the `linkerd-identity-trust-roots` ConfigMap now contains -the Subject keys from both Secrets. +Verify that the `linkerd-identity-trust-roots` ConfigMap now contains the +Subject keys from both Secrets. ```bash kubectl get configmap -n linkerd linkerd-identity-trust-roots \ @@ -858,9 +858,9 @@ This will cause the control plane to pick up the new trust anchor bundle. #### 3. Restart the data plane At this point, you'll need to restart your workloads as well, to force the -proxies to have the new trust anchor bundle. The exact mechanism to do this -will depend on your workloads, but it's often just `kubectl rollout restart` for -each of your application namespaces. +proxies to have the new trust anchor bundle. The exact mechanism to do this will +depend on your workloads, but it's often just `kubectl rollout restart` for each +of your application namespaces. #### 4. Triggering identity issuer rotation @@ -905,10 +905,10 @@ issuer. #### 6. Restart the data plane -Again, you'll need to restart your workloads, to force the -proxies to switch to the new identity issuer signed by the new trust anchor. -The exact mechanism to do this will depend on your workloads, but it's often -just `kubectl rollout restart` for each of your application namespaces. +Again, you'll need to restart your workloads, to force the proxies to switch to +the new identity issuer signed by the new trust anchor. The exact mechanism to +do this will depend on your workloads, but it's often just +`kubectl rollout restart` for each of your application namespaces. #### 7. Remove the old anchor from the trust bundle diff --git a/linkerd.io/content/docs/tasks/automatically-rotating-webhook-tls-credentials.md b/linkerd.io/content/docs/tasks/automatically-rotating-webhook-tls-credentials.md index b6368510c0..9d96cddce9 100644 --- a/linkerd.io/content/docs/tasks/automatically-rotating-webhook-tls-credentials.md +++ b/linkerd.io/content/docs/tasks/automatically-rotating-webhook-tls-credentials.md @@ -22,7 +22,7 @@ This workflow is suitable for most users. However, if you need these webhook certificates to be rotated automatically on a regular basis, it is possible to use cert-manager to automatically manage them. -{{< docs/production-note >}} +{{< production-note >}} ## Install Cert manager diff --git a/linkerd.io/content/docs/tasks/circuit-breakers.md b/linkerd.io/content/docs/tasks/circuit-breakers.md index 13425e16dd..d038ccf382 100644 --- a/linkerd.io/content/docs/tasks/circuit-breakers.md +++ b/linkerd.io/content/docs/tasks/circuit-breakers.md @@ -13,7 +13,7 @@ improve client success rate when a backend replica is unhealthy. See the [reference documentation](../reference/circuit-breaking/) for more details on how Linkerd implements circuit breaking. -{{< docs/production-note >}} +{{< production-note >}} ## Prerequisites diff --git a/linkerd.io/content/docs/tasks/customize-install.md b/linkerd.io/content/docs/tasks/customize-install.md index dc71604c3c..512bb3629d 100644 --- a/linkerd.io/content/docs/tasks/customize-install.md +++ b/linkerd.io/content/docs/tasks/customize-install.md @@ -9,7 +9,7 @@ Instead of forking the Linkerd install and upgrade process, `linkerd install` in a consistent way. This allows customization of the install to add functionality specific to installations. -{{< docs/production-note >}} +{{< production-note >}} To get started, save the output of `linkerd install` to a YAML file. This will be the base resource that Kustomize uses to patch and generate what is added to diff --git a/linkerd.io/content/docs/tasks/exporting-metrics.md b/linkerd.io/content/docs/tasks/exporting-metrics.md index 877aedf5a2..efd60daab3 100644 --- a/linkerd.io/content/docs/tasks/exporting-metrics.md +++ b/linkerd.io/content/docs/tasks/exporting-metrics.md @@ -13,7 +13,7 @@ each proxy only provides a portion of the full picture. Instead, a separate tool is used to collect metrics from all proxies and aggregate them together for consumption. -{{< docs/production-note >}} +{{< production-note >}} One easy option is the [linkerd-viz](../features/dashboard/) extension, which will create an on-cluster Prometheus instance as well as dashboards and CLI diff --git a/linkerd.io/content/docs/tasks/exposing-dashboard.md b/linkerd.io/content/docs/tasks/exposing-dashboard.md index fe8cf24afe..0f0d9ef682 100644 --- a/linkerd.io/content/docs/tasks/exposing-dashboard.md +++ b/linkerd.io/content/docs/tasks/exposing-dashboard.md @@ -10,7 +10,7 @@ going on, you can expose the dashboard via an ingress. This will also expose Grafana, if you have it linked against Linkerd viz through the `grafana.url` setting. -{{< docs/toc >}} +{{< toc >}} ## Nginx diff --git a/linkerd.io/content/docs/tasks/external-prometheus.md b/linkerd.io/content/docs/tasks/external-prometheus.md index ccd0434d2d..4bc0dc59e6 100644 --- a/linkerd.io/content/docs/tasks/external-prometheus.md +++ b/linkerd.io/content/docs/tasks/external-prometheus.md @@ -12,7 +12,7 @@ both the control plane as well as the proxy's metrics in a format that is consumable both by a user as well as Linkerd control plane components like web, etc. -{{< docs/production-note >}} +{{< production-note >}} There are two important points to tackle here. diff --git a/linkerd.io/content/docs/tasks/flagger.md b/linkerd.io/content/docs/tasks/flagger.md index 356ac3b38e..a8a03f093e 100644 --- a/linkerd.io/content/docs/tasks/flagger.md +++ b/linkerd.io/content/docs/tasks/flagger.md @@ -23,7 +23,7 @@ tools: [Flagger](https://flagger.app/) and metrics and request routing together in a control loop, allowing for fully-automated, metrics-aware canary deployments. -{{< docs/production-note >}} +{{< production-note >}} ## Prerequisites diff --git a/linkerd.io/content/docs/tasks/generate-certificates.md b/linkerd.io/content/docs/tasks/generate-certificates.md index 35013ac056..33dd6751d1 100644 --- a/linkerd.io/content/docs/tasks/generate-certificates.md +++ b/linkerd.io/content/docs/tasks/generate-certificates.md @@ -23,7 +23,7 @@ algorithm which is the default for `step`. To generate ECDSA P-256 certificates with openssl, you can use the `openssl ecparam -name prime256v1` command. In this tutorial, we'll walk you through how to to use the `step` CLI to do this. -{{< docs/production-note >}} +{{< production-note >}} ## Generating the certificates with `step` diff --git a/linkerd.io/content/docs/tasks/gitops.md b/linkerd.io/content/docs/tasks/gitops.md index 51328396a3..70c2346f70 100644 --- a/linkerd.io/content/docs/tasks/gitops.md +++ b/linkerd.io/content/docs/tasks/gitops.md @@ -12,7 +12,7 @@ This guide will show you how to set up [Argo CD](https://argoproj.github.io/argo-cd/) to manage the installation and upgrade of Linkerd using a GitOps workflow. -{{< docs/production-note >}} +{{< production-note >}} Specifically, this guide provides instructions on how to securely generate and manage Linkerd's mTLS private keys and certificates using diff --git a/linkerd.io/content/docs/tasks/grafana.md b/linkerd.io/content/docs/tasks/grafana.md index 37cb3d5cfa..24f88e6dc3 100644 --- a/linkerd.io/content/docs/tasks/grafana.md +++ b/linkerd.io/content/docs/tasks/grafana.md @@ -13,7 +13,7 @@ First, you need to install Grafana from a variety of possible sources, and then load the suite of Grafana dashboards that have been pre-configured to consume the metrics exposed by Linkerd. -{{< docs/production-note >}} +{{< production-note >}} ## Install Prometheus diff --git a/linkerd.io/content/docs/tasks/install-helm.md b/linkerd.io/content/docs/tasks/install-helm.md index 1c4082dfe7..5f31f1d3a9 100644 --- a/linkerd.io/content/docs/tasks/install-helm.md +++ b/linkerd.io/content/docs/tasks/install-helm.md @@ -6,7 +6,7 @@ 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. -{{< docs/edge-note >}} +{{< edge-note >}} ## Prerequisite: install the Gateway API diff --git a/linkerd.io/content/docs/tasks/installing-multicluster.md b/linkerd.io/content/docs/tasks/installing-multicluster.md index 2323119ef8..d3e47ded8e 100644 --- a/linkerd.io/content/docs/tasks/installing-multicluster.md +++ b/linkerd.io/content/docs/tasks/installing-multicluster.md @@ -9,7 +9,7 @@ through this installation and configuration as well as common problems that you may encounter. For a detailed walkthrough and explanation of what's going on, check out [getting started](multicluster/). -{{< docs/production-note >}} +{{< production-note >}} ## Requirements diff --git a/linkerd.io/content/docs/tasks/rate-limit-aware-load-balancing.md b/linkerd.io/content/docs/tasks/rate-limit-aware-load-balancing.md index d06cc36817..fa72c16180 100644 --- a/linkerd.io/content/docs/tasks/rate-limit-aware-load-balancing.md +++ b/linkerd.io/content/docs/tasks/rate-limit-aware-load-balancing.md @@ -6,16 +6,16 @@ description: Automatically route traffic away from rate-limited endpoints When backends implement rate limiting and return [HTTP 429](https://www.rfc-editor.org/rfc/rfc6585.html#page-3) or [gRPC RESOURCE_EXHAUSTED](https://grpc.github.io/grpc/core/md_doc_statuscodes.html) -by default, the proxy treats these as successful responses from a load -balancing perspective. Since these types of responses are typically very fast, -Linkerd's [EWMA load balancing](../features/load-balancing.md) may actually -send _more_ traffic to these rate-limited endpoints. This can create a feedback -loop where clients experience high 429 or RESOURCE_EXHAUSTED rates. +by default, the proxy treats these as successful responses from a load balancing +perspective. Since these types of responses are typically very fast, Linkerd's +[EWMA load balancing](../features/load-balancing.md) may actually send _more_ +traffic to these rate-limited endpoints. This can create a feedback loop where +clients experience high 429 or RESOURCE_EXHAUSTED rates. Linkerd has two experimental features to help route traffic away from endpoints which are in a rate-limited state. -{{< docs/production-note >}} +{{< production-note >}} {{< warning >}} @@ -25,18 +25,18 @@ Rate Limit Aware Load Balancing is an experimental, opt-in feature. ## Load Biaser -Linkerd can be configured to use a more sophisticated version of the EWMA -load balancing algorithm which takes rate-limit responses (HTTP 429 or gRPC +Linkerd can be configured to use a more sophisticated version of the EWMA load +balancing algorithm which takes rate-limit responses (HTTP 429 or gRPC RESOURCE_EXHAUSTED) into account. This algorithm is called the Load Biaser because it biases traffic away from endpoints which have returned rate-limit responses recently. The Load Biaser works exactly the same as [EWMA](../features/load-balancing.md) except that when it receives a rate-limited response, it substitutes a fixed -penalty value for the response's actual latency (unless the latency is -higher). For example, if the penalty is configured to be `5s` and the Load -Biaser receives a 429 response in `10ms`, it will treat the latency of that -response as `5s` for load balancing purposes. +penalty value for the response's actual latency (unless the latency is higher). +For example, if the penalty is configured to be `5s` and the Load Biaser +receives a 429 response in `10ms`, it will treat the latency of that response as +`5s` for load balancing purposes. In this way, the load balancer will not favor endpoints which return rate-limited responses quickly. @@ -51,16 +51,16 @@ To enable Linkerd to use the Load Biaser for a Service, set the following annotation on the Service resource: | Annotation | Type | Default | Notes | -|-----------------------------------------------|------|---------|------------------------------------------| +| --------------------------------------------- | ---- | ------- | ---------------------------------------- | | `balancer.alpha.linkerd.io/penalize-failures` | bool | `false` | Enables the Load Biaser for this Service | The Load Biaser can be further configured with these annotations on the Service resource: -| Annotation | Type | Default | Notes | -|---------------------------------------------------------------|----------|---------|----------------------------------------------------------------------------------------| -| `balancer.alpha.linkerd.io/load-biaser-penalty` | duration | `5s` | The latency value to inject for rate-limited responses and failures | -| `balancer.alpha.linkerd.io/load-biaser-max-retry-after` | duration | `300s` | The maximum allowed value of a Retry-After header | +| Annotation | Type | Default | Notes | +| ------------------------------------------------------- | -------- | ------- | ------------------------------------------------------------------- | +| `balancer.alpha.linkerd.io/load-biaser-penalty` | duration | `5s` | The latency value to inject for rate-limited responses and failures | +| `balancer.alpha.linkerd.io/load-biaser-max-retry-after` | duration | `300s` | The maximum allowed value of a Retry-After header | ## Unified Circuit Breaker @@ -68,27 +68,27 @@ Linkerd can be configured to use a more sophisticated version of [consecutive failures failure accrual](../tasks/circuit-breakers.md) called Unified failure accrual. -The Unified failure accrual can be configured with a success rate threshold. -If the percent of responses within a fixed time window drops below this -threshold, the circuit breaker will trip, temporarily cutting off traffic to -this endpoint and giving it time to recover. Critically, any rate-limited -responses will count as failures for this success rate calculation. +The Unified failure accrual can be configured with a success rate threshold. If +the percent of responses within a fixed time window drops below this threshold, +the circuit breaker will trip, temporarily cutting off traffic to this endpoint +and giving it time to recover. Critically, any rate-limited responses will count +as failures for this success rate calculation. -The Unified failure accrual will ALSO trip if it encounters a configured -number of consecutive failures, just like the consecutive failures accrual. +The Unified failure accrual will ALSO trip if it encounters a configured number +of consecutive failures, just like the consecutive failures accrual. To enable the Unified failure accrual circuit breaker on a Service, set the following annotation to `"unified"` on the Service resource: -| Annotation | Type | Default | Notes | -|---------------------------------------|----------|---------|------------------------------------------------------------------------------| -| `balancer.linkerd.io/failure-accrual` | string | None | The failure-accrual mode. Set to `unified` to enable Unified failure accrual | +| Annotation | Type | Default | Notes | +| ------------------------------------- | ------ | ------- | ---------------------------------------------------------------------------- | +| `balancer.linkerd.io/failure-accrual` | string | None | The failure-accrual mode. Set to `unified` to enable Unified failure accrual | The Unified failure accrual can be further configured with these annotations on the Service resource: | Annotation | Type | Default | Notes | -|-----------------------------------------------------------------------|------------------------------|---------|------------------------------------------------------------------| +| --------------------------------------------------------------------- | ---------------------------- | ------- | ---------------------------------------------------------------- | | `balancer.alpha.linkerd.io/failure-accrual-success-rate-threshold` | number between 0 and 1 | `0.8` | The success rate threshold at which to trip the breaker | | `balancer.alpha.linkerd.io/failure-accrual-success-rate-window` | duration | `10s` | The window over which the success rate is calculated | | `balancer.alpha.linkerd.io/failure-accrual-success-rate-min-requests` | number | `5` | Only trip if there are at least this many requests in the window | diff --git a/linkerd.io/content/docs/tasks/setting-up-service-profiles.md b/linkerd.io/content/docs/tasks/setting-up-service-profiles.md index 25f6084bea..be9284058e 100644 --- a/linkerd.io/content/docs/tasks/setting-up-service-profiles.md +++ b/linkerd.io/content/docs/tasks/setting-up-service-profiles.md @@ -63,7 +63,7 @@ demo. There are a couple different ways to use `linkerd profile` to create service profiles. -{{< docs/toc >}} +{{< toc >}} Requests which have been associated with a route will have a `rt_route` annotation. To manually verify if the requests are being associated correctly, diff --git a/linkerd.io/content/docs/tasks/traffic-shifting.md b/linkerd.io/content/docs/tasks/traffic-shifting.md index 3c1bcdec9f..1091aa6198 100644 --- a/linkerd.io/content/docs/tasks/traffic-shifting.md +++ b/linkerd.io/content/docs/tasks/traffic-shifting.md @@ -20,7 +20,7 @@ development. {{< /note >}} -{{< docs/production-note >}} +{{< production-note >}} ## Prerequisites diff --git a/linkerd.io/content/docs/tasks/using-the-debug-container.md b/linkerd.io/content/docs/tasks/using-the-debug-container.md index 6e40eecd1a..ff7a10bce9 100644 --- a/linkerd.io/content/docs/tasks/using-the-debug-container.md +++ b/linkerd.io/content/docs/tasks/using-the-debug-container.md @@ -19,7 +19,7 @@ time. For convenience, the `linkerd inject` command provides an adding this annotation to a pre-existing pod will not work. It must be present at pod _creation_ time.) -{{< docs/production-note >}} +{{< production-note >}} The debug sidecar image contains [`tshark`](https://www.wireshark.org/docs/man-pages/tshark.html), `tcpdump`, diff --git a/linkerd.io/content/faq/_index.md b/linkerd.io/content/faq/_index.md index 0e8088eec6..b26c66fc91 100644 --- a/linkerd.io/content/faq/_index.md +++ b/linkerd.io/content/faq/_index.md @@ -8,7 +8,7 @@ sitemap: priority: 1.0 --- -{{< docs/toc >}} +{{< toc >}} ## What is Linkerd? diff --git a/linkerd.io/content/releases/_index.md b/linkerd.io/content/releases/_index.md index 1e7f07c224..d58a1bdb56 100644 --- a/linkerd.io/content/releases/_index.md +++ b/linkerd.io/content/releases/_index.md @@ -9,18 +9,62 @@ types of _release artifacts_. ## Recent versions -{{< versions >}} + + +{{< recent-versions.inline >}} + {{ range hugo.Data.versions }} +
+
+
+

+ Linkerd {{ .version }} +

+
+
+

+ Linkerd {{ .version }} was announced on {{ .releaseDate }}. +

+ +

+ Known distributions of Linkerd {{ .version }}: +

+ +
+
+
+ {{ end }} +{{< /recent-versions.inline >}} + + ## Types of release artifacts ### Edge releases + Edge release artifacts are published on a weekly or near-weekly basis as part of the open source project. The latest edge release is [{{% latest-edge-version %}}](https://github.com/linkerd/linkerd2/releases/tag/{{% latest-edge-version %}}). and the full list of edge release artifacts can be found on [the Linkerd GitHub releases page](https://github.com/linkerd/linkerd2/releases). + Edge release artifacts contain the code in from the _main_ branch at the point diff --git a/linkerd.io/content/tests/shortcodes.md b/linkerd.io/content/tests/shortcodes.md index ab8897b18a..6f1396f06f 100644 --- a/linkerd.io/content/tests/shortcodes.md +++ b/linkerd.io/content/tests/shortcodes.md @@ -7,14 +7,6 @@ title: Shortcodes
-## docs/edge-note - -{{< docs/edge-note >}} - -## docs/production-note - -{{< docs/production-note >}} - ## keyval {{< keyval >}} diff --git a/linkerd.io/layouts/_partials/head-opengraph.html b/linkerd.io/layouts/_partials/head-opengraph.html index 5fbf51f95b..e3b9ba498d 100644 --- a/linkerd.io/layouts/_partials/head-opengraph.html +++ b/linkerd.io/layouts/_partials/head-opengraph.html @@ -3,7 +3,7 @@ Modified Open Graph template https://github.com/gohugoio/hugo/blob/master/tpl/tplimpl/embedded/templates/_partials/opengraph.html -*/}} +*/ -}} {{- with or site.Title site.Params.title | plainify }} diff --git a/linkerd.io/layouts/_partials/head-twitter-cards.html b/linkerd.io/layouts/_partials/head-twitter-cards.html index bff02454ba..92bd493a78 100644 --- a/linkerd.io/layouts/_partials/head-twitter-cards.html +++ b/linkerd.io/layouts/_partials/head-twitter-cards.html @@ -3,7 +3,7 @@ Modified Twitter Cards template https://github.com/gohugoio/hugo/blob/master/tpl/tplimpl/embedded/templates/_partials/twitter_cards.html -*/}} +*/ -}} {{- $images := partial "_funcs/get-page-images" . }} {{- with index $images 0 }} diff --git a/linkerd.io/layouts/_partials/meta-description.html b/linkerd.io/layouts/_partials/meta-description.html index 1016e73210..25a6f1e7bc 100644 --- a/linkerd.io/layouts/_partials/meta-description.html +++ b/linkerd.io/layouts/_partials/meta-description.html @@ -1,3 +1,3 @@ -{{- with or .Description .Summary site.Params.description | truncate 160 | plainify | htmlUnescape }} +{{- with or .Description .Summary site.Params.description | plainify | htmlUnescape | truncate 160 }} {{- trim . "\n\r\t " | replaceRE "[\n\r\t]+" " " }} {{- end -}} diff --git a/linkerd.io/layouts/_shortcodes/versions.html b/linkerd.io/layouts/_shortcodes/versions.html deleted file mode 100644 index 6236d04b60..0000000000 --- a/linkerd.io/layouts/_shortcodes/versions.html +++ /dev/null @@ -1,37 +0,0 @@ -{{ range hugo.Data.versions }} -
-
-
-

- Linkerd {{ .version }} -

-
-
-

- Linkerd {{ .version }} was announced on {{ .releaseDate }}. -

- -

- Known distributions of Linkerd {{ .version }}: -

- -
-
-
-{{ end }} diff --git a/linkerd.io/layouts/baseof.html b/linkerd.io/layouts/baseof.html index 8b2ee115e5..304a576a52 100644 --- a/linkerd.io/layouts/baseof.html +++ b/linkerd.io/layouts/baseof.html @@ -1,7 +1,7 @@ {{ partial "hugo-version-check" . }} {{ partial "alias-latest-docs" . }} - + {{ partial "head-tracking.html" . }} diff --git a/linkerd.io/layouts/blog/rss.xml b/linkerd.io/layouts/blog/rss.xml index d88d31fdd5..a9645d7ff8 100644 --- a/linkerd.io/layouts/blog/rss.xml +++ b/linkerd.io/layouts/blog/rss.xml @@ -10,7 +10,7 @@ {{ .Permalink }} Recent content in {{ .Title }} for {{ site.Title }} Hugo {{ hugo.Version }} - en-us + {{ site.Language.Locale }} {{ with site.Copyright }}{{ . }}{{ end }} {{ if not .Date.IsZero }}{{ (index $pages.ByLastmod.Reverse 0).Lastmod.Format "Mon, 02 Jan 2006 15:04:05 -0700" | safeHTML }}{{ end }} {{ with .OutputFormats.Get "RSS" }}{{ printf "" .Permalink "self" .MediaType | safeHTML }}{{ end }} diff --git a/linkerd.io/layouts/dashboard/list.html b/linkerd.io/layouts/dashboard/list.html index f57067a79b..4bbb250be5 100644 --- a/linkerd.io/layouts/dashboard/list.html +++ b/linkerd.io/layouts/dashboard/list.html @@ -1,5 +1,5 @@ - + Linkerd - {{ .Title }} diff --git a/linkerd.io/layouts/_shortcodes/docs/cli-annotations.html b/linkerd.io/layouts/docs/_shortcodes/cli-annotations.html similarity index 100% rename from linkerd.io/layouts/_shortcodes/docs/cli-annotations.html rename to linkerd.io/layouts/docs/_shortcodes/cli-annotations.html diff --git a/linkerd.io/layouts/_shortcodes/docs/cli-commands.html b/linkerd.io/layouts/docs/_shortcodes/cli-commands.html similarity index 100% rename from linkerd.io/layouts/_shortcodes/docs/cli-commands.html rename to linkerd.io/layouts/docs/_shortcodes/cli-commands.html diff --git a/linkerd.io/layouts/_shortcodes/docs/cli-description.html b/linkerd.io/layouts/docs/_shortcodes/cli-description.html similarity index 100% rename from linkerd.io/layouts/_shortcodes/docs/cli-description.html rename to linkerd.io/layouts/docs/_shortcodes/cli-description.html diff --git a/linkerd.io/layouts/_shortcodes/docs/cli-examples.html b/linkerd.io/layouts/docs/_shortcodes/cli-examples.html similarity index 100% rename from linkerd.io/layouts/_shortcodes/docs/cli-examples.html rename to linkerd.io/layouts/docs/_shortcodes/cli-examples.html diff --git a/linkerd.io/layouts/_shortcodes/docs/cli-flags.html b/linkerd.io/layouts/docs/_shortcodes/cli-flags.html similarity index 100% rename from linkerd.io/layouts/_shortcodes/docs/cli-flags.html rename to linkerd.io/layouts/docs/_shortcodes/cli-flags.html diff --git a/linkerd.io/layouts/_shortcodes/docs/cli-global-flags.html b/linkerd.io/layouts/docs/_shortcodes/cli-global-flags.html similarity index 100% rename from linkerd.io/layouts/_shortcodes/docs/cli-global-flags.html rename to linkerd.io/layouts/docs/_shortcodes/cli-global-flags.html diff --git a/linkerd.io/layouts/_shortcodes/docs/cli-subcommands.html b/linkerd.io/layouts/docs/_shortcodes/cli-subcommands.html similarity index 100% rename from linkerd.io/layouts/_shortcodes/docs/cli-subcommands.html rename to linkerd.io/layouts/docs/_shortcodes/cli-subcommands.html diff --git a/linkerd.io/layouts/_shortcodes/docs/edge-note.html b/linkerd.io/layouts/docs/_shortcodes/edge-note.html similarity index 100% rename from linkerd.io/layouts/_shortcodes/docs/edge-note.html rename to linkerd.io/layouts/docs/_shortcodes/edge-note.html diff --git a/linkerd.io/layouts/_shortcodes/docs/extensions.html b/linkerd.io/layouts/docs/_shortcodes/extensions.html similarity index 100% rename from linkerd.io/layouts/_shortcodes/docs/extensions.html rename to linkerd.io/layouts/docs/_shortcodes/extensions.html diff --git a/linkerd.io/layouts/_shortcodes/docs/production-note.html b/linkerd.io/layouts/docs/_shortcodes/production-note.html similarity index 100% rename from linkerd.io/layouts/_shortcodes/docs/production-note.html rename to linkerd.io/layouts/docs/_shortcodes/production-note.html diff --git a/linkerd.io/layouts/_shortcodes/docs/section-toc.html b/linkerd.io/layouts/docs/_shortcodes/section-toc.html similarity index 100% rename from linkerd.io/layouts/_shortcodes/docs/section-toc.html rename to linkerd.io/layouts/docs/_shortcodes/section-toc.html diff --git a/linkerd.io/layouts/_shortcodes/docs/toc.html b/linkerd.io/layouts/docs/_shortcodes/toc.html similarity index 100% rename from linkerd.io/layouts/_shortcodes/docs/toc.html rename to linkerd.io/layouts/docs/_shortcodes/toc.html diff --git a/linkerd.io/layouts/sitemap.xml b/linkerd.io/layouts/sitemap.xml index ff0c5b1cd1..077b08ad8d 100644 --- a/linkerd.io/layouts/sitemap.xml +++ b/linkerd.io/layouts/sitemap.xml @@ -1,4 +1,9 @@ -{{- /* Modified default base template at: https://github.com/gohugoio/hugo/blob/master/tpl/tplimpl/embedded/templates/sitemap.xml */ -}} +{{- /* + +Modified default base template +https://github.com/gohugoio/hugo/blob/master/tpl/tplimpl/embedded/templates/sitemap.xml + +*/ -}} {{ printf "" | safeHTML }} @@ -13,12 +18,12 @@ {{ .Sitemap.Priority }}{{ end }}{{ if .IsTranslated }}{{ range .Translations }} {{ end }} {{ end }}