Skip to content

Commit 503b3bb

Browse files
committed
Review VMs page
1 parent 58c4424 commit 503b3bb

File tree

1 file changed

+42
-19
lines changed

1 file changed

+42
-19
lines changed

docs/vendor/testing-vm-create.md

Lines changed: 42 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
import Prerequisites from "../partials/cmx/_prerequisites.mdx"
2+
13
# Create VMs (Beta)
24

35
This topic describes how to use Replicated Compatibility Matrix to create and manage ephemeral VMs, which allows greater flexibility in testing VM-based installs such as the [Replicated Embedded Cluster](https://docs.replicated.com/intro-replicated#embedded-cluster).
@@ -7,20 +9,27 @@ This topic describes how to use Replicated Compatibility Matrix to create and ma
79
Compatibility Matrix VMs provide isolated Linux environments for testing your applications. Unlike clusters, VMs give you full control over the operating system and allow you to test installation methods that require direct OS access.
810

911
**When to use VMs vs Clusters:**
10-
* **Use VMs** for testing Embedded Cluster installers, air-gap installations, or when you need full OS control
11-
12-
* **Use Clusters** for testing Kubernetes-based deployments and Helm installations. For more information about creating and managing clusters, see [Create Clusters](/vendor/testing-how-to).
12+
* **Use VMs** for testing Embedded Cluster installers, air-gap installations, or when you need full OS control.
13+
* **Use Clusters** for testing Kubernetes-based deployments and Helm installations. See [Create Clusters](/vendor/testing-how-to).
1314

1415
## Prerequisites
1516

1617
Before you can use Compatibility Matrix VMs, you must complete the following prerequisites:
1718

18-
* [Configure your GitHub username in Replicated Vendor Portal](team-management-github-username#procedure)
19+
<Prerequisites/>
20+
21+
* Existing accounts must accept the TOS for the trial on the [**Compatibility Matrix**](https://vendor.replicated.com/compatibility-matrix) page in the Replicated Vendor Portal.
22+
23+
24+
Prerequisites for SSH access to VMs:
25+
26+
* [Configure your GitHub username or GitHub service account in Replicated Vendor Portal](team-management-github-username#procedure)
1927

2028
* Make sure you have added your SSH key in your GitHub account. For instructions, see [Adding a new SSH key to your GitHub account](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account) in the GitHub documentation.
2129

2230
:::note
23-
GitHub usernames and SSH keys are synced every 24hrs. To immediately sync: → [Account Settings](https://vendor.replicated.com/account-settings) > click Save. Keys are synced to the VM at time of creation, so any updates after creation are ignored.
31+
Troubleshooting
32+
Your GitHub usernames and SSH keys are synced to the VM when you first create it. If you update your GitHub username or keys after VM creation, you can manually sync by going to [Account Settings](https://vendor.replicated.com/account-settings) > click "Save."
2433
:::
2534

2635
## Set Up SSH Access
@@ -37,7 +46,19 @@ If successful, you will see:
3746
You have successfully authenticated, use [VM_ID]@replicatedvm.com to access your VM.
3847
```
3948

40-
If you do not see this message, your public/private key likely was not available.
49+
If you do not see this message, check if your public/private key has been properly set up with GitHub.
50+
51+
```bash
52+
53+
```
54+
55+
If successful, you will see:
56+
57+
```
58+
Hi! You've successfully authenticated, but GitHub does not provide shell access.
59+
```
60+
61+
4162

4263
### Alternative: Use a Service GitHub Account
4364

@@ -57,27 +78,29 @@ replicated vm create --distribution ubuntu --version 20.04 --ssh-public-key ~/.s
5778

5879
To create VMs with Compatibility Matrix:
5980

60-
1. Run the following command to create VMs:
81+
82+
1. (Optional) View the available VM distributions, including the supported VM distribution versions and instance types:
6183

6284
```bash
63-
replicated vm create --distribution DISTRIBUTION --count COUNT
85+
replicated vm versions
6486
```
87+
For command usage, see [vm versions](/reference/replicated-cli-vm-versions).
6588

66-
Where:
67-
* `DISTRIBUTION` is the Linux distribution for the VM (e.g., ubuntu, almalinux)
68-
* `COUNT` is the number of VMs to create
6989

70-
**Example:**
7190

72-
```bash
73-
replicated vm create --distribution ubuntu --count 3
74-
```
91+
2. Run the following command to create VMs:
92+
93+
```bash
94+
replicated vm create --distribution DISTRIBUTION --count COUNT
95+
```
7596

76-
1. List supported distributions and versions:
97+
Where:
98+
* `DISTRIBUTION` is the Linux distribution for the VM (e.g., ubuntu, almalinux).
99+
* `COUNT` is the number of VMs to create
100+
101+
102+
replicated vm versions
77103

78-
```bash
79-
replicated vm versions
80-
```
81104

82105
### Supported VM Types
83106

0 commit comments

Comments
 (0)