operator/config/samples/karmada.yaml may be not valid

[chaosi-zju]

What happened:

When installing karmada by operator, karmada provided a sample karmada.yaml.

we do like this:

cd path/to/karmada

helm install karmada-operator -n karmada-system  --create-namespace --dependency-update ./charts/karmada-operator --debug

kubectl apply -f https://raw.githubusercontent.com/karmada-io/karmada/release-1.7/operator/config/crds/operator.karmada.io_karmadas.yaml

kubectl apply -f operator/config/samples/karmada.yaml

there will report karmada.yaml has syntax error：

I wanna if others think it is a problem, or these configurations have some special purpose?

What you expected to happen:

install success

How to reproduce it (as minimally and precisely as possible):

see above

Anything else we need to know?:

Environment:

• Karmada version: latest
• kubectl-karmada or karmadactl version (the result of kubectl-karmada version or karmadactl version): latest
• Others:

[calvin0327]

/assign

[zhzhuang-zju]

cc @calvin0327 Hi~ have you made some progress? if not, can I take this?

[zhzhuang-zju]

@calvin0327 Hi~ Since you haven't replied yet, I’ll take it first~ Of course, if you have some ideas and suggestions too, be free to share them here
/assign

[zhzhuang-zju]

As can be seen from the error log, karmada does not have the spec.components.etcd.local.volumeData.volumeClaim.metadata.name field. Looking at the code, we can see that the metadata in the structure definition contains the name field, so the problem should be in the process of generating crd from the structure.

karmada/vendor/k8s.io/apimachinery/pkg/apis/meta/v1/types.go

Lines 109 to 119 in cf1dbf0

	// ObjectMeta is metadata that all persisted resources must have, which includes all objects
	// users must create.
	type ObjectMeta struct {
	// Name must be unique within a namespace. Is required when creating resources, although
	// some resources may allow a client to request the generation of an appropriate name
	// automatically. Name is primarily intended for creation idempotence and configuration
	// definition.
	// Cannot be updated.
	// More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
	// +optional
	Name string `json:"name,omitempty" protobuf:"bytes,1,opt,name=name"`

It can be seen from the historical submission records that the above conversion process is completed using the controller-gen tool through command controller-gen crd paths=./operator/pkg/apis/operator/... output:crd:dir=./operator/config/crds.

Referring to kubernetes-sigs/controller-tools#557, embedded ObjectMeta in the CRD get's properly generated if the generator option generateEmbeddedObjectMeta=true is passed, so we should change the command accordingly and add generator option generateEmbeddedObjectMeta=true.

[chaosi-zju]

@zhzhuang-zju great job~

[chaosi-zju]

@zhzhuang-zju would you like to push a PR to fix it?

[zhzhuang-zju]

@zhzhuang-zju would you like to push a PR to fix it?

Of course, I'd love to~