diff --git a/docs/reference/replicated-cli-api-get.mdx b/docs/reference/replicated-cli-api-get.mdx new file mode 100644 index 0000000000..2bd23144c9 --- /dev/null +++ b/docs/reference/replicated-cli-api-get.mdx @@ -0,0 +1,43 @@ +# replicated api get + +Make ad-hoc GET API calls to the Replicated API + +### Synopsis + +This is essentially like curl for the Replicated API, but +uses your local credentials and prints the response unmodified. + +We recommend piping the output to jq for easier reading. + +Pass the PATH of the request as the final argument. Do not include the host or version. + +``` +replicated api get [flags] +``` + +### Examples + +``` +replicated api get /v3/apps +``` + +### Options + +``` + -h, --help help for get +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated api](replicated-cli-api) - Make ad-hoc API calls to the Replicated API + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-api-patch.mdx b/docs/reference/replicated-cli-api-patch.mdx new file mode 100644 index 0000000000..b0600f17b8 --- /dev/null +++ b/docs/reference/replicated-cli-api-patch.mdx @@ -0,0 +1,44 @@ +# replicated api patch + +Make ad-hoc PATCH API calls to the Replicated API + +### Synopsis + +This is essentially like curl for the Replicated API, but +uses your local credentials and prints the response unmodified. + +We recommend piping the output to jq for easier reading. + +Pass the PATH of the request as the final argument. Do not include the host or version. + +``` +replicated api patch [flags] +``` + +### Examples + +``` +replicated api patch /v3/customer/2VffY549paATVfHSGpJhjh6Ehpy -b '{"name":"Valuable Customer"}' +``` + +### Options + +``` + -b, --body string JSON body to send with the request + -h, --help help for patch +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated api](replicated-cli-api) - Make ad-hoc API calls to the Replicated API + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-api-post.mdx b/docs/reference/replicated-cli-api-post.mdx new file mode 100644 index 0000000000..b9f9993ea3 --- /dev/null +++ b/docs/reference/replicated-cli-api-post.mdx @@ -0,0 +1,44 @@ +# replicated api post + +Make ad-hoc POST API calls to the Replicated API + +### Synopsis + +This is essentially like curl for the Replicated API, but +uses your local credentials and prints the response unmodified. + +We recommend piping the output to jq for easier reading. + +Pass the PATH of the request as the final argument. Do not include the host or version. + +``` +replicated api post [flags] +``` + +### Examples + +``` +replicated api post /v3/app/2EuFxKLDxKjPNk2jxMTmF6Vxvxu/channel -b '{"name":"marc-waz-here"}' +``` + +### Options + +``` + -b, --body string JSON body to send with the request + -h, --help help for post +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated api](replicated-cli-api) - Make ad-hoc API calls to the Replicated API + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-api-put.mdx b/docs/reference/replicated-cli-api-put.mdx new file mode 100644 index 0000000000..1010f0a90d --- /dev/null +++ b/docs/reference/replicated-cli-api-put.mdx @@ -0,0 +1,44 @@ +# replicated api put + +Make ad-hoc PUT API calls to the Replicated API + +### Synopsis + +This is essentially like curl for the Replicated API, but +uses your local credentials and prints the response unmodified. + +We recommend piping the output to jq for easier reading. + +Pass the PATH of the request as the final argument. Do not include the host or version. + +``` +replicated api put [flags] +``` + +### Examples + +``` +replicated api put /v3/app/2EuFxKLDxKjPNk2jxMTmF6Vxvxu/channel/2QLPm10JPkta7jO3Z3Mk4aXTPyZ -b '{"name":"marc-waz-here2"}' +``` + +### Options + +``` + -b, --body string JSON body to send with the request + -h, --help help for put +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated api](replicated-cli-api) - Make ad-hoc API calls to the Replicated API + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-api.md b/docs/reference/replicated-cli-api.md deleted file mode 100644 index b988c15b88..0000000000 --- a/docs/reference/replicated-cli-api.md +++ /dev/null @@ -1,59 +0,0 @@ -import Help from "../partials/replicated-cli/_help.mdx" - -# api - -Make adhoc calls 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 [command] -``` - -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 - - - - - - - - - - - - - - - - - - -
CommandDescription
getMake adhoc GET API calls to the Vendor API v3
postMake adhoc POST API calls to the Vendor API v3
putMake adhoc PUT API calls to the Vendor API v3
- -### Flags - - - - - - - - -
FlagType (if applicable)Description
- -## Examples - -```bash -replicated api get /v3/apps -``` - -```bash -replicated api put /v3/app/2EuFxKLDxKjPNk2jxMTmF6Vxvxu/channel/2QLPm10JPkta7jO3Z3Mk4aXTPyZ -b '{"name":"put-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.mdx b/docs/reference/replicated-cli-api.mdx new file mode 100644 index 0000000000..80b1f78bd2 --- /dev/null +++ b/docs/reference/replicated-cli-api.mdx @@ -0,0 +1,28 @@ +# replicated api + +Make ad-hoc API calls to the Replicated API + +### Options + +``` + -h, --help help for api +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated](replicated) - Manage your Commercial Software Distribution Lifecycle using Replicated +* [replicated api get](replicated-cli-api-get) - Make ad-hoc GET API calls to the Replicated API +* [replicated api patch](replicated-cli-api-patch) - Make ad-hoc PATCH API calls to the Replicated API +* [replicated api post](replicated-cli-api-post) - Make ad-hoc POST API calls to the Replicated API +* [replicated api put](replicated-cli-api-put) - Make ad-hoc PUT API calls to the Replicated API + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-app-create.md b/docs/reference/replicated-cli-app-create.md deleted file mode 100644 index 3248b31c9f..0000000000 --- a/docs/reference/replicated-cli-app-create.md +++ /dev/null @@ -1,28 +0,0 @@ -import Token from "../partials/replicated-cli/_token.mdx" -import Help from "../partials/replicated-cli/_help.mdx" - -# app create - -Create an application. - -## Usage -```bash -replicated app create NAME -``` - - - - - - - - - -
FlagType (if applicable)Description
- -## Examples -```bash -replicated app create cli-app -ID NAME SLUG SCHEDULER -1xy9t8G9CO0PRGzTwSwWFkMUjZO cli-app cli-app kots -``` diff --git a/docs/reference/replicated-cli-app-create.mdx b/docs/reference/replicated-cli-app-create.mdx new file mode 100644 index 0000000000..7fb7fe234e --- /dev/null +++ b/docs/reference/replicated-cli-app-create.mdx @@ -0,0 +1,52 @@ +# replicated app create + +Create a new application + +### Synopsis + +Create a new application in your Replicated account. + +This command allows you to initialize a new application that can be distributed +and managed using the KOTS platform. When you create a new app, it will be set up +with default configurations, which you can later customize. + +The NAME argument is required and will be used as the application's name. + +``` +replicated app create NAME [flags] +``` + +### Examples + +``` +# Create a new app named "My App" +replicated app create "My App" + +# Create a new app and output the result in JSON format +replicated app create "Another App" --output json + +# Create a new app with a specific name and view details in table format +replicated app create "Custom App" --output table +``` + +### Options + +``` + -h, --help help for create + --output string The output format to use. One of: json|table (default: table) (default "table") +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated app](replicated-cli-app) - Manage applications + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-app-delete.md b/docs/reference/replicated-cli-app-delete.md deleted file mode 100644 index 217c8fb9fe..0000000000 --- a/docs/reference/replicated-cli-app-delete.md +++ /dev/null @@ -1,36 +0,0 @@ -import Token from "../partials/replicated-cli/_token.mdx" -import Help from "../partials/replicated-cli/_help.mdx" - -# app delete - -Delete an application. - -## Usage -```bash -replicated app delete NAME -``` - - - - - - - - - - - - - - -
FlagType (if applicable)Description
-f, --forceSkip the confirmation prompt. This action cannot be undone.
- -## Examples -```bash -replicated app delete deletion-example - • Fetching App ✓ -ID NAME SLUG SCHEDULER -1xyAIzrmbvqHzzcKPbTmmrTxhl4 deletion-example deletion-example kots -Delete the above listed application? There is no undo: yes█ - • Deleting App ✓ -``` diff --git a/docs/reference/replicated-cli-app-ls.md b/docs/reference/replicated-cli-app-ls.md deleted file mode 100644 index 1683f214ea..0000000000 --- a/docs/reference/replicated-cli-app-ls.md +++ /dev/null @@ -1,39 +0,0 @@ -import Token from "../partials/replicated-cli/_token.mdx" -import Help from "../partials/replicated-cli/_help.mdx" - -# app ls - -List all applications, or specify the application you want to list. - -## Usage -```bash -replicated app ls -``` - - - - - - - - - -
FlagType (if applicable)Description
- -## Examples - -List all created apps: -```bash -replicated app ls -ID NAME SLUG SCHEDULER -cqzmRRIdJtZ_E82Cl36nkBDSmGrG2uoe sentry-enterprise sentry-enterprise-1 kots -1xy9t8G9CO0PRGzTwSwWFkMUjZO cli-app cli-app kots -XlkTz6qxXepG_HjK_vUFlLUY14p05wO1 default-kots default-kots kots -``` - -List a specific app: -```bash -replicated app ls default-kots -ID NAME SLUG SCHEDULER -XlkTz6qxXepG_HjK_vUFlLUY14p05wO1 default-kots default-kots kots -``` diff --git a/docs/reference/replicated-cli-app-ls.mdx b/docs/reference/replicated-cli-app-ls.mdx new file mode 100644 index 0000000000..80eb4e54aa --- /dev/null +++ b/docs/reference/replicated-cli-app-ls.mdx @@ -0,0 +1,57 @@ +# replicated app ls + +List applications + +### Synopsis + +List all applications in your Replicated account, +or search for a specific application by name or ID. + +This command displays information about your applications, including their +names, IDs, and associated channels. If a NAME argument is provided, it will +filter the results to show only applications that match the given name or ID. + +The output can be customized using the --output flag to display results in +either table or JSON format. + +``` +replicated app ls [NAME] [flags] +``` + +### Examples + +``` +# List all applications +replicated app ls + +# Search for a specific application by name +replicated app ls "My App" + +# List applications and output in JSON format +replicated app ls --output json + +# Search for an application and display results in table format +replicated app ls "App Name" --output table +``` + +### Options + +``` + -h, --help help for ls + --output string The output format to use. One of: json|table (default: table) (default "table") +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated app](replicated-cli-app) - Manage applications + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-app-rm.mdx b/docs/reference/replicated-cli-app-rm.mdx new file mode 100644 index 0000000000..cfeb71d225 --- /dev/null +++ b/docs/reference/replicated-cli-app-rm.mdx @@ -0,0 +1,52 @@ +# replicated app rm + +Delete an application + +### Synopsis + +Delete an application from your Replicated account. + +This command allows you to permanently remove an application from your account. +Once deleted, the application and all associated data will be irretrievably lost. + +Use this command with caution as there is no way to undo this operation. + +``` +replicated app rm NAME [flags] +``` + +### Examples + +``` +# Delete a app named "My App" +replicated app delete "My App" + +# Delete an app and skip the confirmation prompt +replicated app delete "Another App" --force + +# Delete an app and output the result in JSON format +replicated app delete "Custom App" --output json +``` + +### Options + +``` + -f, --force Skip confirmation prompt. There is no undo for this action. + -h, --help help for rm + --output string The output format to use. One of: json|table (default: table) (default "table") +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated app](replicated-cli-app) - Manage applications + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-app.mdx b/docs/reference/replicated-cli-app.mdx new file mode 100644 index 0000000000..3d29dace26 --- /dev/null +++ b/docs/reference/replicated-cli-app.mdx @@ -0,0 +1,64 @@ +# replicated app + +Manage applications + +### Synopsis + +The app command allows you to manage applications in your Replicated account. + +This command provides a suite of subcommands for creating, listing, updating, and +deleting applications. You can perform operations such as creating new apps, +viewing app details, modifying app settings, and removing apps from your account. + +Use the various subcommands to: +- Create new applications +- List all existing applications +- View details of a specific application +- Update application settings +- Delete applications from your account + +### Examples + +``` +# List all applications +replicated app ls + +# Create a new application +replicated app create "My New App" + +# View details of a specific application +replicated app inspect "My App Name" + +# Delete an application +replicated app delete "App to Remove" + +# Update an application's settings +replicated app update "My App" --channel stable + +# List applications with custom output format +replicated app ls --output json +``` + +### Options + +``` + -h, --help help for app +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated](replicated) - Manage your Commercial Software Distribution Lifecycle using Replicated +* [replicated app create](replicated-cli-app-create) - Create a new application +* [replicated app ls](replicated-cli-app-ls) - List applications +* [replicated app rm](replicated-cli-app-rm) - Delete an application + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-channel-create.md b/docs/reference/replicated-cli-channel-create.md deleted file mode 100644 index 6582743b6b..0000000000 --- a/docs/reference/replicated-cli-channel-create.md +++ /dev/null @@ -1,40 +0,0 @@ -import Help from "../partials/replicated-cli/_help.mdx" -import App from "../partials/replicated-cli/_app.mdx" -import Token from "../partials/replicated-cli/_token.mdx" - -# channel create - -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' -``` - - - - - - - - - - - - - - - - - - - - -
FlagType (if applicable)Description
--descriptionstringA longer description of this channel
--namestringThe name of this channel. (Required)
- -## Examples -```bash -replicated channel create --name cli-created --description "this is a description for a channel" -ID NAME RELEASE VERSION -1xyB2Mgbg9N7rExShfbdBYIuzeW cli-created 1 0.0.1 -``` diff --git a/docs/reference/replicated-cli-channel-create.mdx b/docs/reference/replicated-cli-channel-create.mdx new file mode 100644 index 0000000000..a9c58b7c2f --- /dev/null +++ b/docs/reference/replicated-cli-channel-create.mdx @@ -0,0 +1,41 @@ +# replicated channel create + +Create a new channel in your app + +### Synopsis + +Create a new channel in your app and print the channel on success. + +``` +replicated channel create [flags] +``` + +### Examples + +``` +replicated channel create --name Beta --description 'New features subject to change' +``` + +### Options + +``` + --description string A longer description of this channel + -h, --help help for create + --name string The name of this channel + --output string The output format to use. One of: json|table (default: table) (default "table") +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated channel](replicated-cli-channel) - List channels + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-channel-delete.md b/docs/reference/replicated-cli-channel-delete.md deleted file mode 100644 index 6192d77adb..0000000000 --- a/docs/reference/replicated-cli-channel-delete.md +++ /dev/null @@ -1,33 +0,0 @@ -import Help from "../partials/replicated-cli/_help.mdx" -import App from "../partials/replicated-cli/_app.mdx" -import Token from "../partials/replicated-cli/_token.mdx" - -# channel delete - -Delete (archive) a channel. - -## Usage -```bash -replicated channel rm CHANNEL_ID -``` - -:::note -You must use the channel ID to delete the channel, not the channel name. -::: - - - - - - - - - - -
FlagType (if applicable)Description
- -## Examples -```bash -replicated channel rm 1xyB2Mgbg9N7rExShfbdBYIuzeW -Channel 1xyB2Mgbg9N7rExShfbdBYIuzeW successfully archived -``` diff --git a/docs/reference/replicated-cli-channel-disable-semantic-versioning.mdx b/docs/reference/replicated-cli-channel-disable-semantic-versioning.mdx new file mode 100644 index 0000000000..57088a1d2b --- /dev/null +++ b/docs/reference/replicated-cli-channel-disable-semantic-versioning.mdx @@ -0,0 +1,38 @@ +# replicated channel disable-semantic-versioning + +Disable semantic versioning for CHANNEL_ID + +### Synopsis + +Disable semantic versioning for the CHANNEL_ID. + +``` +replicated channel disable-semantic-versioning CHANNEL_ID [flags] +``` + +### Examples + +``` +replicated channel disable-semantic-versioning CHANNEL_ID +``` + +### Options + +``` + -h, --help help for disable-semantic-versioning +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated channel](replicated-cli-channel) - List channels + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-channel-disable-semver.md b/docs/reference/replicated-cli-channel-disable-semver.md deleted file mode 100644 index d48c2f31b3..0000000000 --- a/docs/reference/replicated-cli-channel-disable-semver.md +++ /dev/null @@ -1,29 +0,0 @@ -import Help from "../partials/replicated-cli/_help.mdx" -import App from "../partials/replicated-cli/_app.mdx" -import Token from "../partials/replicated-cli/_token.mdx" - -# channel disable-semantic-versioning - -Disable semantic versioning for a channel. - -### Usage -```bash -replicated channel disable-semantic-versioning CHANNEL_ID -``` - - - - - - - - - - -
FlagType (if applicable)Description
- -### Examples -```bash -replicated channel disable-semantic-versioning 1xyB2Mgbg9N7rExShfbdBYIuzeW -Semantic versioning successfully disabled for channel 1xyB2Mgbg9N7rExShfbdBYIuzeW -``` diff --git a/docs/reference/replicated-cli-channel-enable-semantic-versioning.mdx b/docs/reference/replicated-cli-channel-enable-semantic-versioning.mdx new file mode 100644 index 0000000000..8027f44cad --- /dev/null +++ b/docs/reference/replicated-cli-channel-enable-semantic-versioning.mdx @@ -0,0 +1,38 @@ +# replicated channel enable-semantic-versioning + +Enable semantic versioning for CHANNEL_ID + +### Synopsis + +Enable semantic versioning for the CHANNEL_ID. + +``` +replicated channel enable-semantic-versioning CHANNEL_ID [flags] +``` + +### Examples + +``` +replicated channel enable-semantic-versioning CHANNEL_ID +``` + +### Options + +``` + -h, --help help for enable-semantic-versioning +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated channel](replicated-cli-channel) - List channels + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-channel-enable-semver.md b/docs/reference/replicated-cli-channel-enable-semver.md deleted file mode 100644 index 68ef96819b..0000000000 --- a/docs/reference/replicated-cli-channel-enable-semver.md +++ /dev/null @@ -1,29 +0,0 @@ -import Help from "../partials/replicated-cli/_help.mdx" -import App from "../partials/replicated-cli/_app.mdx" -import Token from "../partials/replicated-cli/_token.mdx" - -# channel enable-semantic-versioning - -Enable semantic versioning for a channel. - -### Usage -```bash -replicated channel enable-semantic-versioning CHANNEL_ID -``` - - - - - - - - - - -
FlagType (if applicable)Description
- -### Examples -```bash -replicated channel enable-semantic-versioning 1xyB2Mgbg9N7rExShfbdBYIuzeW -Semantic versioning successfully enabled for channel 1xyB2Mgbg9N7rExShfbdBYIuzeW -``` diff --git a/docs/reference/replicated-cli-channel-inspect.md b/docs/reference/replicated-cli-channel-inspect.md deleted file mode 100644 index 1cd22cb733..0000000000 --- a/docs/reference/replicated-cli-channel-inspect.md +++ /dev/null @@ -1,58 +0,0 @@ -import Help from "../partials/replicated-cli/_help.mdx" -import App from "../partials/replicated-cli/_app.mdx" -import Token from "../partials/replicated-cli/_token.mdx" - -# channel inspect - -Show the full details for a channel. - -## Usage -```bash -replicated channel inspect CHANNEL_ID -``` - - - - - - - - - - -
FlagType (if applicable)Description
- -## Examples -```bash -replicated channel inspect cli-created -ID: 1xyB2Mgbg9N7rExShfbdBYIuzeW -NAME: cli-created -DESCRIPTION: -RELEASE: 1 -VERSION: 0.0.1 -EXISTING: - - curl -fsSL https://kots.io/install | bash - kubectl kots install cli-app/cli-created - -EMBEDDED: - - curl -fsSL https://k8s.kurl.sh/cli-app-cli-created | sudo bash - -AIRGAP: - - curl -fSL -o cli-app-cli-created.tar.gz https://k8s.kurl.sh/bundle/cli-app-cli-created.tar.gz - # ... scp or sneakernet cli-app-cli-created.tar.gz to airgapped machine, then - tar xvf cli-app-cli-created.tar.gz - sudo bash ./install.sh airgap - -``` - -```bash -replicated channel inspect 1xyB2Mgbg9N7rExShfbdBYIuzeW -ID: 1xyB2Mgbg9N7rExShfbdBYIuzeW -NAME: cli-created -DESCRIPTION: this is a description for a channel -RELEASE: 1 -VERSION: 0.0.1 -``` diff --git a/docs/reference/replicated-cli-channel-inspect.mdx b/docs/reference/replicated-cli-channel-inspect.mdx new file mode 100644 index 0000000000..303f71c789 --- /dev/null +++ b/docs/reference/replicated-cli-channel-inspect.mdx @@ -0,0 +1,33 @@ +# replicated channel inspect + +Show full details for a channel + +### Synopsis + +Show full details for a channel + +``` +replicated channel inspect CHANNEL_ID [flags] +``` + +### Options + +``` + -h, --help help for inspect + --output string The output format to use. One of: json|table (default: table) (default "table") +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated channel](replicated-cli-channel) - List channels + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-channel-ls.md b/docs/reference/replicated-cli-channel-ls.md deleted file mode 100644 index ed104bcf92..0000000000 --- a/docs/reference/replicated-cli-channel-ls.md +++ /dev/null @@ -1,31 +0,0 @@ -import Help from "../partials/replicated-cli/_help.mdx" -import App from "../partials/replicated-cli/_app.mdx" -import Token from "../partials/replicated-cli/_token.mdx" - -# channel ls - -List all channels in your application. - -## Usage -```bash -replicated channel ls -``` - - - - - - - - - -
FlagType (if applicable)Description
- -## Examples -```bash -replicated channel ls -ID NAME RELEASE VERSION -QE1niv46O6RyHyzYp185mt5on1SOoVhn Stable 0.0.1 -Ng4EzwjhEdR_XzjOi032qjDKjI4cz3qs Beta 0.0.1 -BHrujJ-qAJiKQ2jIe8EP_GNukpegEF1o Unstable 0.1.2 -``` diff --git a/docs/reference/replicated-cli-channel-ls.mdx b/docs/reference/replicated-cli-channel-ls.mdx new file mode 100644 index 0000000000..85df3510ff --- /dev/null +++ b/docs/reference/replicated-cli-channel-ls.mdx @@ -0,0 +1,33 @@ +# replicated channel ls + +List all channels in your app + +### Synopsis + +List all channels in your app + +``` +replicated channel ls [flags] +``` + +### Options + +``` + -h, --help help for ls + --output string The output format to use. One of: json|table (default: table) (default "table") +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated channel](replicated-cli-channel) - List channels + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-channel-rm.mdx b/docs/reference/replicated-cli-channel-rm.mdx new file mode 100644 index 0000000000..dc111b28d2 --- /dev/null +++ b/docs/reference/replicated-cli-channel-rm.mdx @@ -0,0 +1,32 @@ +# replicated channel rm + +Remove (archive) a channel + +### Synopsis + +Remove (archive) a channel + +``` +replicated channel rm CHANNEL_ID [flags] +``` + +### Options + +``` + -h, --help help for rm +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated channel](replicated-cli-channel) - List channels + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-channel.mdx b/docs/reference/replicated-cli-channel.mdx new file mode 100644 index 0000000000..0a246939cd --- /dev/null +++ b/docs/reference/replicated-cli-channel.mdx @@ -0,0 +1,34 @@ +# replicated channel + +List channels + +### Synopsis + +List channels + +### Options + +``` + -h, --help help for channel +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated](replicated) - Manage your Commercial Software Distribution Lifecycle using Replicated +* [replicated channel create](replicated-cli-channel-create) - Create a new channel in your app +* [replicated channel disable-semantic-versioning](replicated-cli-channel-disable-semantic-versioning) - Disable semantic versioning for CHANNEL_ID +* [replicated channel enable-semantic-versioning](replicated-cli-channel-enable-semantic-versioning) - Enable semantic versioning for CHANNEL_ID +* [replicated channel inspect](replicated-cli-channel-inspect) - Show full details for a channel +* [replicated channel ls](replicated-cli-channel-ls) - List all channels in your app +* [replicated channel rm](replicated-cli-channel-rm) - Remove (archive) a channel + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-cluster-addon-create-object-store.md b/docs/reference/replicated-cli-cluster-addon-create-object-store.md deleted file mode 100644 index 27572ffd4d..0000000000 --- a/docs/reference/replicated-cli-cluster-addon-create-object-store.md +++ /dev/null @@ -1,51 +0,0 @@ -import Help from "../partials/replicated-cli/\_help.mdx" - -# cluster addon create object-store (Alpha) - -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)._ - -## Usage - -```bash -replicated cluster addon create object-store CLUSTER_ID --bucket-prefix BUCKET_PREFIX [flags] -``` - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FlagType (if applicable)Description
--bucket-prefixstringA prefix for the bucket name to be created. (Required)
--waitboolWait duration for add-on to be ready before exiting (leave empty to not wait).
--dry-runboolSimulate creation to verify that your inputs are valid without actually creating an add-on.
--outputstringThe output format to use. Value values: json, table or wide. Default: table
- -## Example - -```bash -$ 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-object-store.mdx b/docs/reference/replicated-cli-cluster-addon-create-object-store.mdx new file mode 100644 index 0000000000..c8beded06b --- /dev/null +++ b/docs/reference/replicated-cli-cluster-addon-create-object-store.mdx @@ -0,0 +1,55 @@ +# replicated cluster addon create object-store + +Create an object store bucket for a cluster. + +### Synopsis + +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. + +``` +replicated cluster addon create object-store CLUSTER_ID --bucket-prefix BUCKET_PREFIX [flags] +``` + +### Examples + +``` +# Create an object store bucket with a specified prefix +replicated cluster addon create object-store 05929b24 --bucket-prefix mybucket + +# Create an object store bucket and wait for it to be ready (up to 5 minutes) +replicated cluster addon create object-store 05929b24 --bucket-prefix mybucket --wait 5m + +# Perform a dry run to validate inputs without creating the bucket +replicated cluster addon create object-store 05929b24 --bucket-prefix mybucket --dry-run + +# Create an object store bucket and output the result in JSON format +replicated cluster addon create object-store 05929b24 --bucket-prefix mybucket --output json + +# Create an object store bucket with a custom prefix and wait for 10 minutes +replicated cluster addon create object-store 05929b24 --bucket-prefix custom-prefix --wait 10m +``` + +### Options + +``` + --bucket-prefix string A prefix for the bucket name to be created (required) + --dry-run Simulate creation to verify that your inputs are valid without actually creating an add-on + -h, --help help for object-store + --output string The output format to use. One of: json|table|wide (default: table) (default "table") + --wait duration Wait duration for add-on to be ready before exiting (leave empty to not wait) +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated cluster addon create](replicated-cli-cluster-addon-create) - Create cluster add-ons. + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-cluster-addon-create.md b/docs/reference/replicated-cli-cluster-addon-create.md deleted file mode 100644 index 2d259fb6db..0000000000 --- a/docs/reference/replicated-cli-cluster-addon-create.md +++ /dev/null @@ -1,35 +0,0 @@ -import Help from "../partials/replicated-cli/_help.mdx" - -# cluster addon create - -Create cluster add-ons. - -## Usage - -```bash -replicated cluster addon create [command] -``` - -The following `cluster addon create` commands are supported: - - - - - - - - - - -
CommandDescription
replicated cluster addon create object-storeCreate an object store bucket for a cluster.
- -The following flags are supported: - - - - - - - - -
FlagType (if applicable)Description
diff --git a/docs/reference/replicated-cli-cluster-addon-create.mdx b/docs/reference/replicated-cli-cluster-addon-create.mdx new file mode 100644 index 0000000000..20476d509f --- /dev/null +++ b/docs/reference/replicated-cli-cluster-addon-create.mdx @@ -0,0 +1,39 @@ +# replicated cluster addon create + +Create cluster add-ons. + +### Synopsis + +Create new add-ons for a cluster. This command allows you to add functionality or services to a cluster by provisioning the required add-ons. + +### Examples + +``` +# Create an object store bucket add-on for a cluster +replicated cluster addon create object-store CLUSTER_ID --bucket-prefix mybucket + +# Perform a dry run for creating an object store add-on +replicated cluster addon create object-store CLUSTER_ID --bucket-prefix mybucket --dry-run +``` + +### Options + +``` + -h, --help help for create +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated cluster addon](replicated-cli-cluster-addon) - Manage cluster add-ons. +* [replicated cluster addon create object-store](replicated-cli-cluster-addon-create-object-store) - Create an object store bucket for a cluster. + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-cluster-addon-ls.md b/docs/reference/replicated-cli-cluster-addon-ls.md deleted file mode 100644 index 96f6594d75..0000000000 --- a/docs/reference/replicated-cli-cluster-addon-ls.md +++ /dev/null @@ -1,33 +0,0 @@ -import Help from "../partials/replicated-cli/_help.mdx" - -# cluster addon ls - -List cluster add-ons for a cluster - -## Usage - -```bash -replicated cluster addon ls CLUSTER_ID [flags] -``` - - - - - - - - - - - - - -
FlagType (if applicable)Description
--outputstringThe output format to use. Value values: json, table or wide. Default: table
- -## Example - -```bash -$ 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-ls.mdx b/docs/reference/replicated-cli-cluster-addon-ls.mdx new file mode 100644 index 0000000000..944b31dc8f --- /dev/null +++ b/docs/reference/replicated-cli-cluster-addon-ls.mdx @@ -0,0 +1,48 @@ +# replicated cluster addon ls + +List cluster add-ons for a cluster. + +### Synopsis + +The 'cluster addon ls' command allows you to list all add-ons for a specific cluster. This command provides a detailed overview of the add-ons currently installed on the cluster, including their status and any relevant configuration details. + +This can be useful for monitoring the health and configuration of add-ons or performing troubleshooting tasks. + +``` +replicated cluster addon ls CLUSTER_ID [flags] +``` + +### Examples + +``` +# List add-ons for a cluster with default table output +replicated cluster addon ls CLUSTER_ID + +# List add-ons for a cluster with JSON output +replicated cluster addon ls CLUSTER_ID --output json + +# List add-ons for a cluster with wide table output +replicated cluster addon ls CLUSTER_ID --output wide +``` + +### Options + +``` + -h, --help help for ls + --output string The output format to use. One of: json|table|wide (default: table) (default "table") +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated cluster addon](replicated-cli-cluster-addon) - Manage cluster add-ons. + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-cluster-addon-rm.md b/docs/reference/replicated-cli-cluster-addon-rm.md deleted file mode 100644 index 630ca743e6..0000000000 --- a/docs/reference/replicated-cli-cluster-addon-rm.md +++ /dev/null @@ -1,32 +0,0 @@ -import Help from "../partials/replicated-cli/_help.mdx" - -# cluster addon rm - -Remove cluster add-on by ID - -## Usage - -```bash -replicated cluster addon rm CLUSTER_ID --id ADDON_ID [flags] -``` - - - - - - - - - - - - - -
FlagType (if applicable)Description
--idstringThe ID of the cluster add-on to remove. (Required)
- -## Example - -```bash -replicated cluster addon rm 4d2f7e70 --id 05929b24 -Add-on 05929b24 has been deleted -``` diff --git a/docs/reference/replicated-cli-cluster-addon-rm.mdx b/docs/reference/replicated-cli-cluster-addon-rm.mdx new file mode 100644 index 0000000000..ab9671c6e4 --- /dev/null +++ b/docs/reference/replicated-cli-cluster-addon-rm.mdx @@ -0,0 +1,42 @@ +# replicated cluster addon rm + +Remove cluster add-on by ID. + +### Synopsis + +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. + +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. + +``` +replicated cluster addon rm CLUSTER_ID --id ADDON_ID [flags] +``` + +### Examples + +``` +# Remove an add-on with ID 'abc123' from cluster 'cluster456' +replicated cluster addon rm cluster456 --id abc123 +``` + +### Options + +``` + -h, --help help for rm + --id string The ID of the cluster add-on to remove (required) +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated cluster addon](replicated-cli-cluster-addon) - Manage cluster add-ons. + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-cluster-addon.mdx b/docs/reference/replicated-cli-cluster-addon.mdx new file mode 100644 index 0000000000..e7aa9d1f7a --- /dev/null +++ b/docs/reference/replicated-cli-cluster-addon.mdx @@ -0,0 +1,49 @@ +# replicated cluster addon + +Manage cluster add-ons. + +### Synopsis + +The 'cluster addon' command allows you to manage add-ons installed on a test cluster. Add-ons are additional components or services that can be installed and configured to enhance or extend the functionality of the cluster. + +You can use various subcommands to create, list, remove, or check the status of add-ons on a cluster. This command is useful for adding databases, object storage, monitoring, security, or other specialized tools to your cluster environment. + +### Examples + +``` +# List all add-ons installed on a cluster +replicated cluster addon ls CLUSTER_ID + +# Remove an add-on from a cluster +replicated cluster addon rm CLUSTER_ID --id ADDON_ID + +# Create an object store bucket add-on for a cluster +replicated cluster addon create object-store CLUSTER_ID --bucket-prefix mybucket + +# List add-ons with JSON output +replicated cluster addon ls CLUSTER_ID --output json +``` + +### Options + +``` + -h, --help help for addon +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated cluster](replicated-cli-cluster) - Manage test Kubernetes clusters. +* [replicated cluster addon create](replicated-cli-cluster-addon-create) - Create cluster add-ons. +* [replicated cluster addon ls](replicated-cli-cluster-addon-ls) - List cluster add-ons for a cluster. +* [replicated cluster addon rm](replicated-cli-cluster-addon-rm) - Remove cluster add-on by ID. + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-cluster-create.md b/docs/reference/replicated-cli-cluster-create.md deleted file mode 100644 index 324bf32a6c..0000000000 --- a/docs/reference/replicated-cli-cluster-create.md +++ /dev/null @@ -1,133 +0,0 @@ -import Help from "../partials/replicated-cli/\_help.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). - -## Usage - -```bash -replicated cluster create [flags] -``` - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FlagType (if applicable)Description
--addonstringAdd-ons to install in the cluster. Can be specified multiple times.
--bucket-prefixstringA prefix for the bucket name to be created. Required by `--addon object-store`.
--diskintegerThe disk size (GiB) to request per node. Default: 50
--distributionstringThe Kubernetes cluster distribution type to provision. Default: kind
--dry-runThe dry run option runs a simulated test to verify that your inputs are valid without actually creating a cluster.
--instance-typestringThe type of instance to use for nodes in the cluster. For supported instance types, see Supported Compatibility Matrix Cluster Types (Beta).
--ip-familystringIP Family to use for the cluster (ipv4|ipv6|dual). Default: ipv4
--license-idstringA valid customer license ID. Required for Replicated embedded cluster distribution.
--namestringThe name of the cluster. If no name is specified, a name will be generated.
--nodesintegerThe node count. Default: 1
--min-nodesstringMinimum Node count (only for EKS, AKS and GKE clusters).
--max-nodesstringMaximum Node count (only for EKS, AKS and GKE clusters).
--nodegroupstringNode 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.
--tagstringTag to apply to the cluster (key=value format, can be specified multiple times)
--ttlstring

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

--versionstringThe 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.
--waitdurationThe wait duration for the cluster to be ready. Leave the value empty to avoid waiting.
- -## Examples - -- For an EKS distribution: - - ```bash - replicated cluster create --name eks-example --distribution eks --version 1.27 --node-count 3 --instance-type m6i.large - ``` - -- For an EKS distribution with an additional node group: - - ```bash - replicated cluster create --name eks-nodegroup-example --distribution eks --instance-type m6i.large --nodes 1 --nodegroup name=arm,instance-type=m7g.large,nodes=1,disk=50 - ``` - -- For a kind distribution: - - ```bash - replicated cluster create --name kind-example --distribution kind --version 1.25.2 --disk 100 --instance-type r1.small - ``` - -- For a Replicated embedded cluster distribution: - -```bash -replicated cluster create --distribution embedded-cluster --license-id -``` diff --git a/docs/reference/replicated-cli-cluster-create.mdx b/docs/reference/replicated-cli-cluster-create.mdx new file mode 100644 index 0000000000..e112e5529d --- /dev/null +++ b/docs/reference/replicated-cli-cluster-create.mdx @@ -0,0 +1,82 @@ +# replicated cluster create + +Create test clusters. + +### Synopsis + +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. + +``` +replicated cluster create [flags] +``` + +### Examples + +``` +# Create a new cluster with basic configuration +replicated cluster create --distribution eks --version 1.21 --nodes 3 --instance-type t3.large --disk 100 --ttl 24h + +# Create a cluster with a custom node group +replicated cluster create --distribution eks --version 1.21 --nodegroup name=workers,instance-type=t3.large,nodes=5 --ttl 24h + +# Simulate cluster creation (dry-run) +replicated cluster create --distribution eks --version 1.21 --nodes 3 --disk 100 --ttl 24h --dry-run + +# Create a cluster with autoscaling configuration +replicated cluster create --distribution eks --version 1.21 --min-nodes 2 --max-nodes 5 --instance-type t3.large --ttl 24h + +# Create a cluster with multiple node groups +replicated cluster create --distribution eks --version 1.21 \ +--nodegroup name=workers,instance-type=t3.large,nodes=3 \ +--nodegroup name=cpu-intensive,instance-type=c5.2xlarge,nodes=2 \ +--ttl 24h + +# Create a cluster with custom tags +replicated cluster create --distribution eks --version 1.21 --nodes 3 --tag env=test --tag project=demo --ttl 24h + +# Create a cluster with addons +replicated cluster create --distribution eks --version 1.21 --nodes 3 --addon object-store --ttl 24h +``` + +### Options + +``` + --addon stringArray Addons to install on the cluster (can be specified multiple times) + --bucket-prefix string A prefix for the bucket name to be created (required by '--addon object-store') + --disk int Disk Size (GiB) to request per node (default 50) + --distribution string Kubernetes distribution of the cluster to provision + --dry-run Dry run + -h, --help help for create + --instance-type string The type of instance to use (e.g. m6i.large) + --ip-family string IP Family to use for the cluster (ipv4|ipv6|dual). + --license-id string License ID to use for the installation (required for Embedded Cluster distribution) + --max-nodes string Maximum Node count (non-negative number) (only for EKS, AKS and GKE clusters). + --min-nodes string Minimum Node count (non-negative number) (only for EKS, AKS and GKE clusters). + --name string Cluster name (defaults to random name) + --nodegroup stringArray 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 int Node count (default 1) + --output string The output format to use. One of: json|table|wide (default: table) (default "table") + --tag stringArray Tag to apply to the cluster (key=value format, can be specified multiple times) + --ttl string Cluster TTL (duration, max 48h) + --version string Kubernetes version to provision (format is distribution dependent) + --wait duration Wait duration for cluster to be ready (leave empty to not wait) +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated cluster](replicated-cli-cluster) - Manage test Kubernetes clusters. + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-cluster-kubeconfig.md b/docs/reference/replicated-cli-cluster-kubeconfig.md deleted file mode 100644 index 328727b9f2..0000000000 --- a/docs/reference/replicated-cli-cluster-kubeconfig.md +++ /dev/null @@ -1,44 +0,0 @@ -import Help from "../partials/replicated-cli/_help.mdx" - -# cluster kubeconfig - -Download the credentials for a test cluster. For more information, see [About Compatibility Matrix](/vendor/testing-about). - -## Usage - -```bash -replicated cluster kubeconfig ID [flags] -``` - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FlagType (if applicable)Description
--idstringThe ID of the cluster to download credentials for, when the a name is not specified.
--namestringThe name of the cluster to download credentials for, when an ID is not provided.
--output-pathstringThe path to kubeconfig file to write to. If a path is not specified, the output will be merged to your existing kubeconfig.
--stdoutWrites kubeconfig to stdout.
- - - - diff --git a/docs/reference/replicated-cli-cluster-kubeconfig.mdx b/docs/reference/replicated-cli-cluster-kubeconfig.mdx new file mode 100644 index 0000000000..e9b0620aee --- /dev/null +++ b/docs/reference/replicated-cli-cluster-kubeconfig.mdx @@ -0,0 +1,59 @@ +# replicated cluster kubeconfig + +Download credentials for a test cluster. + +### Synopsis + +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. + +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. + +You can also use this command to automatically update your current Kubernetes context with the downloaded credentials. + +``` +replicated cluster kubeconfig [ID] [flags] +``` + +### Examples + +``` +# Download and merge kubeconfig into your existing configuration +replicated cluster kubeconfig CLUSTER_ID + +# Save the kubeconfig to a specific file +replicated cluster kubeconfig CLUSTER_ID --output-path ./kubeconfig + +# Print the kubeconfig to stdout +replicated cluster kubeconfig CLUSTER_ID --stdout + +# Download kubeconfig for a cluster by name +replicated cluster kubeconfig --name "My Cluster" + +# Download kubeconfig for a cluster by ID +replicated cluster kubeconfig --id CLUSTER_ID +``` + +### Options + +``` + -h, --help help for kubeconfig + --id string id of the cluster to download credentials for (when name is not provided) + --name string name of the cluster to download credentials for (when id is not provided) + --output-path string path to kubeconfig file to write to, if not provided, it will be merged into your existing kubeconfig + --stdout write kubeconfig to stdout +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated cluster](replicated-cli-cluster) - Manage test Kubernetes clusters. + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-cluster-ls.md b/docs/reference/replicated-cli-cluster-ls.md deleted file mode 100644 index 073bf0ff0f..0000000000 --- a/docs/reference/replicated-cli-cluster-ls.md +++ /dev/null @@ -1,54 +0,0 @@ -import Help from "../partials/replicated-cli/_help.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] -``` - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
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.
- -## Example - -```bash -replicated cluster ls -``` - diff --git a/docs/reference/replicated-cli-cluster-ls.mdx b/docs/reference/replicated-cli-cluster-ls.mdx new file mode 100644 index 0000000000..cd20bda8d1 --- /dev/null +++ b/docs/reference/replicated-cli-cluster-ls.mdx @@ -0,0 +1,63 @@ +# replicated cluster ls + +List test clusters. + +### Synopsis + +The 'cluster ls' command lists all test clusters. This command provides information about the clusters, such as their status, name, distribution, version, and creation time. The output can be formatted in different ways, depending on your needs. + +You can filter the list of clusters by time range and status (e.g., show only terminated clusters). You can also watch clusters in real-time, which updates the list every few seconds. + +Clusters that have been deleted will be shown with a 'deleted' status. + +``` +replicated cluster ls [flags] +``` + +### Examples + +``` +# List all clusters with default table output +replicated cluster ls + +# Show clusters created after a specific date +replicated cluster ls --start-time 2023-01-01T00:00:00Z + +# Watch for real-time updates +replicated cluster ls --watch + +# List clusters with JSON output +replicated cluster ls --output json + +# List only terminated clusters +replicated cluster ls --show-terminated + +# List clusters with wide table output +replicated cluster ls --output wide +``` + +### Options + +``` + --end-time string end time for the query (Format: 2006-01-02T15:04:05Z) + -h, --help help for ls + --output string The output format to use. One of: json|table|wide (default: table) (default "table") + --show-terminated when set, only show terminated clusters + --start-time string start time for the query (Format: 2006-01-02T15:04:05Z) + -w, --watch watch clusters +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated cluster](replicated-cli-cluster) - Manage test Kubernetes clusters. + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-cluster-nodegroup-ls.md b/docs/reference/replicated-cli-cluster-nodegroup-ls.md deleted file mode 100644 index b8caed8422..0000000000 --- a/docs/reference/replicated-cli-cluster-nodegroup-ls.md +++ /dev/null @@ -1,37 +0,0 @@ -import Help from "../partials/replicated-cli/_help.mdx" -import Output from "../partials/replicated-cli/_output.mdx" -import Token from "../partials/replicated-cli/_token.mdx" - -# cluster nodegroup ls - -List node groups for a cluster. - -For more information, see [About Compatibility Matrix](/vendor/testing-about). - -## Usage - -```bash -replicated cluster nodegroup ls [ID] -``` - - - - - - - - - -
FlagType (if applicable)Description
- -## Example - -A cluster with three node groups: - -```bash -ID NAME DEFAULT INSTANCE TYPE NODES DISK -c1955ee4 default true Standard_B2ms 1 50 -4073a716 lkfsqe false Standard_B2ms 1 100 -47124127 zrbwpm false Standard_B2ms 1 100 -``` - diff --git a/docs/reference/replicated-cli-cluster-nodegroup-ls.mdx b/docs/reference/replicated-cli-cluster-nodegroup-ls.mdx new file mode 100644 index 0000000000..7ed5e9dd92 --- /dev/null +++ b/docs/reference/replicated-cli-cluster-nodegroup-ls.mdx @@ -0,0 +1,50 @@ +# replicated cluster nodegroup ls + +List node groups for a cluster. + +### Synopsis + +The 'cluster nodegroup ls' command lists all the node groups associated with a given cluster. Each node group defines a specific set of nodes with particular configurations, such as instance types and scaling options. + +You can view information about the node groups within the specified cluster, including their ID, name, node count, and other configuration details. + +You must provide the cluster ID to list its node groups. + +``` +replicated cluster nodegroup ls [ID] [flags] +``` + +### Examples + +``` +# List all node groups in a cluster with default table output +replicated cluster nodegroup ls CLUSTER_ID + +# List node groups with JSON output +replicated cluster nodegroup ls CLUSTER_ID --output json + +# List node groups with wide table output +replicated cluster nodegroup ls CLUSTER_ID --output wide +``` + +### Options + +``` + -h, --help help for ls + --output string The output format to use. One of: json|table|wide (default: table) (default "table") +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated cluster nodegroup](replicated-cli-cluster-nodegroup) - Manage node groups for clusters. + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-cluster-nodegroup.mdx b/docs/reference/replicated-cli-cluster-nodegroup.mdx new file mode 100644 index 0000000000..26aa7543fe --- /dev/null +++ b/docs/reference/replicated-cli-cluster-nodegroup.mdx @@ -0,0 +1,38 @@ +# replicated cluster nodegroup + +Manage node groups for clusters. + +### Synopsis + +The 'cluster nodegroup' command provides functionality to manage node groups within a cluster. This command allows you to list node groups in a Kubernetes or VM-based cluster. + +Node groups define a set of nodes with specific configurations, such as instance types, node counts, or scaling rules. You can use subcommands to perform various actions on node groups. + +### Examples + +``` +# List all node groups for a cluster +replicated cluster nodegroup ls CLUSTER_ID +``` + +### Options + +``` + -h, --help help for nodegroup +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated cluster](replicated-cli-cluster) - Manage test Kubernetes clusters. +* [replicated cluster nodegroup ls](replicated-cli-cluster-nodegroup-ls) - List node groups for a cluster. + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-cluster-port-expose.md b/docs/reference/replicated-cli-cluster-port-expose.md deleted file mode 100644 index ee0d8265c9..0000000000 --- a/docs/reference/replicated-cli-cluster-port-expose.md +++ /dev/null @@ -1,54 +0,0 @@ -import Help from "../partials/replicated-cli/\_help.mdx" - -# cluster port expose - -Expose a port on a cluster to the public internet. This command creates a DNS entry and TLS certificate (if "https") for the specified port on the cluster. - -A wildcard DNS entry and TLS certificate can be created by specifying the `--wildcard` flag. This will take extra time to provision. - -:::note -This feature supports only VM cluster distributions. For more information, see [VM Cluster](/vendor/testing-supported-clusters#vm-clusters) in _Supported Compatibility Matrix Cluster Types_. -::: - -## Usage - -```bash -replicated cluster port expose CLUSTER_ID --port PORT [flags] -``` - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FlagType (if applicable)Description
--portstringPort to expose. (Required)
--protocolstringProtocol to expose (valid values are "http" and "https"). Specify multiple or separate values with commas.
--wildcardboolCreate a wildcard DNS entry and TLS certificate for this port.
--outputstringThe output format to use. Value values: json, table or wide. Default: table
- -## Example - -```bash -$ replicated cluster port expose 05929b24 --port 8080 --protocol https --wildcard -ID CLUSTER PORT PROTOCOL EXPOSED PORT WILDCARD STATUS -d079b2fc 8080 https https://happy-germain.ingress.replicatedcluster.com true pending -``` diff --git a/docs/reference/replicated-cli-cluster-port-expose.mdx b/docs/reference/replicated-cli-cluster-port-expose.mdx new file mode 100644 index 0000000000..410fb8aca0 --- /dev/null +++ b/docs/reference/replicated-cli-cluster-port-expose.mdx @@ -0,0 +1,58 @@ +# replicated cluster port expose + +Expose a port on a cluster to the public internet. + +### Synopsis + +The 'cluster port expose' command is used to expose a specified port on a cluster to the public internet. When exposing a port, the command automatically creates a DNS entry and, if using the "https" protocol, provisions a TLS certificate for secure communication. + +You can also create a wildcard DNS entry and TLS certificate by specifying the "--wildcard" flag. Please note that creating a wildcard certificate may take additional time. + +This command supports different protocols including "http", "https", "ws", and "wss" for web traffic and web socket communication. + +NOTE: Currently, this feature only supports VM-based cluster distributions. + +``` +replicated cluster port expose CLUSTER_ID --port PORT [flags] +``` + +### Examples + +``` +# Expose port 8080 with HTTPS protocol and wildcard DNS +replicated cluster port expose CLUSTER_ID --port 8080 --protocol https --wildcard + +# Expose port 3000 with HTTP protocol +replicated cluster port expose CLUSTER_ID --port 3000 --protocol http + +# Expose port 8080 with multiple protocols +replicated cluster port expose CLUSTER_ID --port 8080 --protocol http,https + +# Expose port 8080 and display the result in JSON format +replicated cluster port expose CLUSTER_ID --port 8080 --protocol https --output json +``` + +### Options + +``` + -h, --help help for expose + --output string The output format to use. One of: json|table|wide (default: table) (default "table") + --port int Port to expose (required) + --protocol strings Protocol to expose (valid values are "http", "https", "ws" and "wss") (default [http,https]) + --wildcard Create a wildcard DNS entry and TLS certificate for this port +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated cluster port](replicated-cli-cluster-port) - Manage cluster ports. + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-cluster-port-ls.md b/docs/reference/replicated-cli-cluster-port-ls.md deleted file mode 100644 index 014206aef2..0000000000 --- a/docs/reference/replicated-cli-cluster-port-ls.md +++ /dev/null @@ -1,35 +0,0 @@ -import Help from "../partials/replicated-cli/_help.mdx" - -# cluster port ls - -List cluster ports for a cluster. - -## Usage - -```bash -replicated cluster port ls CLUSTER_ID [flags] -``` - - - - - - - - - - - - - -
FlagType (if applicable)Description
--outputstringThe output format to use. Value values: json, table or wide. Default: table
- -## Example - -```bash -$ replicated cluster port ls 05929b24 -ID CLUSTER PORT PROTOCOL EXPOSED PORT WILDCARD STATUS -d079b2fc 8080 https https://happy-germain.ingress.replicatedcluster.com true pending -0baa3e98 8080 http http://romantic-hellman.ingress.replicatedcluster.com false ready -0baa3e98 8080 https https://romantic-hellman.ingress.replicatedcluster.com false ready -``` diff --git a/docs/reference/replicated-cli-cluster-port-ls.mdx b/docs/reference/replicated-cli-cluster-port-ls.mdx new file mode 100644 index 0000000000..8d84c30c56 --- /dev/null +++ b/docs/reference/replicated-cli-cluster-port-ls.mdx @@ -0,0 +1,48 @@ +# replicated cluster port ls + +List cluster ports for a cluster. + +### Synopsis + +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. + +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. + +``` +replicated cluster port ls CLUSTER_ID [flags] +``` + +### Examples + +``` +# List ports for a cluster in the default table format +replicated cluster port ls CLUSTER_ID + +# List ports for a cluster in JSON format +replicated cluster port ls CLUSTER_ID --output json + +# List ports for a cluster in wide format +replicated cluster port ls CLUSTER_ID --output wide +``` + +### Options + +``` + -h, --help help for ls + --output string The output format to use. One of: json|table|wide (default: table) (default "table") +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated cluster port](replicated-cli-cluster-port) - Manage cluster ports. + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-cluster-port-rm.md b/docs/reference/replicated-cli-cluster-port-rm.md deleted file mode 100644 index a1860009dc..0000000000 --- a/docs/reference/replicated-cli-cluster-port-rm.md +++ /dev/null @@ -1,39 +0,0 @@ -import Help from "../partials/replicated-cli/_help.mdx" - -# cluster port rm - -Remove cluster port by ID. - -## Usage - -```bash -replicated cluster port rm CLUSTER_ID --id PORT_ID [flags] -``` - - - - - - - - - - - - - - - - - - -
FlagType (if applicable)Description
--idstringID of the port to remove. (Required)
--outputstringThe output format to use. Value values: json, table or wide. Default: table
- -## Example - -```bash -$ replicated cluster port rm 05929b24 --id d079b2fc -ID CLUSTER PORT PROTOCOL EXPOSED PORT WILDCARD STATUS -0baa3e98 8080 http http://romantic-hellman.ingress.replicatedcluster.com false ready -0baa3e98 8080 https https://romantic-hellman.ingress.replicatedcluster.com false ready -``` diff --git a/docs/reference/replicated-cli-cluster-port-rm.mdx b/docs/reference/replicated-cli-cluster-port-rm.mdx new file mode 100644 index 0000000000..0c7420952c --- /dev/null +++ b/docs/reference/replicated-cli-cluster-port-rm.mdx @@ -0,0 +1,51 @@ +# replicated cluster port rm + +Remove cluster port by ID. + +### Synopsis + +The 'cluster port rm' command removes a specific port from a cluster. You must provide either the ID of the port or the port number and protocol(s) to remove. + +This command is useful for managing the network settings of your test clusters by allowing you to clean up unused or incorrect ports. After removing a port, the updated list of ports will be displayed. + +Note that you can only use either the port ID or port number when removing a port, not both at the same time. + +``` +replicated cluster port rm CLUSTER_ID --id PORT_ID [flags] +``` + +### Examples + +``` +# Remove a port using its ID +replicated cluster port rm CLUSTER_ID --id PORT_ID + +# Remove a port using its number (deprecated) +replicated cluster port rm CLUSTER_ID --port 8080 --protocol http,https + +# Remove a port and display the result in JSON format +replicated cluster port rm CLUSTER_ID --id PORT_ID --output json +``` + +### Options + +``` + -h, --help help for rm + --id string ID of the port to remove (required) + --output string The output format to use. One of: json|table|wide (default: table) (default "table") +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated cluster port](replicated-cli-cluster-port) - Manage cluster ports. + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-cluster-port.mdx b/docs/reference/replicated-cli-cluster-port.mdx new file mode 100644 index 0000000000..f241928fd5 --- /dev/null +++ b/docs/reference/replicated-cli-cluster-port.mdx @@ -0,0 +1,46 @@ +# replicated cluster port + +Manage cluster ports. + +### Synopsis + +The 'cluster port' command is a parent command for managing ports in a cluster. It allows users to list, remove, or expose specific ports used by the cluster. Use the subcommands (such as 'ls', 'rm', and 'expose') to manage port configurations effectively. + +This command provides flexibility for handling ports in various test clusters, ensuring efficient management of cluster networking settings. + +### Examples + +``` +# List all exposed ports in a cluster +replicated cluster port ls [CLUSTER_ID] + +# Remove an exposed port from a cluster +replicated cluster port rm [CLUSTER_ID] [PORT] + +# Expose a new port in a cluster +replicated cluster port expose [CLUSTER_ID] [PORT] +``` + +### Options + +``` + -h, --help help for port +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated cluster](replicated-cli-cluster) - Manage test Kubernetes clusters. +* [replicated cluster port expose](replicated-cli-cluster-port-expose) - Expose a port on a cluster to the public internet. +* [replicated cluster port ls](replicated-cli-cluster-port-ls) - List cluster ports for a cluster. +* [replicated cluster port rm](replicated-cli-cluster-port-rm) - Remove cluster port by ID. + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-cluster-prepare.md b/docs/reference/replicated-cli-cluster-prepare.md deleted file mode 100644 index 98d66e718e..0000000000 --- a/docs/reference/replicated-cli-cluster-prepare.md +++ /dev/null @@ -1,177 +0,0 @@ -import Help from "../partials/replicated-cli/_help.mdx" - - -# cluster prepare - -Create a cluster and a release, then install the release in the cluster. This allows you to deploy applications to a cluster for compatibility testing without needing to promote a release to a channel or create a temporary customer. For more information, see [About Compatibility Matrix](/vendor/testing-about). - -## Limtiations - -* `cluster prepare` is not recommended for production testing. For production testing, use `cluster create` instead. -* `cluster prepare` is not supported for the Embedded Cluster type. - -## Usage -```bash -replicated cluster prepare [flags] -``` - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FlagType (if applicable)Description
--diskintegerThe disk size (GiB) to request per node. Default: 50
--distributionstringThe Kubernetes cluster distribution type to provision. Default: kind
--instance-typestringThe type of instance to use for nodes in the cluster. See Supported Compatibility Matrix Cluster Types (Beta).
--namestringThe name of the cluster. If no name is specified, a name will be generated.
--nodesintegerThe node count. Default: 1
--ttlstringThe 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
--versionstring(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).
--waitdurationThe wait duration for the cluster to be ready. Default: 5 minutes
--cluster-idstringThe ID of an existing cluster to use instead of creating a new ID.
--entitlementsstringThe entitlements to set on the customer. You can specify multiple entitlements.
--namespacestringThe namespace in which to deploy the KOTS or Helm chart application. Default: default
--app-ready-timeoutstringTimeout to wait for the application to be ready. Requires the Go duration format (e.g., 10s, 2m). Default: 5 minutes
--chartstringThe path to the Helm chart for a release.
--valuesstringSpecify values in a YAML file or a URL. You can specify multiple values.
--setstringSet values using the command line. Specify multiple or separate values with commas: key1=val1,key2=val2.
--set-stringstringSet String values using the command line. Specify multiple or separate values with commas: key1=val1,key2=val2.
--set-filestringSet values from respective files specified using the command line. Specify multiple or separate values with commas: key1=path1,key2=path2.
--set-jsonstringSet JSON values using the command line. Specify multiple or separate values with commas: key1=jsonval1,key2=jsonval2.
--set-literalstringSet a literal String value using the command line.
--yamlstringThe YAML config for this release. Use - to read from stdin. Cannot be used with the --yaml-file flag.
--yaml-filestringThe YAML config for this release. Cannot be used with the --yaml flag.
--yaml-dirstringThe directory containing multiple YAML files for a KOTS release. Cannot be used with the --yaml flag.
--config-values-filestringPath to a manifest containing config values. Must use apiVersion: kots.io/v1beta1, kind: ConfigValues.
--shared-passwordstringShared password for the KOTS admin console.
- -## Examples - -- For a Helm application with a kind distribution: - - ```bash - replicated cluster cluster prepare \ - --distribution kind \ - --version 1.27.0 \ - --chart nginx-chart-0.0.14.tgz \ - --set key1=val1,key2=val2 \ - --set-string s1=val1,s2=val2 \ - --set-json j1='{"key1":"val1","key2":"val2"}' \ - --set-literal l1=val1,l2=val2 \ - --values values.yaml - ``` - -- For a KOTS-based application with a k3s distribution: - - ```bash - replicated cluster prepare \ - --distribution k3s \ - --version 1.26 \ - --namespace config-validation \ - --shared-password password \ - --app-ready-timeout 10m \ - --yaml-dir config-validation \ - --config-values-file config-values.yaml \ - --entitlements "num_of_queues=5" - ``` - diff --git a/docs/reference/replicated-cli-cluster-prepare.mdx b/docs/reference/replicated-cli-cluster-prepare.mdx new file mode 100644 index 0000000000..0362fc3524 --- /dev/null +++ b/docs/reference/replicated-cli-cluster-prepare.mdx @@ -0,0 +1,72 @@ +# replicated cluster prepare + +Prepare cluster for testing. + +### Synopsis + +The 'cluster prepare' command provisions a Kubernetes cluster and installs an application using a Helm chart or KOTS YAML configuration. + +This command is designed to be used in CI environments to prepare a cluster for testing by deploying a Helm chart or KOTS application with entitlements and custom values. You can specify the cluster configuration, such as the Kubernetes distribution, version, node count, and instance type, and then install your application automatically. + +Alternatively, if you prefer deploying KOTS applications, you can specify YAML manifests for the release and use the '--shared-password' flag for the KOTS admin console. + +You can also pass entitlement values to configure the cluster's customer entitlements. + +Note: +- The '--chart' flag cannot be used with '--yaml', '--yaml-file', or '--yaml-dir'. +- If deploying a Helm chart, use the '--set' flags to pass chart values. When deploying a KOTS application, the '--shared-password' flag is required. + +``` +replicated cluster prepare [flags] +``` + +### Examples + +``` +replicated cluster prepare --distribution eks --version 1.27 --instance-type c6.xlarge --node-count 3 --chart ./your-chart.tgz --values ./values.yaml --set chart-key=value --set chart-key2=value2 +``` + +### Options + +``` + --app-ready-timeout duration Timeout to wait for the application to be ready. Must be in Go duration format (e.g., 10s, 2m). (default 5m0s) + --chart string Path to the helm chart package to deploy + --cluster-id string The ID of an existing cluster to use instead of creating a new one. + --config-values-file string Path to a manifest containing config values (must be apiVersion: kots.io/v1beta1, kind: ConfigValues). + --disk int Disk Size (GiB) to request per node. (default 50) + --distribution string Kubernetes distribution of the cluster to provision + --entitlements strings The entitlements to set on the customer. Can be specified multiple times. + -h, --help help for prepare + --instance-type string the type of instance to use clusters (e.g. x5.xlarge) + --name string Cluster name + --namespace string The namespace into which to deploy the KOTS application or Helm chart. (default "default") + --node-count int Node count. (default 1) + --set stringArray Set values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2). + --set-file stringArray Set values from respective files specified via the command line (can specify multiple or separate values with commas: key1=path1,key2=path2). + --set-json stringArray Set JSON values on the command line (can specify multiple or separate values with commas: key1=jsonval1,key2=jsonval2). + --set-literal stringArray Set a literal STRING value on the command line. + --set-string stringArray Set STRING values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2). + --shared-password string Shared password for the KOTS admin console. + --ttl string Cluster TTL (duration, max 48h) + --values strings Specify values in a YAML file or a URL (can specify multiple). + --version string Kubernetes version to provision (format is distribution dependent) + --wait duration Wait duration for cluster to be ready. (default 5m0s) + --yaml string The YAML config for this release. Use '-' to read from stdin. Cannot be used with the --yaml-file flag. + --yaml-dir string The directory containing multiple yamls for a KOTS release. Cannot be used with the --yaml flag. + --yaml-file string The YAML config for this release. Cannot be used with the --yaml flag. +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated cluster](replicated-cli-cluster) - Manage test Kubernetes clusters. + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-cluster-rm.md b/docs/reference/replicated-cli-cluster-rm.md deleted file mode 100644 index 3b79effb6d..0000000000 --- a/docs/reference/replicated-cli-cluster-rm.md +++ /dev/null @@ -1,52 +0,0 @@ -import Help from "../partials/replicated-cli/_help.mdx" - - -# cluster rm - -Remove the test clusters. You can delete multiple clusters at a time. For more information, see [About Compatibility Matrix](/vendor/testing-about). - -## Usage - -```bash -replicated cluster rm [Cluster ID, name, or tag] [flags] -``` - -Replace `Cluster ID, name, or tag` with one or more cluster IDs, names, or tags. You can find cluster IDs, names, and tags in the output of the `replicated cluster ls` command. - - - - - - - - - - - - - - - - - - - - - - - -
FlagType (if applicable)Description
--namestringArrayName of the cluster to remove (can be specified multiple times).
--tagstringArrayTag of the cluster to remove (key=value format, can be specified multiple times).
--allRemoves all clusters.
- -## Example - -```bash -replicated cluster rm 1234567890 -``` - -```bash -replicated cluster rm --name qatesting -``` - -```bash -replicated cluster rm --all -``` diff --git a/docs/reference/replicated-cli-cluster-rm.mdx b/docs/reference/replicated-cli-cluster-rm.mdx new file mode 100644 index 0000000000..a4693c42e3 --- /dev/null +++ b/docs/reference/replicated-cli-cluster-rm.mdx @@ -0,0 +1,52 @@ +# replicated cluster rm + +Remove test clusters. + +### Synopsis + +The 'rm' command removes test clusters immediately. + +You can remove clusters by specifying a cluster ID, or by using other criteria such as cluster names or tags. Alternatively, you can remove all clusters in your account at once. + +This command can also be used in a dry-run mode to simulate the removal without actually deleting anything. + +You cannot mix the use of cluster IDs with other options like removing by name, tag, or removing all clusters at once. + +``` +replicated cluster rm ID [ID …] [flags] +``` + +### Examples + +``` +# Remove a specific cluster by ID +replicated cluster rm CLUSTER_ID + +# Remove all clusters +replicated cluster rm --all +``` + +### Options + +``` + --all remove all clusters + --dry-run Dry run + -h, --help help for rm + --name stringArray Name of the cluster to remove (can be specified multiple times) + --tag stringArray Tag of the cluster to remove (key=value format, can be specified multiple times) +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated cluster](replicated-cli-cluster) - Manage test Kubernetes clusters. + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-cluster-shell.mdx b/docs/reference/replicated-cli-cluster-shell.mdx index 7bed7b9183..b0dfa6476f 100644 --- a/docs/reference/replicated-cli-cluster-shell.mdx +++ b/docs/reference/replicated-cli-cluster-shell.mdx @@ -1,46 +1,48 @@ -import Help from "../partials/replicated-cli/_help.mdx" +# replicated cluster shell -# cluster shell +Open a new shell with kubeconfig configured. -Opens a new shell session with the kubeconfig configured for the specified cluster. This allows you to have immediate kubectl access to the cluster within the shell environment. +### Synopsis + +The 'shell' command opens a new shell session with the kubeconfig configured for the specified test cluster. This allows you to have immediate kubectl access to the cluster within the shell environment. You can either specify the cluster ID directly or provide the cluster name to resolve the corresponding cluster ID. The shell will inherit your existing environment and add the necessary kubeconfig context for interacting with the Kubernetes cluster. Once inside the shell, you can use 'kubectl' to interact with the cluster. To exit the shell, press Ctrl-D or type 'exit'. When the shell closes, the kubeconfig will be reset back to your default configuration. -## Usage - -```bash +``` replicated cluster shell [ID] [flags] ``` - - - - - - - - - - - - - - - - - -
FlagType (if applicable)Description
--idstringID of the cluster to have kubectl access to (when name is not provided)
--namestringName of the cluster to have kubectl access to.
- -## Examples - -```bash -# Open a shell for a cluster by ID -replicated cluster shell 89be02de +### Examples + ``` +# Open a shell for a cluster by ID +replicated cluster shell CLUSTER_ID -```bash # Open a shell for a cluster by name replicated cluster shell --name "My Cluster" -``` \ No newline at end of file +``` + +### Options + +``` + -h, --help help for shell + --id string id of the cluster to have kubectl access to (when name is not provided) + --name string name of the cluster to have kubectl access to. +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated cluster](replicated-cli-cluster) - Manage test Kubernetes clusters. + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-cluster-update-nodegroup.mdx b/docs/reference/replicated-cli-cluster-update-nodegroup.mdx new file mode 100644 index 0000000000..ce67b0f723 --- /dev/null +++ b/docs/reference/replicated-cli-cluster-update-nodegroup.mdx @@ -0,0 +1,52 @@ +# replicated cluster update nodegroup + +Update a nodegroup for a test cluster. + +### Synopsis + +The 'nodegroup' command allows you to update the configuration of a nodegroup within a test cluster. You can update attributes like the number of nodes, minimum and maximum node counts for autoscaling, and more. + +If you do not provide the nodegroup ID, the command will try to resolve it based on the nodegroup name provided. + +``` +replicated cluster update nodegroup [ID] [flags] +``` + +### Examples + +``` +# Update the number of nodes in a nodegroup +replicated cluster update nodegroup CLUSTER_ID --nodegroup-id NODEGROUP_ID --nodes 3 + +# Update the autoscaling limits for a nodegroup +replicated cluster update nodegroup CLUSTER_ID --nodegroup-id NODEGROUP_ID --min-nodes 2 --max-nodes 5 +``` + +### Options + +``` + -h, --help help for nodegroup + --max-nodes string The maximum number of nodes in the nodegroup + --min-nodes string The minimum number of nodes in the nodegroup + --nodegroup-id string The ID of the nodegroup to update + --nodegroup-name string The name of the nodegroup to update + --nodes int The number of nodes in the nodegroup + --output string The output format to use. One of: json|table|wide (default: table) (default "table") +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --id string id of the cluster to update (when name is not provided) + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --name string Name of the cluster to update. + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated cluster update](replicated-cli-cluster-update) - Update cluster settings. + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-cluster-update-ttl.md b/docs/reference/replicated-cli-cluster-update-ttl.md deleted file mode 100644 index 2ba0be23c3..0000000000 --- a/docs/reference/replicated-cli-cluster-update-ttl.md +++ /dev/null @@ -1,73 +0,0 @@ -import Help from "../partials/replicated-cli/_help.mdx" -import Output from "../partials/replicated-cli/_output.mdx" - -# cluster update ttl - -Increase or decrease the Time to Live (TTL) for a running cluster that was provisioned with the Replicated Compatibility Matrix. The `cluster update ttl` command updates the expiration timestamp for a cluster and does _not_ change the creation timestamp. - -For more information, see [About Compatibility Matrix](/vendor/testing-about). - -## Usage - -```bash -replicated cluster update ttl [ID] [flags] -``` - -The `cluster update ttl` command first looks for the target cluster based on the value supplied for `[ID]`. If `[ID]` is not specified, the command looks for the first matching cluster with the same name as specified by the `--name` flag. If `--name` is also not provided, then the command looks for a cluster with the same ID as specified by the `--id` flag. - - - - - - - - - - - - - - - - - - - - - - - - -
FlagType (if applicable)Description
--ttlstring -

The updated TTL for the cluster, in hours or minutes. Must be a duration longer than the current lifespan of the cluster. Valid values: 10m through 48h. For example, 15h or 120min.

-
--idstring -

ID of the cluster to update TTL (when --name is not provided).

-
--namestring -

Name of the cluster to update TTL.

-
- -## Example - -Given the following cluster with a TTL of one hour: - -```bash -replicated cluster ls 81cd2169 -ID NAME DISTRIBUTION VERSION STATUS CREATED EXPIRES TAGS -81cd2169 gallant_fermat gke 1.27 running 2023-12-15 19:16:56 +0000 UTC 2023-12-15 20:21:35 +0000 UTC -``` - -Update the TTL to two hours: - -```bash -replicated cluster update ttl 81cd2169 --ttl 2h -ID NAME DISTRIBUTION VERSION STATUS CREATED EXPIRES TAGS -81cd2169 gallant_fermat gke 1.27 running 2023-12-15 19:16:56 +0000 UTC 2023-12-15 21:21:35 +0000 UTC -``` - -Update the TTL to two hours using the cluster name: - -```bash -replicated cluster update ttl --name gallant_fermat --ttl 2h -ID NAME DISTRIBUTION VERSION STATUS CREATED EXPIRES TAGS -81cd2169 gallant_fermat gke 1.27 running 2023-12-15 19:16:56 +0000 UTC 2023-12-15 21:21:35 +0000 UTC -``` \ No newline at end of file diff --git a/docs/reference/replicated-cli-cluster-update-ttl.mdx b/docs/reference/replicated-cli-cluster-update-ttl.mdx new file mode 100644 index 0000000000..91968b1b6f --- /dev/null +++ b/docs/reference/replicated-cli-cluster-update-ttl.mdx @@ -0,0 +1,43 @@ +# replicated cluster update ttl + +Update TTL for a test cluster. + +### Synopsis + +The 'ttl' command allows you to update the Time-To-Live (TTL) of a test cluster. The TTL represents the duration for which the cluster will remain active before it is automatically terminated. The duration starts from the moment the cluster becomes active. You must provide a valid duration, with a maximum limit of 48 hours. + +``` +replicated cluster update ttl [ID] [flags] +``` + +### Examples + +``` +# Update the TTL for a specific cluster +replicated cluster update ttl CLUSTER_ID --ttl 24h +``` + +### Options + +``` + -h, --help help for ttl + --output string The output format to use. One of: json|table|wide (default: table) (default "table") + --ttl string Update TTL which starts from the moment the cluster is running (duration, max 48h). +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --id string id of the cluster to update (when name is not provided) + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --name string Name of the cluster to update. + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated cluster update](replicated-cli-cluster-update) - Update cluster settings. + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-cluster-update.mdx b/docs/reference/replicated-cli-cluster-update.mdx new file mode 100644 index 0000000000..4f4e675ac9 --- /dev/null +++ b/docs/reference/replicated-cli-cluster-update.mdx @@ -0,0 +1,44 @@ +# replicated cluster update + +Update cluster settings. + +### Synopsis + +The 'update' command allows you to update various settings of a test cluster, such as its name or ID. + +You can either specify the cluster ID directly or provide the cluster name, and the command will resolve the corresponding cluster ID. This allows you to modify the cluster's configuration based on the unique identifier or the name of the cluster. + +### Examples + +``` +# Update a cluster using its ID +replicated cluster update --id [subcommand] + +# Update a cluster using its name +replicated cluster update --name [subcommand] +``` + +### Options + +``` + -h, --help help for update + --id string id of the cluster to update (when name is not provided) + --name string Name of the cluster to update. +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated cluster](replicated-cli-cluster) - Manage test Kubernetes clusters. +* [replicated cluster update nodegroup](replicated-cli-cluster-update-nodegroup) - Update a nodegroup for a test cluster. +* [replicated cluster update ttl](replicated-cli-cluster-update-ttl) - Update TTL for a test cluster. + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-cluster-upgrade.md b/docs/reference/replicated-cli-cluster-upgrade.md deleted file mode 100644 index ca91cf30ae..0000000000 --- a/docs/reference/replicated-cli-cluster-upgrade.md +++ /dev/null @@ -1,43 +0,0 @@ -import Help from "../partials/replicated-cli/_help.mdx" - - -# cluster upgrade - -Upgrade cluster version for compatibility testing. For more information, see [About Compatibility Matrix](/vendor/testing-about). - -## Usage -```bash -replicated cluster upgrade ID [flags] -``` - - - - - - - - - - - - - - - - - - - - - - - -
FlagType (if applicable)Description
--dry-runThe dry run option runs a simulated test to verify that your inputs are valid without actually creating a cluster.
--versionstring(Required) Kubernetes version to upgrade to (format is distribution dependent). For supported versions, see Supported Compatibility Matrix Cluster Types (Beta).
--waitdurationWait duration for cluster to be ready (leave empty to not wait)
- -## Examples - -For a kURL distribution: - -```bash -replicated cluster upgrade cabb74d5 --version 9d5a44c -``` diff --git a/docs/reference/replicated-cli-cluster-upgrade.mdx b/docs/reference/replicated-cli-cluster-upgrade.mdx new file mode 100644 index 0000000000..9bc6fa7db9 --- /dev/null +++ b/docs/reference/replicated-cli-cluster-upgrade.mdx @@ -0,0 +1,49 @@ +# replicated cluster upgrade + +Upgrade a test cluster. + +### Synopsis + +The 'upgrade' command upgrades a Kubernetes test cluster to a specified version. You must provide a cluster ID and the version to upgrade to. The upgrade can be simulated with a dry-run option, or you can choose to wait for the cluster to be fully upgraded. + +``` +replicated cluster upgrade [ID] [flags] +``` + +### Examples + +``` +# Upgrade a cluster to a new Kubernetes version +replicated cluster upgrade [CLUSTER_ID] --version 1.31 + +# Perform a dry run of a cluster upgrade without making any changes +replicated cluster upgrade [CLUSTER_ID] --version 1.31 --dry-run + +# Upgrade a cluster and wait for it to be ready +replicated cluster upgrade [CLUSTER_ID] --version 1.31 --wait 30m +``` + +### Options + +``` + --dry-run Dry run + -h, --help help for upgrade + --output string The output format to use. One of: json|table|wide (default: table) (default "table") + --version string Kubernetes version to upgrade to (format is distribution dependent) + --wait duration Wait duration for cluster to be ready (leave empty to not wait) +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated cluster](replicated-cli-cluster) - Manage test Kubernetes clusters. + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-cluster-versions.md b/docs/reference/replicated-cli-cluster-versions.md deleted file mode 100644 index 3c4773f373..0000000000 --- a/docs/reference/replicated-cli-cluster-versions.md +++ /dev/null @@ -1,44 +0,0 @@ -import Help from "../partials/replicated-cli/_help.mdx" - - -# cluster versions - -List the supported clusters versions available for compatibility testing. For more information, see [About Compatibility Matrix](/vendor/testing-about). - -## Usage - -```bash -replicated cluster versions [flags] -``` - - - - - - - - - - - - - - - - - - -
FlagType (if applicable)Description
--outputstringThe output format to use. Value values: json or table. Default: table
--distributionstringThe Kuberntes distribution to filter by. For example, openshift
- -## Example - -```bash -replicated cluster versions --distribution openshift - -Supported Kubernetes distributions and versions are: -DISTRIBUTION: openshift -• VERSIONS: 4.13.0-okd -• INSTANCE TYPES: r1.medium, r1.large, r1.xlarge, r1.2xlarge -• MAX NODES: 1 -``` - diff --git a/docs/reference/replicated-cli-cluster-versions.mdx b/docs/reference/replicated-cli-cluster-versions.mdx new file mode 100644 index 0000000000..cf59898fc0 --- /dev/null +++ b/docs/reference/replicated-cli-cluster-versions.mdx @@ -0,0 +1,47 @@ +# replicated cluster versions + +List cluster versions. + +### Synopsis + +The 'versions' command lists available Kubernetes versions for supported distributions. You can filter the versions by specifying a distribution and choose between different output formats. + +``` +replicated cluster versions [flags] +``` + +### Examples + +``` +# List all available Kubernetes cluster versions +replicated cluster versions + +# List available versions for a specific distribution (e.g., eks) +replicated cluster versions --distribution eks + +# Output the versions in JSON format +replicated cluster versions --output json +``` + +### Options + +``` + --distribution string Kubernetes distribution to filter by. + -h, --help help for versions + --output string The output format to use. One of: json|table (default: table) (default "table") +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated cluster](replicated-cli-cluster) - Manage test Kubernetes clusters. + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-cluster.mdx b/docs/reference/replicated-cli-cluster.mdx new file mode 100644 index 0000000000..1a32212a28 --- /dev/null +++ b/docs/reference/replicated-cli-cluster.mdx @@ -0,0 +1,56 @@ +# replicated cluster + +Manage test Kubernetes clusters. + +### Synopsis + +The 'cluster' command allows you to manage and interact with Kubernetes clusters used for testing purposes. With this command, you can create, list, remove, and manage node groups within clusters, as well as retrieve information about available clusters. + +### Examples + +``` +# Create a single-node EKS cluster +replicated cluster create --distribution eks --version 1.31 + +# List all clusters +replicated cluster ls + +# Remove a specific cluster by ID +replicated cluster rm + +# List all nodegroups in a specific cluster +replicated cluster nodegroup ls +``` + +### Options + +``` + -h, --help help for cluster +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated](replicated) - Manage your Commercial Software Distribution Lifecycle using Replicated +* [replicated cluster addon](replicated-cli-cluster-addon) - Manage cluster add-ons. +* [replicated cluster create](replicated-cli-cluster-create) - Create test clusters. +* [replicated cluster kubeconfig](replicated-cli-cluster-kubeconfig) - Download credentials for a test cluster. +* [replicated cluster ls](replicated-cli-cluster-ls) - List test clusters. +* [replicated cluster nodegroup](replicated-cli-cluster-nodegroup) - Manage node groups for clusters. +* [replicated cluster port](replicated-cli-cluster-port) - Manage cluster ports. +* [replicated cluster prepare](replicated-cli-cluster-prepare) - Prepare cluster for testing. +* [replicated cluster rm](replicated-cli-cluster-rm) - Remove test clusters. +* [replicated cluster shell](replicated-cli-cluster-shell) - Open a new shell with kubeconfig configured. +* [replicated cluster update](replicated-cli-cluster-update) - Update cluster settings. +* [replicated cluster upgrade](replicated-cli-cluster-upgrade) - Upgrade a test cluster. +* [replicated cluster versions](replicated-cli-cluster-versions) - List cluster versions. + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-completion-bash.md b/docs/reference/replicated-cli-completion-bash.md deleted file mode 100644 index a3a9dd7aaa..0000000000 --- a/docs/reference/replicated-cli-completion-bash.md +++ /dev/null @@ -1,22 +0,0 @@ -import Help from "../partials/replicated-cli/_help.mdx" - -# completion bash - -Generates scripts for bash command completion. - -## Usage - -```bash -replicated completion bash [flags] -``` - -The following flags are supported: - - - - - - - - -
FlagType (if applicable)Description
\ No newline at end of file diff --git a/docs/reference/replicated-cli-completion-fish.md b/docs/reference/replicated-cli-completion-fish.md deleted file mode 100644 index 9175e95919..0000000000 --- a/docs/reference/replicated-cli-completion-fish.md +++ /dev/null @@ -1,22 +0,0 @@ -import Help from "../partials/replicated-cli/_help.mdx" - -# completion fish - -Generates scripts for fish command completion. - -## Usage - -```bash -replicated completion fish [flags] -``` - -The following flags are supported: - - - - - - - - -
FlagType (if applicable)Description
diff --git a/docs/reference/replicated-cli-completion-powershell.md b/docs/reference/replicated-cli-completion-powershell.md deleted file mode 100644 index 5b12ba4aba..0000000000 --- a/docs/reference/replicated-cli-completion-powershell.md +++ /dev/null @@ -1,22 +0,0 @@ -import Help from "../partials/replicated-cli/_help.mdx" - -# completion powershell - -Generates scripts for powershell command completion. - -## Usage - -```bash -replicated completion powershell [flags] -``` - -The following flags are supported: - - - - - - - - -
FlagType (if applicable)Description
diff --git a/docs/reference/replicated-cli-completion-zsh.md b/docs/reference/replicated-cli-completion-zsh.md deleted file mode 100644 index 9f120b8d46..0000000000 --- a/docs/reference/replicated-cli-completion-zsh.md +++ /dev/null @@ -1,22 +0,0 @@ -import Help from "../partials/replicated-cli/_help.mdx" - -# completion zsh - -Generates scripts for zsh command completion. - -## Usage - -```bash -replicated completion zsh [flags] -``` - -The following flags are supported: - - - - - - - - -
FlagType (if applicable)Description
diff --git a/docs/reference/replicated-cli-completion.mdx b/docs/reference/replicated-cli-completion.mdx index 2f03fbbef3..96649dbeae 100644 --- a/docs/reference/replicated-cli-completion.mdx +++ b/docs/reference/replicated-cli-completion.mdx @@ -1,47 +1,75 @@ -import Help from "../partials/replicated-cli/_help.mdx" - -# completion - -Generates scripts for bash, fish, powershell, and zsh command completion. - -## Usage - -```bash -replicated completion [command] [flags] -``` - -The following `completion` commands are supported: - - - - - - - - - - - - - - - - - - - - - - -
CommandDescription
replicated completion bashGenerates bash completion script
replicated completion fishGenerates fish completion script
replicated completion powershellGenerates powershell completion script
replicated completion zshGenerates zsh completion script
- -The following flags are supported: - - - - - - - - -
FlagType (if applicable)Description
+# replicated completion + +Generate completion script + +``` +replicated completion [bash|zsh|fish|powershell] +``` + +### Examples + +``` +To load completions: + +Bash: + + This script depends on the 'bash-completion' package. + If it is not installed already, you can install it via your OS's package manager. + + $ source <(replicated completion bash) + + # To load completions for each session, execute once: + # Linux: + $ replicated completion bash > /etc/bash_completion.d/replicated + # macOS: + $ replicated completion bash > $(brew --prefix)/etc/bash_completion.d/replicated + +Zsh: + + # If shell completion is not already enabled in your environment, + # you will need to enable it. You can execute the following once: + + $ echo "autoload -U compinit; compinit" >> ~/.zshrc + + # To load completions for each session, execute once: + $ replicated completion zsh > "${fpath[1]}/_replicated" + + # You will need to start a new shell for this setup to take effect. + +fish: + + $ replicated completion fish | source + + # To load completions for each session, execute once: + $ replicated completion fish > ~/.config/fish/completions/replicated.fish + +PowerShell: + + PS> replicated completion powershell | Out-String | Invoke-Expression + + # To load completions for every new session, run: + PS> replicated completion powershell > replicated.ps1 + # and source this file from your PowerShell profile. + +``` + +### Options + +``` + -h, --help help for completion +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated](replicated) - Manage your Commercial Software Distribution Lifecycle using Replicated + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-customer-archive.mdx b/docs/reference/replicated-cli-customer-archive.mdx new file mode 100644 index 0000000000..f831ffbc70 --- /dev/null +++ b/docs/reference/replicated-cli-customer-archive.mdx @@ -0,0 +1,54 @@ +# replicated customer archive + +Archive a customer + +### Synopsis + +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. + +``` +replicated customer archive [flags] +``` + +### Examples + +``` +# Archive a customer by name +replicated customer archive "Acme Inc" + +# Archive a customer by ID +replicated customer archive cus_abcdef123456 + +# Archive multiple customers by ID +replicated customer archive cus_abcdef123456 cus_xyz9876543210 + +# Archive a customer in a specific app (if you have multiple apps) +replicated customer archive --app myapp "Acme Inc" +``` + +### Options + +``` + --app string The app to archive the customer in (not required when using a customer id) + -h, --help help for archive +``` + +### Options inherited from parent commands + +``` + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated customer](replicated-cli-customer) - Manage customers + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-customer-create.md b/docs/reference/replicated-cli-customer-create.md deleted file mode 100644 index a2444037bc..0000000000 --- a/docs/reference/replicated-cli-customer-create.md +++ /dev/null @@ -1,59 +0,0 @@ -import Token from "../partials/replicated-cli/_token.mdx" -import Help from "../partials/replicated-cli/_help.mdx" -import App from "../partials/replicated-cli/_app.mdx" - -# customer create - -Create a new customer in your application and associate a customer to a channel. -Customer information returned on success. - -## Usage -```bash -replicated customer create [Flags] -``` - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FlagType (if applicable)Description
--namestringThe name of the customer. (Required)
--channelstringThe channel name to associate with the customer. Case-sensitive. (Required)
--ensure-channelIf set, channel is created if it does not exist.
--expires-indurationIf set, license will expire a specified number of units from the current time. For example, 2h or 1h60m or 120m are all the same duration.
--custom-idstringIf 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.)
- -## Examples -```bash -replicated customer create --channel Megacorp_Beta --name "Megacorp" --ensure-channel --expires-in "8760h" --custom-id "salesforceid-123" -``` - -```bash -ID NAME CHANNELS EXPIRES TYPE CUSTOM_ID -2u4KGXSY65SAUW0ltG_pPhxBGPJ4XNSS Megacorp Megacorp_Beta 2021-01-20 00:17:38 +0000 UTC dev salesforceid-123 -``` diff --git a/docs/reference/replicated-cli-customer-create.mdx b/docs/reference/replicated-cli-customer-create.mdx new file mode 100644 index 0000000000..9144128a1f --- /dev/null +++ b/docs/reference/replicated-cli-customer-create.mdx @@ -0,0 +1,83 @@ +# replicated customer create + +Create a new customer for the current application + +### Synopsis + +Create a new customer for the current application with specified attributes. + +This command allows you to create a customer record with various properties such as name, +custom ID, channels, license type, and feature flags. You can set expiration dates, +enable or disable specific features, and assign the customer to one or more channels. + +The --app flag must be set to specify the target application. + +``` +replicated customer create [flags] +``` + +### Examples + +``` +# Create a basic customer with a name and assigned to a channel +replicated customer create --app myapp --name "Acme Inc" --channel stable + +# Create a customer with multiple channels and a custom ID +replicated customer create --app myapp --name "Beta Corp" --custom-id "BETA123" --channel beta --channel stable + +# Create a paid customer with specific features enabled +replicated customer create --app myapp --name "Enterprise Ltd" --type paid --channel enterprise --airgap --snapshot + +# Create a trial customer with an expiration date +replicated customer create --app myapp --name "Trial User" --type trial --channel stable --expires-in 720h + +# Create a customer with all available options +replicated customer create --app myapp --name "Full Options Inc" --custom-id "FULL001" \ + --channel stable --channel beta --default-channel stable --type paid \ + --email "contact@fulloptions.com" --expires-in 8760h \ + --airgap --snapshot --kots-install --embedded-cluster-download \ + --support-bundle-upload --ensure-channel +``` + +### Options + +``` + --airgap If set, the license will allow airgap installs. + --channel stringArray Release channel to which the customer should be assigned (can be specified multiple times) + --custom-id string Set a custom customer ID to more easily tie this customer record to your external data systems + --default-channel string Which of the specified channels should be the default channel. if not set, the first channel specified will be the default channel. + --developer-mode If set, Replicated SDK installed in dev mode will use mock data. + --email string Email address of the customer that is to be created. + --embedded-cluster-download If set, the license will allow embedded cluster downloads. + --ensure-channel If set, channel will be created if it does not exist. + --expires-in duration If set, an expiration date will be set on the license. Supports Go durations like '72h' or '3600m' + --geo-axis If set, the license will allow Geo Axis usage. + --gitops If set, the license will allow the GitOps usage. + --helm-install If set, the license will allow Helm installs. + --helmvm-cluster-download If set, the license will allow helmvm cluster downloads. + -h, --help help for create + --identity-service If set, the license will allow Identity Service usage. + --installer-support If set, the license will allow installer support. + --kots-install If set, the license will allow KOTS install. Otherwise license will allow Helm CLI installs only. (default true) + --kurl-install If set, the license will allow kURL installs. + --name string Name of the customer + --output string The output format to use. One of: json|table (default: table) (default "table") + --snapshot If set, the license will allow Snapshots. + --support-bundle-upload If set, the license will allow uploading support bundles. + --type string The license type to create. One of: dev|trial|paid|community|test (default: dev) (default "dev") +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated customer](replicated-cli-customer) - Manage customers + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-customer-download-license.md b/docs/reference/replicated-cli-customer-download-license.md deleted file mode 100644 index 62a5a2ed9f..0000000000 --- a/docs/reference/replicated-cli-customer-download-license.md +++ /dev/null @@ -1,53 +0,0 @@ -import Token from "../partials/replicated-cli/_token.mdx" -import Help from "../partials/replicated-cli/_help.mdx" -import App from "../partials/replicated-cli/_app.mdx" - -# customer download-license - -Print the license YAML file for a customer. - -## Usage -```bash -replicated customer download-license -``` - - - - - - - - - - - - - - - -
FlagType (if applicable)Description
--customerstringThe customer name or ID.
- -## Examples -```bash -replicated customer download-license --customer cli-customer -apiVersion: kots.io/v1beta1 -kind: License -metadata: - name: cli-customer -spec: - appSlug: cli-app - channelID: 1xy9tHhAwHyoc0HEybppxPpbPn6 - channelName: Unstable - customerName: cli-customer - endpoint: https://staging.replicated.app - entitlements: - expires_at: - description: License Expiration - title: Expiration - value: "" - valueType: String - licenseID: 1xyCOBjfm5FVkDoCYOAyvVnELfZ - licenseSequence: 1 - licenseType: dev - signature: (ommitted) -``` diff --git a/docs/reference/replicated-cli-customer-download-license.mdx b/docs/reference/replicated-cli-customer-download-license.mdx new file mode 100644 index 0000000000..587b6c39a3 --- /dev/null +++ b/docs/reference/replicated-cli-customer-download-license.mdx @@ -0,0 +1,53 @@ +# replicated customer download-license + +Download a customer's license + +### Synopsis + +The download-license command allows you to retrieve and save a customer's license. + +This command fetches the license for a specified customer and either outputs it +to stdout or saves it to a file. The license contains crucial information about +the customer's subscription and usage rights. + +You must specify the customer using either their name or ID with the --customer flag. + +``` +replicated customer download-license [flags] +``` + +### Examples + +``` +# Download license for a customer by ID and output to stdout +replicated customer download-license --customer cus_abcdef123456 + +# Download license for a customer by name and save to a file +replicated customer download-license --customer "Acme Inc" --output license.yaml + +# Download license for a customer in a specific app (if you have multiple apps) +replicated customer download-license --app myapp --customer "Acme Inc" --output license.yaml +``` + +### Options + +``` + --customer string The Customer Name or ID + -h, --help help for download-license + -o, --output string Path to output license to. Defaults to stdout (default "-") +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated customer](replicated-cli-customer) - Manage customers + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-customer-inspect.mdx b/docs/reference/replicated-cli-customer-inspect.mdx new file mode 100644 index 0000000000..f21554e35b --- /dev/null +++ b/docs/reference/replicated-cli-customer-inspect.mdx @@ -0,0 +1,56 @@ +# replicated customer inspect + +Show detailed information about a specific customer + +### Synopsis + +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. + +``` +replicated customer inspect [flags] +``` + +### Examples + +``` +# Inspect a customer by ID +replicated customer inspect --customer cus_abcdef123456 + +# Inspect a customer by name +replicated customer inspect --customer "Acme Inc" + +# Inspect a customer and output in JSON format +replicated customer inspect --customer cus_abcdef123456 --output json + +# Inspect a customer for a specific app (if you have multiple apps) +replicated customer inspect --app myapp --customer "Acme Inc" +``` + +### Options + +``` + --customer string The Customer Name or ID + -h, --help help for inspect + --output string The output format to use. One of: json|table (default: table) (default "table") +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated customer](replicated-cli-customer) - Manage customers + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-customer-ls.md b/docs/reference/replicated-cli-customer-ls.md deleted file mode 100644 index 11e023f82f..0000000000 --- a/docs/reference/replicated-cli-customer-ls.md +++ /dev/null @@ -1,44 +0,0 @@ -import Token from "../partials/replicated-cli/_token.mdx" -import Help from "../partials/replicated-cli/_help.mdx" -import App from "../partials/replicated-cli/_app.mdx" - -# customer ls - -List the customers for your application. - -## Usage -```bash -replicated customer ls -``` - - - - - - - - - - - -
FlagType (if applicable)Description
--app-versionstringThe application version. Used to list customers and their instances for a specific application version.
- -## Examples - -List all customers: - -```bash -replicated customer ls -ID NAME CHANNELS EXPIRES TYPE CUSTOM_ID -iEgJuVDHy2pi-AqOjLXbZCTX9bqlV6YH John Smith Unstable Never Not Set -YAg7ripYbK0tM5MVn_81nMy0YrhBsHrm Megacorp Megacorp_Beta Never salesforceid-123 -``` - -List customers and their instances for a specific application version: - -```bash -replicated customer ls --app-version 1.1.0 - -CUSTOMER NAME INSTANCE ID LAST ACTIVE VERSION -ACME Corp iEgJuVDHy2pi-AqOjLXbZCTX9bqlV6YH 2023-05-23 23:13:01.403 +0000 UTC 1.1.0 -Megacorp YAg7ripYbK0tM5MVn_81nMy0YrhBsHrm 2023-05-24 00:00:02.937 +0000 UTC 1.1.0 diff --git a/docs/reference/replicated-cli-customer-ls.mdx b/docs/reference/replicated-cli-customer-ls.mdx new file mode 100644 index 0000000000..5284abc3ce --- /dev/null +++ b/docs/reference/replicated-cli-customer-ls.mdx @@ -0,0 +1,55 @@ +# replicated customer ls + +List customers for the current application + +### Synopsis + +List customers associated with the current application. + +This command displays information about customers linked to your application. +By default, it shows all non-test customers. You can use flags to: +- Filter customers by a specific app version +- Include test customers in the results +- Change the output format (table or JSON) + +The command requires an app to be set using the --app flag. + +``` +replicated customer ls [flags] +``` + +### Examples + +``` +# List all customers for the current application +replicated customer ls --app myapp +# Output results in JSON format +replicated customer ls --app myapp --output json + +# Combine multiple flags +replicated customer ls --app myapp --output json +``` + +### Options + +``` + --app-version string Filter customers by a specific app version + -h, --help help for ls + --include-test Include test customers in the results + --output string Output format: json|table (default: table) (default "table") +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated customer](replicated-cli-customer) - Manage customers + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-customer-update.mdx b/docs/reference/replicated-cli-customer-update.mdx new file mode 100644 index 0000000000..4e20037bfe --- /dev/null +++ b/docs/reference/replicated-cli-customer-update.mdx @@ -0,0 +1,82 @@ +# replicated customer update + +Update an existing customer + +### Synopsis + +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. + +``` +replicated customer update --customer --name [options] [flags] +``` + +### Examples + +``` +# Update a customer's name +replicated customer update --customer cus_abcdef123456 --name "New Company Name" + +# Change a customer's channel and make it the default +replicated customer update --customer cus_abcdef123456 --channel stable --default-channel stable + +# Enable airgap installations for a customer +replicated customer update --customer cus_abcdef123456 --airgap + +# Update multiple attributes at once +replicated customer update --customer cus_abcdef123456 --name "Updated Corp" --type paid --channel enterprise --airgap --snapshot + +# Set an expiration date for a customer's license +replicated customer update --customer cus_abcdef123456 --expires-in 8760h + +# Update a customer and output the result in JSON format +replicated customer update --customer cus_abcdef123456 --name "JSON Corp" --output json +``` + +### Options + +``` + --airgap If set, the license will allow airgap installs. + --channel stringArray Release channel to which the customer should be assigned (can be specified multiple times) + --custom-id string Set a custom customer ID to more easily tie this customer record to your external data systems + --customer string The ID of the customer to update + --default-channel string Which of the specified channels should be the default channel. if not set, the first channel specified will be the default channel. + --developer-mode If set, Replicated SDK installed in dev mode will use mock data. + --email string Email address of the customer that is to be updated. + --embedded-cluster-download If set, the license will allow embedded cluster downloads. + --ensure-channel If set, channel will be created if it does not exist. + --expires-in duration If set, an expiration date will be set on the license. Supports Go durations like '72h' or '3600m' + --geo-axis If set, the license will allow Geo Axis usage. + --gitops If set, the license will allow the GitOps usage. + --helm-install If set, the license will allow Helm installs. + --helmvm-cluster-download If set, the license will allow helmvm cluster downloads. + -h, --help help for update + --identity-service If set, the license will allow Identity Service usage. + --kots-install If set, the license will allow KOTS install. Otherwise license will allow Helm CLI installs only. (default true) + --kurl-install If set, the license will allow kURL installs. + --name string Name of the customer + --output string The output format to use. One of: json|table (default: table) (default "table") + --snapshot If set, the license will allow Snapshots. + --support-bundle-upload If set, the license will allow uploading support bundles. + --type string The license type to update. One of: dev|trial|paid|community|test (default: dev) (default "dev") +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated customer](replicated-cli-customer) - Manage customers + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-customer.mdx b/docs/reference/replicated-cli-customer.mdx new file mode 100644 index 0000000000..5c460f8b0d --- /dev/null +++ b/docs/reference/replicated-cli-customer.mdx @@ -0,0 +1,34 @@ +# replicated customer + +Manage customers + +### Synopsis + +The customers command allows vendors to create, display, modify end customer records. + +### Options + +``` + -h, --help help for customer +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated](replicated) - Manage your Commercial Software Distribution Lifecycle using Replicated +* [replicated customer archive](replicated-cli-customer-archive) - Archive a customer +* [replicated customer create](replicated-cli-customer-create) - Create a new customer for the current application +* [replicated customer download-license](replicated-cli-customer-download-license) - Download a customer's license +* [replicated customer inspect](replicated-cli-customer-inspect) - Show detailed information about a specific customer +* [replicated customer ls](replicated-cli-customer-ls) - List customers for the current application +* [replicated customer update](replicated-cli-customer-update) - Update an existing customer + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-default-clear-all.mdx b/docs/reference/replicated-cli-default-clear-all.mdx new file mode 100644 index 0000000000..7afd47c819 --- /dev/null +++ b/docs/reference/replicated-cli-default-clear-all.mdx @@ -0,0 +1,41 @@ +# replicated default clear-all + +Clear all default values + +### Synopsis + +Clears all default values that are used by other commands. + +This command removes all default values that are used by other commands run by the current user. + +``` +replicated default clear-all [flags] +``` + +### Examples + +``` +# Clear all default values +replicated default clear-all +``` + +### Options + +``` + -h, --help help for clear-all +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated default](replicated-cli-default) - Manage default values used by other commands + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-default-clear.mdx b/docs/reference/replicated-cli-default-clear.mdx new file mode 100644 index 0000000000..6be58a2197 --- /dev/null +++ b/docs/reference/replicated-cli-default-clear.mdx @@ -0,0 +1,44 @@ +# replicated default clear + +Clear default value for a key + +### Synopsis + +Clears default value for the specified key. + +This command removes default values that are used by other commands run by the current user. + +Supported keys: +- app: the default application to use + +``` +replicated default clear KEY [flags] +``` + +### Examples + +``` +# Clear default application +replicated default clear app +``` + +### Options + +``` + -h, --help help for clear +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated default](replicated-cli-default) - Manage default values used by other commands + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-default-set.mdx b/docs/reference/replicated-cli-default-set.mdx new file mode 100644 index 0000000000..d8d55a9eb4 --- /dev/null +++ b/docs/reference/replicated-cli-default-set.mdx @@ -0,0 +1,48 @@ +# replicated default set + +Set default value for a key + +### Synopsis + +Sets default value for the specified key. + +This command sets default values that will be used by other commands run by the current user. + +Supported keys: +- app: the default application to use + +The output can be customized using the --output flag to display results in +either table or JSON format. + +``` +replicated default set KEY VALUE [flags] +``` + +### Examples + +``` +# Set default application +replicated default set app my-app-slug +``` + +### Options + +``` + -h, --help help for set + --output string The output format to use. One of: json|table (default: table) (default "table") +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated default](replicated-cli-default) - Manage default values used by other commands + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-default-show.mdx b/docs/reference/replicated-cli-default-show.mdx new file mode 100644 index 0000000000..d9953dba98 --- /dev/null +++ b/docs/reference/replicated-cli-default-show.mdx @@ -0,0 +1,49 @@ +# replicated default show + +Show default value for a key + +### Synopsis + +Shows defaul values for the specified key. + +This command shows default values that will be used by other commands run by the current user. + +Supported keys: +- app: the default application to use + +The output can be customized using the --output flag to display results in +either table or JSON format. + +``` +replicated default show KEY [flags] +``` + +### Examples + +``` +# Show default application +replicated default show app + +``` + +### Options + +``` + -h, --help help for show + --output string The output format to use. One of: json|table (default: table) (default "table") +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated default](replicated-cli-default) - Manage default values used by other commands + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-default.mdx b/docs/reference/replicated-cli-default.mdx new file mode 100644 index 0000000000..b8da1395bc --- /dev/null +++ b/docs/reference/replicated-cli-default.mdx @@ -0,0 +1,28 @@ +# replicated default + +Manage default values used by other commands + +### Options + +``` + -h, --help help for default +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated](replicated) - Manage your Commercial Software Distribution Lifecycle using Replicated +* [replicated default clear](replicated-cli-default-clear) - Clear default value for a key +* [replicated default clear-all](replicated-cli-default-clear-all) - Clear all default values +* [replicated default set](replicated-cli-default-set) - Set default value for a key +* [replicated default show](replicated-cli-default-show) - Show default value for a key + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-installer-create.md b/docs/reference/replicated-cli-installer-create.md deleted file mode 100644 index 320a2ce0bb..0000000000 --- a/docs/reference/replicated-cli-installer-create.md +++ /dev/null @@ -1,94 +0,0 @@ -import Help from "../partials/replicated-cli/_help.mdx" -import App from "../partials/replicated-cli/_app.mdx" -import Token from "../partials/replicated-cli/_token.mdx" - -# installer create - -Create a new kURL installer manifest by providing a YAML file for a cluster. For more information, see [Creating a kURL Installer](/vendor/packaging-embedded-kubernetes). - -## Usage -```bash -replicated installer create [flags] -``` - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FlagType (if applicable)Description
--autoGenerate the default values for use in the CI
-y, --confirm-autoAuto-accept the configuration generated by the --auto flag
--ensure-channelWhen used with --promote channel, creates the channel if it does not exist.
--promotestringChannel name or ID to promote this installer to. Channel name is case sensitive.
--yamlstringThe YAML config for this installer. Use '-' to read from stdin. Cannot be used with the --yaml-file flag.
--yaml-filestringThe file name with YAML config for this installer. Cannot be used with the --yaml flag.
- -## Examples - - -```bash -cat longhorn.yaml -apiVersion: "cluster.kurl.sh/v1beta1" -kind: "Installer" -metadata: - name: "longhorn-install" -spec: - kubernetes: - version: "1.21.x" - weave: - version: "2.8.x" - prometheus: - version: "latest" - registry: - version: "latest" - containerd: - version: "latest" - kotsadm: - version: "latest" - ekco: - version: "latest" - minio: - version: "latest" - longhorn: - version: "latest" - metricsServer: - version: "latest" - goldpinger: - version: "latest" - -replicated installer create --yaml-file ./longhorn.yaml --promote Unstable - • Creating Installer ✓ - • SEQUENCE: 2 - • Promoting ✓ - • Channel 1xy9tHhAwHyoc0HEybppxPpbPn6 successfully set to installer 2 - -``` diff --git a/docs/reference/replicated-cli-installer-create.mdx b/docs/reference/replicated-cli-installer-create.mdx new file mode 100644 index 0000000000..e434caa82a --- /dev/null +++ b/docs/reference/replicated-cli-installer-create.mdx @@ -0,0 +1,38 @@ +# replicated installer create + +Create a new installer spec + +### Synopsis + +Create a new installer spec by providing YAML configuration for a https://kurl.sh cluster. + +``` +replicated installer create [flags] +``` + +### Options + +``` + --auto generate default values for use in CI + -y, --confirm-auto auto-accept the configuration generated by the --auto flag + --ensure-channel When used with --promote , will create the channel if it doesn't exist + -h, --help help for create + --promote string Channel name or id to promote this installer to + --yaml string The YAML config for this installer. Use '-' to read from stdin. Cannot be used with the --yaml-file flag. + --yaml-file string The file name with YAML config for this installer. Cannot be used with the --yaml flag. +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated installer](replicated-cli-installer) - Manage Kubernetes installers + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-installer-ls.md b/docs/reference/replicated-cli-installer-ls.md deleted file mode 100644 index 7e0db3342e..0000000000 --- a/docs/reference/replicated-cli-installer-ls.md +++ /dev/null @@ -1,33 +0,0 @@ -import Help from "../partials/replicated-cli/_help.mdx" -import App from "../partials/replicated-cli/_app.mdx" -import Token from "../partials/replicated-cli/_token.mdx" - -# installer ls - -List the Kubernetes installer manifests for an app. For more information, see [Create An Installer](https://kurl.sh/docs/create-installer/) in the kURL documentation. - -## Usage -```bash -replicated installer ls -``` - - - - - - - - - - -
FlagType (if applicable)Description
- -## Examples - - -```bash -replicated installer ls -SEQUENCE CREATED ACTIVE_CHANNELS -2 2021-09-11T00:06:45Z -1 2021-09-10T23:31:13Z -``` diff --git a/docs/reference/replicated-cli-installer-ls.mdx b/docs/reference/replicated-cli-installer-ls.mdx new file mode 100644 index 0000000000..1011b3f690 --- /dev/null +++ b/docs/reference/replicated-cli-installer-ls.mdx @@ -0,0 +1,33 @@ +# replicated installer ls + +List an app's Kubernetes Installers + +### Synopsis + +List an app's https://kurl.sh Kubernetes Installers + +``` +replicated installer ls [flags] +``` + +### Options + +``` + -h, --help help for ls + --output string The output format to use. One of: json|table (default: table) (default "table") +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated installer](replicated-cli-installer) - Manage Kubernetes installers + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-installer.mdx b/docs/reference/replicated-cli-installer.mdx new file mode 100644 index 0000000000..53d3ab6069 --- /dev/null +++ b/docs/reference/replicated-cli-installer.mdx @@ -0,0 +1,30 @@ +# replicated installer + +Manage Kubernetes installers + +### Synopsis + +The installers command allows vendors to create, display, modify and promote kurl.sh specs for managing the installation of Kubernetes. + +### Options + +``` + -h, --help help for installer +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated](replicated) - Manage your Commercial Software Distribution Lifecycle using Replicated +* [replicated installer create](replicated-cli-installer-create) - Create a new installer spec +* [replicated installer ls](replicated-cli-installer-ls) - List an app's Kubernetes Installers + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-instance-inspect.md b/docs/reference/replicated-cli-instance-inspect.md deleted file mode 100644 index 36abfa488d..0000000000 --- a/docs/reference/replicated-cli-instance-inspect.md +++ /dev/null @@ -1,45 +0,0 @@ -import Help from "../partials/replicated-cli/_help.mdx" -import App from "../partials/replicated-cli/_app.mdx" -import Token from "../partials/replicated-cli/_token.mdx" - -# instance inspect - -Show full details for a customer instance. - -## Usage - -``` -instance inspect [flags] -``` - - - - - - - - - - - - - - - - - - - - - - - - - -
FlagType (if applicable)Description
--customerstringCustomer Name or ID that instance belongs to.
--instancestringInstance Name or ID to inspect.
--outputstringThe output format to use: json or table. Default: table
- -## Example - -```bash -replicated instance inspect --customer ci-customer --instance ci-instance --output json -``` diff --git a/docs/reference/replicated-cli-instance-inspect.mdx b/docs/reference/replicated-cli-instance-inspect.mdx new file mode 100644 index 0000000000..00964a729e --- /dev/null +++ b/docs/reference/replicated-cli-instance-inspect.mdx @@ -0,0 +1,35 @@ +# replicated instance inspect + +Show full details for a customer instance + +### Synopsis + +Show full details for a customer instance + +``` +replicated instance inspect [flags] +``` + +### Options + +``` + --customer string Customer Name or ID + -h, --help help for inspect + --instance string Instance Name or ID + --output string The output format to use. One of: json|table (default: table) (default "table") +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated instance](replicated-cli-instance) - Manage instances + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-instance-ls.md b/docs/reference/replicated-cli-instance-ls.md deleted file mode 100644 index ff41ea7317..0000000000 --- a/docs/reference/replicated-cli-instance-ls.md +++ /dev/null @@ -1,49 +0,0 @@ -import Help from "../partials/replicated-cli/_help.mdx" -import App from "../partials/replicated-cli/_app.mdx" -import Token from "../partials/replicated-cli/_token.mdx" - -# instance ls - -List customer instances. - -## Usage - -``` -instance ls [flags] -``` - - - - - - - - - - - - - - - - - - - - - - - - - -
FlagType (if applicable)Description
--customerstringCustomer Name or ID to list instances for.
--outputstringThe output format to use: json or table. Default: table
--tagstringTags to filter instances. Multiple --tag flags can be specified. Only one of the tags must match per instance.
- -## Examples - -```bash -replicated instance ls --customer ci-customer -``` - -```bash -replicated instance ls --customer 2ULcKDT6snYYy5Zsdx3xuc3fffl --tag manager=joe --tag role=support -``` diff --git a/docs/reference/replicated-cli-instance-ls.mdx b/docs/reference/replicated-cli-instance-ls.mdx new file mode 100644 index 0000000000..4d4aaf41bf --- /dev/null +++ b/docs/reference/replicated-cli-instance-ls.mdx @@ -0,0 +1,35 @@ +# replicated instance ls + +list customer instances + +### Synopsis + +list customer instances + +``` +replicated instance ls [flags] +``` + +### Options + +``` + --customer string Customer Name or ID + -h, --help help for ls + --output string The output format to use. One of: json|table (default: table) (default "table") + --tag stringArray Tags to use to filter instances (key=value format, can be specified multiple times). Only one tag needs to match (an OR operation) +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated instance](replicated-cli-instance) - Manage instances + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-instance-tag.md b/docs/reference/replicated-cli-instance-tag.md deleted file mode 100644 index e3c50feda0..0000000000 --- a/docs/reference/replicated-cli-instance-tag.md +++ /dev/null @@ -1,51 +0,0 @@ -import Help from "../partials/replicated-cli/_help.mdx" -import App from "../partials/replicated-cli/_app.mdx" -import Token from "../partials/replicated-cli/_token.mdx" - -# instance tag - -Add or remove instance tags - -## Usage - -``` -instance tag [flags] -``` - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FlagType (if applicable)Description
--customerstringCustomer Name or ID that instance belongs to.
--instancestringInstance Name or ID to add or remove tags.
--outputstringThe output format to use: json or table. Default: table
--tagstringTags to apply to the instance. Leave value empty to remove tag. Tags not specified are removed or modified.
- -## Example - -```bash -replicated instance tag --customer ci-customer --instance ci-instance --tag tag-to-set=value tag-to-remove= -``` - diff --git a/docs/reference/replicated-cli-instance-tag.mdx b/docs/reference/replicated-cli-instance-tag.mdx new file mode 100644 index 0000000000..65cd6b7a22 --- /dev/null +++ b/docs/reference/replicated-cli-instance-tag.mdx @@ -0,0 +1,36 @@ +# replicated instance tag + +tag an instance + +### Synopsis + +remove or add instance tags + +``` +replicated instance tag [flags] +``` + +### Options + +``` + --customer string Customer Name or ID + -h, --help help for tag + --instance string Instance Name or ID + --output string The output format to use. One of: json|table (default: table) (default "table") + --tag stringArray Tags to apply to instance. Leave value empty to remove tag. Tags not specified will not be removed. +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated instance](replicated-cli-instance) - Manage instances + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-instance.mdx b/docs/reference/replicated-cli-instance.mdx new file mode 100644 index 0000000000..d9aa2e9236 --- /dev/null +++ b/docs/reference/replicated-cli-instance.mdx @@ -0,0 +1,31 @@ +# replicated instance + +Manage instances + +### Synopsis + +The instance command allows vendors to display and tag customer instances. + +### Options + +``` + -h, --help help for instance +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated](replicated) - Manage your Commercial Software Distribution Lifecycle using Replicated +* [replicated instance inspect](replicated-cli-instance-inspect) - Show full details for a customer instance +* [replicated instance ls](replicated-cli-instance-ls) - list customer instances +* [replicated instance tag](replicated-cli-instance-tag) - tag an instance + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-login.md b/docs/reference/replicated-cli-login.md deleted file mode 100644 index fa33e2a53a..0000000000 --- a/docs/reference/replicated-cli-login.md +++ /dev/null @@ -1,30 +0,0 @@ -import Help from "../partials/replicated-cli/_help.mdx" - -# login - -Open a browser for collecting authentication details, then create and retrieve an API token to authorize the Replicated CLI. [`replicated logout`](/reference/replicated-cli-logout) removes the credentials created by `replicated login`. - -`replicated login` can be used instead of generating an API token and setting the `REPLICATED_API_TOKEN` environment variable. For more information, see [Installing the Replicated CLI](/reference/replicated-cli-installing). - -## Usage - -```bash -replicated login [flags] -``` - -Where `SEQUENCE` is the sequence number for the target release. - - - - - - - - -
FlagType (if applicable)Description
- -## Example - -```bash -replicated login -``` \ No newline at end of file diff --git a/docs/reference/replicated-cli-login.mdx b/docs/reference/replicated-cli-login.mdx new file mode 100644 index 0000000000..c3c84274c8 --- /dev/null +++ b/docs/reference/replicated-cli-login.mdx @@ -0,0 +1,32 @@ +# replicated login + +Log in to Replicated + +### Synopsis + +This command will open your browser to ask you authentication details and create / retrieve an API token for the CLI to use. + +``` +replicated login [flags] +``` + +### Options + +``` + -h, --help help for login +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated](replicated) - Manage your Commercial Software Distribution Lifecycle using Replicated + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-logout.md b/docs/reference/replicated-cli-logout.md deleted file mode 100644 index 7626d392bb..0000000000 --- a/docs/reference/replicated-cli-logout.md +++ /dev/null @@ -1,30 +0,0 @@ -import Help from "../partials/replicated-cli/_help.mdx" - -# logout - -Remove any credentials created by the [`replicated login`](/reference/replicated-cli-login) command. - -## Usage - -```bash -replicated logout [flags] -``` - -:::note -If the `REPLICATED_API_TOKEN` environment variable is set, the `replicated logout` command displayed the following error: `Error: REPLICATED_API_TOKEN is set. Please unset it to logout.` For more information, see [Installing the Replicated CLI](/reference/replicated-cli-installing). -::: - - - - - - - - -
FlagType (if applicable)Description
- -## Examples - -```bash -replicated logout -``` \ No newline at end of file diff --git a/docs/reference/replicated-cli-logout.mdx b/docs/reference/replicated-cli-logout.mdx new file mode 100644 index 0000000000..8cd5e201d6 --- /dev/null +++ b/docs/reference/replicated-cli-logout.mdx @@ -0,0 +1,32 @@ +# replicated logout + +Logout from Replicated + +### Synopsis + +This command will remove any stored credentials from the CLI. + +``` +replicated logout [flags] +``` + +### Options + +``` + -h, --help help for logout +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated](replicated) - Manage your Commercial Software Distribution Lifecycle using Replicated + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-registry-add-dockerhub.mdx b/docs/reference/replicated-cli-registry-add-dockerhub.mdx index 682371d9c0..f00864e6da 100644 --- a/docs/reference/replicated-cli-registry-add-dockerhub.mdx +++ b/docs/reference/replicated-cli-registry-add-dockerhub.mdx @@ -1,37 +1,39 @@ -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" +# replicated registry add dockerhub -# registry add dockerhub +Add a DockerHub registry -Add a DockerHub registry using a username/password or an account token. +### Synopsis -## Usage +Add a DockerHub registry using a username/password or an account token -```bash +``` replicated registry add dockerhub [flags] ``` -The following flags are supported: - - - - - - - - - - - - - - - - -
FlagType (if applicable)Description
+ +### Options + +``` + --authtype string Auth type for the registry (default "password") + -h, --help help for dockerhub + --output string The output format to use. One of: json|table (default: table) (default "table") + --password string The password to authenticate to the registry with + --password-stdin Take the password from stdin + --token string The token to authenticate to the registry with + --token-stdin Take the token from stdin + --username string The userame to authenticate to the registry with +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --skip-validation Skip validation of the registry (not recommended) +``` + +### SEE ALSO + +* [replicated registry add](replicated-cli-registry-add) - add + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-registry-add-ecr.mdx b/docs/reference/replicated-cli-registry-add-ecr.mdx index e0a1741707..99eef6c383 100644 --- a/docs/reference/replicated-cli-registry-add-ecr.mdx +++ b/docs/reference/replicated-cli-registry-add-ecr.mdx @@ -1,42 +1,38 @@ -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" +# replicated registry add ecr -# registry add ecr +Add an ECR registry -Adds an ECR registry using an access key ID and secret access key. +### Synopsis -## Usage +Add an ECR registry using an Access Key ID and Secret Access Key -```bash +``` replicated registry add ecr [flags] ``` -The following flags are supported: - - - - - - - - - - - - - - - - - - - - - - - - - - -
FlagType (if applicable)Description
--accesskeyidstringThe access key ID to use when authenticating to the registry.
--secretaccesskeystringThe secret access key to use when authenticating to the registry.
--secretaccesskey-stdinTakes the secret access key from stdin.
+ +### Options + +``` + --accesskeyid string The access key id to authenticate to the registry with + --endpoint string The ECR endpoint + -h, --help help for ecr + --output string The output format to use. One of: json|table (default: table) (default "table") + --secretaccesskey string The secret access key to authenticate to the registry with + --secretaccesskey-stdin Take the secret access key from stdin +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --skip-validation Skip validation of the registry (not recommended) + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated registry add](replicated-cli-registry-add) - add + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-registry-add-gar.mdx b/docs/reference/replicated-cli-registry-add-gar.mdx index 2a21454403..fda6c4a57d 100644 --- a/docs/reference/replicated-cli-registry-add-gar.mdx +++ b/docs/reference/replicated-cli-registry-add-gar.mdx @@ -1,47 +1,39 @@ -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" +# replicated registry add gar -# registry add gar +Add a Google Artifact Registry -Adds a Google Artifact Registry (GAR) using a service account key or token. +### Synopsis -## Usage +Add a Google Artifact Registry using a service account key -```bash +``` replicated registry add gar [flags] ``` -The following flags are supported: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FlagType (if applicable)Description
--serviceaccountkeystringThe service account key to use when authenticating to the registry.
--serviceaccountkey-stdinTake the service account key from stdin.
--tokenstringThe Google Cloud OAuth token to use when authenticating to the registry.
--token-stdinTakes the Google Cloud OAuth token from stdin.
+### Options + +``` + --authtype string Auth type for the registry (default "serviceaccount") + --endpoint string The GAR endpoint + -h, --help help for gar + --output string The output format to use. One of: json|table (default: table) (default "table") + --serviceaccountkey string The service account key to authenticate to the registry with + --serviceaccountkey-stdin Take the service account key from stdin + --token string The token to use to auth to the registry with + --token-stdin Take the token from stdin +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --skip-validation Skip validation of the registry (not recommended) +``` + +### SEE ALSO + +* [replicated registry add](replicated-cli-registry-add) - add + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-registry-add-gcr.mdx b/docs/reference/replicated-cli-registry-add-gcr.mdx index 4fe49e2b40..775e303b45 100644 --- a/docs/reference/replicated-cli-registry-add-gcr.mdx +++ b/docs/reference/replicated-cli-registry-add-gcr.mdx @@ -1,38 +1,37 @@ -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" +# replicated registry add gcr -# registry add gcr +Add a Google Container Registry -Adds a Google Container Registry (GCR) using a service account key. +### Synopsis -## Usage +Add a Google Container Registry using a service account key -```bash +``` replicated registry add gcr [flags] ``` -The following flags are supported: - - - - - - - - - - - - - - - - - - - - - -
FlagType (if applicable)Description
--serviceaccountkeystringThe service account key to use when authenticating to the registry.
--serviceaccountkey-stdinTake the service account key from stdin.
+### Options + +``` + --endpoint string The GCR endpoint + -h, --help help for gcr + --output string The output format to use. One of: json|table (default: table) (default "table") + --serviceaccountkey string The service account key to authenticate to the registry with + --serviceaccountkey-stdin Take the service account key from stdin +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --skip-validation Skip validation of the registry (not recommended) + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated registry add](replicated-cli-registry-add) - add + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-registry-add-ghcr.mdx b/docs/reference/replicated-cli-registry-add-ghcr.mdx index d9a9575f59..8102735900 100644 --- a/docs/reference/replicated-cli-registry-add-ghcr.mdx +++ b/docs/reference/replicated-cli-registry-add-ghcr.mdx @@ -1,28 +1,35 @@ -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 TokenStdin from "../partials/replicated-cli/_token-stdin.mdx" -import Help from "../partials/replicated-cli/_help.mdx" +# replicated registry add ghcr -# registry add ghcr +Add a GitHub Container Registry -Adds a GitHub Container Registry using a username and personal access token (PAT). +### Synopsis -```bash +Add a GitHub Container Registry using a username and personal access token (PAT) + +``` replicated registry add ghcr [flags] ``` -The following flags are supported: - - - - - - - - - - - - -
FlagType (if applicable)Description
+### Options + +``` + -h, --help help for ghcr + --output string The output format to use. One of: json|table (default: table) (default "table") + --token string The token to use to auth to the registry with + --token-stdin Take the token from stdin +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --skip-validation Skip validation of the registry (not recommended) +``` + +### SEE ALSO + +* [replicated registry add](replicated-cli-registry-add) - add + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-registry-add-other.mdx b/docs/reference/replicated-cli-registry-add-other.mdx index f22a291e53..e85ba3f7b0 100644 --- a/docs/reference/replicated-cli-registry-add-other.mdx +++ b/docs/reference/replicated-cli-registry-add-other.mdx @@ -1,39 +1,38 @@ -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" +# replicated registry add other -# registry add other +Add a generic registry -Adds a generic registry using a username/password. +### Synopsis -## Usage +Add a generic registry using a username/password -```bash +``` replicated registry add other [flags] ``` -The following flags are supported: - - - - - - - - - - - - - - - - - - - -
FlagType (if applicable)Description
--endpointstringThe endpoint for the registry.
+### Options + +``` + --endpoint string endpoint for the registry + -h, --help help for other + --output string The output format to use. One of: json|table (default: table) (default "table") + --password string The password to authenticate to the registry with + --password-stdin Take the password from stdin + --username string The userame to authenticate to the registry with +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --skip-validation Skip validation of the registry (not recommended) + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated registry add](replicated-cli-registry-add) - add + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-registry-add-quay.mdx b/docs/reference/replicated-cli-registry-add-quay.mdx index 252e886650..3b32cc32f7 100644 --- a/docs/reference/replicated-cli-registry-add-quay.mdx +++ b/docs/reference/replicated-cli-registry-add-quay.mdx @@ -1,34 +1,37 @@ -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" +# replicated registry add quay -# registry add quay +Add a quay.io registry -Adds a quay.io registry using a username/password or a robot account. +### Synopsis -## Usage +Add a quay.io registry using a username/password (or a robot account) ``` replicated registry add quay [flags] ``` -The following flags are supported: - - - - - - - - - - - - - - -
FlagType (if applicable)Description
+### Options + +``` + -h, --help help for quay + --output string The output format to use. One of: json|table (default: table) (default "table") + --password string The password to authenticate to the registry with + --password-stdin Take the password from stdin + --username string The userame to authenticate to the registry with +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --skip-validation Skip validation of the registry (not recommended) + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated registry add](replicated-cli-registry-add) - add + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-registry-add.mdx b/docs/reference/replicated-cli-registry-add.mdx index 7286c26049..19064f6f7d 100644 --- a/docs/reference/replicated-cli-registry-add.mdx +++ b/docs/reference/replicated-cli-registry-add.mdx @@ -1,65 +1,36 @@ -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" +# replicated registry add -# registry add +add -Adds a new external registry. +### Synopsis -## Usage +add -```bash -registry add [command] [flags] +### Options + +``` + -h, --help help for add + --skip-validation Skip validation of the registry (not recommended) ``` -The following `registry add` commands are supported: +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --token string The API token to use to access your app in the Vendor API +``` - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
CommandDescription
replicated registry add dockerhubAdds a DockerHub registry.
replicated registry add ecrAdds an Amazon Elastic Container Registry (ECR).
replicated registry add garAdds a Google Artifact Registry (GAR).
replicated registry add gcrAdds a Google Container Registry (GCR).
replicated registry add ghcrAdds a GitHub Container Registry (GHCR).
replicated registry add otherAdds a registry that is not otherwise specified with its own command.
replicated registry add quayAdds a quay.io registry.
+### SEE ALSO -The following flags are supported: +* [replicated registry](replicated-cli-registry) - Manage registries +* [replicated registry add dockerhub](replicated-cli-registry-add-dockerhub) - Add a DockerHub registry +* [replicated registry add ecr](replicated-cli-registry-add-ecr) - Add an ECR registry +* [replicated registry add gar](replicated-cli-registry-add-gar) - Add a Google Artifact Registry +* [replicated registry add gcr](replicated-cli-registry-add-gcr) - Add a Google Container Registry +* [replicated registry add ghcr](replicated-cli-registry-add-ghcr) - Add a GitHub Container Registry +* [replicated registry add other](replicated-cli-registry-add-other) - Add a generic registry +* [replicated registry add quay](replicated-cli-registry-add-quay) - Add a quay.io registry - - - - - - - - - - -
FlagType (if applicable)Description
+###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-registry-logs.mdx b/docs/reference/replicated-cli-registry-logs.mdx deleted file mode 100644 index 1f5a96f37e..0000000000 --- a/docs/reference/replicated-cli-registry-logs.mdx +++ /dev/null @@ -1,28 +0,0 @@ -import App from "../partials/replicated-cli/_app.mdx" -import Token from "../partials/replicated-cli/_token.mdx" -import Help from "../partials/replicated-cli/_help.mdx" - -# registry logs - -Shows registry logs for a single registry. - -## Usage - -```bash -replicated registry logs [NAME] [flags] -``` - -Replace NAME with the name of the registry. - -The following flags are supported: - - - - - - - - - - -
FlagType (if applicable)Description
diff --git a/docs/reference/replicated-cli-registry-ls.mdx b/docs/reference/replicated-cli-registry-ls.mdx index 99c59b4e83..cdbf6d40de 100644 --- a/docs/reference/replicated-cli-registry-ls.mdx +++ b/docs/reference/replicated-cli-registry-ls.mdx @@ -1,28 +1,33 @@ -import App from "../partials/replicated-cli/_app.mdx" -import Token from "../partials/replicated-cli/_token.mdx" -import Help from "../partials/replicated-cli/_help.mdx" +# replicated registry ls -# registry ls +list registries -Lists multiple registries or a single registry by name. +### Synopsis -## Usage +list registries, or a single registry by name ``` replicated registry ls [NAME] [flags] ``` -Replace NAME with the name of the registry. +### Options -The following flags are supported: +``` + -h, --help help for ls + --output string The output format to use. One of: json|table (default: table) (default "table") +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated registry](replicated-cli-registry) - Manage registries - - - - - - - - - -
FlagType (if applicable)Description
+###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-registry-rm.mdx b/docs/reference/replicated-cli-registry-rm.mdx index e10c090d8a..0875d7af70 100644 --- a/docs/reference/replicated-cli-registry-rm.mdx +++ b/docs/reference/replicated-cli-registry-rm.mdx @@ -1,28 +1,32 @@ -import App from "../partials/replicated-cli/_app.mdx" -import Token from "../partials/replicated-cli/_token.mdx" -import Help from "../partials/replicated-cli/_help.mdx" +# replicated registry rm -# registry rm +remove registry -Removes a registry by endpoint. +### Synopsis -## Usage +remove registry by endpoint ``` replicated registry rm [ENDPOINT] [flags] ``` -Replace ENDPOINT with the name of the endpoint, such as gcr.io. +### Options -The following flags are supported: +``` + -h, --help help for rm +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated registry](replicated-cli-registry) - Manage registries - - - - - - - - - -
FlagType (if applicable)Description
+###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-registry-test.mdx b/docs/reference/replicated-cli-registry-test.mdx index d8aecbc834..672bd81122 100644 --- a/docs/reference/replicated-cli-registry-test.mdx +++ b/docs/reference/replicated-cli-registry-test.mdx @@ -1,33 +1,33 @@ -import App from "../partials/replicated-cli/_app.mdx" -import Token from "../partials/replicated-cli/_token.mdx" -import Help from "../partials/replicated-cli/_help.mdx" +# replicated registry test -# registry test +test registry -Tests pulling an image from a registry. +### Synopsis -## Usage +test registry -```bash +``` replicated registry test HOSTNAME [flags] ``` -Replace HOSTNAME with the name of the host. - -The following flags are supported: - - - - - - - - - - - - - - - -
FlagType (if applicable)Description
--imagestringThe image to use to do a test pull.
+### Options + +``` + -h, --help help for test + --image string The image to test pulling +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated registry](replicated-cli-registry) - Manage registries + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-registry.mdx b/docs/reference/replicated-cli-registry.mdx new file mode 100644 index 0000000000..c6c8d49b92 --- /dev/null +++ b/docs/reference/replicated-cli-registry.mdx @@ -0,0 +1,32 @@ +# replicated registry + +Manage registries + +### Synopsis + +registry can be used to manage existing registries and add new registries to a team + +### Options + +``` + -h, --help help for registry +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated](replicated) - Manage your Commercial Software Distribution Lifecycle using Replicated +* [replicated registry add](replicated-cli-registry-add) - add +* [replicated registry ls](replicated-cli-registry-ls) - list registries +* [replicated registry rm](replicated-cli-registry-rm) - remove registry +* [replicated registry test](replicated-cli-registry-test) - test registry + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-release-compatibility.md b/docs/reference/replicated-cli-release-compatibility.md deleted file mode 100644 index a2c897c798..0000000000 --- a/docs/reference/replicated-cli-release-compatibility.md +++ /dev/null @@ -1,53 +0,0 @@ -import Help from "../partials/replicated-cli/_help.mdx" - -# release compatibility - -Report the success or failure of compatibility tests ran against a release. View the compatibility result for a release with [`release inspect`](/reference/replicated-cli-release-inspect). - -## Usage - -```bash -replicated release compatibility SEQUENCE [flags] -``` - -Where `SEQUENCE` is the sequence number for the target release. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FlagType (if applicable)Description
--distributionstring

Kubernetes distribution of the cluster to report on.

--failurebool If set, the compatibility will be reported as a failure.
--notesstringAdditional notes to report.
--successIf set, the compatibility will be reported as a success.
--versionstringKubernetes version of the cluster to report on (format is distribution dependent).
- -## Example - -```bash -replicated release compatibility 48 --distribution openshift --version 1.27.0 --success -``` \ No newline at end of file diff --git a/docs/reference/replicated-cli-release-compatibility.mdx b/docs/reference/replicated-cli-release-compatibility.mdx new file mode 100644 index 0000000000..9b2a1734fc --- /dev/null +++ b/docs/reference/replicated-cli-release-compatibility.mdx @@ -0,0 +1,37 @@ +# replicated release compatibility + +Report release compatibility + +### Synopsis + +Report release compatibility for a kubernetes distribution and version + +``` +replicated release compatibility SEQUENCE [flags] +``` + +### Options + +``` + --distribution string Kubernetes distribution of the cluster to report on. + --failure If set, the compatibility will be reported as a failure. + -h, --help help for compatibility + --notes string Additional notes to report. + --success If set, the compatibility will be reported as a success. + --version string Kubernetes version of the cluster to report on (format is distribution dependent) +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated release](replicated-cli-release) - Manage app releases + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-release-create.md b/docs/reference/replicated-cli-release-create.md deleted file mode 100644 index c87e6779b9..0000000000 --- a/docs/reference/replicated-cli-release-create.md +++ /dev/null @@ -1,115 +0,0 @@ -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" - -# release create - -Create a new release using a collection of application manifest files and/or one or more Helm charts. - -## Usage -```bash -replicated release create --yaml-dir YAML_DIR [flags] -``` - -:::note -Additional flags returned by `--help` that are not supported by Replicated are omitted from the table below. -::: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FlagType (if applicable)Description
--yaml-dirpath

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

--promotestringChannel name to promote this release to. Case sensitive.
--ensure-channelWhen used with --promote channel, creates the channel if it does not exist.
--lintLint a manifest directory prior to creation of the release. For more information, see Linter Rules.
--release-notesstringWhen used with --promote channel, creates the release notes in markdown.
--versionstring

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.

- -## Examples - -### `--yaml-dir` - -```bash -replicated release create --yaml-dir ./manifests - - • Reading manifests from ./manifests ✓ - • Creating Release ✓ - • SEQUENCE: 58 -``` - -### `--promote` - -```bash -replicated release create --yaml-dir manifests --promote Unstable - - • Reading manifests from manifests ✓ - • Creating Release ✓ - • SEQUENCE: 59 - • Promoting ✓ - • Channel Unstable successfully set to release 59 -``` - -### `--ensure-channel` - -```bash -replicated release create --yaml-dir ./manifests --promote my-new-channel --ensure-channel - - • Reading manifests from manifests ✓ - • Creating Release ✓ - • SEQUENCE: 60 - • Promoting ✓ - • Channel my-new-channel successfully set to release 60 -``` - -### `--release-notes` - -```bash -replicated release create --yaml-dir ./manifests --promote Unstable --ensure-channel --release-notes "CI Release" - - • Reading manifests from manifests ✓ - • Creating Release ✓ - • SEQUENCE: 61 - • Promoting ✓ - • Channel Unstable successfully set to release 61 -``` - -### `--version` - -```bash -replicated release create --yaml-dir ./manifests --promote Unstable --ensure-channel --release-notes "Beta Release" --version "1.2.3" - - • Reading manifests from manifests ✓ - • Creating Release ✓ - • SEQUENCE: 62 - • Promoting ✓ - • Channel Unstable successfully set to release 62 -``` diff --git a/docs/reference/replicated-cli-release-create.mdx b/docs/reference/replicated-cli-release-create.mdx new file mode 100644 index 0000000000..a0fad26e62 --- /dev/null +++ b/docs/reference/replicated-cli-release-create.mdx @@ -0,0 +1,42 @@ +# replicated release create + +Create a new release + +### Synopsis + +Create a new release by providing application manifests for the next release in + your sequence. + +``` +replicated release create [flags] +``` + +### Options + +``` + --auto generate default values for use in CI + -y, --confirm-auto auto-accept the configuration generated by the --auto flag + --ensure-channel When used with --promote , will create the channel if it doesn't 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") + -h, --help help for create + --lint Lint a manifests directory prior to creation of the KOTS Release. + --promote string Channel name or id to promote this release to + --release-notes string When used with --promote , sets the **markdown** release notes + --version string When used with --promote , sets the version label for the release in this channel + --yaml-dir string The directory containing multiple yamls for a Kots release. Cannot be used with the --yaml flag. +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated release](replicated-cli-release) - Manage app releases + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-release-download.md b/docs/reference/replicated-cli-release-download.md deleted file mode 100644 index 5acc06985b..0000000000 --- a/docs/reference/replicated-cli-release-download.md +++ /dev/null @@ -1,47 +0,0 @@ -import Help from "../partials/replicated-cli/_help.mdx" -import App from "../partials/replicated-cli/_app.mdx" -import Token from "../partials/replicated-cli/_token.mdx" - -# release download - -Download the config manifest file for a release. - -**Note:** This command is the same as the `release inspect` command for applications that are not packaged with Replicated. - -## Usage -```bash -replicated release download SEQUENCE -d ./appyaml -``` - - - - - - - - - - - - - - - -
FlagType (if applicable)Description
-d, --deststringDirectory where release manifests should be downloaded.
- -## Examples -```bash -replicated release download 9 -d ./appyaml - • Fetching Release 9 ✓ - • Writing files to ./appyaml - • config-map.yaml - • config.yaml - • deployment.yaml - • fluentd.yaml - • nginx2.yaml - • preflight.yaml - • redis.yaml - • replicated-app.yaml - • service.yaml - • support-bundle.yaml -``` diff --git a/docs/reference/replicated-cli-release-download.mdx b/docs/reference/replicated-cli-release-download.mdx new file mode 100644 index 0000000000..67ddb88b74 --- /dev/null +++ b/docs/reference/replicated-cli-release-download.mdx @@ -0,0 +1,41 @@ +# replicated release download + +Download application manifests for a release. + +### Synopsis + +Download application manifests for a release to a specified directory. + +For non-KOTS applications, this is equivalent to the 'release inspect' command. + +``` +replicated release download RELEASE_SEQUENCE [flags] +``` + +### Examples + +``` +replicated release download 1 --dest ./manifests +``` + +### Options + +``` + -d, --dest string Directory to which release manifests should be downloaded + -h, --help help for download +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated release](replicated-cli-release) - Manage app releases + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-release-inspect.md b/docs/reference/replicated-cli-release-inspect.md deleted file mode 100644 index c8cf164831..0000000000 --- a/docs/reference/replicated-cli-release-inspect.md +++ /dev/null @@ -1,37 +0,0 @@ -import Help from "../partials/replicated-cli/_help.mdx" - -# release inspect - -Inspect a release, including created and edited timestamps, compatibility results reported with the [`replicated release compatibility`](/reference/replicated-cli-release-compatibility) command, and the release config. - -## Usage - -```bash -replicated release inspect SEQUENCE [flags] -``` - -Where `SEQUENCE` is the sequence number for the target release. - - - - - - - - -
FlagType (if applicable)Description
- -## Example - -```bash -replicated release inspect 48 - -SEQUENCE: 48 -CREATED: 2023-09-25T16:31:33Z -EDITED: 0001-01-01T00:00:00Z -COMPATIBILITY RESULTS - DISTRIBUTION VERSION SUCCESS_AT SUCCESS NOTES FAILURE_AT FAILURE NOTES - eks 1.27 2023-09-25T18:59:46Z - -CONFIG: - ... -``` \ No newline at end of file diff --git a/docs/reference/replicated-cli-release-inspect.mdx b/docs/reference/replicated-cli-release-inspect.mdx new file mode 100644 index 0000000000..c1eb81db68 --- /dev/null +++ b/docs/reference/replicated-cli-release-inspect.mdx @@ -0,0 +1,49 @@ +# replicated release inspect + +Long: information about a release + +### Synopsis + +Show information about the specified application release. + +This command displays detailed information about a specific release of an application. + +The output can be customized using the --output flag to display results in +either table or JSON format. + + +``` +replicated release inspect RELEASE_SEQUENCE [flags] +``` + +### Examples + +``` +# Display information about a release +replicated release inspect 123 + +# Display information about a release in JSON format +replicated release inspect 123 --output json +``` + +### Options + +``` + -h, --help help for inspect + --output string The output format to use. One of: json|table (default: table) (default "table") +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated release](replicated-cli-release) - Manage app releases + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-release-lint.md b/docs/reference/replicated-cli-release-lint.md deleted file mode 100644 index 6e4d998db4..0000000000 --- a/docs/reference/replicated-cli-release-lint.md +++ /dev/null @@ -1,38 +0,0 @@ -import Help from "../partials/replicated-cli/_help.mdx" -import YamlDir from "../partials/replicated-cli/_yaml-dir.mdx" - -# release lint - -Lint a directory of application manifest files. For more information, see [Linter Rules](linter). - -## 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)._ - - - - - - - - - - - - - - -
FlagType (if applicable)Description
--fail-onstringThe minimum severity of a linting rule to cause a non-zero exit code. Supported values are info, warn, error, none. Default: Error
- -## Examples -```bash -replicated release lint --yaml-dir ./manifests --fail-on error -RULE TYPE LINE MESSAGE -config-spec warn Missing config spec -replicas-1 info 10 Found Replicas 1 -container-resource-requests info 27 Missing resource requests -``` diff --git a/docs/reference/replicated-cli-release-lint.mdx b/docs/reference/replicated-cli-release-lint.mdx new file mode 100644 index 0000000000..e63ca46fd6 --- /dev/null +++ b/docs/reference/replicated-cli-release-lint.mdx @@ -0,0 +1,35 @@ +# replicated release lint + +Lint a directory of KOTS manifests + +### Synopsis + +Lint a directory of KOTS manifests + +``` +replicated release lint [flags] +``` + +### Options + +``` + --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") + -h, --help help for lint + --output string The output format to use. One of: json|table (default: table) (default "table") + --yaml-dir yaml The directory containing multiple yamls for a Kots release. Cannot be used with the yaml flag. +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated release](replicated-cli-release) - Manage app releases + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-release-ls.md b/docs/reference/replicated-cli-release-ls.md deleted file mode 100644 index 57692bba96..0000000000 --- a/docs/reference/replicated-cli-release-ls.md +++ /dev/null @@ -1,33 +0,0 @@ -import Help from "../partials/replicated-cli/_help.mdx" -import App from "../partials/replicated-cli/_app.mdx" -import Token from "../partials/replicated-cli/_token.mdx" - -# release ls - -List all of an app's releases. - -## Usage -```bash -replicated release ls -``` - - - - - - - - - - -
FlagType (if applicable)Description
- -## Example -```bash -replicated release ls -SEQUENCE CREATED EDITED ACTIVE_CHANNELS -26 2020-01-20T17:53:22-08:00 0001-01-01T00:00:00Z Unstable -25 2019-12-12T15:40:58-08:00 0001-01-01T00:00:00Z -24 2019-10-28T19:41:23-07:00 0001-01-01T00:00:00Z Beta -1 2019-10-17T15:01:16-07:00 0001-01-01T00:00:00Z Stable -``` diff --git a/docs/reference/replicated-cli-release-ls.mdx b/docs/reference/replicated-cli-release-ls.mdx new file mode 100644 index 0000000000..18d8f5e78b --- /dev/null +++ b/docs/reference/replicated-cli-release-ls.mdx @@ -0,0 +1,33 @@ +# replicated release ls + +List all of an app's releases + +### Synopsis + +List all of an app's releases + +``` +replicated release ls [flags] +``` + +### Options + +``` + -h, --help help for ls + --output string The output format to use. One of: json|table (default: table) (default "table") +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated release](replicated-cli-release) - Manage app releases + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-release-promote.md b/docs/reference/replicated-cli-release-promote.md deleted file mode 100644 index e1d5fa13ab..0000000000 --- a/docs/reference/replicated-cli-release-promote.md +++ /dev/null @@ -1,51 +0,0 @@ -import Help from "../partials/replicated-cli/_help.mdx" -import App from "../partials/replicated-cli/_app.mdx" -import Token from "../partials/replicated-cli/_token.mdx" - -# release promote - -Associates (promotes) a given release to a channel. - -## Usage -```bash -replicated release promote SEQUENCE CHANNEL_ID [Flags] -``` - -* _The required `SEQUENCE` argument is the integer number corresponding to a specific release._ -* _The required `CHANNEL_ID` argument is channel ID or the **case sensitive** name of the channel, as displayed to the user._ - - - - - - - - - - - - - - - - - - - - - - - - - -
FlagType (if applicable)Description
--release-notesstringThe release notes for the release. Supports markdown formatting.
--requiredPrevents users from skipping this release during application upgrades. For more information, see Managing Releases with the Vendor Portal.
--versionstring

A 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.

- -## Examples -```bash -replicated release promote 24 Beta --optional --version 1.3.0 --release-notes "Optional Beta release for feature X" -Channel jWNZHo8ypjrX1HkC4UXInoSI5OsK586m successfully set to release 24 -``` - -```bash -replicated release promote 15 fe4901690971757689f022f7a460f9b2 -Channel fe4901690971757689f022f7a460f9b2 successfully set to release 15 diff --git a/docs/reference/replicated-cli-release-promote.mdx b/docs/reference/replicated-cli-release-promote.mdx new file mode 100644 index 0000000000..f849658f4e --- /dev/null +++ b/docs/reference/replicated-cli-release-promote.mdx @@ -0,0 +1,42 @@ +# replicated release promote + +Set the release for a channel + +### Synopsis + +Set the release for a channel + +``` +replicated release promote SEQUENCE CHANNEL_ID [flags] +``` + +### Examples + +``` +replicated release promote 15 fe4901690971757689f022f7a460f9b2 +``` + +### Options + +``` + -h, --help help for promote + --optional If set, this release can be skipped + --release-notes string The **markdown** release notes + --required If set, this release can't be skipped + --version string A version label for the release in this channel +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated release](replicated-cli-release) - Manage app releases + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-release-test.mdx b/docs/reference/replicated-cli-release-test.mdx new file mode 100644 index 0000000000..5d52f4a7ca --- /dev/null +++ b/docs/reference/replicated-cli-release-test.mdx @@ -0,0 +1,32 @@ +# replicated release test + +Test the application release + +### Synopsis + +Test the application release + +``` +replicated release test SEQUENCE [flags] +``` + +### Options + +``` + -h, --help help for test +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated release](replicated-cli-release) - Manage app releases + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-release-update.md b/docs/reference/replicated-cli-release-update.md deleted file mode 100644 index 50266dae41..0000000000 --- a/docs/reference/replicated-cli-release-update.md +++ /dev/null @@ -1,34 +0,0 @@ -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" - -# release update - -Updates the YAML application manifests for a given release. - -## Usage -```bash -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_ - - - - - - - - - - - -
FlagType (if applicable)Description
- -## Examples -```bash -replicated release update 25 --yaml-dir ./manifests -Release 25 updated -``` diff --git a/docs/reference/replicated-cli-release-update.mdx b/docs/reference/replicated-cli-release-update.mdx new file mode 100644 index 0000000000..0deb293f5d --- /dev/null +++ b/docs/reference/replicated-cli-release-update.mdx @@ -0,0 +1,35 @@ +# replicated release update + +Updated a release's yaml config + +### Synopsis + +Updated a release's yaml config + +``` +replicated release update SEQUENCE [flags] +``` + +### Options + +``` + -h, --help help for update + --yaml string The new YAML config for this release. Use '-' to read from stdin. Cannot be used with the --yaml-file flag. + --yaml-dir string The directory containing multiple yamls for a Kots release. Cannot be used with the --yaml flag. + --yaml-file string The file name with YAML config for this release. Cannot be used with the --yaml flag. +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated release](replicated-cli-release) - Manage app releases + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-release.mdx b/docs/reference/replicated-cli-release.mdx new file mode 100644 index 0000000000..a8be7ba355 --- /dev/null +++ b/docs/reference/replicated-cli-release.mdx @@ -0,0 +1,37 @@ +# replicated release + +Manage app releases + +### Synopsis + +The release command allows vendors to create, display, and promote their releases. + +### Options + +``` + -h, --help help for release +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated](replicated) - Manage your Commercial Software Distribution Lifecycle using Replicated +* [replicated release compatibility](replicated-cli-release-compatibility) - Report release compatibility +* [replicated release create](replicated-cli-release-create) - Create a new release +* [replicated release download](replicated-cli-release-download) - Download application manifests for a release. +* [replicated release inspect](replicated-cli-release-inspect) - Long: information about a release +* [replicated release lint](replicated-cli-release-lint) - Lint a directory of KOTS manifests +* [replicated release ls](replicated-cli-release-ls) - List all of an app's releases +* [replicated release promote](replicated-cli-release-promote) - Set the release for a channel +* [replicated release test](replicated-cli-release-test) - Test the application release +* [replicated release update](replicated-cli-release-update) - Updated a release's yaml config + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-version-upgrade.mdx b/docs/reference/replicated-cli-version-upgrade.mdx new file mode 100644 index 0000000000..12fe858b7f --- /dev/null +++ b/docs/reference/replicated-cli-version-upgrade.mdx @@ -0,0 +1,32 @@ +# replicated version upgrade + +Upgrade the replicated CLI to the latest version + +### Synopsis + +Download, verify, and upgrade the Replicated CLI to the latest version + +``` +replicated version upgrade [flags] +``` + +### Options + +``` + -h, --help help for upgrade +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated version](replicated-cli-version) - Print the current version and exit + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-version.mdx b/docs/reference/replicated-cli-version.mdx new file mode 100644 index 0000000000..ed6346c7e8 --- /dev/null +++ b/docs/reference/replicated-cli-version.mdx @@ -0,0 +1,34 @@ +# replicated version + +Print the current version and exit + +### Synopsis + +Print the current version and exit + +``` +replicated version [flags] +``` + +### Options + +``` + -h, --help help for version + --json output version info in json +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated](replicated) - Manage your Commercial Software Distribution Lifecycle using Replicated +* [replicated version upgrade](replicated-cli-version-upgrade) - Upgrade the replicated CLI to the latest version + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-vm-create.mdx b/docs/reference/replicated-cli-vm-create.mdx new file mode 100644 index 0000000000..198aaedc55 --- /dev/null +++ b/docs/reference/replicated-cli-vm-create.mdx @@ -0,0 +1,63 @@ +# replicated vm create + +Create one or more test VMs with specified distribution, version, and configuration options. + +### Synopsis + +Create one or more test VMs with a specified distribution, version, and a variety of customizable configuration options. + +This command allows you to provision VMs with different distributions (e.g., Ubuntu, RHEL), versions, instance types, and more. You can set the number of VMs to create, disk size, and specify the network to use. If no network is provided, a new network will be created automatically. You can also assign tags to your VMs and use a TTL (Time-To-Live) to define how long the VMs should live. + +By default, the command provisions one VM, but you can customize the number of VMs to create by using the "--count" flag. Additionally, you can use the "--dry-run" flag to simulate the creation without actually provisioning the VMs. + +The command also supports a "--wait" flag to wait for the VMs to be ready before returning control, with a customizable timeout duration. + +``` +replicated vm create [flags] +``` + +### Examples + +``` +# Create a single Ubuntu 20.04 VM +replicated vm create --distribution ubuntu --version 20.04 + +# Create 3 Ubuntu 22.04 VMs +replicated vm create --distribution ubuntu --version 22.04 --count 3 + +# Create 5 Ubuntu VMs with a custom instance type and disk size +replicated vm create --distribution ubuntu --version 20.04 --count 5 --instance-type r1.medium --disk 100 +``` + +### Options + +``` + --count int Number of matching VMs to create (default 1) + --disk int Disk Size (GiB) to request per node (default 50) + --distribution string Distribution of the vm to provision + --dry-run Dry run + -h, --help help for create + --instance-type string The type of instance to use (e.g. r1.medium) + --name string VM name (defaults to random name) + --network string The network to use for the VM(s). If not supplied, create a new network + --output string The output format to use. One of: json|table|wide (default: table) (default "table") + --tag stringArray Tag to apply to the VM (key=value format, can be specified multiple times) + --ttl string VM TTL (duration, max 48h) + --version string Vversion to provision (format is distribution dependent) + --wait duration Wait duration for VM(s) to be ready (leave empty to not wait) +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated vm](replicated-cli-vm) - Manage test virtual machines. + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-vm-ls.mdx b/docs/reference/replicated-cli-vm-ls.mdx new file mode 100644 index 0000000000..b3b7e98960 --- /dev/null +++ b/docs/reference/replicated-cli-vm-ls.mdx @@ -0,0 +1,59 @@ +# replicated vm ls + +List test VMs and their status, with optional filters for start/end time and terminated VMs. + +### Synopsis + +List all test VMs in your account, including their current status, distribution, version, and more. You can use optional flags to filter the output based on VM termination status, start time, or end time. This command can also watch the VM status in real-time. + +By default, the command will return a table of all VMs, but you can switch to JSON or wide output formats for more detailed information. The command supports filtering to show only terminated VMs or to specify a time range for the query. + +You can use the '--watch' flag to monitor VMs continuously. This will refresh the list of VMs every 2 seconds, displaying any updates in real-time, such as new VMs being created or existing VMs being terminated. + +The command also allows you to customize the output format, supporting 'json', 'table', and 'wide' views for flexibility based on your needs. + +``` +replicated vm ls [flags] +``` + +### Examples + +``` +# List all active VMs +replicated vm ls + +# List all VMs that were created after a specific start time +replicated vm ls --start-time 2024-10-01T00:00:00Z + +# Show only terminated VMs +replicated vm ls --show-terminated + +# Watch VM status changes in real-time +replicated vm ls --watch +``` + +### Options + +``` + --end-time string end time for the query (Format: 2006-01-02T15:04:05Z) + -h, --help help for ls + --output string The output format to use. One of: json|table|wide (default: table) (default "table") + --show-terminated when set, only show terminated vms + --start-time string start time for the query (Format: 2006-01-02T15:04:05Z) + -w, --watch watch vms +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated vm](replicated-cli-vm) - Manage test virtual machines. + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-vm-port-expose.mdx b/docs/reference/replicated-cli-vm-port-expose.mdx new file mode 100644 index 0000000000..1957b763de --- /dev/null +++ b/docs/reference/replicated-cli-vm-port-expose.mdx @@ -0,0 +1,56 @@ +# replicated vm port expose + +Expose a port on a vm to the public internet. + +### Synopsis + +The 'vm port expose' command is used to expose a specified port on a vm to the public internet. When exposing a port, the command automatically creates a DNS entry and, if using the "https" protocol, provisions a TLS certificate for secure communication. + +You can also create a wildcard DNS entry and TLS certificate by specifying the "--wildcard" flag. Please note that creating a wildcard certificate may take additional time. + +This command supports different protocols including "http", "https", "ws", and "wss" for web traffic and web socket communication. + +``` +replicated vm port expose VM_ID --port PORT [flags] +``` + +### Examples + +``` +# Expose port 8080 with HTTPS protocol and wildcard DNS +replicated vm port expose VM_ID --port 8080 --protocol https --wildcard + +# Expose port 3000 with HTTP protocol +replicated vm port expose VM_ID --port 3000 --protocol http + +# Expose port 8080 with multiple protocols +replicated vm port expose VM_ID --port 8080 --protocol http,https + +# Expose port 8080 and display the result in JSON format +replicated vm port expose VM_ID --port 8080 --protocol https --output json +``` + +### Options + +``` + -h, --help help for expose + --output string The output format to use. One of: json|table|wide (default: table) (default "table") + --port int Port to expose (required) + --protocol strings Protocol to expose (valid values are "http", "https", "ws" and "wss") (default [http,https]) + --wildcard Create a wildcard DNS entry and TLS certificate for this port +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated vm port](replicated-cli-vm-port) - Manage VM ports. + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-vm-port-ls.mdx b/docs/reference/replicated-cli-vm-port-ls.mdx new file mode 100644 index 0000000000..6f03a57ce6 --- /dev/null +++ b/docs/reference/replicated-cli-vm-port-ls.mdx @@ -0,0 +1,48 @@ +# replicated vm port ls + +List vm ports for a vm. + +### Synopsis + +The 'vm port ls' command lists all the ports configured for a specific vm. You must provide the vm ID to retrieve and display the ports. + +This command is useful for viewing the current port configurations, protocols, and other related settings of your test vm. The output format can be customized to suit your needs, and the available formats include table, JSON, and wide views. + +``` +replicated vm port ls VM_ID [flags] +``` + +### Examples + +``` +# List ports for a vm in the default table format +replicated vm port ls VM_ID + +# List ports for a vm in JSON format +replicated vm port ls VM_ID --output json + +# List ports for a vm in wide format +replicated vm port ls VM_ID --output wide +``` + +### Options + +``` + -h, --help help for ls + --output string The output format to use. One of: json|table|wide (default: table) (default "table") +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated vm port](replicated-cli-vm-port) - Manage VM ports. + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-vm-port-rm.mdx b/docs/reference/replicated-cli-vm-port-rm.mdx new file mode 100644 index 0000000000..814a2fff37 --- /dev/null +++ b/docs/reference/replicated-cli-vm-port-rm.mdx @@ -0,0 +1,46 @@ +# replicated vm port rm + +Remove vm port by ID. + +### Synopsis + +The 'vm port rm' command removes a specific port from a vm. You must provide the ID of the port to remove. + +This command is useful for managing the network settings of your test vms by allowing you to clean up unused or incorrect ports. After removing a port, the updated list of ports will be displayed. + +``` +replicated vm port rm VM_ID --id PORT_ID [flags] +``` + +### Examples + +``` +# Remove a port using its ID +replicated vm port rm VM_ID --id PORT_ID + +# Remove a port and display the result in JSON format +replicated vm port rm VM_ID --id PORT_ID --output json +``` + +### Options + +``` + -h, --help help for rm + --id string ID of the port to remove (required) + --output string The output format to use. One of: json|table|wide (default: table) (default "table") +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated vm port](replicated-cli-vm-port) - Manage VM ports. + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-vm-port.mdx b/docs/reference/replicated-cli-vm-port.mdx new file mode 100644 index 0000000000..6f0562caa4 --- /dev/null +++ b/docs/reference/replicated-cli-vm-port.mdx @@ -0,0 +1,46 @@ +# replicated vm port + +Manage VM ports. + +### Synopsis + +The 'vm port' command is a parent command for managing ports in a vm. It allows users to list, remove, or expose specific ports used by the vm. Use the subcommands (such as 'ls', 'rm', and 'expose') to manage port configurations effectively. + +This command provides flexibility for handling ports in various test vms, ensuring efficient management of vm networking settings. + +### Examples + +``` +# List all exposed ports in a vm +replicated vm port ls [VM_ID] + +# Remove an exposed port from a vm +replicated vm port rm [VM_ID] [PORT] + +# Expose a new port in a vm +replicated vm port expose [VM_ID] [PORT] +``` + +### Options + +``` + -h, --help help for port +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated vm](replicated-cli-vm) - Manage test virtual machines. +* [replicated vm port expose](replicated-cli-vm-port-expose) - Expose a port on a vm to the public internet. +* [replicated vm port ls](replicated-cli-vm-port-ls) - List vm ports for a vm. +* [replicated vm port rm](replicated-cli-vm-port-rm) - Remove vm port by ID. + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-vm-rm.mdx b/docs/reference/replicated-cli-vm-rm.mdx new file mode 100644 index 0000000000..9bedd6e8f9 --- /dev/null +++ b/docs/reference/replicated-cli-vm-rm.mdx @@ -0,0 +1,62 @@ +# replicated vm rm + +Remove test VM(s) immediately, with options to filter by name, tag, or remove all VMs. + +### Synopsis + +The 'rm' command allows you to remove test VMs from your account immediately. You can specify one or more VM IDs directly, or use flags to filter which VMs to remove based on their name, tags, or simply remove all VMs at once. + +This command supports multiple filtering options, including removing VMs by their name, by specific tags, or by specifying the '--all' flag to remove all VMs in your account. + +You can also use the '--dry-run' flag to simulate the removal without actually deleting the VMs. + +``` +replicated vm rm ID [ID …] [flags] +``` + +### Examples + +``` +# Remove a VM by ID +replicated vm rm aaaaa11 + +# Remove multiple VMs by ID +replicated vm rm aaaaa11 bbbbb22 ccccc33 + +# Remove all VMs with a specific name +replicated vm rm --name test-vm + +# Remove all VMs with a specific tag +replicated vm rm --tag env=dev + +# Remove all VMs +replicated vm rm --all + +# Perform a dry run of removing all VMs +replicated vm rm --all --dry-run +``` + +### Options + +``` + --all remove all vms + --dry-run Dry run + -h, --help help for rm + --name stringArray Name of the vm to remove (can be specified multiple times) + --tag stringArray Tag of the vm to remove (key=value format, can be specified multiple times) +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated vm](replicated-cli-vm) - Manage test virtual machines. + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-vm-update-ttl.mdx b/docs/reference/replicated-cli-vm-update-ttl.mdx new file mode 100644 index 0000000000..33dfbdea14 --- /dev/null +++ b/docs/reference/replicated-cli-vm-update-ttl.mdx @@ -0,0 +1,52 @@ +# replicated vm update ttl + +Update TTL for a test VM. + +### Synopsis + +The 'ttl' command allows you to update the Time to Live (TTL) for a test VM. This command modifies the lifespan of a running VM by updating its TTL, which is a duration starting from the moment the VM is provisioned. + +The TTL specifies how long the VM will run before it is automatically terminated. You can specify a duration up to a maximum of 48 hours. + +The command accepts a VM ID as an argument and requires the '--ttl' flag to specify the new TTL value. + +You can also specify the output format (json, table, wide) using the '--output' flag. + +``` +replicated vm update ttl [ID] [flags] +``` + +### Examples + +``` +# Update the TTL of a VM to 2 hours +replicated vm update ttl aaaaa11 --ttl 2h + +# Update the TTL of a VM to 30 minutes +replicated vm update ttl aaaaa11 --ttl 30m +``` + +### Options + +``` + -h, --help help for ttl + --output string The output format to use. One of: json|table|wide (default: table) (default "table") + --ttl string Update TTL which starts from the moment the vm is running (duration, max 48h). +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --id string id of the vm to update (when name is not provided) + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --name string Name of the vm to update. + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated vm update](replicated-cli-vm-update) - Update VM settings. + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-vm-update.mdx b/docs/reference/replicated-cli-vm-update.mdx new file mode 100644 index 0000000000..f23fd9559b --- /dev/null +++ b/docs/reference/replicated-cli-vm-update.mdx @@ -0,0 +1,46 @@ +# replicated vm update + +Update VM settings. + +### Synopsis + +The 'vm update' command allows you to modify the settings of a virtual machine. You can update a VM either by providing its ID or by specifying its name. This command supports updating various VM settings, which will be handled by specific subcommands. + +- To update the VM by its ID, use the '--id' flag. +- To update the VM by its name, use the '--name' flag. + +Subcommands will allow for more specific updates like TTL + +### Examples + +``` +# Update a VM by specifying its ID +replicated vm update --id aaaaa11 --ttl 12h + +# Update a VM by specifying its name +replicated vm update --name --ttl 12h +``` + +### Options + +``` + -h, --help help for update + --id string id of the vm to update (when name is not provided) + --name string Name of the vm to update. +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated vm](replicated-cli-vm) - Manage test virtual machines. +* [replicated vm update ttl](replicated-cli-vm-update-ttl) - Update TTL for a test VM. + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-vm-versions.mdx b/docs/reference/replicated-cli-vm-versions.mdx new file mode 100644 index 0000000000..b0ea452190 --- /dev/null +++ b/docs/reference/replicated-cli-vm-versions.mdx @@ -0,0 +1,50 @@ +# replicated vm versions + +List available VM versions. + +### Synopsis + +The 'vm versions' command lists all the available versions of virtual machines that can be provisioned. This includes the available distributions and their respective versions. + +- You can filter the list by a specific distribution using the '--distribution' flag. +- The output can be formatted as a table or in JSON format using the '--output' flag. + +``` +replicated vm versions [flags] +``` + +### Examples + +``` +# List all available VM versions +replicated vm versions + +# List VM versions for a specific distribution (e.g., Ubuntu) +replicated vm versions --distribution ubuntu + +# Display the output in JSON format +replicated vm versions --output json +``` + +### Options + +``` + --distribution string Kubernetes distribution to filter by. + -h, --help help for versions + --output string The output format to use. One of: json|table (default: table) (default "table") +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated vm](replicated-cli-vm) - Manage test virtual machines. + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated-cli-vm.mdx b/docs/reference/replicated-cli-vm.mdx new file mode 100644 index 0000000000..dc296a466d --- /dev/null +++ b/docs/reference/replicated-cli-vm.mdx @@ -0,0 +1,50 @@ +# replicated vm + +Manage test virtual machines. + +### Synopsis + +The 'vm' command allows you to manage and interact with virtual machines (VMs) used for testing purposes. With this command, you can create, list, remove, update, and manage VMs, as well as retrieve information about available VM versions. + +### Examples + +``` +# Create a single Ubuntu VM +replicated vm create --distribution ubuntu --version 20.04 + +# List all VMs +replicated vm ls + +# Remove a specific VM by ID +replicated vm rm + +# Update TTL for a specific VM +replicated vm update ttl --ttl 24h +``` + +### Options + +``` + -h, --help help for vm +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated](replicated) - Manage your Commercial Software Distribution Lifecycle using Replicated +* [replicated vm create](replicated-cli-vm-create) - Create one or more test VMs with specified distribution, version, and configuration options. +* [replicated vm ls](replicated-cli-vm-ls) - List test VMs and their status, with optional filters for start/end time and terminated VMs. +* [replicated vm port](replicated-cli-vm-port) - Manage VM ports. +* [replicated vm rm](replicated-cli-vm-rm) - Remove test VM(s) immediately, with options to filter by name, tag, or remove all VMs. +* [replicated vm update](replicated-cli-vm-update) - Update VM settings. +* [replicated vm versions](replicated-cli-vm-versions) - List available VM versions. + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/docs/reference/replicated.mdx b/docs/reference/replicated.mdx new file mode 100644 index 0000000000..ee0ad4de85 --- /dev/null +++ b/docs/reference/replicated.mdx @@ -0,0 +1,37 @@ +# replicated + +Manage your Commercial Software Distribution Lifecycle using Replicated + +### Synopsis + +The 'replicated' CLI allows Replicated customers (vendors) to manage their Commercial Software Distribution Lifecycle (CSDL) using the Replicated API. + +### Options + +``` + --app string The app slug or app id to use in all calls + -h, --help help for replicated + --integration-test string Set to the name of the integration test to run + --log-api-calls string Log the API calls to the specified file + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated api](replicated-cli-api) - Make ad-hoc API calls to the Replicated API +* [replicated app](replicated-cli-app) - Manage applications +* [replicated channel](replicated-cli-channel) - List channels +* [replicated cluster](replicated-cli-cluster) - Manage test Kubernetes clusters. +* [replicated completion](replicated-cli-completion) - Generate completion script +* [replicated customer](replicated-cli-customer) - Manage customers +* [replicated default](replicated-cli-default) - Manage default values used by other commands +* [replicated installer](replicated-cli-installer) - Manage Kubernetes installers +* [replicated instance](replicated-cli-instance) - Manage instances +* [replicated login](replicated-cli-login) - Log in to Replicated +* [replicated logout](replicated-cli-logout) - Logout from Replicated +* [replicated registry](replicated-cli-registry) - Manage registries +* [replicated release](replicated-cli-release) - Manage app releases +* [replicated version](replicated-cli-version) - Print the current version and exit +* [replicated vm](replicated-cli-vm) - Manage test virtual machines. + +###### Auto generated by spf13/cobra on 22-Jan-2025 diff --git a/sidebars.js b/sidebars.js index 7a2a24dfb5..610f45afcf 100644 --- a/sidebars.js +++ b/sidebars.js @@ -611,51 +611,73 @@ const sidebars = { 'reference/replicated-sdk-apis', { type: 'category', - label: 'Replicated CLI', + label: 'Replicated CLI', // This label is generated. Do not edit. items: [ + // This list is generated. Do not edit. 'reference/replicated-cli-installing', + 'reference/replicated', 'reference/replicated-cli-api', + 'reference/replicated-cli-api-get', + 'reference/replicated-cli-api-patch', + 'reference/replicated-cli-api-post', + 'reference/replicated-cli-api-put', + 'reference/replicated-cli-app', 'reference/replicated-cli-app-create', - 'reference/replicated-cli-app-delete', 'reference/replicated-cli-app-ls', + 'reference/replicated-cli-app-rm', + 'reference/replicated-cli-channel', '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-disable-semantic-versioning', + 'reference/replicated-cli-channel-enable-semantic-versioning', 'reference/replicated-cli-channel-inspect', 'reference/replicated-cli-channel-ls', + 'reference/replicated-cli-channel-rm', + 'reference/replicated-cli-cluster', + 'reference/replicated-cli-cluster-addon', + 'reference/replicated-cli-cluster-addon-create', + 'reference/replicated-cli-cluster-addon-create-object-store', + 'reference/replicated-cli-cluster-addon-ls', + 'reference/replicated-cli-cluster-addon-rm', 'reference/replicated-cli-cluster-create', 'reference/replicated-cli-cluster-kubeconfig', 'reference/replicated-cli-cluster-ls', + 'reference/replicated-cli-cluster-nodegroup', 'reference/replicated-cli-cluster-nodegroup-ls', - 'reference/replicated-cli-cluster-prepare', + 'reference/replicated-cli-cluster-port', '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', + 'reference/replicated-cli-cluster-update-nodegroup', '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', + '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', + 'reference/replicated-cli-default', + 'reference/replicated-cli-default-clear-all', + 'reference/replicated-cli-default-clear', + 'reference/replicated-cli-default-set', + 'reference/replicated-cli-default-show', + 'reference/replicated-cli-installer', 'reference/replicated-cli-installer-create', 'reference/replicated-cli-installer-ls', + 'reference/replicated-cli-instance', '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', 'reference/replicated-cli-registry-add', 'reference/replicated-cli-registry-add-dockerhub', 'reference/replicated-cli-registry-add-ecr', @@ -664,18 +686,32 @@ const sidebars = { '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', '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-test', 'reference/replicated-cli-release-update', + 'reference/replicated-cli-version', + 'reference/replicated-cli-version-upgrade', + 'reference/replicated-cli-vm', + 'reference/replicated-cli-vm-create', + 'reference/replicated-cli-vm-ls', + 'reference/replicated-cli-vm-port', + 'reference/replicated-cli-vm-port-expose', + 'reference/replicated-cli-vm-port-ls', + 'reference/replicated-cli-vm-port-rm', + 'reference/replicated-cli-vm-rm', + 'reference/replicated-cli-vm-update', + 'reference/replicated-cli-vm-update-ttl', + 'reference/replicated-cli-vm-versions', ], }, { @@ -841,4 +877,4 @@ const sidebars = { ], }; -module.exports = sidebars; +module.exports = sidebars; \ No newline at end of file