Skip to content

docs: fix the application failover examples that the API rejects - #1055

Open
prawalpokharel wants to merge 1 commit into
karmada-io:mainfrom
prawalpokharel:fix-application-failover-purge-modes
Open

prawalpokharel wants to merge 1 commit into
karmada-io:mainfrom
prawalpokharel:fix-application-failover-purge-modes

Conversation

@prawalpokharel

Copy link
Copy Markdown

What type of PR is this?

/kind documentation

What this PR does / why we need it:

Some examples in the application failover guide (v1.19 and next) don't pass the API's validation:

  • The PurgeMode values Immediately and Graciously were removed in v1.19 (Remove deprecated PurgeMode values karmada#7792), but the guide still lists them and uses them in two examples. This replaces them with Directly and Gracefully, the names the cluster failover guide and the v1.18 to v1.19 upgrade notes already use.
  • The FlinkDeployment example, and the nginx example in the Chinese guide, set failover.application without propagateDeps: true, which the policy webhook rejects. This adds it, as the English nginx example already has.

On Karmada master (a17d6e0, and v1.19.0 has the same checks), applying policies like these with kubectl apply -f - gives:

The PropagationPolicy "graciously" is invalid: spec.failover.application.purgeMode: Unsupported value: "Graciously": supported values: "Directly", "Gracefully", "Never"

Error from server (Forbidden): error when creating "STDIN": admission webhook "propagationpolicy.karmada.io" denied the request: spec.propagateDeps: Invalid value: false: application failover is set, propagateDeps must be true

The stateful-injection restriction now says Directly, matching pkg/controllers/binding/common.go on master. The v1.18 and older pages keep the old PurgeMode values, since those releases still accept them.

Which issue(s) this PR fixes:

None.

Special notes for your reviewer:

#1005 restructures the next copy of this page and moves the injection restriction into a note, so one changed line overlaps with it. Its new prerequisites table and note also still say Graciously and Immediately. If you'd rather fix the next copy there, I can drop the docs/ and i18n/.../current/ changes.

The v1.14 to v1.18 pages have the same missing propagateDeps in the FlinkDeployment example, and in the Chinese nginx example. I can add those here or in a follow-up.

The PurgeMode values Immediately and Graciously were removed in v1.19,
but the application failover guide for v1.19 and for the next release
still listed them and used them in its examples. Replace them with
Directly and Gracefully, as the cluster failover guide and the v1.18
to v1.19 upgrade notes already do.

The FlinkDeployment example, and the nginx example in the Chinese
guide, also set failover.application without propagateDeps, which the
policy webhook rejects. Add propagateDeps: true, as the English nginx
example already has.

Signed-off-by: Prawal Pokharel <57414987+prawalpokharel@users.noreply.github.com>
@karmada-bot karmada-bot added the kind/documentation Categorizes issue or PR as related to documentation. label Nov 17, 2026
@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 @prawalpokharel! 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 Nov 17, 2026
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.

2 participants