External etcd Support for Karmada Operator - Part 2

[jabellard]

What type of PR is this?

/kind feature

What this PR does / why we need it:
This is an implementation of this proposal for adding support to the Karmada operator for external etcd cluster connections.

Which issue(s) this PR fixes:
Fixes #5242

Special notes for your reviewer:

Does this PR introduce a user-facing change?:

NONE

[jabellard]

@RainbowMango, I gave some thought into how to best implement this part of the feature. Given that @chaosi-zju is doing some great work for standardizing naming conventions, my goal was to not duplicate that work. As such, the approach I took here is intended to:

• Introduce as minimal changes as possible
• Implement the changes in such a way that future refactorings and changes for the ongoing standardization effort can be incorporated into the code very easily

[RainbowMango]

/assign

[RainbowMango]

Generally looks good to me.

But the unit test is failing:

# go test ./operator/pkg/controller/karmada/... 
I1023 14:40:51.153174  499685 defaults.go:53] default Karmada Image Version: v0.0.0-master
--- FAIL: TestNewPlannerFor (0.00s)
    --- FAIL: TestNewPlannerFor/NewPlannerFor_WithInitAction_PlannerConstructed (0.00s)
panic: runtime error: invalid memory address or nil pointer dereference [recovered]
	panic: runtime error: invalid memory address or nil pointer dereference
[signal SIGSEGV: segmentation violation code=0x1 addr=0x0 pc=0x178edff]

goroutine 42 [running]:
testing.tRunner.func1.2({0x1984860, 0x2c942f0})
	/root/.local/share/mise/installs/go/1.22.7/src/testing/testing.go:1631 +0x24a
testing.tRunner.func1()
	/root/.local/share/mise/installs/go/1.22.7/src/testing/testing.go:1634 +0x377
panic({0x1984860?, 0x2c942f0?})
	/root/.local/share/mise/installs/go/1.22.7/src/runtime/panic.go:770 +0x132
github.com/karmada-io/karmada/operator/pkg.NewInitJob(0xc0001b4a80)
	/root/go/src/github.com/karmada-io/karmada/operator/pkg/init.go:123 +0x73f
github.com/karmada-io/karmada/operator/pkg/controller/karmada.NewPlannerFor(0xc000602300, {0x7f57f0111bc8, 0xc000130d20}, 0xc00047c908)
	/root/go/src/github.com/karmada-io/karmada/operator/pkg/controller/karmada/planner.go:72 +0x14f
github.com/karmada-io/karmada/operator/pkg/controller/karmada.TestNewPlannerFor.func1(0xc0001c7520)
	/root/go/src/github.com/karmada-io/karmada/operator/pkg/controller/karmada/planner_test.go:79 +0x3c
testing.tRunner(0xc0001c7520, 0xc000130e10)
	/root/.local/share/mise/installs/go/1.22.7/src/testing/testing.go:1689 +0xfb
created by testing.(*T).Run in goroutine 41
	/root/.local/share/mise/installs/go/1.22.7/src/testing/testing.go:1742 +0x390
FAIL	github.com/karmada-io/karmada/operator/pkg/controller/karmada	0.024s

[RainbowMango]

Suggested change

	// EtcClientCredentialsVolumeName defines the name of the volume for the etcd client credentials
	EtcClientCredentialsVolumeName = "etcd-client" // #nosec G101
	// EtcClientCredentialsMountPath defines the mount path for the etcd client credentials data
	EtcClientCredentialsMountPath = "/etc/karmada/pki/etcd-client" // #nosec G101
	// EtcdClientCredentialsVolumeName defines the name of the volume for the etcd client credentials
	EtcdClientCredentialsVolumeName = "etcd-client-cert" // #nosec G101
	// EtcdClientCredentialsMountPath defines the mount path for the etcd client credentials data
	EtcdClientCredentialsMountPath = "/etc/karmada/pki/etcd-client" // #nosec G101

const name: s/Etc/Etcd
volume name: s/etcd-client/etcd-client-cert

[codecov-commenter]

⚠️ Please install the to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

Attention: Patch coverage is 37.67123% with 91 lines in your changes missing coverage. Please review.

Project coverage is 40.85%. Comparing base (13df63f) to head (5442736).
Report is 6 commits behind head on master.

Files with missing lines	Patch %	Lines
operator/pkg/controlplane/etcd/util.go	0.00%	56 Missing ⚠️
operator/pkg/tasks/deinit/component.go	0.00%	21 Missing ⚠️
operator/pkg/controlplane/apiserver/apiserver.go	75.00%	4 Missing and 4 partials ⚠️
operator/pkg/controlplane/search/search.go	73.33%	2 Missing and 2 partials ⚠️
operator/pkg/controller/karmada/controller.go	0.00%	1 Missing ⚠️
operator/pkg/tasks/init/component.go	0.00%	1 Missing ⚠️

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #5720      +/-   ##
==========================================
+ Coverage   40.52%   40.85%   +0.32%     
==========================================
  Files         650      651       +1     
  Lines       55184    55256      +72     
==========================================
+ Hits        22365    22573     +208     
+ Misses      31386    31241     -145     
- Partials     1433     1442       +9     

Flag	Coverage Δ
unittests	40.85% <37.67%> (+0.32%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[jabellard]

Generally looks good to me.

But the unit test is failing:

@RainbowMango , I just pushed changes to address those issues.

[RainbowMango]

Great!
Maybe you can help to tidy the commits? e.g. squash them?

[jabellard]

Great! Maybe you can help to tidy the commits? e.g. squash them?

Just squashed.

[RainbowMango]

/lgtm
/approve

[karmada-bot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: RainbowMango

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

• operator/OWNERS [RainbowMango]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[RainbowMango]

Hi @jabellard
As we discussed at the last community meeting, we will have a pre-release for this feature.
Here it is: https://github.com/karmada-io/karmada/releases/tag/v1.12.0-beta.0

[jabellard]

Here it is: https://github.com/karmada-io/karmada/releases/tag/v1.12.0-beta.0

This is amazing! Thank you!