Skip to content

Commit 414808b

Browse files
committed
edits
1 parent 45a6725 commit 414808b

File tree

2 files changed

+50
-46
lines changed

2 files changed

+50
-46
lines changed

docs/vendor/testing-vm-create.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -164,10 +164,6 @@ For information about how to copy files to a VM after connecting, see [Copy File
164164
165165
### Compatibility Matrix Forwarder
166166
167-
:::note
168-
Transferring files using Compatibility Matrix Forwarder is slower than using direct SSH. Compatibility Matrix servers run on EKS, so depending on your location, using the Forwarder adds latency. If you want to transfer large files such as air gap bundles onto the VM, use [Direct SSH](#direct-ssh) in combination with SCP.
169-
:::
170-
171167
To connect to a VM using the Forwarder:
172168
173169
* SSH into the VM:
@@ -178,6 +174,8 @@ To connect to a VM using the Forwarder:
178174
179175
Where `VMID` is the ID of the VM.
180176
177+
For information about copying files to the VM after connecting, see [After Connecting to the VM with the Forwarder](#after-connecting-to-the-vm-with-the-forwarder) below.
178+
181179
### Direct SSH
182180
183181
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.
@@ -334,16 +332,17 @@ To copy files to a VM using the scp endpoint:
334332

335333
### After Connecting to the VM with the Forwarder
336334

337-
You can also copy files with SCP after connecting to the VM using the Compatibility Matrix Forwarder.
338-
339335
:::note
340-
**Beta Limitations:**
336+
Transferring files using Compatibility Matrix Forwarder is slower than using direct SSH. Compatibility Matrix servers run on EKS, so depending on your location, using the Forwarder adds latency. If you want to transfer large files such as air gap bundles onto the VM, use direct SSH in combination with SCP. See [Using the SCP Endpoint](#using-the-scp-endpoint) above.
337+
:::
338+
339+
#### Limitations
340+
Transferring files using the Compatibility Matrix Forwarder has the following limitations:
341341
- `scp` with flag `-O` (legacy scp protocol) is not supported.
342342
- Relative paths is not supported. For example:
343343
- Unsupported: `scp somefile [email protected]:~`
344344
- Supported: `scp somefile VMID@replicatedvm:/home/folder/somefile`
345345
- File permissions are not inherited.
346-
:::
347346

348347
To copy files to the VM using SCP after connecting with the Compatibility Matrix Forwarder:
349348

docs/vendor/testing-vm-networking.md

Lines changed: 43 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,10 @@ You can expose ports on a VM and make them accessible on the public internet. Fo
1616
replicated vm port expose VMID_OR_VMNAME --port PORT --protocol PROTOCOL
1717
```
1818

19-
**Example** – Expose port 3000 with HTTP protocol
20-
`replicated vm port expose VM_ID --port 30000 --protocol http`
19+
For example, to expose port 3000 with HTTP protocol:
20+
```bash
21+
replicated vm port expose VM_ID --port 30000 --protocol http
22+
```
2123

2224
### List Tunnels
2325

@@ -33,59 +35,62 @@ replicated vm port rm VMID_OR_VMNAME
3335

3436
## Connect a Compatibility Matrix VM with a Compatibility Matrix Cluster
3537

36-
You can make a Compatibility Matrix Cluster available on the same network as a CMX VM.
38+
You can make a Compatibility Matrix cluster available on the same network as a Compatibility Matrix VM.
3739

38-
**Compatible Clusters:** Openshift, K3s, RKE2, EC, kURL
39-
**Requirement:** Replicated CLI 0.90.0 or higher
40-
**Note:** Create the cluster first, then attach the new VM to that existing network.
40+
**Compatible clusters:** Openshift, K3s, RKE2, EC, kURL
41+
**Requirement:** Replicated CLI 0.90.0 or later
4142

42-
### Create a Cluster
43+
To connect a Compatibility Matrix VM with a Compatibility Matrix cluster on the same network:
4344

44-
```bash
45-
replicated cluster create --distribution K8S_DISTRIBUTION
46-
```
45+
1. Create a cluster:
4746

48-
**Example**`replicated cluster create --distribution k3s`
47+
```bash
48+
replicated cluster create --distribution K8S_DISTRIBUTION
49+
```
4950

50-
If successful, you'll see:
51+
For example, `replicated cluster create --distribution k3s`.
5152

52-
```
53-
ID NAME DISTRIBUTION VERSION STATUS CREATED
54-
EXPIRES COST
55-
b09cf035 affect_mend k3s 1.32.0 queued 2025-01-28 16:04 PST - $0.60
56-
```
53+
Example output:
5754

58-
### Check the Network
55+
```
56+
ID NAME DISTRIBUTION VERSION STATUS CREATED
57+
EXPIRES COST
58+
b09cf035 affect_mend k3s 1.32.0 queued 2025-01-28 16:04 PST - $0.60
59+
```
5960

60-
```bash
61-
replicated network ls
62-
```
61+
1. Check the network:
6362

64-
If successful, you'll see:
63+
```bash
64+
replicated network ls
65+
```
6566

66-
```
67-
ID NAME STATUS CREATED EXPIRES
68-
accbd6a7 affect_mend running 2025-01-28 16:04 PST 2025-01-28 17:05 PST
69-
```
67+
Example output:
7068

71-
### Create CMX VM on Same Network
69+
```
70+
ID NAME STATUS CREATED EXPIRES
71+
accbd6a7 affect_mend running 2025-01-28 16:04 PST 2025-01-28 17:05 PST
72+
```
7273

73-
```bash
74-
replicated vm create --distribution DISTRIBUTION --network NETWORK_ID
75-
```
74+
1. Create a VM on the same network:
7675

77-
**Example**`replicated vm create --distribution ubuntu --network accbd6a7`
76+
```bash
77+
replicated vm create --distribution DISTRIBUTION --network NETWORK_ID
78+
```
7879

79-
If successful, you'll see:
80+
For example, `replicated vm create --distribution ubuntu --network accbd6a7`.
8081

81-
```
82-
ID NAME DISTRIBUTION VERSION STATUS CREATED EXPIRES COST
83-
760a30b1 laughing_tu ubuntu 24.04 queued 2025-01-28 16:07 PST - $0.60
84-
```
82+
Example output:
83+
84+
```
85+
ID NAME DISTRIBUTION VERSION STATUS CREATED EXPIRES COST
86+
760a30b1 laughing_tu ubuntu 24.04 queued 2025-01-28 16:07 PST - $0.60
87+
```
88+
89+
In this example, both the cluster `b09cf035` and the VM `760a30b1` are now on the same tailnet.
8590

86-
**Example** – Both the cluster `b09cf035` and the VM `760a30b1` are now on the same tailnet.
91+
## Connect Compatibility Matrix VMs on a Shared Network
8792

88-
## Connect CMX VMs on a Shared Network
93+
### Create VMs on the Same Network
8994

9095
Use the `--count` flag to create multiple VMs with the same name, all running on the same Network ID.
9196

0 commit comments

Comments
 (0)