openstack/ironic-python-agent
Code Issues Proposed changes

update dynamic-login to mention the sshkey option

Browse Source 
The docs mentioned using the SSH key option but didn't say what it was.
Added it and reflowed the section to make it more clear that the options
are one or the other and the steps that need to happen.

Change-Id: I8663379d51e5e946915cb9236ccbccb26660bcc4
This commit is contained in:
Doug Goldstein 2024-07-31 12:20:47 -05:00
parent b2ec08a15e
commit 4cea26f185
1 changed files with 4 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
doc/source/admin/troubleshooting.rst
View File

@ -69,8 +69,8 @@ ironic-python-agent-builder: dynamic-login
Users wishing to use password access can be add the dynamic-login [0]_ or the
devuser element [1]_
The dynamic-login element allows the operator to change the root password
dynamically when the image boots. Kernel command line parameters
The dynamic-login element allows the operator to change the root password or
SSH key dynamically when the image boots. Kernel command line parameters
are used to do this.
Generate a password hash with following command:
@ -79,7 +79,8 @@ Generate a password hash with following command:
$ openssl passwd -1 -stdin | sed 's/\$/\$\$/g'
Add ``rootpwd="<openssl output>"`` value on the ``kernel_append_params``
Add ``rootpwd="<openssl output>"`` value or add ``sshkey="<ssh public key>"``
on the ``kernel_append_params``
setting in the Ironic configuration file (``/etc/ironic/ironic.conf``).
Restart the ironic-conductor e.g. with
@ -87,8 +88,6 @@ Restart the ironic-conductor e.g. with
$ sudo systemctl restart ironic-conductor
Alternatively, you can use the contents of the SSH public key.
.. warning::
* The ``sed`` command is used to escape the ``$`` symbols in the