Skip to content

Commit fc03b4a

Browse files
committed
Review Cluster and VM create info
1 parent 503b3bb commit fc03b4a

File tree

2 files changed

+34
-8
lines changed

2 files changed

+34
-8
lines changed

docs/vendor/testing-how-to.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,13 @@ To create a cluster using the Replicated CLI:
4545

4646
1. Run the following command to create a cluster:
4747

48+
49+
```bash
50+
replicated cluster create --distribution DISTRIBUTION
51+
```
52+
53+
To specify more options:
54+
4855
```bash
4956
replicated cluster create --name NAME --distribution K8S_DISTRO --version K8S_VERSION --disk DISK_SIZE --instance-type INSTANCE_TYPE [--license-id LICENSE_ID]
5057
```

docs/vendor/testing-vm-create.md

Lines changed: 27 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -88,18 +88,37 @@ To create VMs with Compatibility Matrix:
8888

8989

9090

91-
2. Run the following command to create VMs:
91+
2. Run the following command to create a VM:
9292

93-
```bash
94-
replicated vm create --distribution DISTRIBUTION --count COUNT
95-
```
93+
```bash
94+
replicated vm create --distribution DISTRIBUTION
95+
```
96+
97+
To specify more options:
98+
99+
100+
```bash
101+
replicated vm create --name NAME --distribution DISTRIBUTION --version VERSION --instance-type INSTANCE_TYPE --count COUNT --ttl TTL
102+
```
103+
104+
Where:
105+
* `NAME` is any name for the VM. If `--name` is excluded, a name is automatically generated for the cluster.
106+
* `DISTRIBUTION` is the operating system distribution for the VM (e.g., ubuntu, almalinux).
107+
* `VERSION` is the version of the distribution to provision (e.g., 20.04, 22.04 for Ubuntu).
108+
* `INSTANCE_TYPE` is the instance type to use for the VM (e.g., r1.medium, r1.large).
109+
* `COUNT` is the number of VMs to create. If `--count` is excluded, one VM is created by default.
110+
* `TTL` is the VM Time-To-Live duration (maximum 48h). If `--ttl` is excluded, the default TTL is 1 hour.
111+
112+
For command usage and additional optional flags, see [vm create](/reference/replicated-cli-vm-create).
96113

97-
Where:
98-
* `DISTRIBUTION` is the Linux distribution for the VM (e.g., ubuntu, almalinux).
99-
* `COUNT` is the number of VMs to create
114+
**Example:**
100115

116+
The following example creates an Ubuntu VM with version 22.04, a disk size of 50 GiB, and an instance type of `r1.medium`.
117+
118+
```bash
119+
replicated vm create --distribution ubuntu --version 22.04 --disk 50 --instance-type r1.medium
120+
```
101121

102-
replicated vm versions
103122

104123

105124
### Supported VM Types

0 commit comments

Comments
 (0)