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
+55-35Lines changed: 55 additions & 35 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,14 +4,10 @@ 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 a GitHub account or a personal public/private key.
7
+
To access VMs that you create with Compatibility Matrix, you need to set up SSH access. You can do this using your GitHub account, a personal public/private key, or a service account or bot with shared access.
8
8
9
9
### Use Your GitHub Account
10
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.
12
-
13
-
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 [Use a GitHub Service Account](#github-service-account) below.
14
-
15
11
:::note
16
12
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**.
17
13
:::
@@ -36,21 +32,31 @@ To set up and verify SSH access for Compatibility Matrix VMs using your personal
36
32
37
33
1. On the **Account Settings > Account Information** page, for **GitHub username**, add your GitHub username.
38
34
39
-
### Use a GitHub Service Account {#github-service-account}
35
+
1. Verify that SSH access was set up successfully:
40
36
41
-
Use a GitHub service account if you are setting up SSH access for VMs created in CI/CD workflows used by your team.
37
+
1. On the command line, authenticate with the Replicated CLI using your Vendor Portal account:
42
38
43
-
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:
39
+
```bash
40
+
replicated login
41
+
```
42
+
:::note
43
+
To log out of an existing session, first run `replicated logout`.
44
+
:::
44
45
45
-
```bash
46
-
replicated vm create --distribution ubuntu --version 24.04 --ssh-public-key ~/.ssh/id_rsa.pub
47
-
```
46
+
1. Run the following command to verify that your SSH setup is working:
Hi <username>! You have successfully authenticated, use [VM_ID]@replicatedvm.com to access your VM.
55
+
```
56
+
57
+
:::note
58
+
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.
59
+
:::
54
60
55
61
### Use a Personal Public/Private Key
56
62
@@ -62,33 +68,47 @@ To set up and verify SSH access for Compatibility Matrix VMs using a personal pu
62
68
63
69
1. On the **Compatibility Matrix Settings > SSH Public Keys** page, upload your public key.
64
70
65
-
### Test Your SSH Access
71
+
1. Verify that SSH access was set up successfully:
66
72
67
-
To test that you SSH access is working:
73
+
1. On the command line, authenticate with the Replicated CLI using your Vendor Portal account:
68
74
69
-
1. On the command line, authenticate with the Replicated CLI using your Vendor Portal account:
75
+
```bash
76
+
replicated login
77
+
```
78
+
:::note
79
+
To log out of an existing session, first run `replicated logout`.
80
+
:::
70
81
71
-
```bash
72
-
replicated login
73
-
```
74
-
:::note
75
-
To log out of an existing session, first run `replicated logout`.
76
-
:::
82
+
1. Run the following command to verify that your SSH setup is working:
77
83
78
-
1. Run the following command to verify that your SSH setup is working:
If successful, you will see a message similar to the following:
89
+
```
90
+
Hi <username>! You have successfully authenticated, use [VM_ID]@replicatedvm.com to access your VM.
91
+
```
84
92
85
-
```
86
-
Hi <username>! You have successfully authenticated, use [VM_ID]@replicatedvm.com to access your VM.
87
-
```
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
+
97
+
### Use a Service Account {#github-service-account}
88
98
89
-
:::note
90
-
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.
91
-
:::
99
+
If you are setting up SSH access for VMs created in CI/CD workflows used by your team, you can use the SSH key of a service account or bot with shared access.
100
+
101
+
To automate the creation of VMs in your CI/CD workflows, use the flag `--ssh-public-key` to provide the SSH public key. For example:
102
+
103
+
```bash
104
+
replicated vm create --distribution ubuntu --version 24.04 --ssh-public-key ~/.ssh/id_rsa.pub
0 commit comments