diff --git a/manifests/function/hwcc/README.md b/manifests/function/hwcc/README.md new file mode 100644 index 000000000..e690034e8 --- /dev/null +++ b/manifests/function/hwcc/README.md @@ -0,0 +1,39 @@ +# Function: hwcc + +Controller for classifying host hardware characteristics to expected values. + +The HWCC (Hardware Classification Controller) compares and validates the +workload profile against Baremetal Hosts and classifies right match host +and label the host. Also it displays the count for matched, unmatched +and error hosts. + +Comparison and validation is done on baremetalhost list provided by `BMO` +against hardware profile mentioned in +`metal3.io_hardwareclassifications.yaml`. + +HWCC will label matched hosts. + * Default + + `hardwareclassification.metal3.io/=matches` + * User Provided + + `hardwareclassification.metal3.io/=