summaryrefslogtreecommitdiffstats
path: root/docs/guides
diff options
context:
space:
mode:
authorEric Debeau <eric.debeau@orange.com>2022-05-19 13:10:43 +0000
committerGerrit Code Review <gerrit@onap.org>2022-05-19 13:10:43 +0000
commit13cee45442f2ff45810d5e733a3160e5399813dd (patch)
treec752733d406df3ed6e2386ea5381eb09c9d864f1 /docs/guides
parent54909f22c151a8d848d9c53b7843066bf591bb38 (diff)
parent2055c0e93761c2b797c0fceb057c62cb116a5c27 (diff)
Merge "[DOC] Add instruction for ssh key generation"
Diffstat (limited to 'docs/guides')
-rw-r--r--docs/guides/onap-developer/how-to-use-docs/setting-up-environment.rst22
1 files changed, 19 insertions, 3 deletions
diff --git a/docs/guides/onap-developer/how-to-use-docs/setting-up-environment.rst b/docs/guides/onap-developer/how-to-use-docs/setting-up-environment.rst
index 6213afc24..e7d0a2f22 100644
--- a/docs/guides/onap-developer/how-to-use-docs/setting-up-environment.rst
+++ b/docs/guides/onap-developer/how-to-use-docs/setting-up-environment.rst
@@ -79,11 +79,27 @@ Setting SSH keys
1. Generate SSH keys.
-.. code-block:: bash
+ For OpenSSH 8.7 or older versions:
+
+ .. code-block:: bash
+
+ ssh-keygen -t rsa
+
+ For OpenSSH 8.8 or later versions, either use ed25519 or ECDSA algorithm to generate ssh keys:
+
+ .. code-block:: bash
+
+ ssh-keygen -t ed25519
+
+ or
+
+ .. code-block:: bash
+
+ ssh-keygen -t ECDSA
- ssh-keygen -t rsa
+ .. note:: OpenSSH 8.8+ disables RSA signatures using the SHA-1 hash algorithm by default, which may cause authentication problem when pull/push code. You can either specify the encrypt algorithm or re-enable the RSA/SHA1 in ~/.ssh/config file to solve the issue. For more information, please refer to `OpenSSH Release Notes <https://www.openssh.com/releasenotes.html>`_.
-Your public key is now available as .ssh/id_rsa.pub in your home folder.
+ Your public key is now available as .ssh/id_rsa.pub or .ssh/id_ed25519.pub or .ssh/id_ecdsa.pub under .ssh folder.
2. Print the generated key to the terminal and copy it.