Skip to content

Commit bf90ee8

Browse files
committed
edits
1 parent 414808b commit bf90ee8

File tree

1 file changed

+14
-57
lines changed

1 file changed

+14
-57
lines changed

docs/vendor/testing-vm-create.md

Lines changed: 14 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -84,15 +84,16 @@ To set up and verify SSH access for Compatibility Matrix VMs using your personal
8484
```bash
8585
8686
```
87-
88-
1. For the prompt `Are you sure you want to continue connecting (yes/no/[fingerprint])?`, type `yes` and press Enter.
89-
9087
If successful, you will see a message similar to the following:
9188
9289
```
93-
You have successfully authenticated, use <VM_ID>@replicatedvm.com to access your VM.
90+
Hi <username>! You have successfully authenticated, use [VM_ID]@replicatedvm.com to access your VM.
9491
```
9592
93+
:::note
94+
If you see the prompt `Are you sure you want to continue connecting (yes/no/[fingerprint])?`, type `yes` and press Enter to continue. You might see this prompt if it is the first time you are authenticating with the public/private SSH key in your GitHub account.
95+
:::
96+
9697
### Use a Service Account
9798
9899
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:
@@ -158,8 +159,6 @@ You can SSH into a VM using one of the following methods:
158159
159160
* [**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.
160161
161-
* [**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.
162-
163162
For information about how to copy files to a VM after connecting, see [Copy Files to a VM](#copy-files-to-a-vm) below.
164163
165164
### Compatibility Matrix Forwarder
@@ -178,7 +177,9 @@ For information about copying files to the VM after connecting, see [After Conne
178177
179178
### Direct SSH
180179
181-
Transferring files using Direct SSH allows you to use your SSH tool of choice, and pass any client-supported flags. Direct SSH requires Replicated CLI v0.104.0 or later.
180+
Connecting to a VM with direct SSH requires Replicated CLI v0.104.0 or later.
181+
182+
To connect to a VM using direct SSH:
182183
183184
1. Get the SSH endpoint for the VM:
184185
@@ -205,6 +206,10 @@ Transferring files using Direct SSH allows you to use your SSH tool of choice, a
205206
```
206207
For example, `ssh://[email protected]:46795`.
207208
209+
:::note
210+
You can also get the SSH endpoint and port in JSON format by running `replicated vm ls --output json`.
211+
:::
212+
208213
1. Copy the SSH endpoint.
209214
210215
1. SSH into the VM using the SSH endpoint that you copied:
@@ -230,59 +235,11 @@ Transferring files using Direct SSH allows you to use your SSH tool of choice, a
230235

231236
```
232237
ssh $(replicated vm ssh-endpoint aba1acc2)
233-
```
234-
235-
### Connect to a VM Manually
236-
237-
If the Forwarder or direct SSH do not work with your preferred SSH client, you can connect manually. When a VM is created, a random port is assigned to each machine within each group of the VM.
238-
239-
To connect with the machine over SSH:
240-
241-
1. Run the following command:
242-
243-
```bash
244-
replicated vm ls --output json
245-
```
246-
247-
The following shows an example of the output of this command:
248-
249-
```json
250-
[
251-
{
252-
"id": "e32aafa1",
253-
"name": "sad_black",
254-
"distribution": "ubuntu",
255-
"version": "24.04",
256-
"status": "running",
257-
"created_at": "2024-10-24T15:00:37Z",
258-
"expires_at": "2024-10-24T16:01:10Z",
259-
"ttl": "1h",
260-
"credits_per_hour_per_vm": 0,
261-
"flat_fee": 50000,
262-
"total_credits": 0,
263-
"estimated_cost": 0,
264-
"direct_ssh_port": 33655,
265-
"direct_ssh_endpoint": "95.217.47.21",
266-
"tags": []
267-
}
268-
]
269-
```
270-
271-
1. Run the following command to connect:
272-
273-
```bash
274-
ssh -p DIRECT_SSH_PORT GITHUB_USERNAME@DIRECT_SSH_ENDPOINT
275-
```
276-
277-
**Example:**
278-
279-
```bash
280-
ssh -p 33655 [email protected]
281-
```
238+
```
282239

283240
## Copy Files to a VM
284241

285-
You can copy files to a VM either using an SCP endpoint, or by using SCP after connecting to the VM with the Compatibility Matrix Forwarder.
242+
You can copy files to a VM either using direct SSH and an SCP endpoint, or by using SCP after connecting to the VM with the Compatibility Matrix Forwarder. Transferring files using direct SSH allows you to use your SSH tool of choice, and pass any client-supported flags.
286243

287244
### Using the SCP Endpoint
288245

0 commit comments

Comments
 (0)