opendev/infra-manual
Code Issues Proposed changes

Document Gerrit service SSH host key fingerprints

Browse Source 
At some point, the Gerrit WebUI ceased displaying SSH host key
details, so go ahead and bake them into our Developer's Guide and
cross-link to them from the appropriate part of the Getting Started
chapter too.

While we're here, add a link from Getting Started to the Developer's
Guide section on the OpenStack ICLA, as users following these
instructions may see errors about that when trying to set up to
contribute to a repository which enforces it.

Change-Id: I9ea5cc9952a0fd4a2bd45fd0ba3e97f8acc7b920
This commit is contained in:
Jeremy Stanley 2023-09-13 15:18:16 +00:00
parent e40ff9d3c5
commit 08eea5856c
2 changed files with 21 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
doc/source/developers.rst
View File

@ -45,6 +45,8 @@ For further information about the use of IRC in OpenStack, see
Extra Gerrit account setup steps
--------------------------------
.. _openstack-individual-contributor-license-agreement:
OpenStack Individual Contributor License Agreement
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -53,6 +55,20 @@ Individual Contributor License Agreement, see `these detailed
instructions
<https://docs.openstack.org/contributors/common/setup-gerrit.html#individual-contributor-license-agreement>`_.
.. _gerrit-ssh-host-keys:
Gerrit SSH Host Keys
^^^^^^^^^^^^^^^^^^^^
Careful users may wish to verify the SSH Host key fingerprints for the
Gerrit service the first time they connect from a new system. Depending on
which key types your client is configured to negotiate, you may see some or
all of these listed::
256 SHA256:/aPoKpg+804wdezs21L9djZ4bOsLudpGF7m7779XVuQ [review.opendev.org]:29418 (ECDSA)
2048 SHA256:RXNl/GKyDaKiIQ93BoDvrNSKUPFvA1PNeAO9QiirYZU [review.opendev.org]:29418 (RSA)
256 SHA256:lHsyuBxtcAiZeJM+viHllq52he9JNPqg8FFKv5+/BJ8 [review.opendev.org]:29418 (ED25519)
Accessing Gerrit over HTTPS
^^^^^^^^^^^^^^^^^^^^^^^^^^^

5
doc/source/gettingstarted.rst
View File

@ -113,6 +113,11 @@ Then ask git-review to configure your repository to know about Gerrit::
git review -s
Feel free to check any unknown host key fingerprints against the
:ref:`gerrit-ssh-host-keys`, and if you get an error about a missing
contributor license agreement, see the Developer's Guide section on the
:ref:`openstack-individual-contributor-license-agreement`.
Create a change in a topic branch
---------------------------------