Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

add karmadactl init --config & karmadactl config documents #690

Merged
merged 1 commit into from
Oct 29, 2024
Merged

add karmadactl init --config & karmadactl config documents #690

merged 1 commit into from
Oct 29, 2024

Conversation

tiansuo114
Copy link
Contributor

What type of PR is this?

/kind feature
What this PR does / why we need it:
The purpose of this pr is to make changes to and supplement the content of the document with the modifications in the issue
Which issue(s) this PR fixes:
Fixes #

Special notes for your reviewer:

@karmada-bot karmada-bot added the kind/feature Categorizes issue or PR as related to a new feature. label Sep 21, 2024
@karmada-bot
Copy link
Collaborator

Welcome @tiansuo114! It looks like this is your first PR to karmada-io/website 🎉

@karmada-bot karmada-bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Sep 21, 2024
@tiansuo114 tiansuo114 mentioned this pull request Sep 21, 2024
Closed
7 tasks
@liangyuanpeng
Copy link

/hold
pending for karmada-io/karmada#5277

@karmada-bot karmada-bot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Sep 23, 2024
@karmada-bot karmada-bot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Oct 22, 2024
@karmada-bot karmada-bot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Oct 23, 2024
@tiansuo114
Copy link
Contributor Author

@liangyuanpeng
Mentor, where do you think it would be a better choice to place the supplementary configuration file documentation?
I observed that in the Reference sidebar, there are two options: Command line tool (karmadactl) and karmada API. Currently, I have placed the documentation for this configuration file under Command line tool (karmadactl). Do you think this is the better choice, or would it be better placed elsewhere?

@liangyuanpeng
Copy link

liangyuanpeng commented Oct 24, 2024 •
edited
Loading

I recommend to add to https://karmada.io/docs/installation, WDYT? @XiShanYongYe-Chang

RainbowMango
RainbowMango reviewed Oct 26, 2024
View reviewed changes
Copy link
Member

@RainbowMango RainbowMango left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/assign

@tiansuo114
Copy link
Contributor Author

/hold cancel

The karmada-io/karmada#5277 has been merged and the pr should now be able to continue the review and merge process

@karmada-bot karmada-bot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Oct 26, 2024
RainbowMango
RainbowMango reviewed Oct 26, 2024
View reviewed changes
docs/installation/installation.md Outdated Show resolved Hide resolved
docs/installation/installation.md Outdated Show resolved Hide resolved
docs/installation/installation.md Outdated Show resolved Hide resolved
docs/installation/installation.md Outdated Show resolved Hide resolved
@tiansuo114 tiansuo114 force-pushed the test branch 2 times, most recently from 66edb2e to dd28561 Compare October 27, 2024 01:15
RainbowMango
RainbowMango reviewed Oct 28, 2024
View reviewed changes
docs/installation/install-with-configuration-file.md Outdated Show resolved Hide resolved
sidebars.js Outdated Show resolved Hide resolved
@tiansuo114 tiansuo114 force-pushed the test branch 2 times, most recently from 560c7e6 to 79d6d73 Compare October 28, 2024 11:21
@RainbowMango
Copy link
Member

Hi Seems the comments mentioned above (#690 (comment)) haven't been addressed.

RainbowMango
RainbowMango reviewed Oct 28, 2024
View reviewed changes
docs/installation/installation.md Outdated
Comment on lines 237 to 247
| Component | Default Image Registry + Name | Default Tag |
| --------------------------------- | ------------------------------------------------ |-----------------------------|
| **Karmada API Server** | `registry.k8s.io/kube-apiserver` | `v1.29.6` (current release) |
| **Karmada Aggregated API Server** | `docker.io/karmada/karmada-aggregated-apiserver` | `v${karmadaGitVersion}` |
| **Kube Controller Manager** | `registry.k8s.io/kube-controller-manager` | `v1.30.4` (current release) |
| **Karmada Controller Manager** | `docker.io/karmada/karmada-controller-manager` | `v${karmadaGitVersion}` |
| **Karmada Scheduler** | `docker.io/karmada/karmada-scheduler` | `v${karmadaGitVersion}` |
| **Karmada Webhook** | `docker.io/karmada/karmada-webhook` | `v${karmadaGitVersion}` |
| **Etcd (Local)** | `registry.k8s.io/etcd` | `latest` (current release) |
| **Etcd Init Image (Local)** | `docker.io/alpine` | `3.19.1` (current release) |
| **Karmada Agent** | `docker.io/karmada/karmada-agent` | `v${karmadaGitVersion}` |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See the comments #690 (comment).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See the comments #690 (comment).

Yes, I accidentally missed that change 😭. Now, that part has been updated in the documentation, and I look forward to further progress.

@tiansuo114
add karmadactl init --config & KarmadaInitConfig v1alpha1 documents
1731e08 
Signed-off-by: tiansuo114 <1729765480@qq.com>
RainbowMango
RainbowMango approved these changes Oct 29, 2024
View reviewed changes
Copy link
Member

@RainbowMango RainbowMango left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm
/approve
Thanks.

@karmada-bot karmada-bot added the lgtm Indicates that a PR is ready to be merged. label Oct 29, 2024
@karmada-bot
Copy link
Collaborator

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

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

@karmada-bot karmada-bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Oct 29, 2024
@karmada-bot karmada-bot merged commit fccf748 into karmada-io:main Oct 29, 2024
7 checks passed
@tiansuo114 tiansuo114 mentioned this pull request Oct 29, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@RainbowMango RainbowMango RainbowMango approved these changes

@Poor12 Poor12 Awaiting requested review from Poor12

@Tingtal Tingtal Awaiting requested review from Tingtal

Assignees

@RainbowMango RainbowMango

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. kind/feature Categorizes issue or PR as related to a new feature. lgtm Indicates that a PR is ready to be merged. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@tiansuo114 @karmada-bot @liangyuanpeng @RainbowMango