Skip to content
This repository was archived by the owner on Nov 19, 2024. It is now read-only.

Commit 3ac857d

Browse files
meker12sathiyaaaBarny Shergold
authored
Mae ssh enablement improvements (#8469)
* Updates based on review feedback - Replaced instructions for testing ssh connection with link to GitHub documentation - Editorial cleanup * Updates to ssh key enablement for Cloud projects (#8416) * Added an additional method regarding adding a SSH key (#8379) * Added an additional method regarding adding a SSH key * Apply suggestions from code review Co-authored-by: Barny Shergold <barny.shergold@vaimo.com> * Updates based on review feedback - Replaced test SSH connection through GitHub instructions with link to GitHub documentation - Editorial revision and clean up Co-authored-by: Sathiya Prakash <50226394+sathiyaaa@users.noreply.github.com> Co-authored-by: Barny Shergold <barny.shergold@vaimo.com> Co-authored-by: Sathiya Prakash <50226394+sathiyaaa@users.noreply.github.com> Co-authored-by: Barny Shergold <barny.shergold@vaimo.com>
1 parent 0e02640 commit 3ac857d

File tree

1 file changed

+22
-18
lines changed

1 file changed

+22
-18
lines changed

src/_includes/cloud/enable-ssh.md

Lines changed: 22 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -38,34 +38,23 @@ If the directory does not exist or has no SSH key files, you must generate at le
3838

3939
If you have at least one SSH key in your directory, add the key to your Magento and GitHub accounts:
4040

41-
- [Add an SSH key to your GitHub account](https://help.github.com/articles/adding-a-new-ssh-key-to-your-github-account/)
41+
- [Add an SSH key to your GitHub account](https://help.github.com/articles/adding-a-new-ssh-key-to-your-github-account/) and [test the SSH connection](https://docs.github.com/en/free-pro-team@latest/github/authenticating-to-github/testing-your-ssh-connection).
4242
- [Add your public SSH key to your Magento account](#ssh-add-to-account)
4343

44-
### Test the SSH keys {#test}
45-
46-
After adding the SSH keys, test the SSH connection to GitHub:
47-
48-
1. In the terminal, enter the following command:
49-
50-
```bash
51-
ssh -T git@github.com
52-
```
53-
54-
1. You may see a warning that the authenticity of the host can't be established followed by an RSA fingerprint. Enter `yes` to continue.
55-
56-
1. If successful, you should receive a success message. If you receive a permission denied error, see [Error: Permission denied (publickey)](https://help.github.com/articles/error-permission-denied-publickey) troubleshooting on GitHub.
57-
5844
## Add a public SSH key to your Magento account {#ssh-add-to-account}
5945

6046
You can add SSH keys to your account in any of the following ways:
6147

6248
- Using the [{{site.data.var.ece}} CLI](#add-key-cli)
6349
- Using the [{{site.data.var.ece}} Web Interface](#add-key-web)
50+
- Using the [{{site.data.var.ece}} Cloud account Dashboard](#add-key-cloud)
51+
52+
After you add a key, you must [redeploy active Cloud environments](#update-cloud-environments-with-a-new-ssh-key) to upload the key.
6453

6554
### Add your SSH key using the CLI {#add-key-cli}
6655

6756
{:.procedure}
68-
To add an SSH key using the CLI:
57+
To add an SSH key using the [Magento Cloud CLI]({{site.baseurl}}/cloud/reference/cli-ref-topic.html):
6958

7059
1. Open a terminal application on your local workstation.
7160

@@ -118,8 +107,23 @@ To add an SSH key using the Project Web interface:
118107

119108
- Follow the prompts on your screen to complete the task.
120109

121-
{:.bs-callout-tip}
122-
You can view and manage the SSH keys on your account in _Account settings_. In the upper right corner of the Project Web interface, click **your-user-name** > **Account Settings**.
110+
### Add a key from the Cloud Account dashboard {#add-key-cloud}
111+
112+
You can add your SSH public key directly from the Cloud _Account Settings_ page.
113+
114+
1. Open your [Cloud account page](https://accounts.magento.cloud) and log in if required.
115+
1. On the Cloud account dashboard, click the **Account Settings** tab.
116+
1. Under _SSH keys_, click **Add a public key**.
117+
118+
## Update Cloud environments with a new SSH key
119+
120+
After you add an SSH key, redeploy each active Cloud environment to upload the new key.
121+
122+
Use the [Magento Cloud CLI]({{site.baseurl}}/cloud/reference/cli-ref-topic.html) to redeploy the environment:
123+
124+
```bash
125+
magento-cloud redeploy --project <project-name> --host <host-name> --environment <environment-name>
126+
```
123127

124128
## Set global Git variables
125129

0 commit comments

Comments
 (0)