Skip to content

docs - fixed configuration file priority over CLI flags in karmadactl… - #1037

Open
apoorvslst wants to merge 1 commit into
karmada-io:mainfrom
apoorvslst:fix/issue-925-config-priority
Open

apoorvslst wants to merge 1 commit into
karmada-io:mainfrom
apoorvslst:fix/issue-925-config-priority

Conversation

@apoorvslst

Copy link
Copy Markdown

What type of PR is this?
/kind documentation

What this PR does / why we need it:
Fixes a doc error for karmadactl init. The docs used to say that CLI flags override the config file, but it's actually the other way around (the config file wins). This updates the docs to match the actual code behavior and the original design proposal.

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

Special notes for your reviewer:
(You can just leave this blank or delete this line)

@karmada-bot karmada-bot added the kind/documentation Categorizes issue or PR as related to documentation. label Jul 9, 2026
@karmada-bot
karmada-bot requested review from Poor12 and Tingtal July 9, 2026 19:17
@karmada-bot

Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign rainbowmango for approval. For more information see the Code Review Process.

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

Details 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

Copy link
Copy Markdown
Contributor

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

@karmada-bot karmada-bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Jul 9, 2026

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Code Review

This pull request updates several versions of the karmadactl-config.v1alpha1.md documentation to clarify that configuration file values take precedence over command-line flags. The reviewer noted that the example configuration path used, apiServer.replicas, is incorrect and should be updated to components.karmadaAPIServer.replicas to prevent user confusion.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment thread docs/reference/karmadactl/karmadactl-config.v1alpha1.md Outdated
Comment thread versioned_docs/version-v1.18/reference/karmadactl/karmadactl-config.v1alpha1.md Outdated
Comment thread versioned_docs/version-v1.17/reference/karmadactl/karmadactl-config.v1alpha1.md Outdated
Comment thread versioned_docs/version-v1.16/reference/karmadactl/karmadactl-config.v1alpha1.md Outdated
Comment thread versioned_docs/version-v1.15/reference/karmadactl/karmadactl-config.v1alpha1.md Outdated
Comment thread versioned_docs/version-v1.14/reference/karmadactl/karmadactl-config.v1alpha1.md Outdated
Comment thread versioned_docs/version-v1.13/reference/karmadactl/karmadactl-config.v1alpha1.md Outdated
@apoorvslst
apoorvslst force-pushed the fix/issue-925-config-priority branch from f5294e2 to af65c47 Compare July 9, 2026 19:27
…init

Signed-off-by: apoorvslst <apoorvarceus13012007@gmail.com>
@apoorvslst
apoorvslst force-pushed the fix/issue-925-config-priority branch from 06925e0 to 1861ccb Compare July 9, 2026 19:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

kind/documentation Categorizes issue or PR as related to documentation. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

The priority of configuration files and command lines in Karmadactl init.

2 participants