-
Notifications
You must be signed in to change notification settings - Fork 29
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
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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**. | ||
|
||
 | ||
|
||
[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: | ||
|
@@ -236,7 +298,28 @@ To connect to a VM using direct SSH: | |
|
||
``` | ||
ssh $(replicated vm ssh-endpoint aba1acc2) | ||
``` | ||
``` | ||
|
||
## Expose Ports on Running VMs | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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**. | ||
|
||
 | ||
|
||
[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. | ||
|
||
 | ||
[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 | ||
|
||
|
There was a problem hiding this comment.
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