openstack/bifrost
Code Issues Proposed changes

Revise the testing environment documentation

Browse Source 
* Stop mentioning the removed agent_ssh driver
* The CSV format is deprecated and no longer used
* Provide correct links instead of "above" (which is no longer above).

Change-Id: I0b93c0e0b348f8bfa18f3a17941cbd7c8771da87
This commit is contained in:
Dmitry Tantsur 2020-01-30 11:42:44 +01:00
parent c6613585ee
commit 6d90609f6c
2 changed files with 17 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
doc/source/contributor/testenv.rst
View File

@ -39,13 +39,8 @@ Manually test with Virtual Machines
Bifrost supports using virtual machines to emulate the hardware. Bifrost supports using virtual machines to emulate the hardware.
It is assumed you have an SSH server running on the host machine. The The VirtualBMC_ project is used as an IPMI proxy, so that the same ``ipmi``
``agent_ssh`` driver, used by ironic with VM testing, will need to use hardware type can be used as for real hardware.
SSH to control the virtual machines.
An SSH key is generated for the ``ironic`` user when testing. The
ironic conductor will use this key to connect to the host machine and
run virsh commands.
#. Set ``testing`` to *true* in the #. Set ``testing`` to *true* in the
``playbooks/inventory/group_vars/target`` file. ``playbooks/inventory/group_vars/target`` file.
@ -57,7 +52,10 @@ run virsh commands.
adding ``-e testing=true`` to the Ansible command line. adding ``-e testing=true`` to the Ansible command line.
#. Set the environment variable of ``BIFROST_INVENTORY_SOURCE`` to the #. Set the environment variable of ``BIFROST_INVENTORY_SOURCE`` to the
path to the JSON file, which by default has been written to path to the JSON file, which by default has been written to
/tmp/baremetal.json. ``/tmp/baremetal.json``.
#. Run the enrollment step, as documented above, using the CSV file #. Run the :ref:`enrollment step <enroll>`, using the JSON file you created
you created in the previous step. in the previous step.
#. Run the deployment step, as documented above. #. Run the deployment step, as documented in :ref:`deploy`.
.. _VirtualBMC: https://docs.openstack.org/virtualbmc/

14
doc/source/user/howto.rst
View File

@ -107,11 +107,9 @@ Example::
"uuid": "00000000-0000-0000-0000-000000000001", "uuid": "00000000-0000-0000-0000-000000000001",
"driver_info": { "driver_info": {
"power": { "power": {
"ssh_port": 22, "ipmi_address": "192.168.122.1",
"ssh_username": "ironic", "ipmi_username": "admin",
"ssh_virt_type": "virsh", "ipmi_password": "pa$$w0rd"
"ssh_address": "192.168.122.1",
"ssh_key_filename": "/home/ironic/.ssh/id_rsa"
} }
}, },
"nics": [ "nics": [
@ -119,7 +117,7 @@ Example::
"mac": "52:54:00:f9:32:f6" "mac": "52:54:00:f9:32:f6"
} }
], ],
"driver": "agent_ssh", "driver": "ipmi",
"ansible_ssh_host": "192.168.122.2", "ansible_ssh_host": "192.168.122.2",
"ipv4_address": "192.168.122.2", "ipv4_address": "192.168.122.2",
"provisioning_ipv4_address": "10.0.0.9", "provisioning_ipv4_address": "10.0.0.9",
@ -176,6 +174,8 @@ list, as well as reference the specific field items.
An example file can be found at: ``playbooks/inventory/baremetal.csv.example`` An example file can be found at: ``playbooks/inventory/baremetal.csv.example``
.. _enroll:
How this works? How this works?
--------------- ---------------
@ -205,6 +205,8 @@ manually at the moment.
Additionally, it is important to note that the playbooks for enrollment are Additionally, it is important to note that the playbooks for enrollment are
split into three separate playbooks based on the ``ipmi_bridging`` setting. split into three separate playbooks based on the ``ipmi_bridging`` setting.
.. _deploy:
Deploy Hardware Deploy Hardware
=============== ===============