Skip to content

Commit 4984433

Browse files
committed
Read through VM doc
1 parent fc03b4a commit 4984433

File tree

1 file changed

+25
-15
lines changed

1 file changed

+25
-15
lines changed

docs/vendor/testing-vm-create.md

Lines changed: 25 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -135,12 +135,12 @@ The following VM types are supported:
135135
There are currently two supported methods to SSH into a VM:
136136

137137
1. [**Compatibility Matrix Forwarder**](#compatibility-matrix-forwarder)
138-
* Easier – You only need to know the VM ID to connect to the machine via SSH. This is more approachable for users less familiar with SSH clients.
139-
* Example Use Case – Run an online Embedded Cluster install command
138+
* **Easier** – You only need to know the VM ID to connect to the machine via SSH. This is more approachable for users less familiar with SSH clients.
139+
* **Example Use Case** – Run an online Embedded Cluster install command
140140

141141
2. [**Direct SSH**](#direct-ssh)
142-
* More Flexible – Leverage your SSH tool of choice and pass any client supported flags, without any added connection lag of being routed through the Compatibility Matrix Forwarder.
143-
* Example Use Case – SCP large assets to the VM, such as air gap bundles.
142+
* **More Flexible** – Leverage your SSH tool of choice and pass any client supported flags, without any added connection lag of being routed through the Compatibility Matrix Forwarder.
143+
* **Example Use Case** – SCP large assets to the VM, such as air gap bundles.
144144
Pass specific SHH flags during testing workflows
145145

146146
### Compatibility Matrix Forwarder
@@ -155,45 +155,53 @@ SSH into the VM:
155155
156156
```
157157

158-
Where `VMID` is the ID of the VM.
158+
- Where `VMID` is the ID of the VM.
159159

160160
If needed, copy files onto the machine:
161161

162162
```bash
163163
scp somefile VMID@replicatedvm:/home/folder/somefile
164164
```
165165

166-
Where `VMID` is the ID of the VM.
166+
- Where `VMID` is the ID of the VM.
167167

168168
:::note
169-
**Beta Limitations:** scp with flag -O (legacy scp protocol) is not supported. Relative paths is not supported `❌ scp somefile [email protected]:~ ✅ scp somefile VMID@replicatedvm:/home/folder/somefile` File permissions are not inherited.
169+
**Beta Limitations:**
170+
- `scp` with flag `-O` (legacy scp protocol) is not supported.
171+
- Relative paths is not supported
172+
- Unsupported: `scp somefile [email protected]:~`
173+
- Supported: `scp somefile VMID@replicatedvm:/home/folder/somefile`
174+
- File permissions are not inherited.
170175
:::
171176

172177
### Direct SSH
173178

179+
Transferring files using Direct SSH allows you to use your SSH tool of choice, and pass any client-supported flags.
180+
181+
174182
:::note
175-
Transferring files using Direct SSH allows you to use your SSH tool of choice, and pass any client-supported flags. Note: Requires Replicated CLI v0.104.0 or later.
183+
Requires Replicated CLI v0.104.0 or later.
176184
:::
177185

178-
Get the SSH endpoint for the VM:
179-
180-
1. Run the following command to get the SSH endpoint:
186+
1. Get the SSH endpoint for the VM:
181187

182188
```bash
183189
replicated vm ssh-endpoint VMID_OR_VMNAME
184190
```
185191

186-
Where `VMID_OR_VMNAME` is the ID or name of the VM.
192+
- Where `VMID_OR_VMNAME` is the ID or name of the VM. Run `replicated vm ls`
187193

188194
If successful, you'll see:
189195

190196
```
191197
ssh://[github-user-name]@[ssh-endpoint]:[port]
192198
```
193199

194-
**Example**`ssh://[email protected]:46795`
200+
- **Example**`ssh://[email protected]:46795`
195201

196-
⚠️ The username for SSH should match the GitHub username in Vendor Portal. For more information about overriding the username, see [Override Username](#override-username).
202+
:::note
203+
Make sure the username for SSH matches the GitHub username in Vendor Portal. For more information about overriding the username, see [Override Username](#override-username).
204+
:::
197205

198206
1. SSH into the VM:
199207

@@ -225,7 +233,9 @@ Request the scp endpoint:
225233

226234
**Example**`scp://[email protected]:46795`
227235

228-
⚠️ The username for SSH should match the GitHub username in Vendor Portal. For more information about overriding the username, see [Override Username](#override-username).
236+
:::note
237+
Make sure the username for SSH matches the GitHub username in Vendor Portal. For more information about overriding the username, see [Override Username](#override-username).
238+
:::
229239

230240
1. SCP files into the VM:
231241

0 commit comments

Comments
 (0)