Skip to content

Commit 9a0f646

Browse files
authored
Merge pull request #4367 from zhzhuang-zju/document
update operator/README.md
2 parents 17e7119 + 4c9f69b commit 9a0f646

File tree

1 file changed

+17
-5
lines changed

1 file changed

+17
-5
lines changed

operator/README.md

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,13 @@ metadata:
8282
EOF
8383
```
8484

85+
You can also create a Karmada CR directly using the sample provided by the Karmada operator.
86+
87+
```shell
88+
kubectl create namespace test
89+
kubectl apply -f operator/config/samples/karmada.yaml
90+
```
91+
8592
Wait for around 40 seconds, and the pods of the Karmada components will be running in the same namespace as the Karmada CR.
8693

8794
```shell
@@ -91,10 +98,19 @@ karmada-demo-apiserver-55968d9f8c-mp8hf 1/1 Running 0
9198
karmada-demo-controller-manager-64455f7fd4-stls6 1/1 Running 0 5s
9299
karmada-demo-etcd-0 1/1 Running 0 37s
93100
karmada-demo-kube-controller-manager-584f978bbd-fftwq 1/1 Running 0 5s
101+
karmada-demo-metrics-adapter-57cb5f56b6-4vwk2 1/1 Running 0 5s
102+
karmada-demo-metrics-adapter-57cb5f56b6-zbhjk 1/1 Running 0 5s
94103
karmada-demo-scheduler-6d77b7547-hgz8n 1/1 Running 0 5s
95104
karmada-demo-webhook-6f5944f5d8-bpkqz 1/1 Running 0 5s
96105
```
97106

107+
### Generate kubeconfig for karmada
108+
109+
```shell
110+
kubectl get secret -n test karmada-demo-admin-config -o jsonpath={.data.kubeconfig} | base64 -d > ~/.kube/karmada-apiserver.config
111+
export KUBECONFIG=~/.kube/karmada-apiserver.config
112+
```
113+
98114
> **Tip**:
99115
>
100116
> If no `spec.hostCluster.secretRef` is specified in CR, the Karmada instance will be installed in the cluster where `karmada-operator` is located.
@@ -233,15 +249,11 @@ metadata:
233249
namespace: test
234250
spec:
235251
components:
236-
KarmadaDescheduler: {}
252+
karmadaDescheduler: {}
237253
```
238254

239255
If you want to install with the defaults, simply define an empty struct for `descheduler`.
240256

241-
> **Tip**:
242-
>
243-
> Now, we only support installing the `descheduler` addon.
244-
245257
## Contributing
246258

247259
The `karmada/operator` repo is part of Karmada from 1.5 onwards. If you're interested in

0 commit comments

Comments
 (0)