Skip to content

Commit 80eb14e

Browse files
authored
chore: add beta disclaimer to vm commands (#563)
1 parent b71ee25 commit 80eb14e

File tree

12 files changed

+37
-12
lines changed

12 files changed

+37
-12
lines changed

cli/cmd/vm.go

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,10 @@ func (r *runners) InitVMCommand(parent *cobra.Command) *cobra.Command {
1111
cmd := &cobra.Command{
1212
Use: "vm",
1313
Short: "Manage test virtual machines.",
14-
Long: `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.`,
14+
Long: `The 'vm' command allows you to manage and interact with virtual machines (VMs) used for testing purposes.
15+
With this command, you can create, list, remove, update, and manage VMs, as well as retrieve information about available VM versions.
16+
17+
VMs are currently a beta feature.`,
1518
Example: `# Create a single Ubuntu VM
1619
replicated vm create --distribution ubuntu --version 20.04
1720

cli/cmd/vm_create.go

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,9 @@ This command allows you to provision VMs with different distributions (e.g., Ubu
3636
3737
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.
3838
39-
The command also supports a "--wait" flag to wait for the VMs to be ready before returning control, with a customizable timeout duration.`,
39+
The command also supports a "--wait" flag to wait for the VMs to be ready before returning control, with a customizable timeout duration.
40+
41+
VMs are currently a beta feature.`,
4042
Example: `# Create a single Ubuntu 20.04 VM
4143
replicated vm create --distribution ubuntu --version 20.04
4244

cli/cmd/vm_endpoints.go

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,9 @@ The output will be in the format: %s
5454
5555
You can identify the VM either by its unique ID or by its name.
5656
57-
Note: %s endpoints can only be retrieved from VMs in the "running" state.`, protocol, outputFormat, protocol)
57+
Note: %s endpoints can only be retrieved from VMs in the "running" state.
58+
59+
VMs are currently a beta feature.`, protocol, outputFormat, protocol)
5860

5961
cmdExample := fmt.Sprintf(`# Get %s endpoint for a specific VM by ID
6062
replicated vm %s-endpoint aaaaa11

cli/cmd/vm_ls.go

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,9 @@ By default, the command will return a table of all VMs, but you can switch to JS
2323
2424
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.
2525
26-
The command also allows you to customize the output format, supporting 'json', 'table', and 'wide' views for flexibility based on your needs.`,
26+
The command also allows you to customize the output format, supporting 'json', 'table', and 'wide' views for flexibility based on your needs.
27+
28+
VMs are currently a beta feature.`,
2729
Example: `# List all active VMs
2830
replicated vm ls
2931

cli/cmd/vm_port.go

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,9 @@ func (r *runners) InitVMPort(parent *cobra.Command) *cobra.Command {
1010
Short: "Manage VM ports.",
1111
Long: `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.
1212
13-
This command provides flexibility for handling ports in various test vms, ensuring efficient management of vm networking settings.`,
13+
This command provides flexibility for handling ports in various test vms, ensuring efficient management of vm networking settings.
14+
15+
VMs are currently a beta feature.`,
1416
Example: `# List all exposed ports in a vm
1517
replicated vm port ls VM_ID_OR_NAME
1618

cli/cmd/vm_port_expose.go

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,9 @@ func (r *runners) InitVMPortExpose(parent *cobra.Command) *cobra.Command {
1212
Short: "Expose a port on a vm to the public internet.",
1313
Long: `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.
1414
15-
This command supports different protocols including "http", "https", "ws", and "wss" for web traffic and web socket communication.`,
15+
This command supports different protocols including "http", "https", "ws", and "wss" for web traffic and web socket communication.
16+
17+
VMs are currently a beta feature.`,
1618
Example: `# Expose port for Embedded Cluster (Port: 30000) with HTTP Protocol
1719
replicated vm port expose VM_ID_OR_NAME --port 30000 --protocol http
1820

cli/cmd/vm_port_ls.go

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,9 @@ func (r *runners) InitVMPortLs(parent *cobra.Command) *cobra.Command {
1111
Short: "List vm ports for a vm.",
1212
Long: `The 'vm port ls' command lists all the ports configured for a specific vm. You must provide the vm ID or name to retrieve and display the ports.
1313
14-
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.`,
14+
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.
15+
16+
VMs are currently a beta feature.`,
1517
Example: `# List ports for a vm in the default table format
1618
replicated vm port ls VM_ID_OR_NAME
1719

cli/cmd/vm_port_rm.go

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,9 @@ func (r *runners) InitVMPortRm(parent *cobra.Command) *cobra.Command {
1111
Short: "Remove vm port by ID.",
1212
Long: `The 'vm port rm' command removes a specific port from a vm. You must provide the ID or name of the vm and the ID of the port to remove.
1313
14-
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.`,
14+
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.
15+
16+
VMs are currently a beta feature.`,
1517
Example: `# Remove a port using its ID
1618
replicated vm port rm VM_ID_OR_NAME --id PORT_ID
1719

cli/cmd/vm_rm.go

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,9 @@ This command supports multiple filtering options, including removing VMs by thei
1919
2020
When specifying a name that matches multiple VMs, all VMs with that name will be removed.
2121
22-
You can also use the '--dry-run' flag to simulate the removal without actually deleting the VMs.`,
22+
You can also use the '--dry-run' flag to simulate the removal without actually deleting the VMs.
23+
24+
VMs are currently a beta feature.`,
2325
Example: `# Remove a VM by ID or name
2426
replicated vm rm aaaaa11
2527

cli/cmd/vm_update.go

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,9 @@ func (r *runners) InitVMUpdateCommand(parent *cobra.Command) *cobra.Command {
1616
- Alternatively, to update the VM by its ID, use the '--id' flag.
1717
- Alternatively, to update the VM by its name, use the '--name' flag.
1818
19-
Subcommands will allow for more specific updates like TTL`,
19+
Subcommands will allow for more specific updates like TTL.
20+
21+
VMs are currently a beta feature.`,
2022
Example: `# Update a VM TTL by specifying its ID or name directly
2123
replicated vm update ttl my-test-vm --ttl 12h
2224

0 commit comments

Comments
 (0)