small fixes in documentation

[almaslennikov]

No description provided.

[coveralls]

Pull Request Test Coverage Report for Build 11571592164

Details

• 1 of 1 (100.0%) changed or added relevant line in 1 file are covered.
• 6 unchanged lines in 1 file lost coverage.
• Overall coverage remained the same at 60.443%

---

Files with Coverage Reduction	New Missed Lines	%
internal/controller/nicconfigurationtemplate_controller.go	6	87.06%

Totals
Change from base Build 11513872292:	0.0%
Covered Lines:	1745
Relevant Lines:	2887

---

💛 - Coveralls

[tobiasgiese]

We should rather make this field required in our API instead of only documenting this

[almaslennikov]

It is required, the additional comment here in the docs is for transparency

[tobiasgiese]

But it is not defined as required via CRD validation. Is this on purpose?
We should add the annotation // +required

nic-configuration-operator/api/v1alpha1/nicconfigurationtemplate_types.go

Lines 82 to 83 in 80db27e

	// Number of VFs to be configured
	NumVfs int `json:"numVfs"`

xref https://book.kubebuilder.io/reference/markers/crd-validation

[almaslennikov]

It doesn't have the omitempty attribute which in turn doesn't allow to create a template without it.

[tobiasgiese]

But it is not a strict contract to the API. Additionally it is not user visible while reading the API docs or running kubectl explain. With the annotation on it the user will see it automatically

[almaslennikov]

Okay, let's add it :)

Nevertheless, our CRDs already mark those fields as required: https://github.com/Mellanox/nic-configuration-operator/blob/main/config/crd/bases/configuration.net.nvidia.com_nicconfigurationtemplates.yaml#L169