[DOC] Add instruction for ssh key generation

[doc.git] / docs / guides / onap-developer / how-to-use-docs / setting-up-environment.rst

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 6213afc..e7d0a2f 100644 (file)
--- 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.