Skip to content

Commit e14f360

Browse files
committed
edits
1 parent f7a7745 commit e14f360

File tree

1 file changed

+55
-35
lines changed

1 file changed

+55
-35
lines changed

docs/vendor/testing-vm-create.md

Lines changed: 55 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,10 @@ 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 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.
88

99
### Use Your GitHub Account
1010

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-
1511
:::note
1612
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**.
1713
:::
@@ -36,21 +32,31 @@ To set up and verify SSH access for Compatibility Matrix VMs using your personal
3632
3733
1. On the **Account Settings > Account Information** page, for **GitHub username**, add your GitHub username.
3834
39-
### Use a GitHub Service Account {#github-service-account}
35+
1. Verify that SSH access was set up successfully:
4036
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:
4238
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+
:::
4445
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:
4847
49-
Using multiple SSH public keys:
48+
```bash
49+
50+
```
51+
If successful, you will see a message similar to the following:
5052
51-
```bash
52-
replicated vm create --distribution ubuntu --version 24.04 --ssh-public-key ~/.ssh/id_rsa.pub --ssh-public-key ~/.ssh/id_ed25519.pub
53-
```
53+
```
54+
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+
:::
5460
5561
### Use a Personal Public/Private Key
5662
@@ -62,33 +68,47 @@ To set up and verify SSH access for Compatibility Matrix VMs using a personal pu
6268
6369
1. On the **Compatibility Matrix Settings > SSH Public Keys** page, upload your public key.
6470
65-
### Test Your SSH Access
71+
1. Verify that SSH access was set up successfully:
6672
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:
6874
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+
:::
7081
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:
7783
78-
1. Run the following command to verify that your SSH setup is working:
84+
```bash
85+
86+
```
87+
If successful, you will see a message similar to the following:
7988
80-
```bash
81-
82-
```
83-
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+
```
8492
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}
8898
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
105+
```
106+
107+
Or, to use multiple SSH public keys:
108+
109+
```bash
110+
replicated vm create --distribution ubuntu --version 24.04 --ssh-public-key ~/.ssh/id_rsa.pub --ssh-public-key ~/.ssh/id_ed25519.pub
111+
```
92112
93113
## Create VMs
94114

0 commit comments

Comments
 (0)