Skip to content

Commit

Permalink
Merge pull request #7 from natrontech/docs/jfu
Browse files Browse the repository at this point in the history
docs: update teleport documentation
  • Loading branch information
janfuhrer authored Dec 18, 2024
2 parents 276ebd4 + 3900d24 commit 04d0fae
Show file tree
Hide file tree
Showing 4 changed files with 28 additions and 8 deletions.
8 changes: 4 additions & 4 deletions docs/access/teleport/client-installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,18 +16,18 @@ Teleport Connect is a desktop application that allows you to connect to a Telepo


## TSH Client

The TSH Client is a command line tool that allows you to connect to a Teleport cluster and access resources. It is available for Linux, macOS, and Windows.

It includes the following commands:

- `tsh login` - log in to a Teleport cluster
- `tsh ssh` - connect to a node or a cluster
- `tsh db` - connect to a database
- `tsh kube` - connect to a Kubernetes cluster
- `tsh status` - show the status of the Teleport cluster

!!! info "Make sure to select `tsh client` from the dropdown menu"
[Install instructinos TSH Client :fontawesome-solid-download:](https://goteleport.com/docs/connect-your-client/tsh/#installing-tsh){ .md-button }


<figure markdown>
![Teleport](../../assets/images/teleport_tsh_download.png)
</figure>

27 changes: 23 additions & 4 deletions docs/access/teleport/k8s-client.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
# Accessing Kubernetes Clusters using the Teleport Connect Client

You can use the Teleport Connect client to access Kubernetes clusters.
You can use the Teleport Connect client or the `tsh` binary to access Kubernetes clusters.

## Prerequisites

- Teleport Connect Client installed on your local machine. See [Installing Teleport Connect Client](/access/teleport/client-installation/) for instructions.
- Teleport Connect Client or TSH Client installed on your local machine. See [Installing Teleport Client](/access/teleport/client-installation/) for instructions.
- Kubectl installed on your local machine. See [Installing kubectl](https://kubernetes.io/docs/tasks/tools/#kubectl) for instructions.
- You must be in a Teleport Role that allows access to Kubernetes clusters.

## Accessing a Kubernetes Cluster using Teleport Connect

## Accessing a Kubernetes Cluster
Launch the Teleport Connect Client and sign in with your account.

Choose the register `Kubes` and select `Connect` to connect to the Kubernetes cluster.
Expand All @@ -19,4 +20,22 @@ A new terminal window will open with the `kubectl` context set to the Kubernetes

Now you can run `kubectl` commands to access the Kubernetes cluster.

![Teleport Connect K8s](../../assets/images/teleport_connect_k8s_terminal.png)
![Teleport Connect K8s](../../assets/images/teleport_connect_k8s_terminal.png)

## Accessing Kubernetes Clusters using tsh

You can use the Teleport CLI `tsh` to access Kubernetes clusters directly in your terminal.

```bash
TELEPORT_URL=teleport.example.com
TELEPORT_USER=your-teleport-user

# Login to the Teleport cluster
tsh login --proxy=$TELEPORT_URL --auth=local --user=$TELEPORT_USER $TELEPORT_URL

# Print available Kubernetes clusters
tsh kube ls

# Connect to a Kubernetes cluster
tsh kube login <cluster-name>
```
1 change: 1 addition & 0 deletions docs/access/teleport/k8s-openlens.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ You can use the Teleport Connect client to access Kubernetes clusters with OpenL
- OpenLens installed on your local machine. See [OpenLens Releases](https://github.com/MuhammedKalkan/OpenLens/releases) for download.

## Configuring OpenLens to use Teleport Connect

Launch the Teleport Connect Client and sign in with your account.

Choose the register `Kubes` and select `Connect` to connect to the Kubernetes cluster.
Expand Down
Binary file removed docs/assets/images/teleport_tsh_download.png
Binary file not shown.

0 comments on commit 04d0fae

Please sign in to comment.