Skip to content

Commit

Permalink
Added admonition about TLS Routing and Machine ID.
Browse files Browse the repository at this point in the history
  • Loading branch information
russjones committed Apr 4, 2022
1 parent 496134f commit 0af5852
Show file tree
Hide file tree
Showing 4 changed files with 48 additions and 0 deletions.
15 changes: 15 additions & 0 deletions docs/pages/machine-id/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,21 @@ Teleport Cloud account.
If you have not set up a Teleport cluster before, follow the
[Getting started](https://goteleport.com/docs/getting-started) guide.

<Admonition type="note" title="Machine ID and TLS Routing">
TLS Routing support will be added to Machine ID in [Teleport
9.1](https://goteleport.com/docs/preview/upcoming-releases/#teleport-91). Until
that time, the Teleport Proxy Server will need to be configured with a
dedicated SSH listener.

```yaml
version: v1
proxy_service:
enabled: "yes"
listen_addr: "0.0.0.0:3023"
...
```
</Admonition>

## Step 1/4. Download and install Teleport (=teleport.version=)

In this step, you will be downloading and installing Teleport binaries onto the
Expand Down
15 changes: 15 additions & 0 deletions docs/pages/machine-id/guides/ansible.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,21 @@ You will need the following tools to use Teleport with Ansible.
- `ansible` >= (=ansible.min_version=)
- Optional tool `jq` to process `JSON` output

<Admonition type="note" title="Machine ID and TLS Routing">
TLS Routing support will be added to Machine ID in [Teleport
9.1](https://goteleport.com/docs/preview/upcoming-releases/#teleport-91). Until
that time, the Teleport Proxy Server will need to be configured with a
dedicated SSH listener.

```yaml
version: v1
proxy_service:
enabled: "yes"
listen_addr: "0.0.0.0:3023"
...
```
</Admonition>

In addition, if you already have not done so, follow the
[Machine ID Getting Started Guide](../getting-started.mdx) to create a bot
user and start Machine ID.
Expand Down
15 changes: 15 additions & 0 deletions docs/pages/machine-id/guides/jenkins.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,21 @@ You will need the following tools to use Teleport with Jenkins.
- Jenkins
- The `tctl` admin tool version >= (=teleport.version=)

<Admonition type="note" title="Machine ID and TLS Routing">
TLS Routing support will be added to Machine ID in [Teleport
9.1](https://goteleport.com/docs/preview/upcoming-releases/#teleport-91). Until
that time, the Teleport Proxy Server will need to be configured with a
dedicated SSH listener.

```yaml
version: v1
proxy_service:
enabled: "yes"
listen_addr: "0.0.0.0:3023"
...
```
</Admonition>

(!docs/pages/includes/tctl.mdx!)

## Architecture
Expand Down
3 changes: 3 additions & 0 deletions docs/pages/machine-id/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@ role-based access controls and audit.
Some of the things you can do with Machine ID:

- Machines can retrieve short-lived SSH certificates for CI/CD pipelines.
- Machines can retrieve short-lived X.509 certificates for use with databases
or applications. [Coming in Teleport
9.1](https://goteleport.com/docs/preview/upcoming-releases/#teleport-91).
- Configure role-based access controls and locking for machines.
- Capture access events in the audit log.

Expand Down

0 comments on commit 0af5852

Please sign in to comment.