Skip to content

Commit 03b6356

Browse files
authored
docs edits
1 parent 431038b commit 03b6356

File tree

1 file changed

+24
-22
lines changed

1 file changed

+24
-22
lines changed

docs/vendor/testing-vm-create.md

Lines changed: 24 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,16 @@ This topic describes how to use Replicated Compatibility Matrix to create and ma
44

55
## Set Up SSH Access
66

7-
In order to access VMs that you create with Compatibility Matrix, you need to set up SSH access. You can do this using your personal GitHub account or a GitHub service account used by your team.
7+
In order to access VMs that you create with Compatibility Matrix, you need to set up SSH access. You can do this using a GitHub account or a personal public/private key.
88

9-
For setting up SSH access to VMs that you create on your local machine, Replicated recommends that you use your personal GitHub account. For setting up SSH access for VMs created in CI/CD workflows used by your team, use a GitHub service account. For more information, see the sections below.
9+
### Use Your GitHub Account
10+
11+
You can set up SSH access using your personal GitHub account or a GitHub service account used by your team. For setting up SSH access to VMs that you create on your local machine, Replicated recommends that you use your personal GitHub account. For setting up SSH access for VMs created in CI/CD workflows used by your team, use a GitHub service account.
1012

1113
:::note
1214
Your GitHub usernames and SSH keys are synced to a VM when it is first created. If you update your GitHub username or keys after creating a VM, you can manually sync by updating your [Account Settings](https://vendor.replicated.com/account-settings) in the Vendor Portal and clicking **Save**.
1315
:::
1416

15-
### Use Your GitHub Account
16-
1717
To set up and verify SSH access for Compatibility Matrix VMs using your personal GitHub account:
1818

1919
1. Log in to your GitHub account and add an SSH key if you do not have one already. For information about how to generate and add a new SSH key, see [Generate a new SSH key](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent#generati[…]w-ssh-key) and [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.
@@ -34,17 +34,33 @@ To set up and verify SSH access for Compatibility Matrix VMs using your personal
3434
3535
1. On the **Account Settings > Account Information** page, for **GitHub username**, add your GitHub username.
3636
37-
### Use a personal public/private key
37+
### Use a GitHub Service Account
38+
39+
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:
40+
41+
```bash
42+
replicated vm create --distribution ubuntu --version 24.04 --ssh-public-key ~/.ssh/id_rsa.pub
43+
```
44+
45+
Using multiple SSH public keys:
46+
47+
```bash
48+
replicated vm create --distribution ubuntu --version 24.04 --ssh-public-key ~/.ssh/id_rsa.pub --ssh-public-key ~/.ssh/id_ed25519.pub
49+
```
50+
51+
### Use a Personal Public/Private Key
3852
3953
To set up and verify SSH access for Compatibility Matrix VMs using a personal public/private key pair:
4054
41-
1. Make sure you have a public and private key, or generate a new public/private key pair.
55+
1. If you do not already have a public and private key, generate a new public/private key pair.
4256
4357
1. Log in to the Vendor Portal and go to [**Compatibility Matrix Settings**](https://vendor.replicated.com/compatibility-matrix/settings).
4458
4559
1. On the **Compatibility Matrix Settings > SSH Public Keys** page, upload your public key.
4660
47-
### Test your SSH setup is working
61+
### Test Your SSH Access
62+
63+
To test that you SSH access is working:
4864
4965
1. On the command line, authenticate with the Replicated CLI using your Vendor Portal account:
5066
@@ -70,20 +86,6 @@ To set up and verify SSH access for Compatibility Matrix VMs using a personal pu
7086
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.
7187
:::
7288
73-
### Use a Service Account
74-
75-
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:
76-
77-
```bash
78-
replicated vm create --distribution ubuntu --version 24.04 --ssh-public-key ~/.ssh/id_rsa.pub
79-
```
80-
81-
Using multiple SSH public keys:
82-
83-
```bash
84-
replicated vm create --distribution ubuntu --version 24.04 --ssh-public-key ~/.ssh/id_rsa.pub --ssh-public-key ~/.ssh/id_ed25519.pub
85-
```
86-
8789
## Create VMs
8890
8991
### With the Replicated CLI
@@ -303,4 +305,4 @@ To set the network policy of a VM to `airgap`:
303305
```bash
304306
replicated network update NETWORK_ID --policy airgap
305307
```
306-
Where `NETWORK_ID` is the ID of the network from the output of the `vm ls` command.
308+
Where `NETWORK_ID` is the ID of the network from the output of the `vm ls` command.

0 commit comments

Comments
 (0)