Skip to content

Commit 845ce80

Browse files
committed
add cluster shell doc page
1 parent 8e13855 commit 845ce80

File tree

1 file changed

+45
-0
lines changed

1 file changed

+45
-0
lines changed
Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# cluster shell
2+
3+
Opens a new shell session with the kubeconfig configured for the specified cluster. This allows you to have immediate kubectl access to the cluster within the shell environment.
4+
5+
You can either specify the cluster ID directly or provide the cluster name to resolve the corresponding cluster ID. The shell will inherit your existing environment and add the necessary kubeconfig context for interacting with the Kubernetes cluster.
6+
7+
Once inside the shell, you can use 'kubectl' to interact with the cluster. To exit the shell, press Ctrl-D or type 'exit'. When the shell closes, the kubeconfig will be reset back to your default configuration.
8+
9+
## Usage
10+
11+
```bash
12+
replicated cluster shell [ID] [flags]
13+
```
14+
15+
<table>
16+
<tr>
17+
<th width="30%">Flag</th>
18+
<th width="20%">Type (if applicable)</th>
19+
<th width="50%">Description</th>
20+
</tr>
21+
<Help/>
22+
<tr>
23+
<td>--id</td>
24+
<td>string</td>
25+
<td>ID of the cluster to have kubectl access to (when name is not provided)</td>
26+
</tr>
27+
<tr>
28+
<td>--name</td>
29+
<td>string</td>
30+
<td>Name of the cluster to have kubectl access to.</td>
31+
</tr>
32+
</table>
33+
34+
## Examples
35+
36+
Example:
37+
```bash
38+
# Open a shell for a cluster by ID
39+
replicated cluster shell CLUSTER_ID
40+
```
41+
42+
```bash
43+
# Open a shell for a cluster by name
44+
replicated cluster shell --name "My Cluster"
45+
```

0 commit comments

Comments
 (0)