diff --git a/docs/partials/replicated-cli/_global-flags.mdx b/docs/partials/replicated-cli/_global-flags.mdx new file mode 100644 index 0000000000..05b12c445e --- /dev/null +++ b/docs/partials/replicated-cli/_global-flags.mdx @@ -0,0 +1,24 @@ +import Help from "./_help.mdx" +import App from "./_app.mdx" +import Token from "./_token.mdx" + + + + + + + + + + + + + + + + + + + + +
FlagType (if applicable)Description
`--integration-test`stringSet to the name of the integration test to run.
`--log-api-calls`stringLog the API calls to the specified file.
\ No newline at end of file diff --git a/docs/reference/replicated-cli-api-get.mdx b/docs/reference/replicated-cli-api-get.mdx new file mode 100644 index 0000000000..5e5db55f93 --- /dev/null +++ b/docs/reference/replicated-cli-api-get.mdx @@ -0,0 +1,23 @@ +import GlobalFlags from "../partials/replicated-cli/_global-flags.mdx" + +# api get + +Make adhoc GET requests to the Vendor API v3. Uses your local credentials and prints the response unmodified. For more information, see the [Vendor API v3 documentation](https://replicated-vendor-api.readme.io/reference/createapp). + +## Usage + +```bash +replicated api get [PATH] +``` + +Pass the PATH of the request as the final argument. Do not include the host or version. Replicated recommends piping the output to jq for easier reading. + +## Global Flags + + + +## Example + +```bash +replicated api get /v3/apps +``` \ No newline at end of file diff --git a/docs/reference/replicated-cli-api-patch.mdx b/docs/reference/replicated-cli-api-patch.mdx new file mode 100644 index 0000000000..90acf041a2 --- /dev/null +++ b/docs/reference/replicated-cli-api-patch.mdx @@ -0,0 +1,17 @@ +import GlobalFlags from "../partials/replicated-cli/_global-flags.mdx" + +# api patch + +Make adhoc PATCH requests to the Vendor API v3. Uses your local credentials and prints the response unmodified. For more information, see the [Vendor API v3 documentation](https://replicated-vendor-api.readme.io/reference/createapp). + +## Usage + +```bash +replicated api patch [PATH] +``` + +Pass the PATH of the request as the final argument. Do not include the host or version. Replicated recommends piping the output to jq for easier reading. + +## Global Flags + + \ No newline at end of file diff --git a/docs/reference/replicated-cli-api-post.mdx b/docs/reference/replicated-cli-api-post.mdx new file mode 100644 index 0000000000..3ae2530221 --- /dev/null +++ b/docs/reference/replicated-cli-api-post.mdx @@ -0,0 +1,23 @@ +import GlobalFlags from "../partials/replicated-cli/_global-flags.mdx" + +# api post + +Make adhoc POST requests to the Vendor API v3. Uses your local credentials and prints the response unmodified. For more information, see the [Vendor API v3 documentation](https://replicated-vendor-api.readme.io/reference/createapp). + +## Usage + +```bash +replicated api post [PATH] +``` + +Pass the PATH of the request as the final argument. Do not include the host or version. Replicated recommends piping the output to jq for easier reading. + +## Global Flags + + + +## Example + +```bash +replicated api post /v3/app/2EuFxKLDxKjPNk2jxMTmF6Vxvxu/channel -b '{"name":"post-example"}' +``` \ No newline at end of file diff --git a/docs/reference/replicated-cli-api-put.mdx b/docs/reference/replicated-cli-api-put.mdx new file mode 100644 index 0000000000..8bda98aa8b --- /dev/null +++ b/docs/reference/replicated-cli-api-put.mdx @@ -0,0 +1,23 @@ +import GlobalFlags from "../partials/replicated-cli/_global-flags.mdx" + +# api put + +Make adhoc PUT requests to the Vendor API v3. Uses your local credentials and prints the response unmodified. For more information, see the [Vendor API v3 documentation](https://replicated-vendor-api.readme.io/reference/createapp). + +## Usage + +```bash +replicated api put [PATH] +``` + +Pass the PATH of the request as the final argument. Do not include the host or version. Replicated recommends piping the output to jq for easier reading. + +## Global Flags + + + +## Example + +```bash +replicated api put /v3/app/2EuFxKLDxKjPNk2jxMTmF6Vxvxu/channel/2QLPm10JPkta7jO3Z3Mk4aXTPyZ -b '{"name":"put-example"}' +``` \ No newline at end of file diff --git a/docs/reference/replicated-cli-api.md b/docs/reference/replicated-cli-api.md index b988c15b88..dca2a7d085 100644 --- a/docs/reference/replicated-cli-api.md +++ b/docs/reference/replicated-cli-api.md @@ -1,4 +1,4 @@ -import Help from "../partials/replicated-cli/_help.mdx" +import GlobalFlags from "../partials/replicated-cli/_global-flags.mdx" # api @@ -7,12 +7,9 @@ Make adhoc calls to the Vendor API v3. Uses your local credentials and prints th ## Usage ```bash -replicated api [command] +replicated api [command] [flags] ``` - -Pass the PATH of the request as the final argument. Do not include the host or version. Replicated recommends piping the output to jq for easier reading. - -### Available Commands +The following commands are available: @@ -20,29 +17,26 @@ Pass the PATH of the request as the final argument. Do not include the host or v - + - + + + + + - +
Description
get[get](replicated-cli-api-get) Make adhoc GET API calls to the Vendor API v3
post[patch](replicated-cli-api-patch)Make adhoc PATCH API calls to the Vendor API v3
[post](replicated-cli-api-post) Make adhoc POST API calls to the Vendor API v3
put[put](replicated-cli-api-put) Make adhoc PUT API calls to the Vendor API v3
-### Flags +## Global Flags - - - - - - - -
FlagType (if applicable)Description
+ ## Examples diff --git a/docs/reference/replicated-cli-app-create.md b/docs/reference/replicated-cli-app-create.md index 3248b31c9f..4fece3e095 100644 --- a/docs/reference/replicated-cli-app-create.md +++ b/docs/reference/replicated-cli-app-create.md @@ -1,5 +1,4 @@ -import Token from "../partials/replicated-cli/_token.mdx" -import Help from "../partials/replicated-cli/_help.mdx" +import GlobalFlags from "../partials/replicated-cli/_global-flags.mdx" # app create @@ -10,15 +9,9 @@ Create an application. replicated app create NAME ``` - - - - - - - - -
FlagType (if applicable)Description
+## Global Flags + + ## Examples ```bash diff --git a/docs/reference/replicated-cli-app-delete.md b/docs/reference/replicated-cli-app-delete.md index 217c8fb9fe..683156a6e9 100644 --- a/docs/reference/replicated-cli-app-delete.md +++ b/docs/reference/replicated-cli-app-delete.md @@ -1,13 +1,15 @@ -import Token from "../partials/replicated-cli/_token.mdx" -import Help from "../partials/replicated-cli/_help.mdx" +import GlobalFlags from "../partials/replicated-cli/_global-flags.mdx" -# app delete +# app rm (delete) Delete an application. ## Usage ```bash -replicated app delete NAME +replicated app rm APP_NAME +``` +```bash +replicated app delete APP_NAME ``` @@ -16,15 +18,17 @@ replicated app delete NAME - -
Type (if applicable) Description
-f, --force Skip the confirmation prompt. This action cannot be undone.
+## Global Flags + + + ## Examples ```bash replicated app delete deletion-example diff --git a/docs/reference/replicated-cli-app-ls.md b/docs/reference/replicated-cli-app-ls.md index 1683f214ea..30922b8935 100644 --- a/docs/reference/replicated-cli-app-ls.md +++ b/docs/reference/replicated-cli-app-ls.md @@ -1,5 +1,4 @@ -import Token from "../partials/replicated-cli/_token.mdx" -import Help from "../partials/replicated-cli/_help.mdx" +import GlobalFlags from "../partials/replicated-cli/_global-flags.mdx" # app ls @@ -9,16 +8,13 @@ List all applications, or specify the application you want to list. ```bash replicated app ls ``` +```bash +replicated app ls APP_NAME +``` + +## Global Flags - - - - - - - - -
FlagType (if applicable)Description
+ ## Examples diff --git a/docs/reference/replicated-cli-channel-create.md b/docs/reference/replicated-cli-channel-create.md index 6582743b6b..1ebb237861 100644 --- a/docs/reference/replicated-cli-channel-create.md +++ b/docs/reference/replicated-cli-channel-create.md @@ -1,6 +1,4 @@ -import Help from "../partials/replicated-cli/_help.mdx" -import App from "../partials/replicated-cli/_app.mdx" -import Token from "../partials/replicated-cli/_token.mdx" +import GlobalFlags from "../partials/replicated-cli/_global-flags.mdx" # channel create @@ -8,7 +6,7 @@ Create a new channel in your application, and then print the channel. ## Usage ```bash -replicated channel create --name Beta --description 'New features subject to change' +replicated channel create --name CHANNEL_NAME --description 'Channel description' ``` @@ -27,11 +25,12 @@ replicated channel create --name Beta --description 'New features subject to cha - - -
string The name of this channel. (Required)
+## Global Flags + + + ## Examples ```bash replicated channel create --name cli-created --description "this is a description for a channel" diff --git a/docs/reference/replicated-cli-channel-delete.md b/docs/reference/replicated-cli-channel-delete.md index 6192d77adb..f6ca559eda 100644 --- a/docs/reference/replicated-cli-channel-delete.md +++ b/docs/reference/replicated-cli-channel-delete.md @@ -1,8 +1,6 @@ -import Help from "../partials/replicated-cli/_help.mdx" -import App from "../partials/replicated-cli/_app.mdx" -import Token from "../partials/replicated-cli/_token.mdx" +import GlobalFlags from "../partials/replicated-cli/_global-flags.mdx" -# channel delete +# channel rm (delete) Delete (archive) a channel. @@ -10,21 +8,17 @@ Delete (archive) a channel. ```bash replicated channel rm CHANNEL_ID ``` +```bash +replicated channel delete CHANNEL_ID +``` :::note You must use the channel ID to delete the channel, not the channel name. ::: - - - - - - - - - -
FlagType (if applicable)Description
+## Global Flags + + ## Examples ```bash diff --git a/docs/reference/replicated-cli-channel-disable-semver.md b/docs/reference/replicated-cli-channel-disable-semver.md index d48c2f31b3..63f74efc18 100644 --- a/docs/reference/replicated-cli-channel-disable-semver.md +++ b/docs/reference/replicated-cli-channel-disable-semver.md @@ -1,6 +1,4 @@ -import Help from "../partials/replicated-cli/_help.mdx" -import App from "../partials/replicated-cli/_app.mdx" -import Token from "../partials/replicated-cli/_token.mdx" +import GlobalFlags from "../partials/replicated-cli/_global-flags.mdx" # channel disable-semantic-versioning @@ -11,16 +9,9 @@ Disable semantic versioning for a channel. replicated channel disable-semantic-versioning CHANNEL_ID ``` - - - - - - - - - -
FlagType (if applicable)Description
+## Global Flags + + ### Examples ```bash diff --git a/docs/reference/replicated-cli-channel-enable-semver.md b/docs/reference/replicated-cli-channel-enable-semver.md index 68ef96819b..0482946a97 100644 --- a/docs/reference/replicated-cli-channel-enable-semver.md +++ b/docs/reference/replicated-cli-channel-enable-semver.md @@ -1,6 +1,4 @@ -import Help from "../partials/replicated-cli/_help.mdx" -import App from "../partials/replicated-cli/_app.mdx" -import Token from "../partials/replicated-cli/_token.mdx" +import GlobalFlags from "../partials/replicated-cli/_global-flags.mdx" # channel enable-semantic-versioning @@ -11,16 +9,9 @@ Enable semantic versioning for a channel. replicated channel enable-semantic-versioning CHANNEL_ID ``` - - - - - - - - - -
FlagType (if applicable)Description
+## Global Flags + + ### Examples ```bash diff --git a/docs/reference/replicated-cli-channel-inspect.md b/docs/reference/replicated-cli-channel-inspect.md index 1cd22cb733..c788dc0b7a 100644 --- a/docs/reference/replicated-cli-channel-inspect.md +++ b/docs/reference/replicated-cli-channel-inspect.md @@ -1,6 +1,4 @@ -import Help from "../partials/replicated-cli/_help.mdx" -import App from "../partials/replicated-cli/_app.mdx" -import Token from "../partials/replicated-cli/_token.mdx" +import GlobalFlags from "../partials/replicated-cli/_global-flags.mdx" # channel inspect @@ -11,16 +9,9 @@ Show the full details for a channel. replicated channel inspect CHANNEL_ID ``` - - - - - - - - - -
FlagType (if applicable)Description
+## Global Flags + + ## Examples ```bash diff --git a/docs/reference/replicated-cli-channel-ls.md b/docs/reference/replicated-cli-channel-ls.md index ed104bcf92..f36b2fe5a0 100644 --- a/docs/reference/replicated-cli-channel-ls.md +++ b/docs/reference/replicated-cli-channel-ls.md @@ -1,6 +1,4 @@ -import Help from "../partials/replicated-cli/_help.mdx" -import App from "../partials/replicated-cli/_app.mdx" -import Token from "../partials/replicated-cli/_token.mdx" +import GlobalFlags from "../partials/replicated-cli/_global-flags.mdx" # channel ls @@ -10,16 +8,10 @@ List all channels in your application. ```bash replicated channel ls ``` - - - - - - - - - -
FlagType (if applicable)Description
+ +## Global Flags + + ## Examples ```bash diff --git a/docs/reference/replicated-cli-cluster-addon-create-object-store.md b/docs/reference/replicated-cli-cluster-addon-create-object-store.md index 27572ffd4d..83ab46f693 100644 --- a/docs/reference/replicated-cli-cluster-addon-create-object-store.md +++ b/docs/reference/replicated-cli-cluster-addon-create-object-store.md @@ -1,4 +1,4 @@ -import Help from "../partials/replicated-cli/\_help.mdx" +import GlobalFlags from "../partials/replicated-cli/_global-flags.mdx" # cluster addon create object-store (Alpha) @@ -6,7 +6,9 @@ Create an object store bucket for a cluster. Requires a bucket name prefix (using flag "--bucket-prefix") that will be used to create a unique bucket name with format "[BUCKET_PREFIX]-[ADDON_ID]-cmx". -_NOTE: This add-on currently only support EKS (AWS S3)._ +:::note +This add-on supports EKS (AWS S3) only. +::: ## Usage @@ -21,31 +23,34 @@ replicated cluster addon create object-store CLUSTER_ID --bucket-prefix BUCKET_P Description - --bucket-prefix + `--bucket-prefix` string A prefix for the bucket name to be created. (Required) - --wait + `--wait` bool Wait duration for add-on to be ready before exiting (leave empty to not wait). - --dry-run + `--dry-run` bool Simulate creation to verify that your inputs are valid without actually creating an add-on. - --output + `--output` string The output format to use. Value values: json, table or wide. Default: table - +## Global Flags + + + ## Example ```bash -$ replicated cluster addon create object-store 05929b24 --bucket-prefix mybucket +replicated cluster addon create object-store 05929b24 --bucket-prefix mybucket 05929b24 Object Store pending {"bucket_prefix":"mybucket"} ``` diff --git a/docs/reference/replicated-cli-cluster-addon-create.md b/docs/reference/replicated-cli-cluster-addon-create.md index 2d259fb6db..ac267a43a9 100644 --- a/docs/reference/replicated-cli-cluster-addon-create.md +++ b/docs/reference/replicated-cli-cluster-addon-create.md @@ -1,4 +1,4 @@ -import Help from "../partials/replicated-cli/_help.mdx" +import GlobalFlags from "../partials/replicated-cli/_global-flags.mdx" # cluster addon create @@ -10,7 +10,7 @@ Create cluster add-ons. replicated cluster addon create [command] ``` -The following `cluster addon create` commands are supported: +The following commands are available: @@ -18,18 +18,11 @@ The following `cluster addon create` commands are supported: - +
Description
replicated cluster addon create object-store[object-store](replicated-cli-cluster-addon-create-object-store) Create an object store bucket for a cluster.
-The following flags are supported: +## Global Flags - - - - - - - -
FlagType (if applicable)Description
+ diff --git a/docs/reference/replicated-cli-cluster-addon-ls.md b/docs/reference/replicated-cli-cluster-addon-ls.md index 96f6594d75..fc2e583414 100644 --- a/docs/reference/replicated-cli-cluster-addon-ls.md +++ b/docs/reference/replicated-cli-cluster-addon-ls.md @@ -1,4 +1,4 @@ -import Help from "../partials/replicated-cli/_help.mdx" +import GlobalFlags from "../partials/replicated-cli/_global-flags.mdx" # cluster addon ls @@ -17,17 +17,20 @@ replicated cluster addon ls CLUSTER_ID [flags] Description - --output + `--output` string The output format to use. Value values: json, table or wide. Default: table - +## Global Flags + + + ## Example ```bash -$ replicated cluster addon ls 4d2f7e70 +replicated cluster addon ls 4d2f7e70 ID TYPE STATUS DATA 05929b24 Object Store ready {"bucket_prefix":"mybucket","bucket_name":"mybucket-05929b24-cmx","service_account_namespace":"cmx","service_account_name":"mybucket-05929b24-cmx","service_account_name_read_only":"mybucket-05929b24-cmx-ro"} ``` diff --git a/docs/reference/replicated-cli-cluster-addon-rm.md b/docs/reference/replicated-cli-cluster-addon-rm.md index 630ca743e6..aaa6d0897a 100644 --- a/docs/reference/replicated-cli-cluster-addon-rm.md +++ b/docs/reference/replicated-cli-cluster-addon-rm.md @@ -1,4 +1,4 @@ -import Help from "../partials/replicated-cli/_help.mdx" +import GlobalFlags from "../partials/replicated-cli/_global-flags.mdx" # cluster addon rm @@ -17,13 +17,16 @@ replicated cluster addon rm CLUSTER_ID --id ADDON_ID [flags] Description - --id + `--id` string The ID of the cluster add-on to remove. (Required) - +## Global Flags + + + ## Example ```bash diff --git a/docs/reference/replicated-cli-cluster-create.md b/docs/reference/replicated-cli-cluster-create.md index 324bf32a6c..8b30a87021 100644 --- a/docs/reference/replicated-cli-cluster-create.md +++ b/docs/reference/replicated-cli-cluster-create.md @@ -1,10 +1,16 @@ -import Help from "../partials/replicated-cli/\_help.mdx" -import Output from "../partials/replicated-cli/\_output.mdx" +import GlobalFlags from "../partials/replicated-cli/_global-flags.mdx" +import Output from "../partials/replicated-cli/_output.mdx" # cluster create Create clusters for compatibility testing. For more information, see [About Compatibility Matrix](/vendor/testing-about). +The `cluster create` command provisions a new test cluster with the specified Kubernetes distribution and configuration. You can customize the cluster's size, version, node groups, disk space, IP family, and other parameters. + +This command supports creating clusters on multiple Kubernetes distributions, including setting up node groups with different instance types and counts. You can also specify a TTL (Time-To-Live) to automatically terminate the cluster after a set duration. + +Use the `--dry-run` flag to simulate the creation process and get an estimated cost without actually provisioning the cluster. + ## Usage ```bash @@ -17,95 +23,98 @@ replicated cluster create [flags] Type (if applicable) Description - - --addon + `--addon` string Add-ons to install in the cluster. Can be specified multiple times. - --bucket-prefix + `--bucket-prefix` string A prefix for the bucket name to be created. Required by `--addon object-store`. - --disk + `--disk` integer The disk size (GiB) to request per node. Default: 50 - --distribution + `--distribution` string The Kubernetes cluster distribution type to provision. Default: kind - --dry-run + `--dry-run` The dry run option runs a simulated test to verify that your inputs are valid without actually creating a cluster. - --instance-type + `--instance-type` string The type of instance to use for nodes in the cluster. For supported instance types, see Supported Compatibility Matrix Cluster Types (Beta). - --ip-family + `--ip-family` string IP Family to use for the cluster (ipv4|ipv6|dual). Default: ipv4 - --license-id + `--license-id` string A valid customer license ID. Required for Replicated embedded cluster distribution. - --name + `--max-nodes` string - The name of the cluster. If no name is specified, a name will be generated. - - - --nodes - integer - The node count. Default: 1 + Maximum Node count (only for EKS, AKS and GKE clusters). - --min-nodes + `--min-nodes` string Minimum Node count (only for EKS, AKS and GKE clusters). - --max-nodes + `--name` string - Maximum Node count (only for EKS, AKS and GKE clusters). + The name of the cluster. If no name is specified, a name will be generated. - --nodegroup + `--nodegroup` string Node group to create (name=?,instance-type=?,nodes=?,min-nodes=?,max-nodes=?,disk=? format, can be specified multiple times). For each nodegroup, at least one flag must be specified. The flags min-nodes and max-nodes are mutually dependent. + + `--nodes` + integer + The node count. Default: 1 + - --tag + `--tag` string Tag to apply to the cluster (key=value format, can be specified multiple times) - --ttl + `--ttl` string

The cluster Time to Live (TTL) duration, in hours or minutes. When the TTL expires, the cluster is automatically deleted.

Valid values: 10m through 48h. For example, 10h or 120min. TTL starts when the cluster is in a Ready state. Valid values: 1h through 48h. Default: 1h

- --version + `--version` string The Kubernetes version to provision. For OpenShift clusters, provide the supported OpenShift version. The format is distribution dependent. For supported versions, see Supported Compatibility Matrix Cluster Types. - --wait + `--wait` duration The wait duration for the cluster to be ready. Leave the value empty to avoid waiting. +## Global Flags + + + ## Examples - For an EKS distribution: @@ -126,8 +135,8 @@ replicated cluster create [flags] replicated cluster create --name kind-example --distribution kind --version 1.25.2 --disk 100 --instance-type r1.small ``` -- For a Replicated embedded cluster distribution: +- For a Replicated Embedded Cluster distribution: ```bash replicated cluster create --distribution embedded-cluster --license-id -``` +``` \ No newline at end of file diff --git a/docs/reference/replicated-cli-cluster-kubeconfig.md b/docs/reference/replicated-cli-cluster-kubeconfig.md index 328727b9f2..29b58435d8 100644 --- a/docs/reference/replicated-cli-cluster-kubeconfig.md +++ b/docs/reference/replicated-cli-cluster-kubeconfig.md @@ -1,4 +1,4 @@ -import Help from "../partials/replicated-cli/_help.mdx" +import GlobalFlags from "../partials/replicated-cli/_global-flags.mdx" # cluster kubeconfig @@ -16,7 +16,6 @@ replicated cluster kubeconfig ID [flags] Type (if applicable) Description - --id string @@ -39,6 +38,6 @@ replicated cluster kubeconfig ID [flags] - - - +## Global Flags + + \ No newline at end of file diff --git a/docs/reference/replicated-cli-cluster-ls.md b/docs/reference/replicated-cli-cluster-ls.md index 073bf0ff0f..18a06315c9 100644 --- a/docs/reference/replicated-cli-cluster-ls.md +++ b/docs/reference/replicated-cli-cluster-ls.md @@ -1,54 +1,82 @@ -import Help from "../partials/replicated-cli/_help.mdx" - +import GlobalFlags from "../partials/replicated-cli/_global-flags.mdx" # cluster ls List the clusters available for compatibility testing. For more information, see [About Compatibility Matrix](/vendor/testing-about). - ## Usage ```bash replicated cluster ls [flags] ``` - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +```bash +replicated cluster list [flags] +``` + +
FlagType (if applicable)Description
--end-timestringThe end time for the query. Format: 2006-01-02T15:04:05Z
--outputstringThe output format to use. Value values: json, table or wide. Default: table
--show-terminatedWhen set, only shows terminated clusters.
--start-timestringThe start time for the query. Format: 2006-01-02T15:04:05Z
-w, --watchWatches the clusters.
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FlagType (if applicable)Description
`--end-time`stringThe end time for the query. Format: 2006-01-02T15:04:05Z
`--output`stringThe output format to use. Value values: json, table or wide. Default: table
`--show-terminated`When set, only shows terminated clusters.
`--start-time`stringThe start time for the query. Format: 2006-01-02T15:04:05Z
`-w`, `--watch`Watches the clusters.
-## Example +## Global Flags + + + +## Examples ```bash replicated cluster ls ``` - +```bash +# List all clusters with default table output +replicated cluster ls +``` +```bash +# Show clusters created after a specific date +replicated cluster ls --start-time 2023-01-01T00:00:00Z +``` +```bash +# Watch for real-time updates +replicated cluster ls --watch +``` +```bash +# List clusters with JSON output +replicated cluster ls --output json +``` +```bash +# List only terminated clusters +replicated cluster ls --show-terminated +``` +```bash +# List clusters with wide table output +replicated cluster ls --output wide +``` \ No newline at end of file diff --git a/docs/reference/replicated-cli-cluster-nodegroup-ls.md b/docs/reference/replicated-cli-cluster-nodegroup-ls.md index b8caed8422..ac9a239dc9 100644 --- a/docs/reference/replicated-cli-cluster-nodegroup-ls.md +++ b/docs/reference/replicated-cli-cluster-nodegroup-ls.md @@ -1,6 +1,5 @@ -import Help from "../partials/replicated-cli/_help.mdx" import Output from "../partials/replicated-cli/_output.mdx" -import Token from "../partials/replicated-cli/_token.mdx" +import GlobalFlags from "../partials/replicated-cli/_global-flags.mdx" # cluster nodegroup ls @@ -14,15 +13,9 @@ For more information, see [About Compatibility Matrix](/vendor/testing-about). replicated cluster nodegroup ls [ID] ``` - - - - - - - - -
FlagType (if applicable)Description
+## Global Flags + + ## Example diff --git a/docs/reference/replicated-cli-cluster-port-expose.md b/docs/reference/replicated-cli-cluster-port-expose.md index ee0d8265c9..a42bd7cf33 100644 --- a/docs/reference/replicated-cli-cluster-port-expose.md +++ b/docs/reference/replicated-cli-cluster-port-expose.md @@ -1,4 +1,4 @@ -import Help from "../partials/replicated-cli/\_help.mdx" +import GlobalFlags from "../partials/replicated-cli/_global-flags.mdx" # cluster port expose @@ -23,28 +23,31 @@ replicated cluster port expose CLUSTER_ID --port PORT [flags] Description - --port + `--port` string Port to expose. (Required) - --protocol + `--protocol` string Protocol to expose (valid values are "http" and "https"). Specify multiple or separate values with commas. - --wildcard + `--wildcard` bool Create a wildcard DNS entry and TLS certificate for this port. - --output + `--output` string The output format to use. Value values: json, table or wide. Default: table - +## Global Flags + + + ## Example ```bash diff --git a/docs/reference/replicated-cli-cluster-port-ls.md b/docs/reference/replicated-cli-cluster-port-ls.md index 014206aef2..45166506ca 100644 --- a/docs/reference/replicated-cli-cluster-port-ls.md +++ b/docs/reference/replicated-cli-cluster-port-ls.md @@ -1,4 +1,4 @@ -import Help from "../partials/replicated-cli/_help.mdx" +import GlobalFlags from "../partials/replicated-cli/_global-flags.mdx" # cluster port ls @@ -17,13 +17,16 @@ replicated cluster port ls CLUSTER_ID [flags] Description - --output + `--output` string The output format to use. Value values: json, table or wide. Default: table - +## Global Flags + + + ## Example ```bash diff --git a/docs/reference/replicated-cli-cluster-port-rm.md b/docs/reference/replicated-cli-cluster-port-rm.md index a1860009dc..375aa92331 100644 --- a/docs/reference/replicated-cli-cluster-port-rm.md +++ b/docs/reference/replicated-cli-cluster-port-rm.md @@ -1,4 +1,4 @@ -import Help from "../partials/replicated-cli/_help.mdx" +import GlobalFlags from "../partials/replicated-cli/_global-flags.mdx" # cluster port rm @@ -17,18 +17,21 @@ replicated cluster port rm CLUSTER_ID --id PORT_ID [flags] Description - --id + `--id` string ID of the port to remove. (Required) - --output + `--output` string The output format to use. Value values: json, table or wide. Default: table - +## Global Flags + + + ## Example ```bash diff --git a/docs/reference/replicated-cli-cluster-prepare.md b/docs/reference/replicated-cli-cluster-prepare.md index 98d66e718e..948ce315b2 100644 --- a/docs/reference/replicated-cli-cluster-prepare.md +++ b/docs/reference/replicated-cli-cluster-prepare.md @@ -1,5 +1,4 @@ -import Help from "../partials/replicated-cli/_help.mdx" - +import GlobalFlags from "../partials/replicated-cli/_global-flags.mdx" # cluster prepare @@ -21,130 +20,132 @@ replicated cluster prepare [flags] Type (if applicable) Description - - --disk - integer - The disk size (GiB) to request per node. Default: 50 + `--app-ready-timeout` + string + Timeout to wait for the application to be ready. Requires the Go duration format (e.g., 10s, 2m). Default: 5 minutes - --distribution + `--chart` string - The Kubernetes cluster distribution type to provision. Default: kind + The path to the Helm chart for a release. - --instance-type + `--cluster-id` string - The type of instance to use for nodes in the cluster. See Supported Compatibility Matrix Cluster Types (Beta). + The ID of an existing cluster to use instead of creating a new ID. - --name + `--config-values-file` string - The name of the cluster. If no name is specified, a name will be generated. + Path to a manifest containing config values. Must use apiVersion: kots.io/v1beta1, kind: ConfigValues. - --nodes + `--disk` integer - The node count. Default: 1 + The disk size (GiB) to request per node. Default: 50 - --ttl + `--distribution` string - The cluster Time to Live (TTL) duration, in hours, before the cluster is automatically deleted by the service. TTL starts when the cluster is in a Ready state. Valid values: 1 - 48. Default: 1 + The Kubernetes cluster distribution type to provision. Default: kind - --version + `--entitlements` string - (Required) The Kubernetes version to provision. For OpenShift clusters, provide the supported OpenShift version. The format is distribution dependent. For supported versions, see Supported Compatibility Matrix Cluster Types (Beta). - - - --wait - duration - The wait duration for the cluster to be ready. Default: 5 minutes + The entitlements to set on the customer. You can specify multiple entitlements. - --cluster-id + `--instance-type` string - The ID of an existing cluster to use instead of creating a new ID. + The type of instance to use for nodes in the cluster. See Supported Compatibility Matrix Cluster Types (Beta). - --entitlements + `--name` string - The entitlements to set on the customer. You can specify multiple entitlements. + The name of the cluster. If no name is specified, a name will be generated. - --namespace + `--namespace` string The namespace in which to deploy the KOTS or Helm chart application. Default: default - --app-ready-timeout + `--node-count` + integer + The node count. Default: 1 + + + `--set` string - Timeout to wait for the application to be ready. Requires the Go duration format (e.g., 10s, 2m). Default: 5 minutes + Set values using the command line. Specify multiple or separate values with commas: key1=val1,key2=val2. - --chart + `--set-file` string - The path to the Helm chart for a release. + Set values from respective files specified using the command line. Specify multiple or separate values with commas: key1=path1,key2=path2. - --values + `--set-json` string - Specify values in a YAML file or a URL. You can specify multiple values. + Set JSON values using the command line. Specify multiple or separate values with commas: key1=jsonval1,key2=jsonval2. - --set + `--set-literal` string - Set values using the command line. Specify multiple or separate values with commas: key1=val1,key2=val2. + Set a literal String value using the command line. - --set-string + `--set-string` string Set String values using the command line. Specify multiple or separate values with commas: key1=val1,key2=val2. - --set-file + `--shared-password` string - Set values from respective files specified using the command line. Specify multiple or separate values with commas: key1=path1,key2=path2. + Shared password for the KOTS admin console. - --set-json + `--ttl` string - Set JSON values using the command line. Specify multiple or separate values with commas: key1=jsonval1,key2=jsonval2. + The cluster Time to Live (TTL) duration, in hours, before the cluster is automatically deleted by the service. TTL starts when the cluster is in a Ready state. Valid values: 1 - 48. Default: 1 - --set-literal + `--values` string - Set a literal String value using the command line. + Specify values in a YAML file or a URL. You can specify multiple values. - --yaml + `--version` string - The YAML config for this release. Use - to read from stdin. Cannot be used with the --yaml-file flag. + (Required) The Kubernetes version to provision. For OpenShift clusters, provide the supported OpenShift version. The format is distribution dependent. For supported versions, see Supported Compatibility Matrix Cluster Types (Beta). - --yaml-file - string - The YAML config for this release. Cannot be used with the --yaml flag. + `--wait` + duration + The wait duration for the cluster to be ready. Default: 5 minutes - --yaml-dir + `--yaml` string - The directory containing multiple YAML files for a KOTS release. Cannot be used with the --yaml flag. + The YAML config for this release. Use - to read from stdin. Cannot be used with the --yaml-file flag. - --config-values-file + `--yaml-file` string - Path to a manifest containing config values. Must use apiVersion: kots.io/v1beta1, kind: ConfigValues. + The YAML config for this release. Cannot be used with the --yaml flag. - --shared-password + `--yaml-dir` string - Shared password for the KOTS admin console. + The directory containing multiple YAML files for a KOTS release. Cannot be used with the --yaml flag. - +## Global Flags + + + ## Examples - For a Helm application with a kind distribution: diff --git a/docs/reference/replicated-cli-cluster-rm.md b/docs/reference/replicated-cli-cluster-rm.md index 3b79effb6d..beb7e397f9 100644 --- a/docs/reference/replicated-cli-cluster-rm.md +++ b/docs/reference/replicated-cli-cluster-rm.md @@ -1,5 +1,4 @@ -import Help from "../partials/replicated-cli/_help.mdx" - +import GlobalFlags from "../partials/replicated-cli/_global-flags.mdx" # cluster rm @@ -19,7 +18,6 @@ Replace `Cluster ID, name, or tag` with one or more cluster IDs, names, or tags. Type (if applicable) Description - --name stringArray @@ -37,6 +35,10 @@ Replace `Cluster ID, name, or tag` with one or more cluster IDs, names, or tags. +## Global Flags + + + ## Example ```bash diff --git a/docs/reference/replicated-cli-cluster-shell.mdx b/docs/reference/replicated-cli-cluster-shell.mdx index 7bed7b9183..ff2039db45 100644 --- a/docs/reference/replicated-cli-cluster-shell.mdx +++ b/docs/reference/replicated-cli-cluster-shell.mdx @@ -1,4 +1,5 @@ import Help from "../partials/replicated-cli/_help.mdx" +import GlobalFlags from "../partials/replicated-cli/_global-flags.mdx" # cluster shell @@ -20,7 +21,6 @@ replicated cluster shell [ID] [flags] Type (if applicable) Description - --id string @@ -33,6 +33,10 @@ replicated cluster shell [ID] [flags] +## Global Flags + + + ## Examples ```bash diff --git a/docs/reference/replicated-cli-cluster-update-ttl.md b/docs/reference/replicated-cli-cluster-update-ttl.md index 2ba0be23c3..2d2e5aabb7 100644 --- a/docs/reference/replicated-cli-cluster-update-ttl.md +++ b/docs/reference/replicated-cli-cluster-update-ttl.md @@ -1,5 +1,5 @@ -import Help from "../partials/replicated-cli/_help.mdx" import Output from "../partials/replicated-cli/_output.mdx" +import GlobalFlags from "../partials/replicated-cli/_global-flags.mdx" # cluster update ttl @@ -21,7 +21,6 @@ The `cluster update ttl` command first looks for the target cluster based on the Type (if applicable) Description - --ttl @@ -46,6 +45,10 @@ The `cluster update ttl` command first looks for the target cluster based on the +## Global Flags + + + ## Example Given the following cluster with a TTL of one hour: diff --git a/docs/reference/replicated-cli-cluster-upgrade.md b/docs/reference/replicated-cli-cluster-upgrade.md index ca91cf30ae..4ee33d3be0 100644 --- a/docs/reference/replicated-cli-cluster-upgrade.md +++ b/docs/reference/replicated-cli-cluster-upgrade.md @@ -1,5 +1,4 @@ -import Help from "../partials/replicated-cli/_help.mdx" - +import GlobalFlags from "../partials/replicated-cli/_global-flags.mdx" # cluster upgrade @@ -16,7 +15,6 @@ replicated cluster upgrade ID [flags] Type (if applicable) Description - --dry-run @@ -34,6 +32,10 @@ replicated cluster upgrade ID [flags] +## Global Flags + + + ## Examples For a kURL distribution: diff --git a/docs/reference/replicated-cli-cluster-versions.md b/docs/reference/replicated-cli-cluster-versions.md index 3c4773f373..6bded2c024 100644 --- a/docs/reference/replicated-cli-cluster-versions.md +++ b/docs/reference/replicated-cli-cluster-versions.md @@ -1,5 +1,4 @@ -import Help from "../partials/replicated-cli/_help.mdx" - +import GlobalFlags from "../partials/replicated-cli/_global-flags.mdx" # cluster versions @@ -17,19 +16,22 @@ replicated cluster versions [flags] Type (if applicable) Description - - --output + `--output` string The output format to use. Value values: json or table. Default: table - --distribution + `--distribution` string - The Kuberntes distribution to filter by. For example, openshift + The Kubernetes distribution to filter by. For example, openshift +## Global Flags + + + ## Example ```bash diff --git a/docs/reference/replicated-cli-completion-bash.md b/docs/reference/replicated-cli-completion-bash.md index a3a9dd7aaa..dbdbba8cf4 100644 --- a/docs/reference/replicated-cli-completion-bash.md +++ b/docs/reference/replicated-cli-completion-bash.md @@ -1,4 +1,4 @@ -import Help from "../partials/replicated-cli/_help.mdx" +import GlobalFlags from "../partials/replicated-cli/_global-flags.mdx" # completion bash @@ -10,13 +10,6 @@ Generates scripts for bash command completion. replicated completion bash [flags] ``` -The following flags are supported: +## Global Flags - - - - - - - -
FlagType (if applicable)Description
\ No newline at end of file + \ No newline at end of file diff --git a/docs/reference/replicated-cli-completion-fish.md b/docs/reference/replicated-cli-completion-fish.md index 9175e95919..d09728c95a 100644 --- a/docs/reference/replicated-cli-completion-fish.md +++ b/docs/reference/replicated-cli-completion-fish.md @@ -1,4 +1,4 @@ -import Help from "../partials/replicated-cli/_help.mdx" +import GlobalFlags from "../partials/replicated-cli/_global-flags.mdx" # completion fish @@ -10,13 +10,6 @@ Generates scripts for fish command completion. replicated completion fish [flags] ``` -The following flags are supported: +## Global Flags - - - - - - - -
FlagType (if applicable)Description
+ \ No newline at end of file diff --git a/docs/reference/replicated-cli-completion-powershell.md b/docs/reference/replicated-cli-completion-powershell.md index 5b12ba4aba..25912faad6 100644 --- a/docs/reference/replicated-cli-completion-powershell.md +++ b/docs/reference/replicated-cli-completion-powershell.md @@ -1,4 +1,4 @@ -import Help from "../partials/replicated-cli/_help.mdx" +import GlobalFlags from "../partials/replicated-cli/_global-flags.mdx" # completion powershell @@ -7,16 +7,9 @@ Generates scripts for powershell command completion. ## Usage ```bash -replicated completion powershell [flags] +replicated completion powershell ``` -The following flags are supported: +## Global Flags - - - - - - - -
FlagType (if applicable)Description
+ \ No newline at end of file diff --git a/docs/reference/replicated-cli-completion-zsh.md b/docs/reference/replicated-cli-completion-zsh.md index 9f120b8d46..5873137176 100644 --- a/docs/reference/replicated-cli-completion-zsh.md +++ b/docs/reference/replicated-cli-completion-zsh.md @@ -1,4 +1,4 @@ -import Help from "../partials/replicated-cli/_help.mdx" +import GlobalFlags from "../partials/replicated-cli/_global-flags.mdx" # completion zsh @@ -10,13 +10,6 @@ Generates scripts for zsh command completion. replicated completion zsh [flags] ``` -The following flags are supported: +## Global Flags - - - - - - - -
FlagType (if applicable)Description
+ \ No newline at end of file diff --git a/docs/reference/replicated-cli-completion.mdx b/docs/reference/replicated-cli-completion.mdx index 2f03fbbef3..e529dc8ecf 100644 --- a/docs/reference/replicated-cli-completion.mdx +++ b/docs/reference/replicated-cli-completion.mdx @@ -1,4 +1,4 @@ -import Help from "../partials/replicated-cli/_help.mdx" +import GlobalFlags from "../partials/replicated-cli/_global-flags.mdx" # completion @@ -35,13 +35,6 @@ The following `completion` commands are supported: -The following flags are supported: +## Global Flags - - - - - - - -
FlagType (if applicable)Description
+ \ No newline at end of file diff --git a/docs/reference/replicated-cli-customer-archive.mdx b/docs/reference/replicated-cli-customer-archive.mdx new file mode 100644 index 0000000000..998ef4adc9 --- /dev/null +++ b/docs/reference/replicated-cli-customer-archive.mdx @@ -0,0 +1,42 @@ +import GlobalFlags from "../partials/replicated-cli/_global-flags.mdx" + +# customer archive + +Archive a customer for the current application. + +This command allows you to archive a customer record. Archiving a customer +will make their license inactive and remove them from active customer lists. +This action is reversible. You can unarchive a customer later if needed. + +The customer can be specified by either their name or ID. + +## Usage +```bash +replicated customer archive [CUSTOMER_NAME_OR_ID] +``` + +## Global Flags + + + +## Examples + +### Archive a customer by name +```bash +replicated customer archive "Acme Inc" +``` + +### Archive a customer by ID +```bash +replicated customer archive cus_abcdef123456 +``` + +### Archive multiple customers by ID +```bash +replicated customer archive cus_abcdef123456 cus_xyz9876543210 +``` + +### Archive a customer in a specific app (if you have multiple apps) +```bash +replicated customer archive --app myapp "Acme Inc" +``` \ No newline at end of file diff --git a/docs/reference/replicated-cli-customer-create.md b/docs/reference/replicated-cli-customer-create.md index a2444037bc..a8158abc0f 100644 --- a/docs/reference/replicated-cli-customer-create.md +++ b/docs/reference/replicated-cli-customer-create.md @@ -1,6 +1,4 @@ -import Token from "../partials/replicated-cli/_token.mdx" -import Help from "../partials/replicated-cli/_help.mdx" -import App from "../partials/replicated-cli/_app.mdx" +import GlobalFlags from "../partials/replicated-cli/_global-flags.mdx" # customer create @@ -43,11 +41,12 @@ replicated customer create [Flags] string If set, this custom alphanumeric ID is associated with this customer to more easily tie this record to your external data systems (i.e. Salesforce, Hubspot, etc.) - - - +## Global Flags + + + ## Examples ```bash replicated customer create --channel Megacorp_Beta --name "Megacorp" --ensure-channel --expires-in "8760h" --custom-id "salesforceid-123" diff --git a/docs/reference/replicated-cli-customer-download-license.md b/docs/reference/replicated-cli-customer-download-license.md index 62a5a2ed9f..a049994db4 100644 --- a/docs/reference/replicated-cli-customer-download-license.md +++ b/docs/reference/replicated-cli-customer-download-license.md @@ -1,6 +1,4 @@ -import Token from "../partials/replicated-cli/_token.mdx" -import Help from "../partials/replicated-cli/_help.mdx" -import App from "../partials/replicated-cli/_app.mdx" +import GlobalFlags from "../partials/replicated-cli/_global-flags.mdx" # customer download-license @@ -22,11 +20,12 @@ replicated customer download-license string The customer name or ID. - - - +## Global Flags + + + ## Examples ```bash replicated customer download-license --customer cli-customer diff --git a/docs/reference/replicated-cli-customer-inspect.mdx b/docs/reference/replicated-cli-customer-inspect.mdx new file mode 100644 index 0000000000..7b61cfd486 --- /dev/null +++ b/docs/reference/replicated-cli-customer-inspect.mdx @@ -0,0 +1,60 @@ +import GlobalFlags from "../partials/replicated-cli/_global-flags.mdx" + +# customer inspect + +The inspect command provides comprehensive details about a customer. + +This command retrieves and displays full information about a specified customer, +including their assigned channels, registry information, and other relevant attributes. +It's useful for getting an in-depth view of a customer's configuration and status. + +You must specify the customer using either their name or ID with the `--customer` flag. + +## Usage +```bash +replicated customer inspect --customer [CUSTOMER_NAME_OR_ID] +``` + + + + + + + + + + + + + + + + + +
FlagType (if applicable)Description
`--customer`stringCustomer name or ID
`--output`stringThe output format to use: `json` or `table`. **Default:** `table`
+ +## Global Flags + + + +## Examples + +### Inspect a customer by ID +```bash +replicated customer inspect --customer cus_abcdef123456 +``` + +### Inspect a customer by name +```bash +replicated customer inspect --customer "Acme Inc" +``` + +### Inspect a customer and output in JSON format +```bash +replicated customer inspect --customer cus_abcdef123456 --output json +``` + +### Inspect a customer for a specific app (if you have multiple apps) +```bash +replicated customer inspect --app myapp --customer "Acme Inc" +``` \ No newline at end of file diff --git a/docs/reference/replicated-cli-customer-ls.md b/docs/reference/replicated-cli-customer-ls.md index 11e023f82f..b06a5837a7 100644 --- a/docs/reference/replicated-cli-customer-ls.md +++ b/docs/reference/replicated-cli-customer-ls.md @@ -1,6 +1,4 @@ -import Token from "../partials/replicated-cli/_token.mdx" -import Help from "../partials/replicated-cli/_help.mdx" -import App from "../partials/replicated-cli/_app.mdx" +import GlobalFlags from "../partials/replicated-cli/_global-flags.mdx" # customer ls @@ -17,12 +15,13 @@ replicated customer ls Type (if applicable) Description - - --app-versionstringThe application version. Used to list customers and their instances for a specific application version. - +## Global Flags + + + ## Examples List all customers: diff --git a/docs/reference/replicated-cli-customer-update.mdx b/docs/reference/replicated-cli-customer-update.mdx new file mode 100644 index 0000000000..197f3390da --- /dev/null +++ b/docs/reference/replicated-cli-customer-update.mdx @@ -0,0 +1,70 @@ +import GlobalFlags from "../partials/replicated-cli/_global-flags.mdx" + +# customer update + +Update an existing customer's information and settings. + +This command allows you to modify various attributes of a customer, including their name, +custom ID, assigned channels, license type, and feature flags. You can update expiration dates, +enable or disable specific features, and change channel assignments. + +The `--customer` flag is required to specify which customer to update. + +## Usage +```bash +replicated customer update --customer [CUSTOMER_NAME_OR_ID] +``` + + + + + + + + + + + + + + + + + +
FlagType (if applicable)Description
--airgap If set, the license will allow airgap installs.
--channelstringArrayRelease channel to which the customer should be assigned (can be specified multiple times)
+ +## Global Flags + + + +## Examples + +### Update a customer's name +```bash +replicated customer update --customer cus_abcdef123456 --name "New Company Name" +``` + +### Change a customer's channel and make it the default +```bash +replicated customer update --customer cus_abcdef123456 --channel stable --default-channel stable +``` + +### Enable airgap installations for a customer +```bash +replicated customer update --customer cus_abcdef123456 --airgap +``` + +### Update multiple attributes at once +```bash +replicated customer update --customer cus_abcdef123456 --name "Updated Corp" --type paid --channel enterprise --airgap --snapshot +``` + +### Set an expiration date for a customer's license +```bash +replicated customer update --customer cus_abcdef123456 --expires-in 8760h +``` + +### Update a customer and output the result in JSON format +```bash +replicated customer update --customer cus_abcdef123456 --name "JSON Corp" --output json +``` \ No newline at end of file diff --git a/docs/reference/replicated-cli-default-clear.mdx b/docs/reference/replicated-cli-default-clear.mdx new file mode 100644 index 0000000000..f4d98822c0 --- /dev/null +++ b/docs/reference/replicated-cli-default-clear.mdx @@ -0,0 +1,34 @@ +import GlobalFlags from "../partials/replicated-cli/_global-flags.mdx" + +# default clear + +Clear the default value for the specified key. + +## Usage + +```bash +replicated default clear [key] [flags] +``` +The following keys are supported: + + + + + + + + + + +
KeyDescription
appThe default application to use, identified by the unique application slug.
+ +## Global Flags + + + +## Example + +```bash +# Clear default application +replicated default clear app +``` \ No newline at end of file diff --git a/docs/reference/replicated-cli-default-clearall.mdx b/docs/reference/replicated-cli-default-clearall.mdx new file mode 100644 index 0000000000..5c8e3f1fe9 --- /dev/null +++ b/docs/reference/replicated-cli-default-clearall.mdx @@ -0,0 +1,22 @@ +import GlobalFlags from "../partials/replicated-cli/_global-flags.mdx" + +# default clear-all + +Clear all default values used by other commands run by the current user. + +## Usage + +```bash +replicated default clear-all [flags] +``` + +## Global Flags + + + +## Example + +```bash +# Clear all defaults +replicated default clear-all +``` \ No newline at end of file diff --git a/docs/reference/replicated-cli-default-set.mdx b/docs/reference/replicated-cli-default-set.mdx new file mode 100644 index 0000000000..d25d46620c --- /dev/null +++ b/docs/reference/replicated-cli-default-set.mdx @@ -0,0 +1,34 @@ +import GlobalFlags from "../partials/replicated-cli/_global-flags.mdx" + +# default set + +Set default value for the specified key run by the current user. + +## Usage + +```bash +replicated default set [key] [flags] +``` +The following keys are supported: + + + + + + + + + + +
KeyDescription
appThe default application to use, identified by the unique application slug.
+ +## Global Flags + + + +## Example + +```bash +# Set the default application +replicated default set app my-app-slug +``` \ No newline at end of file diff --git a/docs/reference/replicated-cli-default-show.mdx b/docs/reference/replicated-cli-default-show.mdx new file mode 100644 index 0000000000..546498f720 --- /dev/null +++ b/docs/reference/replicated-cli-default-show.mdx @@ -0,0 +1,18 @@ +import GlobalFlags from "../partials/replicated-cli/_global-flags.mdx" + +# default show + + + +## Usage + +```bash +replicated default show [command] [flags] +``` +The following flags are supported: + + + +## Global Flags + + \ No newline at end of file diff --git a/docs/reference/replicated-cli-default.mdx b/docs/reference/replicated-cli-default.mdx new file mode 100644 index 0000000000..d42006e0ec --- /dev/null +++ b/docs/reference/replicated-cli-default.mdx @@ -0,0 +1,39 @@ +import GlobalFlags from "../partials/replicated-cli/_global-flags.mdx" + +# default + +Manage the default values used by other Replicated CLI commands. + +## Usage + +```bash +replicated default [command] [flags] +``` +The following commands are available: + + + + + + + + + + + + + + + + + + + + + + +
CommandDescription
clearClears default value for the specified key.
clear-allRemoves all default values that are used by other commands.
setSets default value for the specified key.
showShows default values for the specified key.
+ +## Global Flags + + \ No newline at end of file diff --git a/docs/reference/replicated-cli-installer-create.md b/docs/reference/replicated-cli-installer-create.md index 320a2ce0bb..0c9c91bca8 100644 --- a/docs/reference/replicated-cli-installer-create.md +++ b/docs/reference/replicated-cli-installer-create.md @@ -1,6 +1,4 @@ -import Help from "../partials/replicated-cli/_help.mdx" -import App from "../partials/replicated-cli/_app.mdx" -import Token from "../partials/replicated-cli/_token.mdx" +import GlobalFlags from "../partials/replicated-cli/_global-flags.mdx" # installer create @@ -47,11 +45,12 @@ replicated installer create [flags] string The file name with YAML config for this installer. Cannot be used with the --yaml flag. - - - +## Global Flags + + + ## Examples diff --git a/docs/reference/replicated-cli-installer-ls.md b/docs/reference/replicated-cli-installer-ls.md index 7e0db3342e..d9dd81160d 100644 --- a/docs/reference/replicated-cli-installer-ls.md +++ b/docs/reference/replicated-cli-installer-ls.md @@ -1,6 +1,4 @@ -import Help from "../partials/replicated-cli/_help.mdx" -import App from "../partials/replicated-cli/_app.mdx" -import Token from "../partials/replicated-cli/_token.mdx" +import GlobalFlags from "../partials/replicated-cli/_global-flags.mdx" # installer ls @@ -11,16 +9,9 @@ List the Kubernetes installer manifests for an app. For more information, see [C replicated installer ls ``` - - - - - - - - - -
FlagType (if applicable)Description
+## Global Flags + + ## Examples diff --git a/docs/reference/replicated-cli-instance-inspect.md b/docs/reference/replicated-cli-instance-inspect.md index 36abfa488d..3ed1be3a38 100644 --- a/docs/reference/replicated-cli-instance-inspect.md +++ b/docs/reference/replicated-cli-instance-inspect.md @@ -1,6 +1,4 @@ -import Help from "../partials/replicated-cli/_help.mdx" -import App from "../partials/replicated-cli/_app.mdx" -import Token from "../partials/replicated-cli/_token.mdx" +import GlobalFlags from "../partials/replicated-cli/_global-flags.mdx" # instance inspect @@ -18,13 +16,11 @@ instance inspect [flags] Type (if applicable) Description - --customer string Customer Name or ID that instance belongs to. - --instance string @@ -35,9 +31,12 @@ instance inspect [flags] string The output format to use: json or table. Default: table - +## Global Flags + + + ## Example ```bash diff --git a/docs/reference/replicated-cli-instance-ls.md b/docs/reference/replicated-cli-instance-ls.md index ff41ea7317..deabb94843 100644 --- a/docs/reference/replicated-cli-instance-ls.md +++ b/docs/reference/replicated-cli-instance-ls.md @@ -1,6 +1,4 @@ -import Help from "../partials/replicated-cli/_help.mdx" -import App from "../partials/replicated-cli/_app.mdx" -import Token from "../partials/replicated-cli/_token.mdx" +import GlobalFlags from "../partials/replicated-cli/_global-flags.mdx" # instance ls @@ -18,13 +16,11 @@ instance ls [flags] Type (if applicable) Description - --customer string Customer Name or ID to list instances for. - --output string @@ -35,9 +31,12 @@ instance ls [flags] string Tags to filter instances. Multiple --tag flags can be specified. Only one of the tags must match per instance. - +## Global Flags + + + ## Examples ```bash diff --git a/docs/reference/replicated-cli-instance-tag.md b/docs/reference/replicated-cli-instance-tag.md index e3c50feda0..bfddb5224d 100644 --- a/docs/reference/replicated-cli-instance-tag.md +++ b/docs/reference/replicated-cli-instance-tag.md @@ -1,6 +1,4 @@ -import Help from "../partials/replicated-cli/_help.mdx" -import App from "../partials/replicated-cli/_app.mdx" -import Token from "../partials/replicated-cli/_token.mdx" +import GlobalFlags from "../partials/replicated-cli/_global-flags.mdx" # instance tag @@ -18,7 +16,6 @@ instance tag [flags] Type (if applicable) Description - --customer string @@ -29,7 +26,6 @@ instance tag [flags] string Instance Name or ID to add or remove tags. - --output string @@ -40,9 +36,12 @@ instance tag [flags] string Tags to apply to the instance. Leave value empty to remove tag. Tags not specified are removed or modified. - +## Global Flags + + + ## Example ```bash diff --git a/docs/reference/replicated-cli-registry-add-dockerhub.mdx b/docs/reference/replicated-cli-registry-add-dockerhub.mdx index 682371d9c0..bb938d5646 100644 --- a/docs/reference/replicated-cli-registry-add-dockerhub.mdx +++ b/docs/reference/replicated-cli-registry-add-dockerhub.mdx @@ -1,12 +1,10 @@ -import App from "../partials/replicated-cli/_app.mdx" import SkipValidation from "../partials/replicated-cli/_skip-validation.mdx" -import Token from "../partials/replicated-cli/_token.mdx" import AuthType from "../partials/replicated-cli/_authtype.mdx" import Password from "../partials/replicated-cli/_password.mdx" import PasswordStdin from "../partials/replicated-cli/_password-stdin.mdx" import TokenStdin from "../partials/replicated-cli/_token-stdin.mdx" import Username from "../partials/replicated-cli/_username.mdx" -import Help from "../partials/replicated-cli/_help.mdx" +import GlobalFlags from "../partials/replicated-cli/_global-flags.mdx" # registry add dockerhub @@ -25,13 +23,14 @@ The following flags are supported: Type (if applicable) Description - - - + +## Global Flags + + diff --git a/docs/reference/replicated-cli-registry-add-ecr.mdx b/docs/reference/replicated-cli-registry-add-ecr.mdx index e0a1741707..d1cd8c8bf9 100644 --- a/docs/reference/replicated-cli-registry-add-ecr.mdx +++ b/docs/reference/replicated-cli-registry-add-ecr.mdx @@ -1,7 +1,5 @@ -import App from "../partials/replicated-cli/_app.mdx" import SkipValidation from "../partials/replicated-cli/_skip-validation.mdx" -import Token from "../partials/replicated-cli/_token.mdx" -import Help from "../partials/replicated-cli/_help.mdx" +import GlobalFlags from "../partials/replicated-cli/_global-flags.mdx" # registry add ecr @@ -25,8 +23,6 @@ The following flags are supported: string The access key ID to use when authenticating to the registry. - - --secretaccesskey string @@ -38,5 +34,8 @@ The following flags are supported: Takes the secret access key from stdin. - + +## Global Flags + + \ No newline at end of file diff --git a/docs/reference/replicated-cli-registry-add-gar.mdx b/docs/reference/replicated-cli-registry-add-gar.mdx index 2a21454403..e79a09f943 100644 --- a/docs/reference/replicated-cli-registry-add-gar.mdx +++ b/docs/reference/replicated-cli-registry-add-gar.mdx @@ -1,7 +1,5 @@ -import App from "../partials/replicated-cli/_app.mdx" import SkipValidation from "../partials/replicated-cli/_skip-validation.mdx" -import Token from "../partials/replicated-cli/_token.mdx" -import Help from "../partials/replicated-cli/_help.mdx" +import GlobalFlags from "../partials/replicated-cli/_global-flags.mdx" # registry add gar @@ -21,8 +19,6 @@ The following flags are supported: Type (if applicable) Description - - --serviceaccountkey string @@ -45,3 +41,7 @@ The following flags are supported: + +## Global Flags + + \ No newline at end of file diff --git a/docs/reference/replicated-cli-registry-add-gcr.mdx b/docs/reference/replicated-cli-registry-add-gcr.mdx index 4fe49e2b40..babc9eaed1 100644 --- a/docs/reference/replicated-cli-registry-add-gcr.mdx +++ b/docs/reference/replicated-cli-registry-add-gcr.mdx @@ -1,7 +1,5 @@ -import App from "../partials/replicated-cli/_app.mdx" import SkipValidation from "../partials/replicated-cli/_skip-validation.mdx" -import Token from "../partials/replicated-cli/_token.mdx" -import Help from "../partials/replicated-cli/_help.mdx" +import GlobalFlags from "../partials/replicated-cli/_global-flags.mdx" # registry add gcr @@ -21,8 +19,6 @@ The following flags are supported: Type (if applicable) Description - - --serviceaccountkey string @@ -34,5 +30,8 @@ The following flags are supported: Take the service account key from stdin. - + +## Global Flags + + \ No newline at end of file diff --git a/docs/reference/replicated-cli-registry-add-ghcr.mdx b/docs/reference/replicated-cli-registry-add-ghcr.mdx index d9a9575f59..5b597b2141 100644 --- a/docs/reference/replicated-cli-registry-add-ghcr.mdx +++ b/docs/reference/replicated-cli-registry-add-ghcr.mdx @@ -1,8 +1,6 @@ -import App from "../partials/replicated-cli/_app.mdx" import SkipValidation from "../partials/replicated-cli/_skip-validation.mdx" -import Token from "../partials/replicated-cli/_token.mdx" +import GlobalFlags from "../partials/replicated-cli/_global-flags.mdx" import TokenStdin from "../partials/replicated-cli/_token-stdin.mdx" -import Help from "../partials/replicated-cli/_help.mdx" # registry add ghcr @@ -20,9 +18,10 @@ The following flags are supported: Type (if applicable) Description - - - + +## Global Flags + + \ No newline at end of file diff --git a/docs/reference/replicated-cli-registry-add-other.mdx b/docs/reference/replicated-cli-registry-add-other.mdx index f22a291e53..8921a4301c 100644 --- a/docs/reference/replicated-cli-registry-add-other.mdx +++ b/docs/reference/replicated-cli-registry-add-other.mdx @@ -1,10 +1,8 @@ -import App from "../partials/replicated-cli/_app.mdx" import SkipValidation from "../partials/replicated-cli/_skip-validation.mdx" -import Token from "../partials/replicated-cli/_token.mdx" import Password from "../partials/replicated-cli/_password.mdx" import PasswordStdin from "../partials/replicated-cli/_password-stdin.mdx" import Username from "../partials/replicated-cli/_username.mdx" -import Help from "../partials/replicated-cli/_help.mdx" +import GlobalFlags from "../partials/replicated-cli/_global-flags.mdx" # registry add other @@ -24,16 +22,17 @@ The following flags are supported: Type (if applicable) Description - --endpoint string The endpoint for the registry. - - + +## Global Flags + + \ No newline at end of file diff --git a/docs/reference/replicated-cli-registry-add-quay.mdx b/docs/reference/replicated-cli-registry-add-quay.mdx index 252e886650..d2c3ec7a58 100644 --- a/docs/reference/replicated-cli-registry-add-quay.mdx +++ b/docs/reference/replicated-cli-registry-add-quay.mdx @@ -1,10 +1,8 @@ -import App from "../partials/replicated-cli/_app.mdx" import SkipValidation from "../partials/replicated-cli/_skip-validation.mdx" -import Token from "../partials/replicated-cli/_token.mdx" import Password from "../partials/replicated-cli/_password.mdx" import PasswordStdin from "../partials/replicated-cli/_password-stdin.mdx" import Username from "../partials/replicated-cli/_username.mdx" -import Help from "../partials/replicated-cli/_help.mdx" +import GlobalFlags from "../partials/replicated-cli/_global-flags.mdx" # registry add quay @@ -24,11 +22,12 @@ The following flags are supported: Type (if applicable) Description - - - + +## Global Flags + + diff --git a/docs/reference/replicated-cli-registry-add.mdx b/docs/reference/replicated-cli-registry-add.mdx index 7286c26049..a11dc28029 100644 --- a/docs/reference/replicated-cli-registry-add.mdx +++ b/docs/reference/replicated-cli-registry-add.mdx @@ -1,7 +1,5 @@ -import App from "../partials/replicated-cli/_app.mdx" import SkipValidation from "../partials/replicated-cli/_skip-validation.mdx" -import Token from "../partials/replicated-cli/_token.mdx" -import Help from "../partials/replicated-cli/_help.mdx" +import GlobalFlags from "../partials/replicated-cli/_global-flags.mdx" # registry add @@ -58,8 +56,9 @@ The following flags are supported: Type (if applicable) Description - - - + +## Global Flags + + diff --git a/docs/reference/replicated-cli-registry-logs.mdx b/docs/reference/replicated-cli-registry-logs.mdx index 1f5a96f37e..5162a8df31 100644 --- a/docs/reference/replicated-cli-registry-logs.mdx +++ b/docs/reference/replicated-cli-registry-logs.mdx @@ -1,6 +1,4 @@ -import App from "../partials/replicated-cli/_app.mdx" -import Token from "../partials/replicated-cli/_token.mdx" -import Help from "../partials/replicated-cli/_help.mdx" +import GlobalFlags from "../partials/replicated-cli/_global-flags.mdx" # registry logs @@ -14,15 +12,6 @@ replicated registry logs [NAME] [flags] Replace NAME with the name of the registry. -The following flags are supported: +## Global Flags - - - - - - - - - -
FlagType (if applicable)Description
+ diff --git a/docs/reference/replicated-cli-registry-ls.mdx b/docs/reference/replicated-cli-registry-ls.mdx index 99c59b4e83..3f14324a7a 100644 --- a/docs/reference/replicated-cli-registry-ls.mdx +++ b/docs/reference/replicated-cli-registry-ls.mdx @@ -1,6 +1,4 @@ -import App from "../partials/replicated-cli/_app.mdx" -import Token from "../partials/replicated-cli/_token.mdx" -import Help from "../partials/replicated-cli/_help.mdx" +import GlobalFlags from "../partials/replicated-cli/_global-flags.mdx" # registry ls @@ -14,15 +12,6 @@ replicated registry ls [NAME] [flags] Replace NAME with the name of the registry. -The following flags are supported: +## Global Flags - - - - - - - - - -
FlagType (if applicable)Description
+ diff --git a/docs/reference/replicated-cli-registry-rm.mdx b/docs/reference/replicated-cli-registry-rm.mdx index e10c090d8a..63885cc267 100644 --- a/docs/reference/replicated-cli-registry-rm.mdx +++ b/docs/reference/replicated-cli-registry-rm.mdx @@ -1,6 +1,4 @@ -import App from "../partials/replicated-cli/_app.mdx" -import Token from "../partials/replicated-cli/_token.mdx" -import Help from "../partials/replicated-cli/_help.mdx" +import GlobalFlags from "../partials/replicated-cli/_global-flags.mdx" # registry rm @@ -14,15 +12,6 @@ replicated registry rm [ENDPOINT] [flags] Replace ENDPOINT with the name of the endpoint, such as gcr.io. -The following flags are supported: +## Global Flags - - - - - - - - - -
FlagType (if applicable)Description
+ diff --git a/docs/reference/replicated-cli-registry-test.mdx b/docs/reference/replicated-cli-registry-test.mdx index d8aecbc834..a842ca911b 100644 --- a/docs/reference/replicated-cli-registry-test.mdx +++ b/docs/reference/replicated-cli-registry-test.mdx @@ -1,6 +1,4 @@ -import App from "../partials/replicated-cli/_app.mdx" -import Token from "../partials/replicated-cli/_token.mdx" -import Help from "../partials/replicated-cli/_help.mdx" +import GlobalFlags from "../partials/replicated-cli/_global-flags.mdx" # registry test @@ -12,8 +10,6 @@ Tests pulling an image from a registry. replicated registry test HOSTNAME [flags] ``` -Replace HOSTNAME with the name of the host. - The following flags are supported: @@ -22,12 +18,13 @@ The following flags are supported: - - -
Type (if applicable) Description
--image string The image to use to do a test pull.
+ +## Global Flags + + diff --git a/docs/reference/replicated-cli-release-compatibility.md b/docs/reference/replicated-cli-release-compatibility.md index a2c897c798..82f944df01 100644 --- a/docs/reference/replicated-cli-release-compatibility.md +++ b/docs/reference/replicated-cli-release-compatibility.md @@ -1,4 +1,4 @@ -import Help from "../partials/replicated-cli/_help.mdx" +import GlobalFlags from "../partials/replicated-cli/_global-flags.mdx" # release compatibility @@ -28,7 +28,6 @@ Where `SEQUENCE` is the sequence number for the target release. bool If set, the compatibility will be reported as a failure. - --notes string @@ -46,6 +45,10 @@ Where `SEQUENCE` is the sequence number for the target release. +## Global Flags + + + ## Example ```bash diff --git a/docs/reference/replicated-cli-release-create.md b/docs/reference/replicated-cli-release-create.md index c87e6779b9..33fffa0601 100644 --- a/docs/reference/replicated-cli-release-create.md +++ b/docs/reference/replicated-cli-release-create.md @@ -1,10 +1,10 @@ -import Help from "../partials/replicated-cli/_help.mdx" import YamlDir from "../partials/replicated-cli/_yaml-dir.mdx" import ChartYamlDirReqs from "../partials/replicated-cli/_chart-yaml-dir-reqs.mdx" +import GlobalFlags from "../partials/replicated-cli/_global-flags.mdx" # release create -Create a new release using a collection of application manifest files and/or one or more Helm charts. +Create a new release. ## Usage ```bash @@ -22,25 +22,35 @@ Additional flags returned by `--help` that are not supported by Replicated are o Description - --yaml-dir - path -

The local directory containing multiple YAML manifest files for a release. (Required)

- + --auto + + Generate default values for use in CI + - --promote - string - Channel name to promote this release to. Case sensitive. + --confirm-auto + + Auto-accept the configuration generated by the --auto flag --ensure-channel When used with --promote channel, creates the channel if it does not exist. + + --fail-on + string + The minimum severity to cause the command to exit with a non-zero exit code. Supported values are [info, warn, error, none]. **Default:** "error" + --lint Lint a manifest directory prior to creation of the release. For more information, see Linter Rules. + + --promote + string + Channel name to promote this release to. Case sensitive. + --release-notes string @@ -51,9 +61,17 @@ Additional flags returned by `--help` that are not supported by Replicated are o string

When used with --promote channel, sets the version label for the release in this channel.

If semantic versioning is enabled on the channel, then the version label must be a valid semantic version number. See Semantic Versioning in About Releases.

- + + --yaml-dir + path +

The local directory containing multiple YAML manifest files for a release. (Required)

+ +## Global Flags + + + ## Examples ### `--yaml-dir` diff --git a/docs/reference/replicated-cli-release-download.md b/docs/reference/replicated-cli-release-download.md index 5acc06985b..bd2626cf76 100644 --- a/docs/reference/replicated-cli-release-download.md +++ b/docs/reference/replicated-cli-release-download.md @@ -1,17 +1,18 @@ -import Help from "../partials/replicated-cli/_help.mdx" -import App from "../partials/replicated-cli/_app.mdx" -import Token from "../partials/replicated-cli/_token.mdx" +import GlobalFlags from "../partials/replicated-cli/_global-flags.mdx" # release download -Download the config manifest file for a release. +Download application manifests for a release to a specified directory. -**Note:** This command is the same as the `release inspect` command for applications that are not packaged with Replicated. +:::note +For application releases that do not support installation a Replicated installer (Replicated Embedded Cluster, Replicated KOTS, Replicated kURL), `release download` is equivalent to the [`release inspect`](replicated-cli-release-inspect) command. +::: ## Usage ```bash -replicated release download SEQUENCE -d ./appyaml +replicated release download SEQUENCE --dest ./DIRECTORY_NAME ``` +Where `SEQUENCE` is the sequence number for the target release. @@ -24,12 +25,14 @@ replicated release download SEQUENCE -d ./appyaml - - -
string Directory where release manifests should be downloaded.
-## Examples +## Global Flags + + + +## Example + ```bash replicated release download 9 -d ./appyaml • Fetching Release 9 ✓ diff --git a/docs/reference/replicated-cli-release-inspect.md b/docs/reference/replicated-cli-release-inspect.md index c8cf164831..eb605aa980 100644 --- a/docs/reference/replicated-cli-release-inspect.md +++ b/docs/reference/replicated-cli-release-inspect.md @@ -1,4 +1,4 @@ -import Help from "../partials/replicated-cli/_help.mdx" +import GlobalFlags from "../partials/replicated-cli/_global-flags.mdx" # release inspect @@ -12,14 +12,9 @@ replicated release inspect SEQUENCE [flags] Where `SEQUENCE` is the sequence number for the target release. - - - - - - - -
FlagType (if applicable)Description
+## Global Flags + + ## Example diff --git a/docs/reference/replicated-cli-release-lint.md b/docs/reference/replicated-cli-release-lint.md index 6e4d998db4..837d97bd98 100644 --- a/docs/reference/replicated-cli-release-lint.md +++ b/docs/reference/replicated-cli-release-lint.md @@ -1,18 +1,17 @@ -import Help from "../partials/replicated-cli/_help.mdx" import YamlDir from "../partials/replicated-cli/_yaml-dir.mdx" +import GlobalFlags from "../partials/replicated-cli/_global-flags.mdx" # release lint Lint a directory of application manifest files. For more information, see [Linter Rules](linter). +Returns exit code 1 when an error in linting is discovered. Otherwise, returns exit code 0 (such as for info and warning messages). + ## Usage ```bash replicated release lint --yaml-dir YAML_DIR [flags] ``` -* _`YAML_DIR` corresponds to the root directory of the YAML application manifest files._ -* _Returns exit code 1 when an error in linting is discovered. Otherwise, returns exit codse 0 (such as for info and warning messages)._ - @@ -25,9 +24,12 @@ replicated release lint --yaml-dir YAML_DIR [flags] -
Flagstring The minimum severity of a linting rule to cause a non-zero exit code. Supported values are info, warn, error, none. Default: Error
+## Global Flags + + + ## Examples ```bash replicated release lint --yaml-dir ./manifests --fail-on error diff --git a/docs/reference/replicated-cli-release-ls.md b/docs/reference/replicated-cli-release-ls.md index 57692bba96..c2a363a56a 100644 --- a/docs/reference/replicated-cli-release-ls.md +++ b/docs/reference/replicated-cli-release-ls.md @@ -1,6 +1,4 @@ -import Help from "../partials/replicated-cli/_help.mdx" -import App from "../partials/replicated-cli/_app.mdx" -import Token from "../partials/replicated-cli/_token.mdx" +import GlobalFlags from "../partials/replicated-cli/_global-flags.mdx" # release ls @@ -11,16 +9,9 @@ List all of an app's releases. replicated release ls ``` - - - - - - - - - -
FlagType (if applicable)Description
+## Global Flags + + ## Example ```bash diff --git a/docs/reference/replicated-cli-release-promote.md b/docs/reference/replicated-cli-release-promote.md index e1d5fa13ab..7929b3daa1 100644 --- a/docs/reference/replicated-cli-release-promote.md +++ b/docs/reference/replicated-cli-release-promote.md @@ -1,6 +1,4 @@ -import Help from "../partials/replicated-cli/_help.mdx" -import App from "../partials/replicated-cli/_app.mdx" -import Token from "../partials/replicated-cli/_token.mdx" +import GlobalFlags from "../partials/replicated-cli/_global-flags.mdx" # release promote @@ -20,8 +18,6 @@ replicated release promote SEQUENCE CHANNEL_ID [Flags] Type (if applicable) Description - - --release-notes string @@ -32,7 +28,6 @@ replicated release promote SEQUENCE CHANNEL_ID [Flags] Prevents users from skipping this release during application upgrades. For more information, see Managing Releases with the Vendor Portal. - --version string @@ -40,6 +35,10 @@ replicated release promote SEQUENCE CHANNEL_ID [Flags] +## Global Flags + + + ## Examples ```bash replicated release promote 24 Beta --optional --version 1.3.0 --release-notes "Optional Beta release for feature X" diff --git a/docs/reference/replicated-cli-release-update.md b/docs/reference/replicated-cli-release-update.md index 50266dae41..de2814057e 100644 --- a/docs/reference/replicated-cli-release-update.md +++ b/docs/reference/replicated-cli-release-update.md @@ -1,7 +1,5 @@ -import Help from "../partials/replicated-cli/_help.mdx" -import App from "../partials/replicated-cli/_app.mdx" -import Token from "../partials/replicated-cli/_token.mdx" import YamlDir from "../partials/replicated-cli/_yaml-dir.mdx" +import GlobalFlags from "../partials/replicated-cli/_global-flags.mdx" # release update @@ -12,9 +10,6 @@ Updates the YAML application manifests for a given release. replicated release update --yaml-dir YAML_DIR [Flags] ``` -* _`YAML_DIR` corresponds to the root directory of the YAML application manifest files._ -* _Additional flags returned by `--help` that are not supported in KOTS have been omitted from the list below_ - @@ -22,12 +17,14 @@ replicated release update --yaml-dir YAML_DIR [Flags] - - -
FlagDescription
+## Global Flags + + + ## Examples + ```bash replicated release update 25 --yaml-dir ./manifests Release 25 updated diff --git a/docs/reference/replicated-cli-version-upgrade.mdx b/docs/reference/replicated-cli-version-upgrade.mdx new file mode 100644 index 0000000000..c68082e34c --- /dev/null +++ b/docs/reference/replicated-cli-version-upgrade.mdx @@ -0,0 +1,15 @@ +import GlobalFlags from "../partials/replicated-cli/_global-flags.mdx" + +# version upgrade + +Download, verify, and upgrade the Replicated CLI to the latest version. + +## Usage + +```bash +replicated version upgrade +``` + +## Global Flags + + \ No newline at end of file diff --git a/docs/reference/replicated-cli-version.mdx b/docs/reference/replicated-cli-version.mdx new file mode 100644 index 0000000000..5e11e5de98 --- /dev/null +++ b/docs/reference/replicated-cli-version.mdx @@ -0,0 +1,30 @@ +import GlobalFlags from "../partials/replicated-cli/_global-flags.mdx" + +# version + +Print the current version and exit + +## Usage + +```bash +replicated version [flags] +``` + +## Flags + + + + + + + + + + + + +
FlagType (if applicable)Description
`--json`stringOutput version info in jso.
+ +## Global Flags + + \ No newline at end of file diff --git a/sidebars.js b/sidebars.js index 7a2a24dfb5..017a76dfab 100644 --- a/sidebars.js +++ b/sidebars.js @@ -614,68 +614,160 @@ const sidebars = { label: 'Replicated CLI', items: [ 'reference/replicated-cli-installing', - 'reference/replicated-cli-api', - 'reference/replicated-cli-app-create', - 'reference/replicated-cli-app-delete', - 'reference/replicated-cli-app-ls', - 'reference/replicated-cli-channel-create', - 'reference/replicated-cli-channel-delete', - 'reference/replicated-cli-channel-disable-semver', - 'reference/replicated-cli-channel-enable-semver', - 'reference/replicated-cli-channel-inspect', - 'reference/replicated-cli-channel-ls', - 'reference/replicated-cli-cluster-create', - 'reference/replicated-cli-cluster-kubeconfig', - 'reference/replicated-cli-cluster-ls', - 'reference/replicated-cli-cluster-nodegroup-ls', - 'reference/replicated-cli-cluster-prepare', - 'reference/replicated-cli-cluster-port-expose', - 'reference/replicated-cli-cluster-port-ls', - 'reference/replicated-cli-cluster-port-rm', - 'reference/replicated-cli-cluster-rm', - 'reference/replicated-cli-cluster-shell', - 'reference/replicated-cli-cluster-update-ttl', - 'reference/replicated-cli-cluster-upgrade', - 'reference/replicated-cli-cluster-versions', - 'reference/replicated-cli-cluster-addon-ls', - 'reference/replicated-cli-cluster-addon-rm', - 'reference/replicated-cli-cluster-addon-create', - 'reference/replicated-cli-cluster-addon-create-object-store', - 'reference/replicated-cli-completion', - 'reference/replicated-cli-completion-bash', - 'reference/replicated-cli-completion-fish', - 'reference/replicated-cli-completion-powershell', - 'reference/replicated-cli-completion-zsh', - 'reference/replicated-cli-customer-create', - 'reference/replicated-cli-customer-download-license', - 'reference/replicated-cli-customer-ls', - 'reference/replicated-cli-installer-create', - 'reference/replicated-cli-installer-ls', - 'reference/replicated-cli-instance-inspect', - 'reference/replicated-cli-instance-ls', - 'reference/replicated-cli-instance-tag', + { + type: 'category', + label: 'api', + items: [ + 'reference/replicated-cli-api', + 'reference/replicated-cli-api-patch', + 'reference/replicated-cli-api-post', + 'reference/replicated-cli-api-put', + 'reference/replicated-cli-api-get', + ], + }, + { + type: 'category', + label: 'app', + items: [ + 'reference/replicated-cli-app-create', + 'reference/replicated-cli-app-ls', + 'reference/replicated-cli-app-delete', + ], + }, + { + type: 'category', + label: 'channel', + items: [ + 'reference/replicated-cli-channel-create', + 'reference/replicated-cli-channel-disable-semver', + 'reference/replicated-cli-channel-enable-semver', + 'reference/replicated-cli-channel-inspect', + 'reference/replicated-cli-channel-ls', + 'reference/replicated-cli-channel-delete', + ], + }, + { + type: 'category', + label: 'cluster', + items: [ + 'reference/replicated-cli-cluster-addon-ls', + 'reference/replicated-cli-cluster-addon-rm', + { + type: 'category', + label: 'cluster addon create', + items: [ + 'reference/replicated-cli-cluster-addon-create', + 'reference/replicated-cli-cluster-addon-create-object-store', + ], + }, + 'reference/replicated-cli-cluster-create', + 'reference/replicated-cli-cluster-kubeconfig', + 'reference/replicated-cli-cluster-ls', + 'reference/replicated-cli-cluster-nodegroup-ls', + 'reference/replicated-cli-cluster-port-expose', + 'reference/replicated-cli-cluster-port-ls', + 'reference/replicated-cli-cluster-port-rm', + 'reference/replicated-cli-cluster-prepare', + 'reference/replicated-cli-cluster-rm', + 'reference/replicated-cli-cluster-shell', + 'reference/replicated-cli-cluster-update-ttl', + 'reference/replicated-cli-cluster-upgrade', + 'reference/replicated-cli-cluster-versions', + ], + }, + { + type: 'category', + label: 'completion', + items: [ + 'reference/replicated-cli-completion', + 'reference/replicated-cli-completion-bash', + 'reference/replicated-cli-completion-fish', + 'reference/replicated-cli-completion-powershell', + 'reference/replicated-cli-completion-zsh', + ], + }, + { + type: 'category', + label: 'customer', + items: [ + 'reference/replicated-cli-customer-archive', + 'reference/replicated-cli-customer-create', + 'reference/replicated-cli-customer-download-license', + 'reference/replicated-cli-customer-inspect', + 'reference/replicated-cli-customer-ls', + 'reference/replicated-cli-customer-update', + ], + }, + { + type: 'category', + label: 'default', + items: [ + 'reference/replicated-cli-default', + 'reference/replicated-cli-default-clear', + 'reference/replicated-cli-default-clearall', + 'reference/replicated-cli-default-set', + 'reference/replicated-cli-default-show', + ], + }, + { + type: 'category', + label: 'installer', + items: [ + 'reference/replicated-cli-installer-create', + 'reference/replicated-cli-installer-ls', + ], + }, + { + type: 'category', + label: 'instance', + items: [ + 'reference/replicated-cli-instance-inspect', + 'reference/replicated-cli-instance-ls', + 'reference/replicated-cli-instance-tag', + ], + }, 'reference/replicated-cli-login', 'reference/replicated-cli-logout', - 'reference/replicated-cli-registry-add', - 'reference/replicated-cli-registry-add-dockerhub', - 'reference/replicated-cli-registry-add-ecr', - 'reference/replicated-cli-registry-add-gar', - 'reference/replicated-cli-registry-add-gcr', - 'reference/replicated-cli-registry-add-ghcr', - 'reference/replicated-cli-registry-add-other', - 'reference/replicated-cli-registry-add-quay', - 'reference/replicated-cli-registry-logs', - 'reference/replicated-cli-registry-ls', - 'reference/replicated-cli-registry-rm', - 'reference/replicated-cli-registry-test', - 'reference/replicated-cli-release-create', - 'reference/replicated-cli-release-compatibility', - 'reference/replicated-cli-release-download', - 'reference/replicated-cli-release-inspect', - 'reference/replicated-cli-release-lint', - 'reference/replicated-cli-release-ls', - 'reference/replicated-cli-release-promote', - 'reference/replicated-cli-release-update', + { + type: 'category', + label: 'registry', + items: [ + 'reference/replicated-cli-registry-add', + 'reference/replicated-cli-registry-add-dockerhub', + 'reference/replicated-cli-registry-add-ecr', + 'reference/replicated-cli-registry-add-gar', + 'reference/replicated-cli-registry-add-gcr', + 'reference/replicated-cli-registry-add-ghcr', + 'reference/replicated-cli-registry-add-other', + 'reference/replicated-cli-registry-add-quay', + 'reference/replicated-cli-registry-logs', + 'reference/replicated-cli-registry-ls', + 'reference/replicated-cli-registry-rm', + 'reference/replicated-cli-registry-test', + ], + }, + { + type: 'category', + label: 'release', + items: [ + 'reference/replicated-cli-release-compatibility', + 'reference/replicated-cli-release-create', + 'reference/replicated-cli-release-download', + 'reference/replicated-cli-release-inspect', + 'reference/replicated-cli-release-lint', + 'reference/replicated-cli-release-ls', + 'reference/replicated-cli-release-promote', + 'reference/replicated-cli-release-update', + ], + }, + { + type: 'category', + label: 'version', + items: [ + 'reference/replicated-cli-version', + 'reference/replicated-cli-version-upgrade', + ], + }, ], }, {