Skip to content

Commit

Permalink
Removed 443/3080 port from tsh login examples (gravitational#8016)
Browse files Browse the repository at this point in the history
  • Loading branch information
stevenGravy authored Aug 21, 2021
1 parent 15cd08c commit dd12797
Show file tree
Hide file tree
Showing 25 changed files with 90 additions and 90 deletions.
8 changes: 4 additions & 4 deletions docs/pages/access-controls/guides/dual-authz.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ tctl status

# Output
Cluster acme.example.com
Version 6.0.2
Version (=teleport.version=)
Host CA never updated
User CA never updated
Jwt CA never updated
Expand Down Expand Up @@ -244,14 +244,14 @@ Alice and Ivan can review and approve request using Web UI or CLI:
<TabItem label="Web UI">
![Teleport-Approve](../../../img/access-controls/dual-authz/teleport-6-ivan-approve.png)
</TabItem>

<TabItem label="CLI">
```bash
tsh request list
# Output
ID User Roles Created (UTC) Status
------------------------------------ --------------- ------- ------------------- -------
------------------------------------ --------------- ------- ------------------- -------
9c721e54-b049-4ef8-a7f6-c777aa066764 [email protected] dbadmin 03 Apr 21 03:58 UTC PENDING
tsh request review --approve --reason="hello" 9c721e54-b049-4ef8-a7f6-c777aa066764
Expand Down
4 changes: 2 additions & 2 deletions docs/pages/access-controls/guides/impersonation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ tctl status

# Output
Cluster acme.example.com
Version 6.0.2
Version (=teleport.version=)
Host CA never updated
User CA never updated
Jwt CA never updated
Expand Down Expand Up @@ -119,7 +119,7 @@ tctl users add alice --roles=impersonator,access
Alice can login using `tsh` and issue a cert for `jenkins`:

```bash
tsh login --proxy=teleport.localhost:3080 --user=alice --auth=local
tsh login --proxy=teleport.localhost --user=alice --auth=local
tctl auth sign --user=jenkins --format=openssh --out=jenkins --ttl=240h
```

Expand Down
10 changes: 5 additions & 5 deletions docs/pages/access-controls/guides/role-templates.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ tctl status

# Output
Cluster acme.example.com
Version 6.0.2
Version (=teleport.version=)
Host CA never updated
User CA never updated
Jwt CA never updated
Expand Down Expand Up @@ -143,15 +143,15 @@ spec:
Update both user's entries with `tctl create -f` command:

```bash
tctl create -f traits.yaml
tctl create -f traits.yaml
# user "alice" has been updated
```

Once Alice logs in, she will receive SSH and X.509 certificates with
a new role and SSH logins and Kubernetes groups set:

```bash
tsh login --proxy=teleport.example.com:443 --user=alice
tsh login --proxy=teleport.example.com --user=alice
# Output
> Profile URL: https://teleport.example.com:443
Expand Down Expand Up @@ -236,7 +236,7 @@ Once Bob logs in using SSO, he will receive SSH and X.509 certificates with
a new role and SSH logins generated using `sso-users` role template:

```bash
tsh login --proxy=teleport.example.com:443 --auth=github
tsh login --proxy=teleport.example.com --auth=github
> Profile URL: https://teleport.example.com:443
Logged in as: bob
Expand Down Expand Up @@ -290,7 +290,7 @@ spec:
database_users: ['{{email.local(external.email)}}']
database_labels:
'env': '{{regexp.replace(external.access["env"], "^(staging)$", "$1")}}'
# Labels can mix template and hard-coded values.
node_labels:
'env': '{{external.access["env"]}}'
Expand Down
6 changes: 3 additions & 3 deletions docs/pages/api/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -40,15 +40,15 @@ Log in as the newly created user with `tsh`.

```bash
# generate tsh profile
tsh login --user=api-admin --proxy=tele.example.com:443
tsh login --user=api-admin --proxy=tele.example.com
```

The [Profile Credentials loader](https://pkg.go.dev/github.com/gravitational/teleport/api/client#LoadProfile)
will automatically retrieve Credentials from the current profile in the next step.

## Step 3/3. Create a Go project

Set up a new [Go module](https://golang.org/doc/tutorial/create-module) and import the `client` package:
Set up a new [Go module](https://golang.org/doc/tutorial/create-module) and import the `client` package:

```bash
mkdir client-demo && cd client-demo
Expand Down Expand Up @@ -93,7 +93,7 @@ func main() {
if err != nil {
log.Fatalf("failed to ping server: %v", err)
}
log.Printf("Example success!")
log.Printf("Example server response: %s", resp)
log.Printf("Server version: %s", resp.ServerVersion)
Expand Down
4 changes: 2 additions & 2 deletions docs/pages/application-access/guides/api-access.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ app_service:
Log into your Teleport cluster and view available applications:
```bash
tsh login --proxy=teleport.example.com:443
tsh login --proxy=teleport.example.com
tsh app ls

# Output
Expand Down Expand Up @@ -102,7 +102,7 @@ tsh app logout
tsh app config
```

shows current app URI and paths to the secrets.
shows current app URI and paths to the secrets.

This is useful when configuring CLI tools (such as `curl`) or GUI tools (such as Postman).

Expand Down
2 changes: 1 addition & 1 deletion docs/pages/application-access/guides/jwt.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -90,4 +90,4 @@ can be trusted. This endpoint is `https://[cluster-name]:3080/.well-known/jwks.j
```

See the example Go program used to validate Teleport's JWT tokens on our
[Github](https://github.com/gravitational/teleport/blob/v6.0.2/examples/jwt/verify-jwt.go).
[Github](https://github.com/gravitational/teleport/blob/v(=teleport.version=)/examples/jwt/verify-jwt.go).
4 changes: 2 additions & 2 deletions docs/pages/cloud/faq.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -37,11 +37,11 @@ There is no need to open any ports on your infrastructure for inbound traffic.
We have made changes to allow you to log into your cluster using `tsh`, then use `tctl` remotely:

```bash
$ tsh login --proxy=myinstance.teleport.sh:443
$ tsh login --proxy=myinstance.teleport.sh
# tctl (Enterprise edition) can use tsh credentials as of version 5.0
$ tctl status
```
You must use the enterprise version of `tctl`.
You must use the enterprise version of `tctl`.

### Why am I getting `permission denied` errors when using `tctl`?

Expand Down
12 changes: 6 additions & 6 deletions docs/pages/cloud/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,8 @@ Install client libraries:
<TabItem label="Linux">
```bash
curl -O https://get.gravitational.com/teleport-ent-v(=teleport.version=)-linux-amd64-bin.tar.gz
# verify signature
echo "$(curl https://get.gravitational.com/teleport-ent-v(=teleport.version=)-linux-amd64-bin.tar.gz.sha256)" | sha256sum --check
# verify signature
echo "$(curl https://get.gravitational.com/teleport-ent-v(=teleport.version=)-linux-amd64-bin.tar.gz.sha256)" | sha256sum --check
tar -xzf teleport-ent-v(=teleport.version=)-linux-amd64-bin.tar.gz
cd teleport-ent
sudo ./install
Expand All @@ -53,11 +53,11 @@ Login into Teleport and test the connection:

```bash
# tsh logs you in and receives short-lived certificates
$ tsh login --proxy=myinstance.teleport.sh:443 [email protected]
$ tsh login --proxy=myinstance.teleport.sh [email protected]
$ tsh ls
Node Name Address Labels
--------- ---------- ------
myserver ⟵ Tunnel
Node Name Address Labels
--------- ---------- ------
myserver ⟵ Tunnel
$ tsh ssh root@myserver
```

Expand Down
6 changes: 3 additions & 3 deletions docs/pages/cloud/guides/u2f.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ Install client libraries:
<TabItem label="Linux">
```bash
curl -O https://get.gravitational.com/teleport-ent-v(=teleport.version=)-linux-amd64-bin.tar.gz
# verify signature
echo "$(curl https://get.gravitational.com/teleport-ent-v(=teleport.version=)-linux-amd64-bin.tar.gz.sha256)" | sha256sum --check
# verify signature
echo "$(curl https://get.gravitational.com/teleport-ent-v(=teleport.version=)-linux-amd64-bin.tar.gz.sha256)" | sha256sum --check
tar -xzf teleport-ent-v(=teleport.version=)-linux-amd64-bin.tar.gz
cd teleport-ent
sudo ./install
Expand All @@ -27,7 +27,7 @@ Login with a teleport user with editor privileges:

```bash
# tsh logs you in and receives short-lived certificates
tsh login --proxy=myinstance.teleport.sh:443 [email protected]
tsh login --proxy=myinstance.teleport.sh [email protected]
# try out the connection
tctl get nodes
```
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/database-access/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ Log into Teleport with the user we've just created. Make sure to use `tsh`
version `6.0` or newer that includes Database Access support.

```shell
tsh login --proxy=teleport.example.com:443 --user=alice
tsh login --proxy=teleport.example.com --user=alice
```

Now we can inspect available databases and retrieve credentials for the
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/database-access/guides/mongodb-atlas.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ certificate with `CN=alice` subject.
Log into your Teleport cluster and see available databases:

```bash
tsh login --proxy=teleport.example.com:3080 --user=alice
tsh login --proxy=teleport.example.com --user=alice
tsh db ls
Name Description Labels
------------- ----------- --------
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/database-access/guides/mongodb-self-hosted.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,7 @@ in MongoDB documentation for more details.
Log into your Teleport cluster and see available databases:

```bash
tsh login --proxy=teleport.example.com:3080 --user=alice
tsh login --proxy=teleport.example.com --user=alice
tsh db ls
Name Description Labels
------------- --------------- --------
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/database-access/guides/mysql-aws.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -220,7 +220,7 @@ Once the database service has joined the cluster, login to see the available
databases:

```sh
$ tsh login --proxy=teleport.example.com:3080 --user=testuser
$ tsh login --proxy=teleport.example.com --user=testuser
$ tsh db ls
Name Description Labels
------ ---------------- --------
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/database-access/guides/mysql-cloudsql.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -201,7 +201,7 @@ Once the database service has joined the cluster, login to see the available
databases:

```bash
$ tsh login --proxy=teleport.example.com:3080 --user=alice
$ tsh login --proxy=teleport.example.com --user=alice
$ tsh db ls
Name Description Labels
-------- ------------------- --------
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/database-access/guides/mysql-self-hosted.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ Once the database service has joined the cluster, login to see the available
databases:

```sh
$ tsh login --proxy=teleport.example.com:3080 --user=testuser
$ tsh login --proxy=teleport.example.com --user=testuser
$ tsh db ls
Name Description Labels
------- ------------- --------
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/database-access/guides/postgres-aws.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,7 @@ Once the database service has joined the cluster, login to see the available
databases:

```sh
$ tsh login --proxy=teleport.example.com:3080 --user=testuser
$ tsh login --proxy=teleport.example.com --user=testuser
$ tsh db ls
Name Description Labels
------ --------------------- --------
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/database-access/guides/postgres-cloudsql.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -263,7 +263,7 @@ Once the database service has joined the cluster, login to see the available
databases:

```sh
$ tsh login --proxy=teleport.example.com:3080 --user=alice
$ tsh login --proxy=teleport.example.com --user=alice
$ tsh db ls
Name Description Labels
-------- ------------------------ --------
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/database-access/guides/postgres-redshift.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -220,7 +220,7 @@ Once the database service has joined the cluster, login to see the available
databases:

```bash
$ tsh login --proxy=teleport.example.com:3080 --user=alice
$ tsh login --proxy=teleport.example.com --user=alice
$ tsh db ls
Name Description Labels
-------- ----------------------- --------
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/database-access/guides/postgres-self-hosted.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@ Once the database service has joined the cluster, login to see the available
databases:

```sh
$ tsh login --proxy=teleport.example.com:3080 --user=testuser
$ tsh login --proxy=teleport.example.com --user=testuser
$ tsh db ls
Name Description Labels
------- ------------------ --------
Expand Down
4 changes: 2 additions & 2 deletions docs/pages/getting-started/linux-server.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -196,14 +196,14 @@ Log in to receive short-lived certificates from Teleport:

```bash
# Replace teleport.example.com:443 with your Teleport cluster's public address as configured above.
tsh login --proxy=teleport.example.com:443 --user=teleport-admin
tsh login --proxy=teleport.example.com --user=teleport-admin
```

## Step 4/4. Have fun with Teleport!

Congrats! You've completed setting up Teleport! Now, feel free to have fun and explore the many features Teleport has to offer.

Here are several common commands and operations you'll likely find useful:
Here are several common commands and operations you'll likely find useful:

### View Status

Expand Down
2 changes: 1 addition & 1 deletion docs/pages/includes/tctl.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ tctl status
To try this flow in the cloud, login into your cluster using tsh, then use tctl remotely:

```bash
tsh login --proxy=myinstance.teleport.sh:443
tsh login --proxy=myinstance.teleport.sh

# tctl (Enterprise edition) can use tsh credentials as of version 5.0
tctl status
Expand Down
6 changes: 3 additions & 3 deletions docs/pages/kubernetes-access/getting-started/cluster.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -226,7 +226,7 @@ Try `tsh login` with a local user. Use a custom `KUBECONFIG` to prevent overwrit
the default one in case there is a problem.

```bash
KUBECONFIG=${HOME?}/teleport.yaml tsh login --proxy=tele.example.com:443 --user=alice
KUBECONFIG=${HOME?}/teleport.yaml tsh login --proxy=tele.example.com --user=alice
```

Teleport updated `KUBECONFIG` with a short-lived 12-hour certificate.
Expand Down Expand Up @@ -336,13 +336,13 @@ the default one in case there is a problem.
<Tabs>
<TabItem label="Open Source">
```bash
KUBECONFIG=${HOME?}/teleport.yaml tsh login --proxy=tele.example.com:443 --auth=github
KUBECONFIG=${HOME?}/teleport.yaml tsh login --proxy=tele.example.com --auth=github
```
</TabItem>

<TabItem label="Enterprise">
```bash
KUBECONFIG=${HOME?}/teleport.yaml tsh login --proxy=tele.example.com:443 --auth=okta
KUBECONFIG=${HOME?}/teleport.yaml tsh login --proxy=tele.example.com --auth=okta
```
</TabItem>
</Tabs>
Expand Down
Loading

0 comments on commit dd12797

Please sign in to comment.