Skip to content

Commit

Permalink
Add a local Getting Started guide for Kubernetes
Browse files Browse the repository at this point in the history
Backports #10620

* Add a local Getting Started guide for Kubernetes

Our current Getting Started guides for Teleport on Kubernetes
assume that readers are deploying resources to the cloud. Some
users may want to get started quickly without, say, asking
another team for permission to deploy a DNS zone. These users
can then read our cloud-focused guides when it comes time to
develop a proof of concept or use Teleport in production.

Hopefully, this guide will expand the range of security-minded
engineers who can get early firsthand experience with Teleport.

This guide sets up Teleport on minikube and uses the App Service
to access Kubernetes Dashboard. Because Kubernetes Dashboard is
not initially accessible outside the cluster, this guide shows
you how you can access it securely via Teleport without using
`kubectl proxy`.

We can also consider expanding this guide later on to introduce
the Teleport Kubernetes Service or more sophisticated RBAC rules.

Also worth noting that while this change adds a new tile to
/docs/pages/kubernetes-access/getting-started.mdx, it does not
add a new tile image. We can consider creating a new one or
using the current one.

Fixes #9359

* Respond to PR feedback

I've made it more explicit that the minikube Docker driver is required
for the demo. I have also added a row to the required software table
that includes Docker Desktop/Docker Engine. I've tested this on my
Linux desktop, and modified commands to support Docker Engine as well
as Docker Desktop (i.e., "minikube tunnel" exposes a private IP address
beside 127.0.0.1 for the load balancer).

Also made a couple of minor tweaks, and removed the mention of
localhost in relation to the Web UI.

* Add Details for troubleshooting minikube tunnel

* Ignore the dead link checker for a localhost link
  • Loading branch information
ptgott committed Mar 29, 2022
1 parent f82b4ee commit 27e3280
Show file tree
Hide file tree
Showing 5 changed files with 408 additions and 3 deletions.
14 changes: 12 additions & 2 deletions docs/config.json
Original file line number Diff line number Diff line change
Expand Up @@ -135,8 +135,18 @@
"title": "Getting Started",
"slug": "/kubernetes-access/getting-started/",
"entries": [
{ "title": "Cluster", "slug": "/kubernetes-access/getting-started/cluster/" },
{ "title": "Agent", "slug": "/kubernetes-access/getting-started/agent/" }
{
"title": "Local Demo Cluster",
"slug": "/kubernetes-access/getting-started/local/"
},
{
"title": "Cluster",
"slug": "/kubernetes-access/getting-started/cluster/"
},
{
"title": "Agent",
"slug": "/kubernetes-access/getting-started/agent/"
}
]
},
{
Expand Down
Binary file added docs/img/connected-app.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/pages/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ layout: tocless-doc
<Tile icon="bolt" title="Docker" href="./getting-started/docker-compose.mdx">
Try Teleport locally using Docker Compose.
</Tile>
<Tile icon="kubernetes" title="Kubernetes" href="./kubernetes-access/getting-started/cluster.mdx">
<Tile icon="kubernetes" title="Kubernetes" href="./kubernetes-access/getting-started/local.mdx">
Get started with Teleport and Kubernetes.
</Tile>
<Tile icon="cloud" title="Cloud" href="https://goteleport.com/signup">
Expand Down
4 changes: 4 additions & 0 deletions docs/pages/kubernetes-access/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ layout: tocless-doc
---

<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)
Quickly see how Teleport works with Kubernetes on your laptop.
</Tile>
<Tile title="Teleport Cluster in Kubernetes" href="./getting-started/cluster.mdx">
![Teleport ](../../img/k8s/mini-diagrams/teleport-in-k8s-mono.svg)
Deploy a standalone Teleport cluster in a Kubernetes cluster.
Expand Down
Loading

0 comments on commit 27e3280

Please sign in to comment.