Skip to content

Add steps for creating/editing VMs through Vendor Portal UI #3447

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Aug 18, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions docs/vendor/testing-how-to.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,13 +82,15 @@ To create a cluster using the Replicated CLI:

To create a cluster using the Vendor Portal:

1. Go to [**Compatibility Matrix > Create cluster**](https://vendor.replicated.com/compatibility-matrix/create-cluster).
1. Go to [**Compatibility Matrix**](https://vendor.replicated.com/compatibility-matrix/create-cluster).

1. Click **Create > Create Kubernetes cluster**.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

^ updated the Create Clusters page to reflect the latest UI updates


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

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

1. On the **Create a cluster** page, complete the following fields:
1. On the **Create a Kubernetes cluster** page, complete the following fields:

<table>
<tr>
Expand Down
85 changes: 84 additions & 1 deletion docs/vendor/testing-vm-create.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,8 @@ replicated vm create --distribution ubuntu --version 24.04 --ssh-public-key ~/.s

## Create VMs

### With the Replicated CLI

To create VMs with Compatibility Matrix:

1. (Optional) View the available VM distributions, including the supported VM distribution versions and instance types:
Expand Down Expand Up @@ -152,6 +154,66 @@ To create VMs with Compatibility Matrix:
replicated vm create --distribution ubuntu --version 22.04 --disk 50 --instance-type r1.medium
```

### With the Vendor Portal
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

new Vendor Portal steps (added cli and vendor portal subheadings under Create VMs)


To create a VM from the Vendor Portal:

1. In the Vendor Portal, go to [**Compatibility Matrix**](https://vendor.replicated.com/compatibility-matrix).

1. Click **Create > Create VM**.

![create vm page in the vendor portal](/images/compatibility-matrix-create-vm.png)

[View a larger version of this image](/images/compatibility-matrix-create-vm.png)

1. On the **Create a Virtual Machine** page, complete the following fields:

<table>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
<tr>
<td>OS distribution</td>
<td>Select the OS distribution for the VM.</td>
</tr>
<tr>
<td>Version</td>
<td>Select the OS version. The options available are specific to the distribution selected.</td>
</tr>
<tr>
<td>Name (optional)</td>
<td>Enter an optional name for the VM.</td>
</tr>
<tr>
<td>Tags</td>
<td>Add one or more tags to the VM as key-value pairs.</td>
</tr>
<tr>
<td>Set TTL</td>
<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>
</tr>
</table>

1. For **VM Config**, complete the following fields:

<table>
<tr>
<td>Instance type</td>
<td>Select the instance type to use for the nodes in the node group. The options available are specific to the distribution selected.</td>
</tr>
<tr>
<td>Disk size</td>
<td>Select the disk size in GiB to use per node.</td>
</tr>
<tr>
<td>Count</td>
<td>Select the number of VMs to provision.</td>
</tr>
</table>

1. Click **Create VM**.

## Connect to a VM

You can SSH into a VM using one of the following methods:
Expand Down Expand Up @@ -236,7 +298,28 @@ To connect to a VM using direct SSH:

```
ssh $(replicated vm ssh-endpoint aba1acc2)
```
```

## Expose Ports on Running VMs
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

^ added these steps with info about how to edit a VM to expose ports using the Ingress & Ports section


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.

To update the ingress and ports settings for a running VM:

1. In the Vendor Portal, go to [**Compatibility Matrix**](https://vendor.replicated.com/compatibility-matrix).

1. Open the dot menu for the target VM and click **Edit VM**.

![Edit VM in the dot menu](/images/compatibility-matrix-edit-vm.png)

[View a larger version of this image](/images/compatibility-matrix-edit-vm.png)

1. Under **Ingress & Ports**, for **Add DNS record**, edit the fields as desired and click **Add** to create a DNS record.

![DNS record for a VM](/images/compatibility-matrix-ingress-ports.png)
[View a larger version of this image](/images/compatibility-matrix-ingress-ports.png)

A DNS record and valid TLS cert are created and connected to the specified port.

## Copy Files to a VM

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.