operator/pkg/tasks/init/etcd.go: Inconsistency Between Comment and Implementation in runWaitEtcd Function?

[mohamedawnallah]

Description

The comment in the runWaitEtcd function mentions that the function waits for etcd, Karmada API server, and aggregated API server to be ready. However, the current implementation only waits for the etcd pods based on the etcdLabels. Is there anything I'm missing? Or the comment should be updated?

karmada/operator/pkg/tasks/init/etcd.go

Lines 84 to 100 in 8cc712f

	func runWaitEtcd(r workflow.RunData) error {
	data, ok := r.(InitData)
	if !ok {
	return errors.New("wait-etcd task invoked with an invalid data struct")
	}
	waiter := apiclient.NewKarmadaWaiter(data.ControlplaneConfig(), data.RemoteClient(), componentBeReadyTimeout)
	// wait etcd, karmada apiserver and aggregated apiserver to ready
	// as long as a replica of pod is ready, we consider the service available.
	if err := waiter.WaitForSomePods(etcdLabels.String(), data.GetNamespace(), 1); err != nil {
	return fmt.Errorf("waiting for karmada-etcd to ready timeout, err: %w", err)
	}
	klog.V(2).InfoS("[wait-etcd] the etcd pods is ready", "karmada", klog.KObj(data))
	return nil
	}

[zhzhuang-zju]

Waiting for etcd, the Karmada API server, and the aggregated API server to be ready is implemented by the functions runWaitEtcd, runWaitKarmadaAPIServer, and runWaitKarmadaAggregatedAPIServer, respectively. Relevant comments can be updated to split this information across the three functions. Ask for @calvin0327 to confirm