-
Notifications
You must be signed in to change notification settings - Fork 1.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: rewrite trusted clusters overview, how-to, and related topics (#…
…31046) * trusted cluster revision WIP * Complete rewrite of trusted clusters under management/admin section * Replace images, miscellaneous fixes * Remove single root cluster statement * Move the jq command examples to a separate topic * Move lookup commands to a separate file * Fix some spelling issues * Some fixes and clarification * Add leaf cluster Auth Server > Proxy service on th eroot cluster * Add service interaction diagram * Updates from review * Update image * Add an example * Add direct and remove security vulnerability clause
- Loading branch information
1 parent
f476edd
commit b3258ca
Showing
6 changed files
with
739 additions
and
871 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
35 changes: 35 additions & 0 deletions
35
docs/pages/management/admin/trusted-cluster-address-lookup.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
--- | ||
title: Commands to look up cluster addresses | ||
description: Suggests command-line tools and scripts to look up cluster addresses. | ||
--- | ||
|
||
If you aren't sure of what values to use for cluster settings such as the `tunnel_addr` | ||
or `web_proxy_addr` in resource configuration files, you can often look up the information | ||
using command-line tools that parse and extract machine-readable data from JSON files. | ||
One of the most common of these tools is `jq`. | ||
You can download `jq` for most operating systems from the | ||
[jqlang](https://jqlang.github.io/jq/download/) website. | ||
|
||
After you download the program, you can run commands that use the jq program to look up | ||
cluster addresses. | ||
|
||
To get cluster addresses: | ||
|
||
1. Set the `PROXY` environment variable to retrieve information about your Teleport cluster | ||
by replacing `teleport.example.com` with your Teleport cluster domain: | ||
|
||
```code | ||
$ PROXY=teleport.example.com | ||
``` | ||
|
||
1. Extract the `tunnel_addr` for your cluster by running the following command: | ||
|
||
```code | ||
$ curl https://$PROXY/webapi/ping | jq 'if .proxy.tls_routing_enabled == true then .proxy.ssh.public_addr else .proxy.ssh.ssh_tunnel_public_addr end' | ||
``` | ||
|
||
1. Extract the `web_proxy_addr` for your cluster by running the following command: | ||
|
||
```code | ||
$ curl https://$PROXY/webapi/ping | jq .proxy.ssh.public_addr | ||
``` |
Oops, something went wrong.