diff --git a/docs/reference/replicated-cli-release-image-ls.mdx b/docs/reference/replicated-cli-release-image-ls.mdx new file mode 100644 index 0000000000..1f64a077e3 --- /dev/null +++ b/docs/reference/replicated-cli-release-image-ls.mdx @@ -0,0 +1,49 @@ +# replicated release image ls + +List images in a channel's current or specified release + +### Synopsis + +List all container images in the current release or a specific version of a channel + +``` +replicated release image ls --channel CHANNEL_NAME_OR_ID [--version SEMVER] [--keep-proxy] [flags] +``` + +### Examples + +``` +# List images in current release of a channel by name +replicated release image ls --channel Stable + +# List images in a specific version of a channel +replicated release image ls --channel Stable --version 1.2.1 + +# List images in a channel by ID +replicated release image ls --channel 2abc123 + +# Keep proxy registry domains in the image names +replicated release image ls --channel Stable --keep-proxy +``` + +### Options + +``` + --channel string The channel name, slug, or ID (required) + -h, --help help for ls + --keep-proxy Keep proxy registry domain in image names instead of stripping it + --version string The specific semver version to get images for (optional, defaults to current release) +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --debug Enable debug output + --token string The API token to use to access your app in the Vendor API +``` + +### SEE ALSO + +* [replicated release image](replicated-cli-release-image) - Manage release images + diff --git a/docs/reference/replicated-cli-release-image.mdx b/docs/reference/replicated-cli-release-image.mdx new file mode 100644 index 0000000000..ea65d1c337 --- /dev/null +++ b/docs/reference/replicated-cli-release-image.mdx @@ -0,0 +1,27 @@ +# replicated release image + +Manage release images + +### Synopsis + +Manage release images + +### Options + +``` + -h, --help help for image +``` + +### Options inherited from parent commands + +``` + --app string The app slug or app id to use in all calls + --debug Enable debug output + --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 +* [replicated release image ls](replicated-cli-release-image-ls) - List images in a channel's current or specified release + diff --git a/docs/reference/replicated-cli-release.mdx b/docs/reference/replicated-cli-release.mdx index b5c2fc8ffe..3b154a26c9 100644 --- a/docs/reference/replicated-cli-release.mdx +++ b/docs/reference/replicated-cli-release.mdx @@ -26,6 +26,7 @@ The release command allows vendors to create, display, and promote their release * [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 image](replicated-cli-release-image) - Manage release images * [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 diff --git a/docs/reference/replicated-cli-vm-create.mdx b/docs/reference/replicated-cli-vm-create.mdx index ae89d2ca5e..683fb59bc5 100644 --- a/docs/reference/replicated-cli-vm-create.mdx +++ b/docs/reference/replicated-cli-vm-create.mdx @@ -12,6 +12,8 @@ By default, the command provisions one VM, but you can customize the number of V The command also supports a "--wait" flag to wait for the VMs to be ready before returning control, with a customizable timeout duration. +VMs are currently a beta feature. + ``` replicated vm create [flags] ``` diff --git a/docs/reference/replicated-cli-vm-ls.mdx b/docs/reference/replicated-cli-vm-ls.mdx index d74ff5df27..46a2310886 100644 --- a/docs/reference/replicated-cli-vm-ls.mdx +++ b/docs/reference/replicated-cli-vm-ls.mdx @@ -12,6 +12,8 @@ You can use the '--watch' flag to monitor VMs continuously. This will refresh th The command also allows you to customize the output format, supporting 'json', 'table', and 'wide' views for flexibility based on your needs. +VMs are currently a beta feature. + ``` replicated vm ls [flags] ``` diff --git a/docs/reference/replicated-cli-vm-port-expose.mdx b/docs/reference/replicated-cli-vm-port-expose.mdx index d8f4364cc8..1825915950 100644 --- a/docs/reference/replicated-cli-vm-port-expose.mdx +++ b/docs/reference/replicated-cli-vm-port-expose.mdx @@ -8,6 +8,8 @@ The 'vm port expose' command is used to expose a specified port on a vm to the p This command supports different protocols including "http", "https", "ws", and "wss" for web traffic and web socket communication. +VMs are currently a beta feature. + ``` replicated vm port expose VM_ID_OR_NAME --port PORT [flags] ``` diff --git a/docs/reference/replicated-cli-vm-port-ls.mdx b/docs/reference/replicated-cli-vm-port-ls.mdx index 19d563994e..4d3e9b9786 100644 --- a/docs/reference/replicated-cli-vm-port-ls.mdx +++ b/docs/reference/replicated-cli-vm-port-ls.mdx @@ -8,6 +8,8 @@ The 'vm port ls' command lists all the ports configured for a specific vm. You m 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. +VMs are currently a beta feature. + ``` replicated vm port ls VM_ID_OR_NAME [flags] ``` diff --git a/docs/reference/replicated-cli-vm-port-rm.mdx b/docs/reference/replicated-cli-vm-port-rm.mdx index 1e213ceda6..8d9fd33587 100644 --- a/docs/reference/replicated-cli-vm-port-rm.mdx +++ b/docs/reference/replicated-cli-vm-port-rm.mdx @@ -8,6 +8,8 @@ The 'vm port rm' command removes a specific port from a vm. You must provide the 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. +VMs are currently a beta feature. + ``` replicated vm port rm VM_ID_OR_NAME --id PORT_ID [flags] ``` diff --git a/docs/reference/replicated-cli-vm-port.mdx b/docs/reference/replicated-cli-vm-port.mdx index c04c39821c..57824e2d62 100644 --- a/docs/reference/replicated-cli-vm-port.mdx +++ b/docs/reference/replicated-cli-vm-port.mdx @@ -8,17 +8,19 @@ The 'vm port' command is a parent command for managing ports in a vm. It allows This command provides flexibility for handling ports in various test vms, ensuring efficient management of vm networking settings. +VMs are currently a beta feature. + ### Examples ``` # List all exposed ports in a vm -replicated vm port ls [VM_ID] +replicated vm port ls VM_ID_OR_NAME # Remove an exposed port from a vm -replicated vm port rm [VM_ID] [PORT] +replicated vm port rm VM_ID_OR_NAME --id PORT_ID # Expose a new port in a vm -replicated vm port expose [VM_ID] [PORT] +replicated vm port expose VM_ID_OR_NAME --port PORT ``` ### Options diff --git a/docs/reference/replicated-cli-vm-rm.mdx b/docs/reference/replicated-cli-vm-rm.mdx index 1d6d6a6c54..d86bb8a5cb 100644 --- a/docs/reference/replicated-cli-vm-rm.mdx +++ b/docs/reference/replicated-cli-vm-rm.mdx @@ -12,6 +12,8 @@ When specifying a name that matches multiple VMs, all VMs with that name will be You can also use the '--dry-run' flag to simulate the removal without actually deleting the VMs. +VMs are currently a beta feature. + ``` replicated vm rm ID_OR_NAME [ID_OR_NAME …] [flags] ``` diff --git a/docs/reference/replicated-cli-vm-scp-endpoint.mdx b/docs/reference/replicated-cli-vm-scp-endpoint.mdx index b83bbe19a1..9a7e8dc242 100644 --- a/docs/reference/replicated-cli-vm-scp-endpoint.mdx +++ b/docs/reference/replicated-cli-vm-scp-endpoint.mdx @@ -11,6 +11,8 @@ The output will be in the format: scp://username@hostname:port You can identify the VM either by its unique ID or by its name. Note: SCP endpoints can only be retrieved from VMs in the "running" state. + +VMs are currently a beta feature. ``` replicated vm scp-endpoint VM_ID_OR_NAME [flags] diff --git a/docs/reference/replicated-cli-vm-ssh-endpoint.mdx b/docs/reference/replicated-cli-vm-ssh-endpoint.mdx index 866730f2da..e1acab688d 100644 --- a/docs/reference/replicated-cli-vm-ssh-endpoint.mdx +++ b/docs/reference/replicated-cli-vm-ssh-endpoint.mdx @@ -11,6 +11,8 @@ The output will be in the format: ssh://username@hostname:port You can identify the VM either by its unique ID or by its name. Note: SSH endpoints can only be retrieved from VMs in the "running" state. + +VMs are currently a beta feature. ``` replicated vm ssh-endpoint VM_ID_OR_NAME [flags] diff --git a/docs/reference/replicated-cli-vm-update-ttl.mdx b/docs/reference/replicated-cli-vm-update-ttl.mdx index d79a22c18d..339a423e99 100644 --- a/docs/reference/replicated-cli-vm-update-ttl.mdx +++ b/docs/reference/replicated-cli-vm-update-ttl.mdx @@ -12,6 +12,8 @@ The command accepts a VM ID or name as an argument and requires the '--ttl' flag You can also specify the output format (json, table, wide) using the '--output' flag. +VMs are currently a beta feature. + ``` replicated vm update ttl [ID_OR_NAME] [flags] ``` diff --git a/docs/reference/replicated-cli-vm-update.mdx b/docs/reference/replicated-cli-vm-update.mdx index e05b7840f5..2f6bb68b0a 100644 --- a/docs/reference/replicated-cli-vm-update.mdx +++ b/docs/reference/replicated-cli-vm-update.mdx @@ -10,7 +10,9 @@ The 'vm update' command allows you to modify the settings of a virtual machine. - Alternatively, to update the VM by its ID, use the '--id' flag. - Alternatively, to update the VM by its name, use the '--name' flag. -Subcommands will allow for more specific updates like TTL +Subcommands will allow for more specific updates like TTL. + +VMs are currently a beta feature. ### Examples diff --git a/docs/reference/replicated-cli-vm-versions.mdx b/docs/reference/replicated-cli-vm-versions.mdx index d8b4d7d6ad..f8dbc7c046 100644 --- a/docs/reference/replicated-cli-vm-versions.mdx +++ b/docs/reference/replicated-cli-vm-versions.mdx @@ -9,6 +9,8 @@ The 'vm versions' command lists all the available versions of virtual machines t - 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. +VMs are currently a beta feature. + ``` replicated vm versions [flags] ``` diff --git a/docs/reference/replicated-cli-vm.mdx b/docs/reference/replicated-cli-vm.mdx index 69863967d8..3616867e6d 100644 --- a/docs/reference/replicated-cli-vm.mdx +++ b/docs/reference/replicated-cli-vm.mdx @@ -4,7 +4,10 @@ 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. +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. + +VMs are currently a beta feature. ### Examples diff --git a/sidebars.js b/sidebars.js index 233c57fa5f..c5153043ce 100644 --- a/sidebars.js +++ b/sidebars.js @@ -717,6 +717,8 @@ const sidebars = { 'reference/replicated-cli-release-compatibility', 'reference/replicated-cli-release-create', 'reference/replicated-cli-release-download', + 'reference/replicated-cli-release-image', + 'reference/replicated-cli-release-image-ls', 'reference/replicated-cli-release-inspect', 'reference/replicated-cli-release-lint', 'reference/replicated-cli-release-ls',