You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/vendor/testing-vm-create.md
+24-22Lines changed: 24 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,16 +4,16 @@ This topic describes how to use Replicated Compatibility Matrix to create and ma
4
4
5
5
## Set Up SSH Access
6
6
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.
8
8
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.
10
12
11
13
:::note
12
14
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**.
13
15
:::
14
16
15
-
### Use Your GitHub Account
16
-
17
17
To set up and verify SSH access for Compatibility Matrix VMs using your personal GitHub account:
18
18
19
19
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
34
34
35
35
1. On the **Account Settings > Account Information** page, for **GitHub username**, add your GitHub username.
36
36
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
To set up and verify SSH access for Compatibility Matrix VMs using a personal public/private key pair:
40
54
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.
42
56
43
57
1. Log in to the Vendor Portal and go to [**Compatibility Matrix Settings**](https://vendor.replicated.com/compatibility-matrix/settings).
44
58
45
59
1. On the **Compatibility Matrix Settings > SSH Public Keys** page, upload your public key.
46
60
47
-
### Test your SSH setup is working
61
+
### Test Your SSH Access
62
+
63
+
To test that you SSH access is working:
48
64
49
65
1. On the command line, authenticate with the Replicated CLI using your Vendor Portal account:
50
66
@@ -70,20 +86,6 @@ To set up and verify SSH access for Compatibility Matrix VMs using a personal pu
70
86
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.
71
87
:::
72
88
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
0 commit comments