Feature: karmadactl init supports deployment through configuration files #5357

tiansuo114 · 2024-08-12T13:38:20Z

What type of PR is this?
/kind feature

What this PR does / why we need it:
Increased karmadactl's ability to init by reading configuration files
From

user@virtual-machine:karmada/_output/bin/linux/amd64# karmadactl init --karmada-apiserver-image registry.k8s.io/kube-apiserver:v1.30.0 --karmada-kube-controller-manager-image registry.k8s.io/kube-controller-manager:v1.30.0 --etcd-image registry.k8s.io/etcd:3.5.13-0 --etcd-init-image docker.io/library/alpine:3.19.1 --karmada-aggregated-apiserver-image docker.io/karmada/karmada-aggregated-apiserver:v1.10.3 --karmada-controller-manager-image docker.io/karmada/karmada-controller-manager:v1.10.3 --karmada-scheduler-image docker.io/karmada/karmada-scheduler:v1.10.3 --karmada-webhook-image docker.io/karmada/karmada-webhook:v1.10.3 --crds /home/tiansuo/Downloads/crds.tar.gz ....

Turn into

user@virtual-machine:karmada/_output/bin/linux/amd64# karmadactl init --config config.yaml

Example of config.yaml

apiVersion: config.karmada.io/v1alpha1
kind: KarmadaInitConfig
metadata:
  name: karmada-init
spec:
  karmadaCrds: "https://github.com/karmada-io/karmada/releases/download/v1.10.3/crds.tar.gz"
  etcd:
    local:
      imageRepository: "registry.k8s.io/etcd"
      imageTag: "3.5.13-0"
      initImage:
        imageRepository: "docker.io/library/alpine"
        imageTag: "3.19.1"
  components:
    karmadaAPIServer:
      imageRepository: "registry.k8s.io/kube-apiserver"
      imageTag: "v1.30.0"
    karmadaAggregatedAPIServer:
      imageRepository: "docker.io/karmada/karmada-aggregated-apiserver"
      imageTag: "v1.10.3"
    kubeControllerManager:
      imageRepository: "registry.k8s.io/kube-controller-manager"
      imageTag: "v1.30.0"
    karmadaControllerManager:
      imageRepository: "docker.io/karmada/karmada-controller-manager"
      imageTag: "v1.10.3"
    karmadaScheduler:
      imageRepository: "docker.io/karmada/karmada-scheduler"
      imageTag: "v1.10.3"
    karmadaWebhook:
      imageRepository: "docker.io/karmada/karmada-webhook"
      imageTag: "v1.10.3"

Which issue(s) this PR fixes:
Fixes #3464
This PR is related to the documentation PR: #5277
Special notes for your reviewer:
@liangyuanpeng
Does this PR introduce a user-facing change?:

liangyuanpeng · 2024-08-12T13:38:24Z

Hi, this is a bot comment, just put the label of ok-to-test here, you can comment /retest to rerun github workflow if github workflow is failing and it's not releated with this PR.

/ok-to-test

pkg/karmadactl/cmdinit/config/config_test.go

liangyuanpeng · 2024-08-12T13:45:23Z

please link to the proposal at PR describe.

releated #5277

codecov-commenter · 2024-08-12T13:50:06Z

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

Codecov Report

Attention: Patch coverage is 79.72973% with 45 lines in your changes missing coverage. Please review.

Project coverage is 41.53%. Comparing base (f7d6da3) to head (9b9847e).

Files with missing lines	Patch %	Lines
pkg/karmadactl/cmdinit/kubernetes/deploy.go	78.61%	29 Missing and 5 partials ⚠️
pkg/karmadactl/cmdinit/config/config.go	89.28%	4 Missing and 2 partials ⚠️
pkg/karmadactl/cmdinit/config/types.go	0.00%	5 Missing ⚠️

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

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #5357      +/-   ##
==========================================
+ Coverage   41.37%   41.53%   +0.16%     
==========================================
  Files         651      653       +2     
  Lines       55265    55484     +219     
==========================================
+ Hits        22868    23048     +180     
- Misses      30917    30949      +32     
- Partials     1480     1487       +7

Flag	Coverage Δ
unittests	`41.53% <79.72%> (+0.16%)`	⬆️

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.

tiansuo114 · 2024-08-12T13:56:04Z

This PR is related to the documentation PR: #5277

tiansuo114 · 2024-08-12T13:59:27Z

please link to the proposal at PR describe.请链接到 PR 描述中的提案。

releated #5277

Ok, I've now connected all three related PRS to document pr

tiansuo114 · 2024-09-21T13:27:58Z

Can we start the review of this pr first, or do we still need to wait for the merge of #5277 before we can conduct the review of this pr
@liangyuanpeng

liangyuanpeng · 2024-09-23T10:21:57Z

I think we need to merge proposal first

tiansuo114 · 2024-10-11T09:47:58Z

The code in this branch has been modified to use the configuration file format from the existing proposal for deployment, and it has been verified that the deployment works correctly. Additionally, the proposal has already been merged into the master branch. Can we start the review now?
@liangyuanpeng

Furthermore, I have some questions in another PR, and we might need to discuss them further.

pkg/karmadactl/cmdinit/config/config.go

pkg/karmadactl/cmdinit/config/config_test.go

liangyuanpeng

sorry for my later and add some comment

pkg/karmadactl/cmdinit/kubernetes/deploy.go

.github/workflows/cli.yaml

hack/cli-testing-init-with-config.sh

pkg/karmadactl/cmdinit/config/config.go

pkg/karmadactl/cmdinit/kubernetes/deploy.go

liangyuanpeng

This PR first reads the configuration file and then convert to CommandInitOption, which is compatible with the legacy code unless you refactor the legacy code logic. Do you agree?

cc @zhzhuang-zju @RainbowMango

pkg/karmadactl/cmdinit/config/types.go

pkg/karmadactl/cmdinit/cmdinit.go

pkg/karmadactl/cmdinit/config/types.go

pkg/karmadactl/cmdinit/config/config.go

RainbowMango · 2024-10-21T09:44:42Z

This PR first reads the configuration file and then convert to CommandInitOption, which is compatible with the legacy code unless you refactor the legacy code logic. Do you agree?

Yeah, I agree.

pkg/karmadactl/cmdinit/config/types.go

RainbowMango

Generally looks good to me after a quick go-through. Just some nits about naming convention.
@liangyuanpeng do you have any further comments?
@tiansuo114 Have you tested it? Can you share the test report here?

tiansuo114 · 2024-10-22T08:34:33Z

Generally looks good to me after a quick go-through. Just some nits about naming convention. @liangyuanpeng do you have any further comments? @tiansuo114 Have you tested it? Can you share the test report here?

I conducted some tests using kind cluster in a virtual machine on my local machine. I also attempted to add a test task in the CLI section of Karmada's GitHub CI workflow to verify whether the karmadactl init --init-config command runs correctly. (The detailed testing process can first be observed in this link)Following the guidance of my mentor, I plan to submit a separate PR to merge the test process into the main branch after the current PR is merged.

RainbowMango · 2024-10-22T08:43:13Z

OK.
/approve
Leave LGTM to @liangyuanpeng for final decision.

pkg/karmadactl/cmdinit/cmdinit.go

pkg/karmadactl/cmdinit/config/config.go

pkg/karmadactl/cmdinit/config/config_test.go

tiansuo114 · 2024-10-25T08:56:34Z

/retest

Signed-off-by: tiansuo114 <1729765480@qq.com> fix lint Signed-off-by: tiansuo114 <1729765480@qq.com>

RainbowMango

/lgtm
/approve

Hi @liangyuanpeng Let's move this forward and handle further comments by separated PRs.

karmada-bot · 2024-10-26T02:35:32Z

[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:

~~OWNERS~~ [RainbowMango]

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

liangyuanpeng · 2024-10-26T02:35:45Z

Hi, this is a bot comment, just put the label of ok-to-test here, you can comment /retest to rerun github workflow if github workflow is failing and it's not releated with this PR.

/ok-to-test

liangyuanpeng · 2024-10-28T09:36:17Z

pkg/karmadactl/cmdinit/config/types.go

+// KarmadaInitConfig defines the configuration for initializing Karmada
+type KarmadaInitConfig struct {
+	metav1.TypeMeta   `json:",inline" yaml:",inline"`
+	metav1.ObjectMeta `json:"metadata,omitempty" yaml:"metadata,omitempty"`


I think this is not need, let's delete it.

Do you mean the metav1.ObjectMeta? It makes sense to me.
Please add a task to the tracking issue.

Updated, How about including it in #5306 (comment) (for Summer OSPP 2024)?, or alone PR for it

Both are OK to me. I just want somewhere track this.

karmada-bot added the kind/feature Categorizes issue or PR as related to a new feature. label Aug 12, 2024

karmada-bot requested review from chaosi-zju and jwcesign August 12, 2024 13:38

karmada-bot added ok-to-test size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Aug 12, 2024

liangyuanpeng reviewed Aug 12, 2024

View reviewed changes

pkg/karmadactl/cmdinit/config/config_test.go Outdated Show resolved Hide resolved

liangyuanpeng mentioned this pull request Aug 16, 2024

[Summer OSPP 2024] karmadactl init supports configuration file #5387

Closed

7 tasks

zhzhuang-zju mentioned this pull request Sep 4, 2024

[Release-1.12] Enhance karmadactl operation and maintenance experience #5477

Open

12 tasks

tiansuo114 force-pushed the origin branch from 2715189 to f4e06e6 Compare September 21, 2024 04:17

karmada-bot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Sep 21, 2024

tiansuo114 force-pushed the origin branch from b16cfb9 to cfc7bd0 Compare October 11, 2024 09:43

karmada-bot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Oct 11, 2024

liangyuanpeng reviewed Oct 13, 2024

View reviewed changes

pkg/karmadactl/cmdinit/config/config.go Outdated Show resolved Hide resolved

liangyuanpeng reviewed Oct 13, 2024

View reviewed changes

pkg/karmadactl/cmdinit/config/config_test.go Outdated Show resolved Hide resolved

tiansuo114 force-pushed the origin branch 2 times, most recently from 0e29649 to 44a25dc Compare October 16, 2024 08:41

liangyuanpeng reviewed Oct 20, 2024

View reviewed changes

pkg/karmadactl/cmdinit/kubernetes/deploy.go Outdated Show resolved Hide resolved

liangyuanpeng reviewed Oct 21, 2024

View reviewed changes

pkg/karmadactl/cmdinit/config/types.go Outdated Show resolved Hide resolved

pkg/karmadactl/cmdinit/cmdinit.go Show resolved Hide resolved

pkg/karmadactl/cmdinit/config/types.go Outdated Show resolved Hide resolved

pkg/karmadactl/cmdinit/config/config.go Outdated Show resolved Hide resolved

RainbowMango reviewed Oct 22, 2024

View reviewed changes

pkg/karmadactl/cmdinit/config/types.go Outdated Show resolved Hide resolved

RainbowMango reviewed Oct 22, 2024

View reviewed changes

tiansuo114 force-pushed the origin branch 2 times, most recently from 3ce103c to 1e85a8a Compare October 22, 2024 05:25

karmada-bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Oct 22, 2024

RainbowMango added this to the v1.12 milestone Oct 22, 2024

tiansuo114 force-pushed the origin branch 2 times, most recently from e18005e to 0e0115b Compare October 22, 2024 10:38

RainbowMango removed the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Oct 22, 2024

RainbowMango reviewed Oct 23, 2024

View reviewed changes

pkg/karmadactl/cmdinit/cmdinit.go Outdated Show resolved Hide resolved

RainbowMango reviewed Oct 23, 2024

View reviewed changes

pkg/karmadactl/cmdinit/cmdinit.go Outdated Show resolved Hide resolved

liangyuanpeng reviewed Oct 23, 2024

View reviewed changes

pkg/karmadactl/cmdinit/config/config.go Show resolved Hide resolved

liangyuanpeng reviewed Oct 23, 2024

View reviewed changes

pkg/karmadactl/cmdinit/config/config_test.go Show resolved Hide resolved

tiansuo114 force-pushed the origin branch from 0e0115b to fbb64fc Compare October 23, 2024 04:16

karmada-bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Oct 23, 2024

tiansuo114 force-pushed the origin branch 2 times, most recently from 16717ca to bdde118 Compare October 23, 2024 04:33

Feature: karmadactl init supports deployment through configuration files

9b9847e

Signed-off-by: tiansuo114 <1729765480@qq.com> fix lint Signed-off-by: tiansuo114 <1729765480@qq.com>

tiansuo114 force-pushed the origin branch from bdde118 to 9b9847e Compare October 25, 2024 09:03

tiansuo114 mentioned this pull request Oct 25, 2024

Add tests for deploying Karmada services using the configuration file with the karmadactl init --config command.(closed) #5744

Closed

RainbowMango approved these changes Oct 26, 2024

View reviewed changes

karmada-bot added the lgtm Indicates that a PR is ready to be merged. label Oct 26, 2024

karmada-bot merged commit 9754a28 into karmada-io:master Oct 26, 2024
15 checks passed

liangyuanpeng reviewed Oct 28, 2024

View reviewed changes

tiansuo114 mentioned this pull request Oct 28, 2024

Add GitHub tests for karmadactl init --config command #5306

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature: karmadactl init supports deployment through configuration files #5357

Feature: karmadactl init supports deployment through configuration files #5357

tiansuo114 commented Aug 12, 2024 •

edited

Loading

liangyuanpeng commented Aug 12, 2024

liangyuanpeng commented Aug 12, 2024

codecov-commenter commented Aug 12, 2024 •

edited

Loading

tiansuo114 commented Aug 12, 2024 •

edited

Loading

tiansuo114 commented Aug 12, 2024

tiansuo114 commented Sep 21, 2024

liangyuanpeng commented Sep 23, 2024

tiansuo114 commented Oct 11, 2024

liangyuanpeng left a comment •

edited

Loading

liangyuanpeng left a comment

RainbowMango commented Oct 21, 2024

RainbowMango left a comment

tiansuo114 commented Oct 22, 2024

RainbowMango commented Oct 22, 2024

tiansuo114 commented Oct 25, 2024

RainbowMango left a comment

karmada-bot commented Oct 26, 2024

liangyuanpeng commented Oct 26, 2024

liangyuanpeng Oct 28, 2024

RainbowMango Oct 28, 2024

liangyuanpeng Oct 28, 2024

RainbowMango Oct 28, 2024

Feature: karmadactl init supports deployment through configuration files #5357

Feature: karmadactl init supports deployment through configuration files #5357

Conversation

tiansuo114 commented Aug 12, 2024 • edited Loading

liangyuanpeng commented Aug 12, 2024

liangyuanpeng commented Aug 12, 2024

codecov-commenter commented Aug 12, 2024 • edited Loading

Codecov Report

tiansuo114 commented Aug 12, 2024 • edited Loading

tiansuo114 commented Aug 12, 2024

tiansuo114 commented Sep 21, 2024

liangyuanpeng commented Sep 23, 2024

tiansuo114 commented Oct 11, 2024

liangyuanpeng left a comment • edited Loading

Choose a reason for hiding this comment

liangyuanpeng left a comment

Choose a reason for hiding this comment

RainbowMango commented Oct 21, 2024

RainbowMango left a comment

Choose a reason for hiding this comment

tiansuo114 commented Oct 22, 2024

RainbowMango commented Oct 22, 2024

tiansuo114 commented Oct 25, 2024

RainbowMango left a comment

Choose a reason for hiding this comment

karmada-bot commented Oct 26, 2024

liangyuanpeng commented Oct 26, 2024

liangyuanpeng Oct 28, 2024

Choose a reason for hiding this comment

RainbowMango Oct 28, 2024

Choose a reason for hiding this comment

liangyuanpeng Oct 28, 2024

Choose a reason for hiding this comment

RainbowMango Oct 28, 2024

Choose a reason for hiding this comment

tiansuo114 commented Aug 12, 2024 •

edited

Loading

codecov-commenter commented Aug 12, 2024 •

edited

Loading

tiansuo114 commented Aug 12, 2024 •

edited

Loading

liangyuanpeng left a comment •

edited

Loading