Skip to content

Commit 3bca24b

Browse files
author
Replicated Release Pipeline
committed
Update Replicated CLI docs for v0.103.0
1 parent 31ed0aa commit 3bca24b

23 files changed

+118
-107
lines changed

docs/reference/replicated-cli-cluster-addon-create-object-store.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,26 +7,26 @@ Create an object store bucket for a cluster.
77
Creates an object store bucket for a cluster, requiring a bucket name prefix. The bucket name will be auto-generated using the format "[BUCKET_PREFIX]-[ADDON_ID]-cmx". This feature provisions an object storage bucket that can be used for storage in your cluster environment.
88

99
```
10-
replicated cluster addon create object-store CLUSTER_ID --bucket-prefix BUCKET_PREFIX [flags]
10+
replicated cluster addon create object-store CLUSTER_ID_OR_NAME --bucket-prefix BUCKET_PREFIX [flags]
1111
```
1212

1313
### Examples
1414

1515
```
1616
# Create an object store bucket with a specified prefix
17-
replicated cluster addon create object-store 05929b24 --bucket-prefix mybucket
17+
replicated cluster addon create object-store CLUSTER_ID_OR_NAME --bucket-prefix mybucket
1818
1919
# Create an object store bucket and wait for it to be ready (up to 5 minutes)
20-
replicated cluster addon create object-store 05929b24 --bucket-prefix mybucket --wait 5m
20+
replicated cluster addon create object-store CLUSTER_ID_OR_NAME --bucket-prefix mybucket --wait 5m
2121
2222
# Perform a dry run to validate inputs without creating the bucket
23-
replicated cluster addon create object-store 05929b24 --bucket-prefix mybucket --dry-run
23+
replicated cluster addon create object-store CLUSTER_ID_OR_NAME --bucket-prefix mybucket --dry-run
2424
2525
# Create an object store bucket and output the result in JSON format
26-
replicated cluster addon create object-store 05929b24 --bucket-prefix mybucket --output json
26+
replicated cluster addon create object-store CLUSTER_ID_OR_NAME --bucket-prefix mybucket --output json
2727
2828
# Create an object store bucket with a custom prefix and wait for 10 minutes
29-
replicated cluster addon create object-store 05929b24 --bucket-prefix custom-prefix --wait 10m
29+
replicated cluster addon create object-store CLUSTER_ID_OR_NAME --bucket-prefix custom-prefix --wait 10m
3030
```
3131

3232
### Options

docs/reference/replicated-cli-cluster-addon-create.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@ Create new add-ons for a cluster. This command allows you to add functionality o
1010

1111
```
1212
# Create an object store bucket add-on for a cluster
13-
replicated cluster addon create object-store CLUSTER_ID --bucket-prefix mybucket
13+
replicated cluster addon create object-store CLUSTER_ID_OR_NAME --bucket-prefix mybucket
1414
1515
# Perform a dry run for creating an object store add-on
16-
replicated cluster addon create object-store CLUSTER_ID --bucket-prefix mybucket --dry-run
16+
replicated cluster addon create object-store CLUSTER_ID_OR_NAME --bucket-prefix mybucket --dry-run
1717
```
1818

1919
### Options

docs/reference/replicated-cli-cluster-addon-ls.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ The 'cluster addon ls' command allows you to list all add-ons for a specific clu
99
This can be useful for monitoring the health and configuration of add-ons or performing troubleshooting tasks.
1010

1111
```
12-
replicated cluster addon ls CLUSTER_ID [flags]
12+
replicated cluster addon ls CLUSTER_ID_OR_NAME [flags]
1313
```
1414

1515
### Aliases
@@ -22,13 +22,13 @@ ls, list
2222

2323
```
2424
# List add-ons for a cluster with default table output
25-
replicated cluster addon ls CLUSTER_ID
25+
replicated cluster addon ls CLUSTER_ID_OR_NAME
2626
2727
# List add-ons for a cluster with JSON output
28-
replicated cluster addon ls CLUSTER_ID --output json
28+
replicated cluster addon ls CLUSTER_ID_OR_NAME --output json
2929
3030
# List add-ons for a cluster with wide table output
31-
replicated cluster addon ls CLUSTER_ID --output wide
31+
replicated cluster addon ls CLUSTER_ID_OR_NAME --output wide
3232
```
3333

3434
### Options

docs/reference/replicated-cli-cluster-addon-rm.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@ Remove cluster add-on by ID.
44

55
### Synopsis
66

7-
The 'cluster addon rm' command allows you to remove a specific add-on from a cluster by specifying the cluster ID and the add-on ID.
7+
The 'cluster addon rm' command allows you to remove a specific add-on from a cluster by specifying the cluster ID or name and the add-on ID.
88

99
This command is useful when you want to deprovision an add-on that is no longer needed or when troubleshooting issues related to specific add-ons. The add-on will be removed immediately, and you will receive confirmation upon successful removal.
1010

1111
```
12-
replicated cluster addon rm CLUSTER_ID --id ADDON_ID [flags]
12+
replicated cluster addon rm CLUSTER_ID_OR_NAME --id ADDON_ID [flags]
1313
```
1414

1515
### Aliases

docs/reference/replicated-cli-cluster-addon.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,16 +12,16 @@ You can use various subcommands to create, list, remove, or check the status of
1212

1313
```
1414
# List all add-ons installed on a cluster
15-
replicated cluster addon ls CLUSTER_ID
15+
replicated cluster addon ls CLUSTER_ID_OR_NAME
1616
1717
# Remove an add-on from a cluster
18-
replicated cluster addon rm CLUSTER_ID --id ADDON_ID
18+
replicated cluster addon rm CLUSTER_ID_OR_NAME --id ADDON_ID
1919
2020
# Create an object store bucket add-on for a cluster
21-
replicated cluster addon create object-store CLUSTER_ID --bucket-prefix mybucket
21+
replicated cluster addon create object-store CLUSTER_ID_OR_NAME --bucket-prefix mybucket
2222
2323
# List add-ons with JSON output
24-
replicated cluster addon ls CLUSTER_ID --output json
24+
replicated cluster addon ls CLUSTER_ID_OR_NAME --output json
2525
```
2626

2727
### Options

docs/reference/replicated-cli-cluster-kubeconfig.mdx

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,39 +6,39 @@ Download credentials for a test cluster.
66

77
The 'cluster kubeconfig' command downloads the credentials (kubeconfig) required to access a test cluster. You can either merge these credentials into your existing kubeconfig file or save them as a new file.
88

9-
This command ensures that the kubeconfig is correctly configured for use with your Kubernetes tools. You can specify the cluster by ID or by name. Additionally, the kubeconfig can be written to a specific file path or printed to stdout.
9+
This command ensures that the kubeconfig is correctly configured for use with your Kubernetes tools. You can specify the cluster by ID or name directly as an argument, or by using the '--id' or '--name' flags. Additionally, the kubeconfig can be written to a specific file path or printed to stdout.
1010

1111
You can also use this command to automatically update your current Kubernetes context with the downloaded credentials.
1212

1313
```
14-
replicated cluster kubeconfig [ID] [flags]
14+
replicated cluster kubeconfig [ID_OR_NAME] [flags]
1515
```
1616

1717
### Examples
1818

1919
```
2020
# Download and merge kubeconfig into your existing configuration
21-
replicated cluster kubeconfig CLUSTER_ID
21+
replicated cluster kubeconfig CLUSTER_ID_OR_NAME
2222
2323
# Save the kubeconfig to a specific file
24-
replicated cluster kubeconfig CLUSTER_ID --output-path ./kubeconfig
24+
replicated cluster kubeconfig CLUSTER_ID_OR_NAME --output-path ./kubeconfig
2525
2626
# Print the kubeconfig to stdout
27-
replicated cluster kubeconfig CLUSTER_ID --stdout
27+
replicated cluster kubeconfig CLUSTER_ID_OR_NAME --stdout
2828
29-
# Download kubeconfig for a cluster by name
29+
# Download kubeconfig for a cluster by name using a flag
3030
replicated cluster kubeconfig --name "My Cluster"
3131
32-
# Download kubeconfig for a cluster by ID
32+
# Download kubeconfig for a cluster by ID using a flag
3333
replicated cluster kubeconfig --id CLUSTER_ID
3434
```
3535

3636
### Options
3737

3838
```
3939
-h, --help help for kubeconfig
40-
--id string id of the cluster to download credentials for (when name is not provided)
41-
--name string name of the cluster to download credentials for (when id is not provided)
40+
--id string id of the cluster to download credentials for (when name is not provided) (DEPRECATED: use ID_OR_NAME arguments instead)
41+
--name string name of the cluster to download credentials for (when id is not provided) (DEPRECATED: use ID_OR_NAME arguments instead)
4242
--output-path string path to kubeconfig file to write to, if not provided, it will be merged into your existing kubeconfig
4343
--stdout write kubeconfig to stdout
4444
```

docs/reference/replicated-cli-cluster-nodegroup-ls.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,10 @@ The 'cluster nodegroup ls' command lists all the node groups associated with a g
88

99
You can view information about the node groups within the specified cluster, including their ID, name, node count, and other configuration details.
1010

11-
You must provide the cluster ID to list its node groups.
11+
You must provide the cluster ID or name to list its node groups.
1212

1313
```
14-
replicated cluster nodegroup ls [ID] [flags]
14+
replicated cluster nodegroup ls [ID_OR_NAME] [flags]
1515
```
1616

1717
### Aliases
@@ -24,13 +24,13 @@ ls, list
2424

2525
```
2626
# List all node groups in a cluster with default table output
27-
replicated cluster nodegroup ls CLUSTER_ID
27+
replicated cluster nodegroup ls CLUSTER_ID_OR_NAME
2828
2929
# List node groups with JSON output
30-
replicated cluster nodegroup ls CLUSTER_ID --output json
30+
replicated cluster nodegroup ls CLUSTER_ID_OR_NAME --output json
3131
3232
# List node groups with wide table output
33-
replicated cluster nodegroup ls CLUSTER_ID --output wide
33+
replicated cluster nodegroup ls CLUSTER_ID_OR_NAME --output wide
3434
```
3535

3636
### Options

docs/reference/replicated-cli-cluster-nodegroup.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Node groups define a set of nodes with specific configurations, such as instance
1212

1313
```
1414
# List all node groups for a cluster
15-
replicated cluster nodegroup ls CLUSTER_ID
15+
replicated cluster nodegroup ls CLUSTER_ID_OR_NAME
1616
```
1717

1818
### Options

docs/reference/replicated-cli-cluster-port-expose.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,23 +13,23 @@ This command supports different protocols including "http", "https", "ws", and "
1313
NOTE: Currently, this feature only supports VM-based cluster distributions.
1414

1515
```
16-
replicated cluster port expose CLUSTER_ID --port PORT [flags]
16+
replicated cluster port expose CLUSTER_ID_OR_NAME --port PORT [flags]
1717
```
1818

1919
### Examples
2020

2121
```
2222
# Expose port 8080 with HTTPS protocol and wildcard DNS
23-
replicated cluster port expose CLUSTER_ID --port 8080 --protocol https --wildcard
23+
replicated cluster port expose CLUSTER_ID_OR_NAME --port 8080 --protocol https --wildcard
2424
2525
# Expose port 30000 with HTTP protocol
26-
replicated cluster port expose CLUSTER_ID --port 30000 --protocol http
26+
replicated cluster port expose CLUSTER_ID_OR_NAME --port 30000 --protocol http
2727
2828
# Expose port 8080 with multiple protocols
29-
replicated cluster port expose CLUSTER_ID --port 8080 --protocol http,https
29+
replicated cluster port expose CLUSTER_ID_OR_NAME --port 8080 --protocol http,https
3030
3131
# Expose port 8080 and display the result in JSON format
32-
replicated cluster port expose CLUSTER_ID --port 8080 --protocol https --output json
32+
replicated cluster port expose CLUSTER_ID_OR_NAME --port 8080 --protocol https --output json
3333
```
3434

3535
### Options

docs/reference/replicated-cli-cluster-port-ls.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@ List cluster ports for a cluster.
44

55
### Synopsis
66

7-
The 'cluster port ls' command lists all the ports configured for a specific cluster. You must provide the cluster ID to retrieve and display the ports.
7+
The 'cluster port ls' command lists all the ports configured for a specific cluster. You must provide the cluster ID or name to retrieve and display the ports.
88

99
This command is useful for viewing the current port configurations, protocols, and other related settings of your test cluster. The output format can be customized to suit your needs, and the available formats include table, JSON, and wide views.
1010

1111
```
12-
replicated cluster port ls CLUSTER_ID [flags]
12+
replicated cluster port ls CLUSTER_ID_OR_NAME [flags]
1313
```
1414

1515
### Aliases
@@ -22,13 +22,13 @@ ls, list
2222

2323
```
2424
# List ports for a cluster in the default table format
25-
replicated cluster port ls CLUSTER_ID
25+
replicated cluster port ls CLUSTER_ID_OR_NAME
2626
2727
# List ports for a cluster in JSON format
28-
replicated cluster port ls CLUSTER_ID --output json
28+
replicated cluster port ls CLUSTER_ID_OR_NAME --output json
2929
3030
# List ports for a cluster in wide format
31-
replicated cluster port ls CLUSTER_ID --output wide
31+
replicated cluster port ls CLUSTER_ID_OR_NAME --output wide
3232
```
3333

3434
### Options

0 commit comments

Comments
 (0)