Skip to content

Commit

Permalink
Split the Helm chart reference
Browse files Browse the repository at this point in the history
Backports #11292

This will make it easier to navigate to different values settings for
each chart, since values can have their own H2 sections that are
distinct from chart names. (Previously, both chart names and values
settings were organized into H2 section headings.)

This will also mean that edition warnings for Cloud users can be more
visible, since we can place them at the top of a page for a given chart.

See #10636
  • Loading branch information
ptgott committed Mar 30, 2022
1 parent f3d489e commit 6d77c8b
Show file tree
Hide file tree
Showing 8 changed files with 2,711 additions and 2,666 deletions.
12 changes: 11 additions & 1 deletion docs/config.json
Original file line number Diff line number Diff line change
Expand Up @@ -382,7 +382,17 @@
},
{
"title": "Helm Chart Reference",
"slug": "/kubernetes-access/helm/reference/"
"slug": "/kubernetes-access/helm/reference/",
"entries": [
{
"title": "teleport-cluster",
"slug": "/kubernetes-access/helm/reference/teleport-cluster/"
},
{
"title": "teleport-kube-agent",
"slug": "/kubernetes-access/helm/reference/teleport-kube-agent/"
}
]
},
{
"title": "Access Controls",
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/kubernetes-access/getting-started/agent.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -162,4 +162,4 @@ $ kubectl get pods

## Next Steps

- Take a look at a [kube-agent helm chart reference](../helm/reference.mdx#teleport-kube-agent) for a full list of parameters.
- Take a look at a [kube-agent helm chart reference](../helm/reference/teleport-kube-agent.mdx) for a full list of parameters.
7 changes: 4 additions & 3 deletions docs/pages/kubernetes-access/helm/guides/aws.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -525,9 +525,10 @@ $ helm --namespace cert-manager uninstall cert-manager

## Next steps

You can follow our [Getting Started with Teleport guide](../../../setup/guides/docker.mdx#step-34-creating-a-teleport-user) to finish setting up your
- You can follow our [Getting Started with Teleport guide](../../../setup/guides/docker.mdx#step-34-creating-a-teleport-user) to finish setting up your
Teleport cluster.

See the [high availability section of our Helm chart reference](../reference.mdx#highavailability) for more details on high availability.
- See the [high availability section of our Helm chart reference](../reference/teleport-cluster.mdx#highavailability) for more details on high availability.

- Read the [`cert-manager` documentation](https://cert-manager.io/docs/).

Reference: [`cert-manager` docs](https://cert-manager.io/docs/).
4 changes: 2 additions & 2 deletions docs/pages/kubernetes-access/helm/guides/gcp.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -409,7 +409,7 @@ To make changes to your Teleport cluster after deployment, you can use `helm upg
Helm defaults to using the latest version of the chart available in the repo, which will also correspond to the latest
version of Teleport. You can make sure that the repo is up to date by running `helm repo update`.

If you want to use a different version of Teleport, set the [`teleportVersionOverride`](../reference.mdx#teleportversionoverride) value.
If you want to use a different version of Teleport, set the [`teleportVersionOverride`](../reference/teleport-cluster.mdx#teleportversionoverride) value.

Here's an example where we set the chart to use 3 replicas:

Expand Down Expand Up @@ -463,4 +463,4 @@ $ helm --namespace cert-manager uninstall cert-manager
You can follow our [Getting Started with Teleport guide](../../../setup/guides/docker.mdx#step-34-creating-a-teleport-user) to finish setting up your
Teleport cluster.

See the [high availability section of our Helm chart reference](../reference.mdx#highavailability) for more details on high availability.
See the [high availability section of our Helm chart reference](../reference/teleport-cluster.mdx#highavailability) for more details on high availability.
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,5 @@ Since the Auth and Proxy Services are fully managed in Teleport Cloud, you shoul

You can use the `teleport-kube-agent` chart to enable the Application Service and Database Service in addition to the Kubernetes Service.

For more information, see our [Helm chart reference](../reference.mdx#teleport-kube-agent).
For more information, see our [Helm chart reference](../reference/teleport-kube-agent.mdx).
</Details>
Loading

0 comments on commit 6d77c8b

Please sign in to comment.