Skip to content

update karmadactl promote doc #996

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

Open
tessapham wants to merge 2 commits into
base: main
Choose a base branch
from
Open

update karmadactl promote doc #996

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
811d94a
update karmadactl promote doc
tessapham Apr 14, 2026
5b867d4
update to match source
tessapham Apr 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/administrator/migration/promote-legacy-workload.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Promote legacy workload
---

Assume that there is a member cluster where a workload (like Deployment) is deployed but not managed by Karmada, we can use the `karmadactl promote` command to let Karmada take over this workload directly and not to cause its pods to restart.
Assuming that there is a member cluster where a workload (like Deployment) is deployed but not managed by Karmada, we can use the `karmadactl promote` command to let Karmada take over this workload directly and not cause its pods to restart.

## Example

Expand Down Expand Up @@ -55,6 +55,6 @@ Most steps are same as those for clusters in `Push` mode. Only the flags of the
karmadactl promote deployment nginx -n default -C cluster1 --cluster-kubeconfig=<CLUSTER_KUBECONFIG_PATH>
```

For more flags and example about the command, you can use `karmadactl promote --help`.
For more flags and examples for the command, you can use `karmadactl promote --help`.

> Note: As the version upgrade of resources in Kubernetes is in progress, the apiserver of Karmada control plane cloud be different from member clusters. To avoid compatibility issues, you can specify the GVK of a resource, such as replacing `deployment` with `deployment.v1.apps`.
> Note: During a version upgrade of a resource in Kubernetes, the API versions in Karmada control plane could be different from those in the member clusters. To avoid compatibility issues, you can specify the GVK of a resource, such as replacing `deployment` with `deployment.v1.apps`.
8 changes: 4 additions & 4 deletions docs/reference/karmadactl/karmadactl-commands/karmadactl_promote.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@
title: karmadactl promote
---

Promote resources from legacy clusters to Karmada control plane
Promote resources from legacy clusters to Karmada control plane.

@zhzhuang-zju zhzhuang-zju Apr 15, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Hi @tessapham, thank you for the corrections you’ve made!

I have a small point to note: the files under the reference directory are automatically generated from the code in the Karmada repo. For details, you can refer to:
https://karmada.io/docs/developers/document-releasing#update-reference-documentsmanually

Therefore, our usual practice is to modify the code in the Karmada repo first, then sync the changes to the website repo.

I noticed that some changes in karmadactl_promote.md are not covered by karmada-io/karmada#7391, so they will be overwritten in the next automatic synchronization.

It is recommended that you either remove these uncovered changes, or make the modifications in the Karmada repo and then sync them to the website repo.

@zhzhuang-zju zhzhuang-zju Apr 15, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Sorry, I missed your comment #996 (comment) before, but there are still some uncovered changes from the source. Please take a look.

@tessapham tessapham Apr 15, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Thanks @zhzhuang-zju for reviewing – I'll revise this PR! Curious - is there a script to run to sync the changes from the source repo to the website repo?

@zhzhuang-zju zhzhuang-zju Apr 16, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Yeah, good question! Not yet; we need to manually run the tools to sync.

@RainbowMango RainbowMango Apr 16, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Hey Tessa, yes, here is the doc for releasing the documentation: https://karmada.io/docs/developers/document-releasing.

By the way, I appreciate your effort on this. Please feel free to open PRs once you have found anything needed.

@zhzhuang-zju zhzhuang-zju May 20, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

is there a script to run to sync the changes from the source repo to the website repo?

I think we’ll have one soon. #1010 will automate the corresponding process.


### Synopsis

Promote resources from legacy clusters to Karmada control plane. Requires the cluster has been joined or registered.
Promote resources from legacy clusters to the Karmada control plane. Requires the cluster to have been joined or registered.

If the resource already exists in Karmada control plane, please edit PropagationPolicy and OverridePolicy to propagate it.
If the resource already exists in the Karmada control plane, please edit PropagationPolicy and OverridePolicy to propagate it.

```
karmadactl promote <RESOURCE_TYPE> <RESOURCE_NAME> -n <NAME_SPACE> -C <CLUSTER_NAME>
Expand Down Expand Up @@ -43,7 +43,7 @@ karmadactl promote <RESOURCE_TYPE> <RESOURCE_NAME> -n <NAME_SPACE> -C <CLUSTER_N

```
--auto-create-policy Automatically create a PropagationPolicy for namespace-scoped resources or create a ClusterPropagationPolicy for cluster-scoped resources. (default true)
-C, --cluster string the name of legacy cluster (eg -C=member1)
-C, --cluster string Name of the legacy cluster (e.g. -C=member1)
--cluster-context string Context name of legacy cluster in kubeconfig. Only works when there are multiple contexts in the kubeconfig.
--cluster-kubeconfig string Path of the legacy cluster's kubeconfig.
-d, --dependencies Promote resource with its dependencies automatically, default to false
Expand Down
8 changes: 4 additions & 4 deletions ...ent-docs/current/reference/karmadactl/karmadactl-commands/karmadactl_promote.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@
title: karmadactl promote
---

Promote resources from legacy clusters to Karmada control plane
Promote resources from legacy clusters to Karmada control plane.

### Synopsis

Promote resources from legacy clusters to Karmada control plane. Requires the cluster has been joined or registered.
Promote resources from legacy clusters to the Karmada control plane. Requires the cluster to have been joined or registered.

If the resource already exists in Karmada control plane, please edit PropagationPolicy and OverridePolicy to propagate it.
If the resource already exists in the Karmada control plane, please edit PropagationPolicy and OverridePolicy to propagate it.

```
karmadactl promote <RESOURCE_TYPE> <RESOURCE_NAME> -n <NAME_SPACE> -C <CLUSTER_NAME>
Expand Down Expand Up @@ -43,7 +43,7 @@ karmadactl promote <RESOURCE_TYPE> <RESOURCE_NAME> -n <NAME_SPACE> -C <CLUSTER_N

```
--auto-create-policy Automatically create a PropagationPolicy for namespace-scoped resources or create a ClusterPropagationPolicy for cluster-scoped resources. (default true)
-C, --cluster string the name of legacy cluster (eg -C=member1)
-C, --cluster string Name of the legacy cluster (e.g. -C=member1)
--cluster-context string Context name of legacy cluster in kubeconfig. Only works when there are multiple contexts in the kubeconfig.
--cluster-kubeconfig string Path of the legacy cluster's kubeconfig.
-d, --dependencies Promote resource with its dependencies automatically, default to false
Expand Down
Loading