Skip to content

Commit

Permalink
Fix lint
Browse files Browse the repository at this point in the history
- Add How it works section
- Capitalize Teleport Agent
  • Loading branch information
bernardjkim committed Jan 8, 2025
1 parent 1ce8f53 commit 2d9190b
Showing 1 changed file with 14 additions and 3 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,17 @@ Trusted clusters are only available for self-hosted Teleport clusters.
This guide will explain how to use Teleport's Kubernetes Operator to deploy
trusted clusters.

## How it works

The Teleport Kubernetes Operator provides a way for Kubernetes users to manage Teleport trusted clusters through
Kubernetes, following [the Operator Pattern](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/).

The trusted cluster custom resource definitions are deployed alongside the Teleport
Kubernetes Operator. Once deployed, users can use a Kubernetes client like `kubectl`
or their existing CI/CD Kubernetes pipelines to create and manage Teleport trusted
clusters. The Teleport Kubernetes Operator watches for these trusted cluster resources
and makes API calls to Teleport to reach the desired state.

## Prerequisites

- Access to **two** Teleport cluster instances.
Expand Down Expand Up @@ -99,7 +110,7 @@ logging in to the server in the leaf cluster.

To add a user and role for accessing the trusted cluster:

1. Open a terminal shell on the server running the Teleport agent in the leaf cluster.
1. Open a terminal shell on the server running the Teleport Agent in the leaf cluster.
1. Add the local `visitor` user and create a home directory for the user by running the
following command:

Expand Down Expand Up @@ -141,7 +152,7 @@ your Teleport username:
```
You must explicitly allow access to nodes with labels to SSH into the server running
the Teleport agent. In this example, the `visitor` login is allowed access to any server.
the Teleport Agent. In this example, the `visitor` login is allowed access to any server.

1. Create the `visitor` role by running the following command:

Expand Down Expand Up @@ -357,7 +368,7 @@ running the following command:
tsh status
```

1. Confirm that the server running the Teleport agent is joined to the leaf cluster by
1. Confirm that the server running the Teleport Agent is joined to the leaf cluster by
running a command similar to the following:

```code
Expand Down

0 comments on commit 2d9190b

Please sign in to comment.