Skip to content
This repository was archived by the owner on Jan 5, 2023. It is now read-only.

Commit 2ac8601

Browse files
Neha Alhatravipwaghmare
Neha Alhat
authored andcommitted
Updated readme.md
1 parent 36521e1 commit 2ac8601

File tree

1 file changed

+9
-10
lines changed

1 file changed

+9
-10
lines changed

README.md

+9-10
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,20 @@
11
# Hardware classification controller
22

3-
Controller for matching expected hardware characteristics to BareMetalHost's
4-
hardware details.
3+
Hardware Classification Controller (HWCC) goal is to identify right matched
4+
host for user provided hardware configurations.
55

6-
The HWCC (Hardware Classification Controller) implements Kubernetes API for
7-
labeling the matching hosts. Implemented `hardware-classification` CRD expects
8-
profile having hardware configurations for CPU, RAM, Disk and NIC.
9-
10-
Comparision and validation is done on list of baremetalhosts in ready state
11-
provided by `BMO` against hardware configuration mentioned in
12-
metal3.io_v1alpha1_hardwareclassification.yaml.
6+
User provides workload profile which has set of hardware configuration
7+
parameters (CPU, RAM, DISK and NIC). HWCC fetches the hosts from BMO.
8+
It then filters the ready state hosts and compares those with the expected
9+
configurations provided by user in profile. The hosts matched to any of the
10+
configurations are then labelled accordingly.
1311

1412
More capabilities are being added regularly. See open issues and pull
1513
requests for more information on work in progress.
1614

1715
For more information about Metal³, the Hardware Classification, and other
18-
related components, see the [Metal³ docs](https://github.com/metal3-io/metal3-docs) and
16+
related components, see the
17+
[Metal³ docs](https://github.com/metal3-io/metal3-docs)and
1918
[Kubebuilder Book](https://book.kubebuilder.io/quick-start.html#create-a-project).
2019

2120
## Resources

0 commit comments

Comments
 (0)