Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/metal3-io/baremetal-operator

Bare metal host provisioning integration for Kubernetes
https://github.com/metal3-io/baremetal-operator

Last synced: 5 days ago
JSON representation

Bare metal host provisioning integration for Kubernetes

Awesome Lists containing this project

README 

        
# Bare Metal Operator



[![CLOMonitor](https://img.shields.io/endpoint?url=https://clomonitor.io/api/projects/cncf/metal3-io/badge)](https://clomonitor.io/projects/cncf/metal3-io)

[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/9160/badge)](https://www.bestpractices.dev/projects/9160)

[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/metal3-io/baremetal-operator/badge)](https://securityscorecards.dev/viewer/?uri=github.com/metal3-io/baremetal-operator)

[![Ubuntu daily main build status](https://jenkins.nordix.org/buildStatus/icon?job=metal3-periodic-ubuntu-e2e-integration-test-main&subject=Ubuntu%20daily%20main)](https://jenkins.nordix.org/view/Metal3/job/metal3-periodic-ubuntu-e2e-integration-test-main/)

[![CentOS daily main build status](https://jenkins.nordix.org/buildStatus/icon?job=metal3-periodic-centos-e2e-integration-test-main&subject=CentOS%20daily%20main)](https://jenkins.nordix.org/view/Metal3/job/metal3-periodic-centos-e2e-integration-test-main/)

[![Periodic E2E Test](https://github.com/metal3-io/baremetal-operator/actions/workflows/e2e-test-periodic-main.yml/badge.svg)](https://github.com/metal3-io/baremetal-operator/actions/workflows/e2e-test-periodic-main.yml)

[![Periodic E2E Test Optional](https://github.com/metal3-io/baremetal-operator/actions/workflows/e2e-test-optional-periodic.yml/badge.svg)](https://github.com/metal3-io/baremetal-operator/actions/workflows/e2e-test-optional-periodic.yml)



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](https://github.com/metal3-io/metal3-docs).



## Resources



- [API documentation](docs/api.md)

- [Setup Development Environment](docs/dev-setup.md)

- [Configuration](docs/configuration.md)

- [Testing](docs/testing.md)

- [Publishing Images](docs/publishing-images.md)



## 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](test/e2e/README.md). 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](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.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



**Release-0.6 branch:**



- **/test metal3-centos-e2e-integration-test-release-1-7** runs CAPM3 e2e

  integration tests with CAPM3 release-1.7 branch and BMO **release-0.6**

  branch on Centos

- **/test metal3-ubuntu-e2e-integration-test-release-1-7** runs ansible

  integration tests with CAPM3 release-1.7 branch and BMO **release-0.6**

  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.