3faf13bbb4
Currently the index page contains a brief introduction and 3 links. Expand the table of contents to show more subheadings. Clean up the install, admin and contributing docs of unnecessary and wrong content and redundant headings. Update URLs throughout the text. Change-Id: I03279ffc9faf387b08f727dee3b8898a69918460
51 lines
1.7 KiB
ReStructuredText
51 lines
1.7 KiB
ReStructuredText
.. _admin_rescue:
|
|
|
|
===========
|
|
Rescue mode
|
|
===========
|
|
|
|
Overview
|
|
========
|
|
|
|
Rescue mode is a feature that can be used to boot a ramdisk for a tenant in
|
|
case the machine is otherwise inaccessible. For example, if there's a disk
|
|
failure that prevents access to another operating system, rescue mode can be
|
|
used to diagnose and fix the problem.
|
|
|
|
Support in ironic-python-agent images
|
|
=====================================
|
|
|
|
Rescue is initiated when ironic-conductor sends the ``finalize_rescue``
|
|
command to ironic-python-agent. A user `rescue` is created with a password
|
|
provided as an argument to this command. DHCP is then configured to
|
|
facilitate network connectivity, thus enabling a user to login to the machine
|
|
in rescue mode.
|
|
|
|
.. warning:: Rescue mode exposes the contents of the ramdisk to the tenant.
|
|
Ensure that any rescue image you build does not contain secrets
|
|
(e.g. sensitive clean steps, proprietary firmware blobs).
|
|
|
|
The below has information about supported images that may be built to use
|
|
rescue mode.
|
|
|
|
DIB
|
|
---
|
|
|
|
The DIB image supports rescue mode when used with DHCP tenant networks.
|
|
|
|
After the ``finalize_rescue`` command completes, DHCP will be configured on all
|
|
network interfaces, and a `rescue` user will be created with the specified
|
|
``rescue_password``.
|
|
|
|
TinyIPA
|
|
-------
|
|
|
|
The TinyIPA image supports rescue mode when used with DHCP tenant networks.
|
|
No special action is required to `build a TinyIPA image`_ with this support.
|
|
|
|
After the ``finalize_rescue`` command completes, DHCP will be configured on all
|
|
network interfaces, and a `rescue` user will be created with the specified
|
|
``rescue_password``.
|
|
|
|
.. _build a TinyIPA image: https://docs.openstack.org/ironic-python-agent-builder/latest/admin/tinyipa.html
|