Skip to content
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.

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

Operator docs may require enhancement #3963

Open
Vacant2333 opened this issue Aug 21, 2023 · 8 comments
Open

Operator docs may require enhancement #3963

Vacant2333 opened this issue Aug 21, 2023 · 8 comments
Assignees
Labels
kind/feature Categorizes issue or PR as related to a new feature.

Comments

@Vacant2333
Copy link
Contributor

What would you like to be added:
Operator docs may require enhancement
https://github.com/karmada-io/karmada/blob/master/operator/README.md

Why is this needed:
for example:
we can add the the usage to get the karmada-apiserver's kubeconfig
kubectl get secret -n {namespace} karmada-demo-admin-config -o jsonpath='{.data.config}' | base64 --decode > kubeconfig.yaml

@Vacant2333 Vacant2333 added the kind/feature Categorizes issue or PR as related to a new feature. label Aug 21, 2023
@RainbowMango
Copy link
Member

Sounds good to me. @calvin0327 can you help to confirm that?

@calvin0327
Copy link

calvin0327 commented Aug 22, 2023

@RainbowMango That's sure.

/assign

@calvin0327
Copy link

calvin0327 commented Aug 22, 2023

@Vacant2333 Thanks pointing this, there is a better way to get the karmada config:

kubectl get secret -n <KARMADA_NAMESPACE> $(kubectl get karmada -n <KARMADA_NAMESPACE> <KARMADA_NAME> -ojsonpath='{.status.secretRef.name}') -ojsonpath='{.data.config}' | base64 -d > config

@Vacant2333
Copy link
Contributor Author

@Vacant2333 Thanks pointing this, there is a better way to get the karmada config:

kubectl get secret -n <KARMADA_NAMESPACE> $(kubectl get karmada -n <KARMADA_NAMESPACE> <KARMADA_NAME> -ojsonpath='{.status.secretRef.name}') -ojsonpath='{.data.config}' | base64 -d > config

yes its better,and is there something we can add to the file too?

@RainbowMango
Copy link
Member

@calvin0327, @Vacant2333 might want to help on this :)

@Vacant2333
Copy link
Contributor Author

@calvin0327, @Vacant2333 might want to help on this :)

ah no, I mean if there something can update to this file too that I didnt mention. And it's ok Calvin to do this

@calvin0327
Copy link

@calvin0327, @Vacant2333 might want to help on this :)

ah no, I mean if there something can update to this file too that I didnt mention. And it's ok Calvin to do this

Except for this, I didn't think of anything else to update to the README.

@Vacant2333
Copy link
Contributor Author

@calvin0327, @Vacant2333 might want to help on this :)

ah no, I mean if there something can update to this file too that I didnt mention. And it's ok Calvin to do this

Except for this, I didn't think of anything else to update to the README.

we may can add a example for spec.hostCluster.secretRef and some links to the docs(component), its a suggestion, im not sure if we need

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/feature Categorizes issue or PR as related to a new feature.
Projects
None yet
Development

No branches or pull requests

3 participants