openstack/kayobe
Code Issues Proposed changes

docs: Reword bare metal registration section

Browse Source 
A few long sentences are split up. YAML indentation is fixed.

Change-Id: I60098522e08f0d463d0300beac64476f7b1488e6
This commit is contained in:
Pierre Riteau 2024-05-30 14:39:34 +02:00
parent d42523cabb
commit 039fa30cef
1 changed files with 37 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

71
doc/source/administration/bare-metal.rst
View File

@ -16,58 +16,61 @@ node. This behavior can be changed by overriding the variable
Register Register
-------- --------
This is an experimental workflow and acts as an alternative to enrolling nodes This is an experimental workflow which acts as an alternative to enrolling
through inspection where nodes can be registered in Ironic via kayobe given these nodes through inspection. Bare metal compute nodes can be registered in Ironic
nodes are defined in the Kayobe inventory, an example hosts file for group r1 is below: via Kayobe if defined in the Kayobe inventory. An example hosts file for group
r1 is below:
.. code-block:: ini .. code-block:: ini
[r1] [r1]
hv100 ipmi_address=1.2.3.4 hv100 ipmi_address=1.2.3.4
... ...
[baremetal-compute:children] [baremetal-compute:children]
r1 r1
You should also define a group_vars file for this group containing the Ironic You should also define a ``group_vars`` file for this group containing the
vars, this could be in ``etc/kayobe/inventory/group_vars/r1/ironic_vars`` or Ironic variables, this could be in
in the environment you are using. ``etc/kayobe/inventory/group_vars/r1/ironic_vars`` or in the environment you
are using.
.. code-block:: yaml .. code-block:: yaml
ironic_driver: redfish ironic_driver: redfish
ironic_driver_info: ironic_driver_info:
redfish_system_id: "{{ ironic_redfish_system_id }}" redfish_system_id: "{{ ironic_redfish_system_id }}"
redfish_address: "{{ ironic_redfish_address }}" redfish_address: "{{ ironic_redfish_address }}"
redfish_username: "{{ ironic_redfish_username }}" redfish_username: "{{ ironic_redfish_username }}"
redfish_password: "{{ ironic_redfish_password }}" redfish_password: "{{ ironic_redfish_password }}"
redfish_verify_ca: "{{ ironic_redfish_verify_ca }}" redfish_verify_ca: "{{ ironic_redfish_verify_ca }}"
ipmi_address: "{{ ipmi_address }}" ipmi_address: "{{ ipmi_address }}"
ironic_properties: ironic_properties:
capabilities: "{{ ironic_capabilities }}" capabilities: "{{ ironic_capabilities }}"
ironic_resource_class: "example_resouce_class" ironic_resource_class: "example_resource_class"
ironic_redfish_system_id: "/redfish/v1/Systems/System.Embedded.1" ironic_redfish_system_id: "/redfish/v1/Systems/System.Embedded.1"
ironic_redfish_verify_ca: "{{ inspector_rule_var_redfish_verify_ca }}" ironic_redfish_verify_ca: "{{ inspector_rule_var_redfish_verify_ca }}"
ironic_redfish_address: "{{ ipmi_address }}" ironic_redfish_address: "{{ ipmi_address }}"
ironic_redfish_username: "{{ inspector_redfish_username }}" ironic_redfish_username: "{{ inspector_redfish_username }}"
ironic_redfish_password: "{{ inspector_redfish_password }}" ironic_redfish_password: "{{ inspector_redfish_password }}"
ironic_capabilities: "boot_option:local,boot_mode:uefi" ironic_capabilities: "boot_option:local,boot_mode:uefi"
It's essential that the Ironic username and password match the BMC username It is essential that the Ironic username and password match the BMC username
and password for your nodes, if the username and password combination is and password for your nodes. If the username and password combination is not
not the same for the entire group you will need to adjust your configuration the same for the entire group you will need to adjust your configuration
accordingly. The IPMI address should also match the BMC address for your node. accordingly. The IPMI address should also match the BMC address for your node.
Once this has been completed you can begin enrolling the Ironic nodes:: Once this has been completed you can begin enrolling the Ironic nodes::
(kayobe) $ kayobe baremetal compute register (kayobe) $ kayobe baremetal compute register
Inspector is not used to discover nodes and no node inspection will take place on Inspector is not used to discover nodes and no node inspection will take place
enrollment, nodes will automatically be placed into ``manageable`` state. To inspect, on enrollment, nodes will automatically be placed into ``manageable`` state. To
you should use ``kayobe baremetal compute inspect`` following enrollment. inspect, you should use ``kayobe baremetal compute inspect`` following
enrollment.
Manage Manage
------ ------