Skip to content

Commit bc2b1e1

Browse files
authored
Merge pull request #3447 from replicatedhq/create-vm-ui
Add steps for creating/editing VMs through Vendor Portal UI
2 parents 97b221c + d6bf3d6 commit bc2b1e1

File tree

5 files changed

+88
-3
lines changed

5 files changed

+88
-3
lines changed

docs/vendor/testing-how-to.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -103,13 +103,15 @@ To create a cluster using the Replicated CLI:
103103

104104
To create a cluster using the Vendor Portal:
105105

106-
1. Go to [**Compatibility Matrix > Create cluster**](https://vendor.replicated.com/compatibility-matrix/create-cluster).
106+
1. Go to [**Compatibility Matrix**](https://vendor.replicated.com/compatibility-matrix/create-cluster).
107+
108+
1. Click **Create > Create Kubernetes cluster**.
107109

108110
<img alt="Create a cluster page" src="/images/create-a-cluster.png" width="650px"/>
109111

110112
[View a larger version of this image](/images/create-a-cluster.png)
111113

112-
1. On the **Create a cluster** page, complete the following fields:
114+
1. On the **Create a Kubernetes cluster** page, complete the following fields:
113115

114116
<table>
115117
<tr>

docs/vendor/testing-vm-create.md

Lines changed: 84 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,8 @@ replicated vm create --distribution ubuntu --version 24.04 --ssh-public-key ~/.s
118118
119119
## Create VMs
120120
121+
### With the Replicated CLI
122+
121123
To create VMs with Compatibility Matrix:
122124
123125
1. (Optional) View the available VM distributions, including the supported VM distribution versions and instance types:
@@ -159,6 +161,66 @@ To create VMs with Compatibility Matrix:
159161
replicated vm create --distribution ubuntu --version 22.04 --disk 50 --instance-type r1.medium
160162
```
161163
164+
### With the Vendor Portal
165+
166+
To create a VM from the Vendor Portal:
167+
168+
1. In the Vendor Portal, go to [**Compatibility Matrix**](https://vendor.replicated.com/compatibility-matrix).
169+
170+
1. Click **Create > Create VM**.
171+
172+
![create vm page in the vendor portal](/images/compatibility-matrix-create-vm.png)
173+
174+
[View a larger version of this image](/images/compatibility-matrix-create-vm.png)
175+
176+
1. On the **Create a Virtual Machine** page, complete the following fields:
177+
178+
<table>
179+
<tr>
180+
<th>Field</th>
181+
<th>Description</th>
182+
</tr>
183+
<tr>
184+
<td>OS distribution</td>
185+
<td>Select the OS distribution for the VM.</td>
186+
</tr>
187+
<tr>
188+
<td>Version</td>
189+
<td>Select the OS version. The options available are specific to the distribution selected.</td>
190+
</tr>
191+
<tr>
192+
<td>Name (optional)</td>
193+
<td>Enter an optional name for the VM.</td>
194+
</tr>
195+
<tr>
196+
<td>Tags</td>
197+
<td>Add one or more tags to the VM as key-value pairs.</td>
198+
</tr>
199+
<tr>
200+
<td>Set TTL</td>
201+
<td>Select the Time to Live (TTL) for the VM. When the TTL expires, the VM is automatically deleted. TTL can be adjusted after VM creation with [vm update ttl](/reference/replicated-cli-vm-update-ttl).</td>
202+
</tr>
203+
</table>
204+
205+
1. For **VM Config**, complete the following fields:
206+
207+
<table>
208+
<tr>
209+
<td>Instance type</td>
210+
<td>Select the instance type to use for the nodes in the node group. The options available are specific to the distribution selected.</td>
211+
</tr>
212+
<tr>
213+
<td>Disk size</td>
214+
<td>Select the disk size in GiB to use per node.</td>
215+
</tr>
216+
<tr>
217+
<td>Count</td>
218+
<td>Select the number of VMs to provision.</td>
219+
</tr>
220+
</table>
221+
222+
1. Click **Create VM**.
223+
162224
## Connect to a VM
163225
164226
You can SSH into a VM using one of the following methods:
@@ -243,7 +305,28 @@ To connect to a VM using direct SSH:
243305

244306
```
245307
ssh $(replicated vm ssh-endpoint aba1acc2)
246-
```
308+
```
309+
310+
## Expose Ports on Running VMs
311+
312+
After creating a VM, you can create update the ingress and ports settings to add DNS records. This allows you to connect to ports on the VM.
313+
314+
To update the ingress and ports settings for a running VM:
315+
316+
1. In the Vendor Portal, go to [**Compatibility Matrix**](https://vendor.replicated.com/compatibility-matrix).
317+
318+
1. Open the dot menu for the target VM and click **Edit VM**.
319+
320+
![Edit VM in the dot menu](/images/compatibility-matrix-edit-vm.png)
321+
322+
[View a larger version of this image](/images/compatibility-matrix-edit-vm.png)
323+
324+
1. Under **Ingress & Ports**, for **Add DNS record**, edit the fields as desired and click **Add** to create a DNS record.
325+
326+
![DNS record for a VM](/images/compatibility-matrix-ingress-ports.png)
327+
[View a larger version of this image](/images/compatibility-matrix-ingress-ports.png)
328+
329+
A DNS record and valid TLS cert are created and connected to the specified port.
247330

248331
## Copy Files to a VM
249332

102 KB
Loading
117 KB
Loading
205 KB
Loading

0 commit comments

Comments
 (0)