Skip to content

Commit 45a6725

Browse files
committed
edits
1 parent 1ad3a85 commit 45a6725

File tree

1 file changed

+34
-34
lines changed

1 file changed

+34
-34
lines changed

docs/vendor/testing-vm-create.md

Lines changed: 34 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ The following VM types are supported:
2626
Creating VMs with Compatibility Matrix has the following limitations:
2727

2828
- Creating VMs with Compatibility Matrix is a Beta feature.
29-
- Installing Embedded Cluster on a VM created with Compatibility Matrix is supported for Embedded Cluster versions 1.21.0 or later.
29+
- Installing Embedded Cluster on a VM created with Compatibility Matrix is supported for Embedded Cluster versions 1.21.0 or later. To reboot a Compatibility Matrix VM, you can run the Embedded Cluster [reset](embedded-using#reset-a-node) command.
3030
- [GitHub Actions](/vendor/testing-how-to#replicated-github-actions) are not supported for Compatibility Matrix VMs.
3131
- The [cluster prepare](/reference/replicated-cli-cluster-prepare) command is not supported for Compatibility Matrix VMs.
3232

@@ -95,7 +95,7 @@ To set up and verify SSH access for Compatibility Matrix VMs using your personal
9595
9696
### Use a Service Account
9797
98-
To automate the creation of VMs in your CI/CD workflows, you can use the flag `--ssh-public-key` when you first create a VM, where you provide the SSH public key for a GitHub service account connected to the Vendor Portal. For example:
98+
To automate the creation of VMs in your CI/CD workflows, you can use the flag `--ssh-public-key` to provide the SSH public key for a GitHub service account. For example:
9999
100100
```bash
101101
replicated vm create --distribution ubuntu --version 20.04 --ssh-public-key ~/.ssh/id_rsa.pub
@@ -154,12 +154,14 @@ To create VMs with Compatibility Matrix:
154154
155155
You can SSH into a VM using one of the following methods:
156156
157-
* [**Compatibility Matrix Forwarder**](#compatibility-matrix-forwarder): To use the Compatibility Matrix Forwarder, you only need to know the VM ID to connect to the machine with SSH. This is more approachable for users less familiar with SSH clients. One example use case for the Forwarder is to run an online Embedded Cluster install command.
157+
* [**Compatibility Matrix Forwarder**](#compatibility-matrix-forwarder): To use the Compatibility Matrix Forwarder, you only need to know the VM ID to connect to the machine with SSH. This is more approachable for users less familiar with SSH clients.
158158
159159
* [**Direct SSH**](#direct-ssh): When you connect to a VM using direct SSH, you can use your SSH tool of choice and pass any client supported flags, without any added connection lag of being routed through the Compatibility Matrix Forwarder. Example use cases for direct SSH include transferring large assets such as air gap bundles to the VM using SCP, or passing specific SHH flags during testing workflows.
160160
161161
* [**Connect to a VM Manually**](#connect-to-a-vm-manually): If the above options are not supported with your preferred SSH client, you can connect to a VM manually.
162162
163+
For information about how to copy files to a VM after connecting, see [Copy Files to a VM](#copy-files-to-a-vm) below.
164+
163165
### Compatibility Matrix Forwarder
164166
165167
:::note
@@ -238,33 +240,35 @@ If the Forwarder or direct SSH do not work with your preferred SSH client, you c
238240

239241
To connect with the machine over SSH:
240242

241-
```bash
242-
replicated vm ls --output json
243-
```
243+
1. Run the following command:
244244

245-
If successful, you'll see:
246-
247-
```json
248-
[
249-
{
250-
"id": "e32aafa1",
251-
"name": "sad_black",
252-
"distribution": "ubuntu",
253-
"version": "24.04",
254-
"status": "running",
255-
"created_at": "2024-10-24T15:00:37Z",
256-
"expires_at": "2024-10-24T16:01:10Z",
257-
"ttl": "1h",
258-
"credits_per_hour_per_vm": 0,
259-
"flat_fee": 50000,
260-
"total_credits": 0,
261-
"estimated_cost": 0,
262-
"direct_ssh_port": 33655,
263-
"direct_ssh_endpoint": "95.217.47.21",
264-
"tags": []
265-
}
266-
]
267-
```
245+
```bash
246+
replicated vm ls --output json
247+
```
248+
249+
The following shows an example of the output of this command:
250+
251+
```json
252+
[
253+
{
254+
"id": "e32aafa1",
255+
"name": "sad_black",
256+
"distribution": "ubuntu",
257+
"version": "24.04",
258+
"status": "running",
259+
"created_at": "2024-10-24T15:00:37Z",
260+
"expires_at": "2024-10-24T16:01:10Z",
261+
"ttl": "1h",
262+
"credits_per_hour_per_vm": 0,
263+
"flat_fee": 50000,
264+
"total_credits": 0,
265+
"estimated_cost": 0,
266+
"direct_ssh_port": 33655,
267+
"direct_ssh_endpoint": "95.217.47.21",
268+
"tags": []
269+
}
270+
]
271+
```
268272

269273
1. Run the following command to connect:
270274

@@ -365,8 +369,4 @@ To copy files to the VM using SCP after connecting with the Compatibility Matrix
365369

366370
```bash
367371
scp somefile 123abc@replicatedvm:/home/folder/somefile
368-
```
369-
370-
## Reboot a VM
371-
372-
To reboot a Compatibility Matrix VM, you can run the Embedded Cluster [reset](embedded-using#reset-a-node) command.
372+
```

0 commit comments

Comments
 (0)