README
¶
Bare Metal Operator
The Bare Metal Operator implements a Kubernetes API for managing bare metal
hosts. It maintains an inventory of available hosts as instances of the
BareMetalHost Custom Resource Definition. The Bare Metal Operator knows how
to:
- Inspect the host’s hardware details and report them on the corresponding
BareMetalHost. This includes information about CPUs, RAM, disks, NICs, and more. - Provision hosts with a desired image.
- Clean a host’s disk contents before or after provisioning.
More capabilities are being added regularly. See open issues and pull requests for more information on work in progress.
For more information about Metal³, the Bare Metal Operator, and other related components, see the Metal³ docs.
Resources
Integration tests
Currently a PR in BMO is tested with CAPM3 integration tests. There are two types of CAPM3 integration test, CAPM3 e2e integration tests and ansible integration tests. You will see one of each kind as a required test on a BMO PR. Eventually these tests will be replaced with BMO's own e2e tests. BMO e2e tests are currently under active development. Here are the tests which run on different branches in BMO:
E2E tests:
- /test metal3-bmo-e2e-test-pull runs required BMO e2e tests on your PR.
- /test metal3-bmo-e2e-test-optional-pull runs optional BMO e2e tests on your PR. These are under active development currently.
For more details on the e2e tests, see test/e2e/README.md.
Main branch:
- /test metal3-centos-e2e-integration-test-main runs CAPM3 e2e integration tests with CAPM3 main branch and BMO main branch on Centos
- /test metal3-ubuntu-e2e-integration-test-main runs ansible integration tests with CAPM3 main branch and BMO main branch on Ubuntu
Release-0.10 branch:
- /test metal3-centos-e2e-integration-test-release-1-10 runs CAPM3 e2e integration tests with CAPM3 release-1.10 branch and BMO release-0.10 branch on Centos
- /test metal3-ubuntu-e2e-integration-test-release-1-10 runs ansible integration tests with CAPM3 release-1.10 branch and BMO release-0.10 branch on Ubuntu
Release-0.9 branch:
- /test metal3-centos-e2e-integration-test-release-1-9 runs CAPM3 e2e integration tests with CAPM3 release-1.9 branch and BMO release-0.9 branch on Centos
- /test metal3-ubuntu-e2e-integration-test-release-1-9 runs ansible integration tests with CAPM3 release-1.9 branch and BMO release-0.9 branch on Ubuntu
Release-0.8 branch:
- /test metal3-centos-e2e-integration-test-release-1-8 runs CAPM3 e2e integration tests with CAPM3 release-1.8 branch and BMO release-0.8 branch on Centos
- /test metal3-ubuntu-e2e-integration-test-release-1-8 runs ansible integration tests with CAPM3 release-1.8 branch and BMO release-0.8 branch on Ubuntu
Important Notes
Whenever there is a change in config/ directory, please remember to run the
following command:
make manifests
This will render the config/render/capm3.yaml. Please do not change the
content of config/render/capm3.yaml manually.
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
apis
module
|
|
|
cmd
|
|
|
get-hardware-details
command
get-hardware-details is a tool that can be used to convert raw Ironic introspection data into the HardwareDetails type used by Metal3.
|
get-hardware-details is a tool that can be used to convert raw Ironic introspection data into the HardwareDetails type used by Metal3. |
|
make-bm-worker
command
|
|
|
make-virt-host
command
|
|
|
internal
|
|
|
webhooks/rackn.io/v1alpha1
Package webhooks contains external webhook implementations for some of our API types.
|
Package webhooks contains external webhook implementations for some of our API types. |
|
pkg
|
|
|
version
Package version includes the version information.
|
Package version includes the version information. |
|
hardwareutils
module
|