Skip to content

Commit

Permalink
Hide Kube Access menu items based on scope (gravitational#12737)
Browse files Browse the repository at this point in the history
See gravitational#11383

Help ensure that no visitor to the Teleport docs site sees content that
is irrelevant to their scope (e.g., Cloud, Open Source, or Enterprise) by
hiding scope-irrelevant content from the navigation menu and menu
pages.

For pages that aren't step-by-step guides and are meant to convey
general information about a Teleport edition, show these pages in all
scopes so users who are curious about another scope can get the
information they need.

This PR focuses on the Kubernetes Access section.

It also adds a short note at the top of the teleport-cluter Helm chart
reference that the chart supports custom agent configurations along with
the Auth/Proxy.
  • Loading branch information
ptgott authored May 24, 2022
1 parent 9333509 commit dd02a89
Show file tree
Hide file tree
Showing 13 changed files with 308 additions and 44 deletions.
23 changes: 15 additions & 8 deletions docs/config.json
Original file line number Diff line number Diff line change
Expand Up @@ -346,9 +346,10 @@
"title": "Local Demo Cluster",
"slug": "/kubernetes-access/getting-started/local/"
},
{
"title": "Cluster",
"slug": "/kubernetes-access/getting-started/cluster/"
{
"title": "Cluster",
"slug": "/kubernetes-access/getting-started/cluster/",
"hideInScopes": "cloud"
},
{
"title": "Agent",
Expand Down Expand Up @@ -381,26 +382,32 @@
{
"title": "Helm Guides",
"slug": "/kubernetes-access/helm/guides/",
"hideInScopes": "cloud",
"entries": [
{
"title": "AWS EKS Cluster",
"slug": "/kubernetes-access/helm/guides/aws/"
"slug": "/kubernetes-access/helm/guides/aws/",
"hideInScopes": "cloud"
},
{
"title": "Google Cloud GKE Cluster",
"slug": "/kubernetes-access/helm/guides/gcp/"
"slug": "/kubernetes-access/helm/guides/gcp/",
"hideInScopes": "cloud"
},
{
"title": "DigitalOcean Kubernetes Cluster",
"slug": "/kubernetes-access/helm/guides/digitalocean/"
"slug": "/kubernetes-access/helm/guides/digitalocean/",
"hideInScopes": "cloud"
},
{
"title": "Customize Deployment Config",
"slug": "/kubernetes-access/helm/guides/custom/"
"slug": "/kubernetes-access/helm/guides/custom/",
"hideInScopes": "cloud"
},
{
"title": "Migrating From Older Charts",
"slug": "/kubernetes-access/helm/guides/migration/"
"slug": "/kubernetes-access/helm/guides/migration/",
"hideInScopes": "cloud"
}
]
},
Expand Down
21 changes: 20 additions & 1 deletion docs/pages/kubernetes-access/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,13 @@ videoBanner: VPGYLEMTdJ8
layout: tocless-doc
---

<ScopedBlock scope={["oss", "enterprise"]}>

## Deploy Teleport on Kubernetes

See how you can deploy the Teleport Auth Service and Proxy Service on a
Kubernetes cluster.

<TileSet>
<Tile title="Try Teleport on a Local Kubernetes Cluster" href="./getting-started/local.mdx">
![Teleport ](../../img/k8s/mini-diagrams/teleport-in-k8s-mono.svg)
Expand All @@ -14,8 +21,20 @@ layout: tocless-doc
![Teleport ](../../img/k8s/mini-diagrams/teleport-in-k8s-mono.svg)
Deploy a standalone Teleport cluster in a Kubernetes cluster.
</Tile>
</TileSet>

</ScopedBlock>

## Use Teleport to access a Kubernetes cluster

Register your Kubernetes clusters with Teleport for secure `kubectl`
connections, fine-grained RBAC, and more.

<TileSet>
<Tile title="Teleport Kubernetes Agent" href="./getting-started/agent.mdx">
![Kubernetes agent](../../img/k8s/mini-diagrams/k8s-to-teleport-mono.svg)
Connect a Kubernetes cluster to an existing Teleport cluster.

Get started with Teleport Kubernetes Access.

</Tile>
</TileSet>
44 changes: 35 additions & 9 deletions docs/pages/kubernetes-access/getting-started/cluster.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,39 @@ title: Getting Started - Kubernetes with SSO
description: Getting started with Teleport. Let's deploy Teleport in a Kubernetes with SSO and Audit logs
---

# Getting Started
<ScopedBlock title="Teleport Cloud customers" scope={["cloud"]}>
This guide shows you how to deploy the Teleport Auth Service and Proxy Service on a Kubernetes cluster. These services are fully managed in Teleport Cloud.

Instead, Teleport Cloud users should consult the following guide, which shows you how to connect a Teleport Kubernetes Service agent to an existing Teleport cluster:

<TileSet>
<Tile
title="Connect a Kubernetes Cluster to Teleport"
href="./agent.mdx"
icon="kubernetes"
>
</Tile>
</TileSet>

You can also view this guide as a user of another Teleport edition:

<TileSet>
<Tile
href="./cluster.mdx/?scope=oss"
title="Open Source"
icon="stack"
>
</Tile>
<Tile
href="./cluster.mdx/?scope=enterprise"
title="Enterprise"
icon="building"
>
</Tile>
</TileSet>
</ScopedBlock>

<ScopedBlock scope={["oss", "enterprise"]}>

Teleport can provide secure, unified access to your Kubernetes clusters. This guide will show you how to:

Expand All @@ -16,14 +48,6 @@ While completing this guide, you will deploy a single Teleport pod running the A
If you are already running Teleport on another platform, you can use your existing Teleport deployment to access your Kubernetes cluster. [Follow our guide](./agent.mdx) to connect your Kubernetes cluster to Teleport.
</Admonition>

<Details title="Teleport Cloud customers" scopeOnly={true} scope={["cloud"]}>
This guide shows you how to deploy the Teleport Auth Service and Proxy Service on a Kubernetes cluster. These services are fully managed in Teleport Cloud.

Instead, Teleport Cloud users should consult the following guide, which shows you how to connect a Teleport Kubernetes Service node to an existing Teleport cluster.

[Connect a Kubernetes Cluster to Teleport](./agent.mdx)
</Details>

## Follow along with our video guide

<iframe
Expand Down Expand Up @@ -352,3 +376,5 @@ the default one in case there is a problem.
- [Setup CI/CD Access with Teleport](../guides/cicd.mdx)
- [Federated Access using Trusted Clusters](../guides/federation.mdx)
- [Single-Sign On and Kubernetes Access Control](../controls.mdx)

</ScopedBlock>
55 changes: 51 additions & 4 deletions docs/pages/kubernetes-access/helm/guides.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,12 @@ description: How to install and configure Teleport in Kubernetes using Helm
layout: tocless-doc
---

## Helm guides

These guides show you how to set up a full self-hosted Teleport deployment using
our `teleport-cluster` Helm chart.

<ScopedBlock scope={["oss", "enterprise"]}>
<TileSet>
<Tile icon="kubernetes" title="Standalone Teleport Cluster" href="../getting-started.mdx">
Getting started with Kubernetes Access
Expand All @@ -18,11 +24,52 @@ layout: tocless-doc
Running a Teleport cluster in Kubernetes with a custom Teleport config
</Tile>
</TileSet>
</ScopedBlock>
<ScopedBlock scope={["cloud"]}>
<TileSet>
<Tile
icon="stack"
title="Open Source Teleport"
href="./guides.mdx/?scope=oss"
>
Learn how to deploy an open source Teleport cluster using Helm.
</Tile>
<Tile
icon="building"
title="Teleport Enterprise"
href="./guides.mdx/?scope=enterprise"
>
Learn how to deploy a Teleport Enterprise cluster using Helm.
</Tile>
</TileSet>
</ScopedBlock>

## Migration Guides
## Detailed Helm chart references

- [Migrating from the legacy `teleport` chart](./guides/migration.mdx)
<TileSet>
<Tile href="./reference/teleport-cluster.mdx" icon="kubernetes" title="teleport-cluster">

## Detailed Helm chart references
Deploy the `teleport` daemon on Kubernetes with preset configurations for the
Auth and Proxy Services and support for any Teleport service configuration.

</Tile>
<Tile href="./reference/teleport-kube-agent.mdx" icon="kubernetes" title="teleport-kube-agent">

Deploy the Teleport Kubernetes Service, Application Service, or Database Service on Kubernetes.

</Tile>
</TileSet>
<ScopedBlock scope={["oss", "enterprise"]}>

## Migration Guides

<TileSet>
<Tile
href="./guides/migration.mdx"
title="Migrating from the legacy Teleport chart"
icon="kubernetes"
>
</Tile>
</TileSet>

- [Helm chart reference](./reference.mdx)
</ScopedBlock>
25 changes: 25 additions & 0 deletions docs/pages/kubernetes-access/helm/guides/aws.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,31 @@ description: Install and configure an HA Teleport cluster using an AWS EKS clust
In this guide, we'll go through how to set up a High Availability Teleport cluster with multiple replicas in Kubernetes
using Teleport Helm charts and AWS products (DynamoDB and S3).

<ScopedBlock scope="cloud">

(!docs/pages/kubernetes-access/helm/includes/teleport-cluster-cloud-warning.mdx!)

You can also view this guide as a user of another Teleport edition:

<TileSet>
<Tile
href="./aws.mdx/?scope=oss"
title="Open Source"
icon="stack"
>
</Tile>
<Tile
href="./aws.mdx/?scope=enterprise"
title="Enterprise"
icon="building"
>
</Tile>
</TileSet>

</ScopedBlock>

<ScopedBlock scope={["oss", "enterprise"]}>

## Prerequisites

(!docs/pages/kubernetes-access/helm/includes/teleport-cluster-prereqs.mdx!)
Expand Down Expand Up @@ -532,3 +555,5 @@ Teleport cluster.
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/).

</ScopedBlock>
39 changes: 37 additions & 2 deletions docs/pages/kubernetes-access/helm/guides/custom.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Running a Teleport cluster with a custom configuration using Helm
title: Running Teleport with a Custom Configuration using Helm
description: Install and configure a Teleport cluster with a custom configuration using Helm
---

Expand All @@ -9,7 +9,40 @@ config file using Teleport Helm charts.
This setup can be useful when you already have an existing Teleport cluster and would like to start running it in Kubernetes, or when
migrating your setup from a legacy version of the Helm charts.

(!docs/pages/kubernetes-access/helm/includes/teleport-cluster-cloud-warning.mdx!)
<ScopedBlock title="Teleport Cloud customers" scope={["cloud"]}>

Teleport Cloud users should consult the following guide, which shows
you how to connect a Teleport Kubernetes Service agent to an existing Teleport
cluster:

<TileSet>
<Tile
title="Connect a Kubernetes Cluster to Teleport"
href="./agent.mdx"
icon="kubernetes"
>
</Tile>
</TileSet>

You can also view this guide as a user of another Teleport edition:

<TileSet>
<Tile
href="./custom.mdx/?scope=oss"
title="Open Source"
icon="stack"
>
</Tile>
<Tile
href="./custom.mdx/?scope=enterprise"
title="Enterprise"
icon="building"
>
</Tile>
</TileSet>
</ScopedBlock>

<ScopedBlock scope={["oss", "enterprise"]}>

## Prerequisites

Expand Down Expand Up @@ -240,3 +273,5 @@ $ helm --namespace teleport uninstall teleport

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.

</ScopedBlock>
47 changes: 44 additions & 3 deletions docs/pages/kubernetes-access/helm/guides/digitalocean.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,50 @@ title: Get started with Teleport on DigitalOcean Kubernetes
description: How to get started with Teleport on DigitalOcean Kubernetes
---

This guide will show you how to get started with Teleport on DigitalOcean Kubernetes.
<ScopedBlock title="Teleport Cloud customers" scope={["cloud"]}>

(!docs/pages/kubernetes-access/helm/includes/teleport-cluster-cloud-warning.mdx!)
This guide shows you how to deploy the Teleport Auth Service and Proxy Service
on a DigitalOcean Kubernetes cluster. These services are fully managed in
Teleport Cloud.

Instead, Teleport Cloud users should consult the following guide, which shows
you how to connect a Teleport Kubernetes Service agent to an existing Teleport
cluster:

<TileSet>
<Tile
title="Connect a Kubernetes Cluster to Teleport"
href="./agent.mdx"
icon="kubernetes"
>
</Tile>
</TileSet>

You can also view this guide as a user of another Teleport edition:

<TileSet>
<Tile
href="./digitalocean.mdx/?scope=oss"
title="Open Source"
icon="stack"
>
</Tile>
<Tile
href="./digitalocean.mdx/?scope=enterprise"
title="Enterprise"
icon="building"
>
</Tile>
</TileSet>
</ScopedBlock>

<ScopedBlock scope={["oss", "enterprise"]}>

This guide will show you how to get started with Teleport on DigitalOcean
Kubernetes.

## Prerequisites

- DigitalOcean account.
- Your workstation configured with [kubectl](https://kubernetes.io/docs/tasks/tools/), [Helm](https://helm.sh/docs/intro/install/), [doctl](https://docs.digitalocean.com/reference/doctl/how-to/install/), and the Teleport [tsh](https://goteleport.com/docs/installation/) client.

Expand Down Expand Up @@ -188,4 +227,6 @@ Teleport keeps an audit log of access to a Kubernetes cluster. In the screenshot
- [Connect Multiple Kubernetes Clusters](../../guides/multiple-clusters.mdx)
- [Setup CI/CD Access with Teleport](../../guides/cicd.mdx)
- [Federated Access using Trusted Clusters](../../guides/federation.mdx)
- [Single-Sign On and Kubernetes Access Control](../../controls.mdx)
- [Single-Sign On and Kubernetes Access Control](../../controls.mdx)

</ScopedBlock>
Loading

0 comments on commit dd02a89

Please sign in to comment.