diskimage-builder/diskimage_builder/elements/dynamic-login/README.rst
Pavlo Shchelokovskyy 62626521ad Fix openssl example command in dynamic-login
the command had one error in it (missing one backslash)
and was rendered wrong, w/o any backslashes at all.

Change-Id: If187f645b818f47d10b602ccee12c29892a8d88d
2022-05-24 14:10:01 +03:00

48 lines
2.0 KiB
ReStructuredText

=============
dynamic-login
=============
This element insert a helper script in the image that allows users to
dynamically configure credentials at boot time. This is specially useful
for troubleshooting.
Troubleshooting an image can be quite hard, specially if you can not get
a prompt you can enter commands to find out what went wrong. By default,
the images (specially ramdisks) doesn't have any SSH key or password for
any user. Of course one could use the ``devuser`` element to generate
an image with SSH keys and user/password in the image but that would be
a massive security hole and very it's discouraged to run in production
with a ramdisk like that.
This element allows the operator to inject a SSH key and/or change the
root password dynamically when the image boots. Two kernel command line
parameters are used to do it:
sshkey
:Description: If the operator append sshkey="$PUBLIC_SSH_KEY" to the
kernel command line on boot, the helper script will append
this key to the root user authorized_keys.
rootpwd
:Description: If the operator append rootpwd="$ENCRYPTED_PASSWORD" to the
kernel command line on boot, the helper script will set the
root password to the one specified by this option. Note that
this password must be **encrypted**. Interpolation can be
avoided by using $$. Encrypted passwords can be generated
using the ``openssl`` command, e.g: ``openssl passwd -1
-stdin <<< YOUR_PASSWORD | sed 's/\$/\$\$/g'``.
.. note::
The value of these parameters must be **quoted**, e.g: sshkey="ssh-rsa
BBBA1NBzaC1yc2E ..."
.. warning::
Some base operational systems might require selinux to be in
**permissive** or **disabled** mode so that you can log in
the image. This can be achieved by building the image with the
``selinux-permissive`` element for diskimage-builder or by passing
``selinux=0`` in the kernel command line. RHEL/CentOS are examples
of OSs which this is true.