Skip to content

Commit

Permalink
Move --cluster to its correct location as a command subflag (gravitat…
Browse files Browse the repository at this point in the history 
…ional#2758)
  • Loading branch information
@webvictim
webvictim authored Jun 5, 2019
1 parent fc8cf3f commit 941704d
Show file tree
Hide file tree
Showing 19 changed files with 45 additions and 45 deletions.
6 changes: 3 additions & 3 deletions docs/2.3/admin-guide.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -865,7 +865,7 @@ This setup works as follows:
"main" must authenticate "east" (cluster-to-cluster authentication) when the
tunnel is established, and "east" must trust users connecting from "main"
(user authentication).
3. Users of "main" must use `tsh --cluster=east` flag if they want to connect to any nodes in "east".
3. Users of "main" must use `tsh` commands with the `--cluster=east` flag if they want to connect to any nodes in "east".
4. Users of "main" can see other trusted clusters connected to "main" by running `tsh clusters`

### Example Configuration
Expand Down Expand Up @@ -963,15 +963,15 @@ main online
east online

# see the list of machines (nodes) behind the eastern cluster:
$ tsh --cluster=east ls
$ tsh ls --cluster=east

Node Name Node ID Address Labels
--------- ------------------ -------------- -----------
db1.east cf7cc5cd-935e-46f1 10.0.5.2:3022 role=db-master
db2.east 3879d133-fe81-3212 10.0.5.3:3022 role=db-slave

# SSH into any node in "east":
$ tsh --cluster=east ssh [email protected]
$ tsh ssh --cluster=east [email protected]
```

## HTTP CONNECT Proxies
Expand Down
4 changes: 2 additions & 2 deletions docs/2.3/user-manual.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -384,7 +384,7 @@ Now you can use `--cluster` flag with any `tsh` command. For example, to list SS
are members of "production" cluster, simply do:

```bash
$ tsh --proxy=work --cluster=production ls
$ tsh --proxy=work ls --cluster=production
Node Name Node ID Address Labels
--------- ------- ------- ------
db-1 xxxxxxxxx 10.0.20.31:3022 kernel:4.4
Expand All @@ -394,7 +394,7 @@ db-2 xxxxxxxxx 10.0.20.41:3022 kernel:4.2
Similarly, if you want to SSH into `db-1` inside "production" cluster:

```bash
$ tsh --proxy=work --cluster=production ssh db-1
$ tsh --proxy=work ssh --cluster=production db-1
```

This is possible even if nodes of the "production" cluster are located behind a firewall
Expand Down
6 changes: 3 additions & 3 deletions docs/2.4/admin-guide.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1006,7 +1006,7 @@ This setup works as follows:
"main" must authenticate "east" (cluster-to-cluster authentication) when the
tunnel is established, and "east" must trust users connecting from "main"
(user authentication).
3. Users of "main" must use `tsh --cluster=east` flag if they want to connect to any nodes in "east".
3. Users of "main" must use `tsh` commands with the `--cluster=east` flag if they want to connect to any nodes in "east".
4. Users of "main" can see other trusted clusters connected to "main" by running `tsh clusters`

### Example Configuration
Expand Down Expand Up @@ -1098,15 +1098,15 @@ main online
east online

# see the list of machines (nodes) behind the eastern cluster:
$ tsh --cluster=east ls
$ tsh ls --cluster=east

Node Name Node ID Address Labels
--------- ------------------ -------------- -----------
db1.east cf7cc5cd-935e-46f1 10.0.5.2:3022 role=db-master
db2.east 3879d133-fe81-3212 10.0.5.3:3022 role=db-slave

# SSH into any node in "east":
$ tsh --cluster=east ssh [email protected]
$ tsh ssh --cluster=east [email protected]
```

## Github OAuth 2.0
Expand Down
4 changes: 2 additions & 2 deletions docs/2.4/user-manual.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -384,7 +384,7 @@ Now you can use `--cluster` flag with any `tsh` command. For example, to list SS
are members of "production" cluster, simply do:

```bash
$ tsh --proxy=work --cluster=production ls
$ tsh --proxy=work ls --cluster=production
Node Name Node ID Address Labels
--------- ------- ------- ------
db-1 xxxxxxxxx 10.0.20.31:3022 kernel:4.4
Expand All @@ -394,7 +394,7 @@ db-2 xxxxxxxxx 10.0.20.41:3022 kernel:4.2
Similarly, if you want to SSH into `db-1` inside "production" cluster:

```bash
$ tsh --proxy=work --cluster=production ssh db-1
$ tsh --proxy=work ssh --cluster=production db-1
```

This is possible even if nodes of the "production" cluster are located behind a firewall
Expand Down
6 changes: 3 additions & 3 deletions docs/2.5/admin-guide.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1099,7 +1099,7 @@ $ tsh ssh host

# SSH into the host located in another cluster called "east"
# The connection is established through main.example.com:
$ tsh --cluster=east ssh host
$ tsh ssh --cluster=east host

# See what other clusters are available
$ tsh clusters
Expand Down Expand Up @@ -1227,15 +1227,15 @@ main online
east online

# see the list of machines (nodes) behind the eastern cluster:
$ tsh --cluster=east ls
$ tsh ls --cluster=east

Node Name Node ID Address Labels
--------- ------------------ -------------- -----------
db1.east cf7cc5cd-935e-46f1 10.0.5.2:3022 role=db-master
db2.east 3879d133-fe81-3212 10.0.5.3:3022 role=db-slave

# SSH into any node in "east":
$ tsh --cluster=east ssh [email protected]
$ tsh ssh --cluster=east [email protected]
```

### Disabling Trust
Expand Down
6 changes: 3 additions & 3 deletions docs/2.5/trustedclusters.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ $ tsh ssh host

# SSH into the host located in another cluster called "east"
# The connection is established through main.example.com:
$ tsh --cluster=east ssh host
$ tsh ssh --cluster=east host

# See what other clusters are available
$ tsh clusters
Expand Down Expand Up @@ -210,7 +210,7 @@ east online

```bash
# see the list of machines (nodes) behind the eastern cluster:
$ tsh --cluster=east ls
$ tsh ls --cluster=east

Node Name Node ID Address Labels
--------- ------------------ -------------- -----------
Expand All @@ -220,7 +220,7 @@ db2.east 3879d133-fe81-3212 10.0.5.3:3022 role=db-slave

```bash
# SSH into any node in "east":
$ tsh --cluster=east ssh [email protected]
$ tsh ssh --cluster=east [email protected]
```


Expand Down
4 changes: 2 additions & 2 deletions docs/2.5/user-manual.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -429,7 +429,7 @@ Now you can use `--cluster` flag with any `tsh` command. For example, to list SS
are members of "production" cluster, simply do:

```bash
$ tsh --proxy=work --cluster=production ls
$ tsh --proxy=work ls --cluster=production
Node Name Node ID Address Labels
--------- ------- ------- ------
db-1 xxxxxxxxx 10.0.20.31:3022 kernel:4.4
Expand All @@ -439,7 +439,7 @@ db-2 xxxxxxxxx 10.0.20.41:3022 kernel:4.2
Similarly, if you want to SSH into `db-1` inside "production" cluster:

```bash
$ tsh --proxy=work --cluster=production ssh db-1
$ tsh --proxy=work ssh --cluster=production db-1
```

This is possible even if nodes of the "production" cluster are located behind a firewall
Expand Down
4 changes: 2 additions & 2 deletions docs/2.7/admin-guide.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1127,7 +1127,7 @@ $ tsh ssh host

# SSH into the host located in another cluster called "east"
# The connection is established through main.example.com:
$ tsh --cluster=east ssh host
$ tsh ssh --cluster=east host

# See what other clusters are available
$ tsh clusters
Expand Down Expand Up @@ -1255,7 +1255,7 @@ main online
east online

# see the list of machines (nodes) behind the eastern cluster:
$ tsh --cluster=east ls
$ tsh ls --cluster=east

Node Name Node ID Address Labels
--------- ------------------ -------------- -----------
Expand Down
6 changes: 3 additions & 3 deletions docs/2.7/trustedclusters.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ $ tsh ssh host

# SSH into the host located in another cluster called "east"
# The connection is established through main.example.com:
$ tsh --cluster=east ssh host
$ tsh ssh --cluster=east host

# See what other clusters are available
$ tsh clusters
Expand Down Expand Up @@ -210,7 +210,7 @@ east online

```bash
# see the list of machines (nodes) behind the eastern cluster:
$ tsh --cluster=east ls
$ tsh ls --cluster=east

Node Name Node ID Address Labels
--------- ------------------ -------------- -----------
Expand All @@ -220,7 +220,7 @@ db2.east 3879d133-fe81-3212 10.0.5.3:3022 role=db-slave

```bash
# SSH into any node in "east":
$ tsh --cluster=east ssh [email protected]
$ tsh ssh --cluster=east [email protected]
```


Expand Down
4 changes: 2 additions & 2 deletions docs/2.7/user-manual.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -429,7 +429,7 @@ Now you can use `--cluster` flag with any `tsh` command. For example, to list SS
are members of "production" cluster, simply do:

```bash
$ tsh --proxy=work --cluster=production ls
$ tsh --proxy=work ls --cluster=production
Node Name Node ID Address Labels
--------- ------- ------- ------
db-1 xxxxxxxxx 10.0.20.31:3022 kernel:4.4
Expand All @@ -439,7 +439,7 @@ db-2 xxxxxxxxx 10.0.20.41:3022 kernel:4.2
Similarly, if you want to SSH into `db-1` inside "production" cluster:

```bash
$ tsh --proxy=work --cluster=production ssh db-1
$ tsh --proxy=work ssh --cluster=production db-1
```

This is possible even if nodes of the "production" cluster are located behind a firewall
Expand Down
6 changes: 3 additions & 3 deletions docs/3.0/admin-guide.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1203,7 +1203,7 @@ $ tsh ssh host
# SSH into the host located in another cluster called "east"
# The connection is established through main.example.com:
$ tsh --cluster=east ssh host
$ tsh ssh --cluster=east host
# See what other clusters are available
$ tsh clusters
Expand Down Expand Up @@ -1342,15 +1342,15 @@ main online
east online
# see the list of machines (nodes) behind the eastern cluster:
$ tsh --cluster=east ls
$ tsh ls --cluster=east
Node Name Node ID Address Labels
--------- ------------------ -------------- -----------
db1.east cf7cc5cd-935e-46f1 10.0.5.2:3022 role=db-master
db2.east 3879d133-fe81-3212 10.0.5.3:3022 role=db-slave
# SSH into any node in "east":
$ tsh --cluster=east ssh [email protected]
$ tsh ssh --cluster=east [email protected]
```

### Disabling Trust
Expand Down
4 changes: 2 additions & 2 deletions docs/3.0/user-manual.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -424,7 +424,7 @@ Now you can use `--cluster` flag with any `tsh` command. For example, to list SS
are members of the "production" cluster, simply do:

```bash
$ tsh --proxy=work --cluster=production ls
$ tsh --proxy=work ls --cluster=production
Node Name Node ID Address Labels
--------- ------- ------- ------
db-1 xxxxxxxxx 10.0.20.31:3022 kernel:4.4
Expand All @@ -434,7 +434,7 @@ db-2 xxxxxxxxx 10.0.20.41:3022 kernel:4.2
Similarly, if you want to SSH into `db-1` inside the "production" cluster:

```bash
$ tsh --proxy=work --cluster=production ssh db-1
$ tsh --proxy=work ssh --cluster=production db-1
```

This is possible even if nodes of the "production" cluster are located behind a firewall
Expand Down
6 changes: 3 additions & 3 deletions docs/3.1/admin-guide.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1324,7 +1324,7 @@ $ tsh ssh host
# SSH into the host located in another cluster called "east"
# The connection is established through main.example.com:
$ tsh --cluster=east ssh host
$ tsh ssh --cluster=east host
# See what other clusters are available
$ tsh clusters
Expand Down Expand Up @@ -1463,15 +1463,15 @@ main online
east online
# see the list of machines (nodes) behind the eastern cluster:
$ tsh --cluster=east ls
$ tsh ls --cluster=east
Node Name Node ID Address Labels
--------- ------------------ -------------- -----------
db1.east cf7cc5cd-935e-46f1 10.0.5.2:3022 role=db-master
db2.east 3879d133-fe81-3212 10.0.5.3:3022 role=db-slave
# SSH into any node in "east":
$ tsh --cluster=east ssh [email protected]
$ tsh ssh --cluster=east [email protected]
```

### Disabling Trust
Expand Down
4 changes: 2 additions & 2 deletions docs/3.1/user-manual.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -470,7 +470,7 @@ Now you can use `--cluster` flag with any `tsh` command. For example, to list SS
are members of the "production" cluster, simply do:

```bash
$ tsh --proxy=work --cluster=production ls
$ tsh --proxy=work ls --cluster=production
Node Name Node ID Address Labels
--------- ------- ------- ------
db-1 xxxxxxxxx 10.0.20.31:3022 kernel:4.4
Expand All @@ -480,7 +480,7 @@ db-2 xxxxxxxxx 10.0.20.41:3022 kernel:4.2
Similarly, if you want to SSH into `db-1` inside the "production" cluster:

```bash
$ tsh --proxy=work --cluster=production ssh db-1
$ tsh --proxy=work ssh --cluster=production db-1
```

This is possible even if nodes of the "production" cluster are located behind a firewall
Expand Down
4 changes: 2 additions & 2 deletions docs/3.2/admin-guide.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1449,15 +1449,15 @@ main online
east online
# see the list of machines (nodes) behind the eastern cluster:
$ tsh --cluster=east ls
$ tsh ls --cluster=east
Node Name Node ID Address Labels
--------- ------------------ -------------- -----------
db1.east cf7cc5cd-935e-46f1 10.0.5.2:3022 role=db-master
db2.east 3879d133-fe81-3212 10.0.5.3:3022 role=db-slave
# SSH into any node in "east":
$ tsh --cluster=east ssh [email protected]
$ tsh ssh --cluster=east [email protected]
```

### Disabling Trust
Expand Down
4 changes: 2 additions & 2 deletions docs/3.2/user-manual.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -470,7 +470,7 @@ Now you can use `--cluster` flag with any `tsh` command. For example, to list SS
are members of the "production" cluster, simply do:

```bash
$ tsh --proxy=work --cluster=production ls
$ tsh --proxy=work ls --cluster=production
Node Name Node ID Address Labels
--------- ------- ------- ------
db-1 xxxxxxxxx 10.0.20.31:3022 kernel:4.4
Expand All @@ -480,7 +480,7 @@ db-2 xxxxxxxxx 10.0.20.41:3022 kernel:4.2
Similarly, if you want to SSH into `db-1` inside the "production" cluster:

```bash
$ tsh --proxy=work --cluster=production ssh db-1
$ tsh --proxy=work ssh --cluster=production db-1
```

This is possible even if nodes of the "production" cluster are located behind a firewall
Expand Down
6 changes: 3 additions & 3 deletions docs/4.0/admin-guide.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1311,7 +1311,7 @@ $ tsh ssh host
# SSH into the host located in another cluster called "east"
# The connection is established through main.example.com:
$ tsh --cluster=east ssh host
$ tsh ssh --cluster=east host
# See what other clusters are available
$ tsh clusters
Expand Down Expand Up @@ -1450,15 +1450,15 @@ main online
east online
# see the list of machines (nodes) behind the eastern cluster:
$ tsh --cluster=east ls
$ tsh ls --cluster=east
Node Name Node ID Address Labels
--------- ------------------ -------------- -----------
db1.east cf7cc5cd-935e-46f1 10.0.5.2:3022 role=db-master
db2.east 3879d133-fe81-3212 10.0.5.3:3022 role=db-slave
# SSH into any node in "east":
$ tsh --cluster=east ssh [email protected]
$ tsh ssh --cluster=east [email protected]
```

### Disabling Trust
Expand Down
4 changes: 2 additions & 2 deletions docs/4.0/user-manual.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -470,7 +470,7 @@ Now you can use `--cluster` flag with any `tsh` command. For example, to list SS
are members of the "production" cluster, simply do:

```bash
$ tsh --proxy=work --cluster=production ls
$ tsh --proxy=work ls --cluster=production
Node Name Node ID Address Labels
--------- ------- ------- ------
db-1 xxxxxxxxx 10.0.20.31:3022 kernel:4.4
Expand All @@ -480,7 +480,7 @@ db-2 xxxxxxxxx 10.0.20.41:3022 kernel:4.2
Similarly, if you want to SSH into `db-1` inside the "production" cluster:

```bash
$ tsh --proxy=work --cluster=production ssh db-1
$ tsh --proxy=work ssh --cluster=production db-1
```

This is possible even if nodes of the "production" cluster are located behind a firewall
Expand Down
Loading

0 comments on commit 941704d

Please sign in to comment.