docs: add proposal of karmadactl init support config file #5277

tiansuo114 · 2024-07-30T04:22:00Z

What type of PR is this?
/kind feature

What this PR does / why we need it:
karmadactl supports configuration file installation and deployment
Which issue(s) this PR fixes:
Parts of #3464

Special notes for your reviewer:

Does this PR introduce a user-facing change?:

codecov-commenter · 2024-07-30T04:33:52Z

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

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 35.19%. Comparing base (b4b6d69) to head (07803e4).
Report is 340 commits behind head on master.

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

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #5277      +/-   ##
==========================================
+ Coverage   28.38%   35.19%   +6.81%     
==========================================
  Files         632      645      +13     
  Lines       43801    44869    +1068     
==========================================
+ Hits        12432    15791    +3359     
+ Misses      30464    27847    -2617     
- Partials      905     1231     +326

Flag	Coverage Δ
unittests	`35.19% <ø> (+6.81%)`	⬆️

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.

XiShanYongYe-Chang · 2024-07-30T08:21:55Z

/assign @liangyuanpeng @zhzhuang-zju

...dactl Supports Configuration File Method for Production-Grade Installation and Deployment.md

liangyuanpeng

Thanks you for opening it! I will check it later!

tiansuo114 · 2024-08-01T05:49:38Z

Thanks you for opening it! I will check it later!

I have completed the implementation code section and updated the reviewer section at the beginning of the document. Professor, could you please check it when you have time?

...dactl Supports Configuration File Method for Production-Grade Installation and Deployment.md

tiansuo114 · 2024-08-02T07:02:42Z

/retest

karmada-bot · 2024-08-02T07:03:00Z

@tiansuo114: Cannot trigger testing until a trusted user reviews the PR and leaves an /ok-to-test message.

In response to this:

/retest

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

zhzhuang-zju · 2024-08-02T07:17:44Z

/ok-to-test
/retest

zhzhuang-zju · 2024-08-05T02:14:04Z

/retest

tiansuo114 · 2024-08-06T08:17:35Z

May need help😭😭, in my own project's github action, these tests passed correctly, but when I commit, these tests become failed, what should I do to fix these problems
@liangyuanpeng

liangyuanpeng · 2024-08-06T08:38:36Z

#2 ERROR: failed to copy: httpReadSeeker: failed open: unexpected status code https://registry-1.docker.io/v2/library/alpine/manifests/sha256:0a4eaa0eecf5f8c050e5bba433f58c052be7587ee8af3e8b3910ef9ab5fbe9f5: 429 Too Many Requests - Server message: toomanyrequests: You have reached your pull rate limit. You may increase the limit by authenticating and upgrading: https://www.docker.com/increase-rate-limit

This is not releated with this PR, have some pull rate limit from dockerhub (: , just run command /retest to rerun github workflow.

/ok-to-test
/retest

liangyuanpeng · 2024-08-06T08:41:26Z

BTW, this is a proposal PR, have not change code, so you don’t need to worry about CI because there is no document-related CI

XiShanYongYe-Chang · 2024-09-20T01:18:02Z

/lgtm
/assign @RainbowMango

...dactl Supports Configuration File Method for Production-Grade Installation and Deployment.md

RainbowMango

No doubt that this is a high-quality proposal, thanks for your effort.
Just leave some comments and questions.

...dactl Supports Configuration File Method for Production-Grade Installation and Deployment.md

RainbowMango · 2024-09-24T11:57:48Z

...dactl Supports Configuration File Method for Production-Grade Installation and Deployment.md

+	KubeConfigPath            string yaml:"kubeConfigPath"
+	KubeImageTag              string yaml:"kubeImageTag"
+	KubeContextName           string yaml:"context"
+	KubeStorageClassesName    string yaml:"storageClassesName"


Can you remind me which flag the KubeStorageClassesName applies to?

Here are some of the early design error, in the back I changed, but when the synchronization in the document missing, the name should be StorageClassesName, used to fill the CommandInitOption. StorageClassesName

OK. By the way, can you add some comments to the structure? If there is a corresponding flag, please also put it in comments.

Ok, so far, I have only added explanatory comments before each general structure, but I think the information in the corresponding fields of each structure should confirm their purpose. In your opinion, where should you add comments about the corresponding flag? Do you mean the corresponding flag of which configuration items?

...dactl Supports Configuration File Method for Production-Grade Installation and Deployment.md

docs/proposals/karmadactl/init-configuration-file.md

RainbowMango · 2024-09-29T03:12:11Z

/retest

RainbowMango · 2024-09-29T04:12:52Z

docs/proposals/karmadactl/init-configuration-file.md

+
+As Karmada is widely used in multi-cluster management, the current `karmadactl init` command has accumulated dozens of command-line parameters. This not only increases the learning curve for users but also reduces the convenience of usage. With the ongoing development of the community, the number and complexity of these parameters are likely to continue growing, further impacting the user experience.
+
+Additionally, during the deployment process of `karmadactl init`, multiple container images are needed. Users may want to download the corresponding images in advance to save deployment time, but currently, there is no easy way for users to obtain the list of required container images.


Shall we move this part out of this proposal?

RainbowMango · 2024-09-29T04:13:07Z

docs/proposals/karmadactl/init-configuration-file.md

+
+Therefore, I think the configuration file can be designed to focus on these parts, structuring the YAML accordingly, and incorporating the existing configuration items into them. Additionally, similar to the commonly used `Extra Arg` field in Kubernetes structures, an extra field can be added to store other general fields. When designing the fields, it is advisable to refer to the field names in the kubeadm configuration file as much as possible, to facilitate user familiarity and quick adoption.
+
+After completing the design for reading config files in `karmada init`, we can extend the functionality of the `karmadactl config image list` command to read the required image configuration from the config file by reusing the config file reading method.


Yes, these parts need to be deleted. Maybe I lost the commit of the deleted part when I was rebase. I will modify this part as soon as possible

Signed-off-by: tiansuo114 <1729765480@qq.com> fix Signed-off-by: tiansuo114 <1729765480@qq.com> add Signed-off-by: tiansuo114 <1729765480@qq.com> fix Signed-off-by: tiansuo114 <1729765480@qq.com> fix Signed-off-by: tiansuo114 <1729765480@qq.com> fix Signed-off-by: tiansuo114 <1729765480@qq.com> add file change Signed-off-by: tiansuo114 <1729765480@qq.com> fix Signed-off-by: tiansuo114 <1729765480@qq.com> fix doc Signed-off-by: tiansuo114 <1729765480@qq.com> fix Signed-off-by: tiansuo114 <1729765480@qq.com> fix comment Signed-off-by: tiansuo114 <1729765480@qq.com> fix Signed-off-by: tiansuo114 <1729765480@qq.com> fix Signed-off-by: tiansuo114 <1729765480@qq.com> fix Signed-off-by: tiansuo114 <1729765480@qq.com> fix Signed-off-by: tiansuo114 <1729765480@qq.com> fix Signed-off-by: tiansuo114 <1729765480@qq.com> fix Signed-off-by: tiansuo114 <1729765480@qq.com> fix Signed-off-by: tiansuo114 <1729765480@qq.com> fix Signed-off-by: tiansuo114 <1729765480@qq.com>

tiansuo114 · 2024-10-01T02:11:05Z

I have already modified this document according to the discussion requirements from the meeting. When you have time, please kindly review it.
@liangyuanpeng @RainbowMango

RainbowMango

/lgtm
/approve

karmada-bot · 2024-10-08T04:11:57Z

[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

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

karmada-bot requested review from Tingtal and whitewindmills July 30, 2024 04:22

karmada-bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Jul 30, 2024

karmada-bot assigned liangyuanpeng and zhzhuang-zju Jul 30, 2024

tiansuo114 force-pushed the doc branch from ffa8f50 to 8ddfe9c Compare July 30, 2024 08:46

liangyuanpeng reviewed Jul 30, 2024

View reviewed changes

...dactl Supports Configuration File Method for Production-Grade Installation and Deployment.md Outdated Show resolved Hide resolved

liangyuanpeng reviewed Jul 30, 2024

View reviewed changes

tiansuo114 force-pushed the doc branch from 8ddfe9c to 820ae62 Compare August 1, 2024 05:47

zhzhuang-zju reviewed Aug 1, 2024

View reviewed changes

tiansuo114 force-pushed the doc branch from 820ae62 to 112a7f2 Compare August 2, 2024 06:26

karmada-bot added the ok-to-test label Aug 2, 2024

tiansuo114 force-pushed the doc branch from 112a7f2 to 13efa98 Compare August 6, 2024 07:07

karmada-bot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Aug 6, 2024

tiansuo114 force-pushed the doc branch 2 times, most recently from f7cb586 to 2ee63b6 Compare August 6, 2024 07:10

karmada-bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Aug 6, 2024

karmada-bot assigned RainbowMango and XiShanYongYe-Chang Sep 20, 2024

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

liangyuanpeng mentioned this pull request Sep 23, 2024

add karmadactl init --config & karmadactl config documents karmada-io/website#690

Merged

RainbowMango reviewed Sep 23, 2024

View reviewed changes

...dactl Supports Configuration File Method for Production-Grade Installation and Deployment.md Outdated Show resolved Hide resolved

RainbowMango reviewed Sep 23, 2024

View reviewed changes

karmada-bot removed the lgtm Indicates that a PR is ready to be merged. label Sep 23, 2024

tiansuo114 force-pushed the doc branch from 9990f38 to 5f9b5e4 Compare September 23, 2024 13:54

XiShanYongYe-Chang mentioned this pull request Sep 24, 2024

OSPP 2024 Project tracking #4879

Closed

8 tasks

RainbowMango reviewed Sep 24, 2024

View reviewed changes

...dactl Supports Configuration File Method for Production-Grade Installation and Deployment.md Outdated Show resolved Hide resolved

RainbowMango reviewed Sep 24, 2024

View reviewed changes

liangyuanpeng reviewed Sep 25, 2024

View reviewed changes

docs/proposals/karmadactl/init-configuration-file.md Outdated Show resolved Hide resolved

liangyuanpeng reviewed Sep 25, 2024

View reviewed changes

docs/proposals/karmadactl/init-configuration-file.md Outdated Show resolved Hide resolved

tiansuo114 force-pushed the doc branch from d784f22 to 44efc0f Compare September 28, 2024 07:35

tiansuo114 mentioned this pull request Sep 28, 2024

docs: add proposal of karmadactl init images list #5623

Closed

RainbowMango reviewed Sep 29, 2024

View reviewed changes

tiansuo114 force-pushed the doc branch from 44efc0f to 2437f64 Compare September 29, 2024 04:55

tiansuo114 force-pushed the doc branch from 2437f64 to 07803e4 Compare October 1, 2024 01:56

karmada-bot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Oct 1, 2024

RainbowMango approved these changes Oct 8, 2024

View reviewed changes

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

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

karmada-bot merged commit 52a5b4c into karmada-io:master Oct 8, 2024
12 checks passed

tiansuo114 deleted the doc branch November 23, 2024 02:16

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: add proposal of karmadactl init support config file #5277

docs: add proposal of karmadactl init support config file #5277

tiansuo114 commented Jul 30, 2024 •

edited

Loading

codecov-commenter commented Jul 30, 2024 •

edited

Loading

XiShanYongYe-Chang commented Jul 30, 2024

liangyuanpeng left a comment

tiansuo114 commented Aug 1, 2024

tiansuo114 commented Aug 2, 2024

karmada-bot commented Aug 2, 2024

zhzhuang-zju commented Aug 2, 2024

zhzhuang-zju commented Aug 5, 2024

tiansuo114 commented Aug 6, 2024

liangyuanpeng commented Aug 6, 2024 •

edited

Loading

liangyuanpeng commented Aug 6, 2024

XiShanYongYe-Chang commented Sep 20, 2024

RainbowMango left a comment

RainbowMango Sep 24, 2024

tiansuo114 Sep 24, 2024

RainbowMango Sep 24, 2024

tiansuo114 Sep 24, 2024

RainbowMango commented Sep 29, 2024

RainbowMango Sep 29, 2024

RainbowMango Sep 29, 2024

tiansuo114 Sep 29, 2024

tiansuo114 commented Oct 1, 2024

RainbowMango left a comment

karmada-bot commented Oct 8, 2024


		As Karmada is widely used in multi-cluster management, the current `karmadactl init` command has accumulated dozens of command-line parameters. This not only increases the learning curve for users but also reduces the convenience of usage. With the ongoing development of the community, the number and complexity of these parameters are likely to continue growing, further impacting the user experience.

		Additionally, during the deployment process of `karmadactl init`, multiple container images are needed. Users may want to download the corresponding images in advance to save deployment time, but currently, there is no easy way for users to obtain the list of required container images.


		Therefore, I think the configuration file can be designed to focus on these parts, structuring the YAML accordingly, and incorporating the existing configuration items into them. Additionally, similar to the commonly used `Extra Arg` field in Kubernetes structures, an extra field can be added to store other general fields. When designing the fields, it is advisable to refer to the field names in the kubeadm configuration file as much as possible, to facilitate user familiarity and quick adoption.

		After completing the design for reading config files in `karmada init`, we can extend the functionality of the `karmadactl config image list` command to read the required image configuration from the config file by reusing the config file reading method.

docs: add proposal of karmadactl init support config file #5277

docs: add proposal of karmadactl init support config file #5277

Conversation

tiansuo114 commented Jul 30, 2024 • edited Loading

codecov-commenter commented Jul 30, 2024 • edited Loading

Codecov Report

XiShanYongYe-Chang commented Jul 30, 2024

liangyuanpeng left a comment

Choose a reason for hiding this comment

tiansuo114 commented Aug 1, 2024

tiansuo114 commented Aug 2, 2024

karmada-bot commented Aug 2, 2024

zhzhuang-zju commented Aug 2, 2024

zhzhuang-zju commented Aug 5, 2024

tiansuo114 commented Aug 6, 2024

liangyuanpeng commented Aug 6, 2024 • edited Loading

liangyuanpeng commented Aug 6, 2024

XiShanYongYe-Chang commented Sep 20, 2024

RainbowMango left a comment

Choose a reason for hiding this comment

RainbowMango Sep 24, 2024

Choose a reason for hiding this comment

tiansuo114 Sep 24, 2024

Choose a reason for hiding this comment

RainbowMango Sep 24, 2024

Choose a reason for hiding this comment

tiansuo114 Sep 24, 2024

Choose a reason for hiding this comment

RainbowMango commented Sep 29, 2024

RainbowMango Sep 29, 2024

Choose a reason for hiding this comment

RainbowMango Sep 29, 2024

Choose a reason for hiding this comment

tiansuo114 Sep 29, 2024

Choose a reason for hiding this comment

tiansuo114 commented Oct 1, 2024

RainbowMango left a comment

Choose a reason for hiding this comment

karmada-bot commented Oct 8, 2024

tiansuo114 commented Jul 30, 2024 •

edited

Loading

codecov-commenter commented Jul 30, 2024 •

edited

Loading

liangyuanpeng commented Aug 6, 2024 •

edited

Loading