diff --git a/docs/vendor/testing-how-to.md b/docs/vendor/testing-how-to.md index b6d4ac2f18..ecf67ab2ab 100644 --- a/docs/vendor/testing-how-to.md +++ b/docs/vendor/testing-how-to.md @@ -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**. Create a cluster page [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: diff --git a/docs/vendor/testing-vm-create.md b/docs/vendor/testing-vm-create.md index f5f9d1292d..e3767f978e 100644 --- a/docs/vendor/testing-vm-create.md +++ b/docs/vendor/testing-vm-create.md @@ -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: @@ -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 + +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: + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
OS distributionSelect the OS distribution for the VM.
VersionSelect the OS version. The options available are specific to the distribution selected.
Name (optional)Enter an optional name for the VM.
TagsAdd one or more tags to the VM as key-value pairs.
Set TTLSelect 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).
+ +1. For **VM Config**, complete the following fields: + + + + + + + + + + + + + + +
Instance typeSelect the instance type to use for the nodes in the node group. The options available are specific to the distribution selected.
Disk sizeSelect the disk size in GiB to use per node.
CountSelect the number of VMs to provision.
+ +1. Click **Create VM**. + ## Connect to a VM You can SSH into a VM using one of the following methods: @@ -236,7 +298,28 @@ To connect to a VM using direct SSH: ``` ssh $(replicated vm ssh-endpoint aba1acc2) - ``` + ``` + +## Expose Ports on Running VMs + +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 diff --git a/static/images/compatibility-matrix-create-vm.png b/static/images/compatibility-matrix-create-vm.png new file mode 100644 index 0000000000..d2c4bb2549 Binary files /dev/null and b/static/images/compatibility-matrix-create-vm.png differ diff --git a/static/images/compatibility-matrix-edit-vm.png b/static/images/compatibility-matrix-edit-vm.png new file mode 100644 index 0000000000..486a29af11 Binary files /dev/null and b/static/images/compatibility-matrix-edit-vm.png differ diff --git a/static/images/compatibility-matrix-ingress-ports.png b/static/images/compatibility-matrix-ingress-ports.png new file mode 100644 index 0000000000..ec74256e25 Binary files /dev/null and b/static/images/compatibility-matrix-ingress-ports.png differ