Skip to content

Commit

Permalink
update karmadactl command document
Browse files Browse the repository at this point in the history
Signed-off-by: changzhen <[email protected]>
  • Loading branch information
XiShanYongYe-Chang committed Feb 29, 2024
1 parent 07bc3ec commit 27553a3
Show file tree
Hide file tree
Showing 7 changed files with 33 additions and 28 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -60,12 +60,12 @@ title: Karmadactl Commands
will first check for an exact match on TYPE and NAME_PREFIX. If no such resource exists, it will output details for every resource that has a name prefixed with NAME_PREFIX.
* [karmadactl exec](karmadactl_exec.md) - Execute a command in a container in a cluster.
* [karmadactl interpret](karmadactl_interpret.md) - Validate, test and edit interpreter customization before applying it to the control plane.

1. Validate the ResourceInterpreterCustomization configuration as per API schema
and try to load the scripts for syntax check.

2. Run the rules locally and test if the result is expected. Similar to the dry run.

1. Validate the ResourceInterpreterCustomization configuration as per API schema
and try to load the scripts for syntax check.
2. Run the rules locally and test if the result is expected. Similar to the dry run.
1. Edit customization. Similar to the kubectl edit.
* [karmadactl logs](karmadactl_logs.md) - Print the logs for a container in a pod in a member cluster or specified resource. If the pod has only one container, the container name is optional.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ karmadactl init
--crds string Karmada crds resource.(local file e.g. --crds /root/crds.tar.gz) (default "https://github.com/karmada-io/karmada/releases/download/v0.0.0-master/crds.tar.gz")
--etcd-data string etcd data path,valid in hostPath mode. (default "/var/lib/karmada-etcd")
--etcd-image string etcd image
--etcd-init-image string etcd init container image (default "docker.io/alpine:3.15.1")
--etcd-init-image string etcd init container image (default "docker.io/alpine:3.19.1")
--etcd-node-selector-labels string etcd pod select the labels of the node. valid in hostPath mode ( e.g. --etcd-node-selector-labels karmada.io/etcd=true)
--etcd-pvc-size string etcd data path,valid in pvc mode. (default "5Gi")
--etcd-replicas int32 etcd replica set, cluster 3,5...singular (default 1)
Expand Down Expand Up @@ -95,7 +95,7 @@ karmadactl init
--karmada-webhook-replicas int32 Karmada webhook replica set (default 1)
--kube-image-mirror-country string Country code of the kube image registry to be used. For Chinese mainland users, set it to cn
--kube-image-registry string Kube image registry. For Chinese mainland users, you may use local gcr.io mirrors such as registry.cn-hangzhou.aliyuncs.com/google_containers to override default kube image registry
--kube-image-tag string Choose a specific Kubernetes version for the control plane. (default "v1.25.4")
--kube-image-tag string Choose a specific Kubernetes version for the control plane. (default "v1.26.12")
--kubeconfig string absolute path to the kubeconfig file
-n, --namespace string Kubernetes namespace (default "karmada-system")
-p, --port int32 Karmada apiserver service node port (default 32443)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@ Validate, test and edit interpreter customization before applying it to the cont
### Synopsis

Validate, test and edit interpreter customization before applying it to the control plane.

1. Validate the ResourceInterpreterCustomization configuration as per API schema
and try to load the scripts for syntax check.

2. Run the rules locally and test if the result is expected. Similar to the dry run.

1. Validate the ResourceInterpreterCustomization configuration as per API schema
and try to load the scripts for syntax check.
2. Run the rules locally and test if the result is expected. Similar to the dry run.
1. Edit customization. Similar to the kubectl edit.

```
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
for f in `find ./ -name *".md"`
do
wc -w $f
done;

Original file line number Diff line number Diff line change
Expand Up @@ -60,12 +60,12 @@ title: Karmadactl Commands
will first check for an exact match on TYPE and NAME_PREFIX. If no such resource exists, it will output details for every resource that has a name prefixed with NAME_PREFIX.
* [karmadactl exec](karmadactl_exec.md) - Execute a command in a container in a cluster.
* [karmadactl interpret](karmadactl_interpret.md) - Validate, test and edit interpreter customization before applying it to the control plane.

1. Validate the ResourceInterpreterCustomization configuration as per API schema
and try to load the scripts for syntax check.

2. Run the rules locally and test if the result is expected. Similar to the dry run.

1. Validate the ResourceInterpreterCustomization configuration as per API schema
and try to load the scripts for syntax check.
2. Run the rules locally and test if the result is expected. Similar to the dry run.
1. Edit customization. Similar to the kubectl edit.
* [karmadactl logs](karmadactl_logs.md) - Print the logs for a container in a pod in a member cluster or specified resource. If the pod has only one container, the container name is optional.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ karmadactl init
--crds string Karmada crds resource.(local file e.g. --crds /root/crds.tar.gz) (default "https://github.com/karmada-io/karmada/releases/download/v0.0.0-master/crds.tar.gz")
--etcd-data string etcd data path,valid in hostPath mode. (default "/var/lib/karmada-etcd")
--etcd-image string etcd image
--etcd-init-image string etcd init container image (default "docker.io/alpine:3.15.1")
--etcd-init-image string etcd init container image (default "docker.io/alpine:3.19.1")
--etcd-node-selector-labels string etcd pod select the labels of the node. valid in hostPath mode ( e.g. --etcd-node-selector-labels karmada.io/etcd=true)
--etcd-pvc-size string etcd data path,valid in pvc mode. (default "5Gi")
--etcd-replicas int32 etcd replica set, cluster 3,5...singular (default 1)
Expand Down Expand Up @@ -95,7 +95,7 @@ karmadactl init
--karmada-webhook-replicas int32 Karmada webhook replica set (default 1)
--kube-image-mirror-country string Country code of the kube image registry to be used. For Chinese mainland users, set it to cn
--kube-image-registry string Kube image registry. For Chinese mainland users, you may use local gcr.io mirrors such as registry.cn-hangzhou.aliyuncs.com/google_containers to override default kube image registry
--kube-image-tag string Choose a specific Kubernetes version for the control plane. (default "v1.25.4")
--kube-image-tag string Choose a specific Kubernetes version for the control plane. (default "v1.26.12")
--kubeconfig string absolute path to the kubeconfig file
-n, --namespace string Kubernetes namespace (default "karmada-system")
-p, --port int32 Karmada apiserver service node port (default 32443)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@ Validate, test and edit interpreter customization before applying it to the cont
### Synopsis

Validate, test and edit interpreter customization before applying it to the control plane.

1. Validate the ResourceInterpreterCustomization configuration as per API schema
and try to load the scripts for syntax check.

2. Run the rules locally and test if the result is expected. Similar to the dry run.

1. Validate the ResourceInterpreterCustomization configuration as per API schema
and try to load the scripts for syntax check.
2. Run the rules locally and test if the result is expected. Similar to the dry run.
1. Edit customization. Similar to the kubectl edit.

```
Expand Down

0 comments on commit 27553a3

Please sign in to comment.