ironic/doc/source/contributor/bifrost-dev-guide.rst
Jay Faulkner 03b8f4dd11 Revamp Ironic dev-quickstart documentation
This is a significant improvement and update to Ironic contributor
documentation, as an attempt to make it easier for new Ironic
contributors to onboard.

It is not perfect, but it's significantly better than the existing
documentation.

What this change does:
- Improve dev-quickstart guide, make it easier to find
  devstack configurations.
- Removes information that can bit-rot over time and replaces with
  more generic information.
- Provides an actual working, tested, Ironic+Nova devstack conf

What hasn't been done:
- Testing of Ironic BFV or Multitenant networking devstack confs
- Validation that the local development method still works
- There is a ton more information about how to use these testing
  envs (both bifrost and devstack) which could be added.
- System prerequsities and Python prerequisites under the unit
  tests section has bitrotted considerably; they have not been
  significantly modified and will be fixed in a future commit.

Change-Id: I0cdfe50042fabb6b65633961fc418aff5d6ebfe3
2023-08-23 15:14:47 -07:00

844 B

Bifrost Development Environment Guide

Bifrost is a project that deploys and operates Ironic using ansible. It is generally used standalone, without many other services running alongside. This makes it a good choice for a quick development environment for Ironic features that may not interact with other OpenStack services, even if you aren't developing against bifrost directly

Bifrost maintains it's own documentation on building a test environment with bifrost.

The testenv provided is ideal for quickly testing API changes in Ironic or features for client libraries. It is not the best choice for changes that interact with one or more OpenStack services or which require tempest testing.