search

SovereignCloudStack / cluster-stack-operator

The SCS Cluster Stack Operator takes care of life cycle management, configuration and provider specific tasks of Kubernetes clusters created with SCS Cluster Stacks
https://scs.community/
Apache License 2.0
13 stars 3 forks source link

support aliases for objects #152

Closed kranurag7 closed 4 months ago

kranurag7 commented 5 months ago

/kind feature

Describe the solution you'd like [A clear and concise description of what you want to happen.]

We as of now don't have any aliases for our types (clusterstack, clusterstackrelease and clusteraddon) as of now. This issue is a discussion where we can agree on having a common alias and use the same going forward with kubectl, k9s etc.

We have these three types as of now. 

clusterstack.x-k8s.io                      ClusterAddon                              v1alpha1        Namespaced        18m 
clusterstack.x-k8s.io                      ClusterStackRelease                       v1alpha1        Namespaced        18m 
clusterstack.x-k8s.io                      ClusterStack                              v1alpha1        Namespaced        18m

From my end, I am proposing the following aliases: csk for clusterstack cskr for clusterstackrelease caddons for clusteraddons

Anything else you would like to add: [Miscellaneous information that will assist in solving the issue.]

This is an open discussion.

// cc @janiskemper @guettli @michal-gubricky @chess-knight @matofeder

guettli commented 5 months ago

looks good. But I would use caddon.

janiskemper commented 5 months ago

I prefer "cs" for clusterstack. Why do you say "csk"?

chess-knight commented 5 months ago

I prefer "cs" for clusterstack. Why do you say "csk"?

"cs" means ComponentStatus:

$ kubectl get cs
Warning: v1 ComponentStatus is deprecated in v1.19+
NAME                 STATUS    MESSAGE   ERROR
controller-manager   Healthy   ok        
scheduler            Healthy   ok        
etcd-0               Healthy   ok

"csr" is CertificateSigningRequest

chess-knight commented 5 months ago

CAPI has "cl" for the Cluster, so maybe cls and clsr?

kranurag7 commented 5 months ago

CAPI has "cl" for the Cluster, so maybe cls and clsr?

I'll prefer this over csk and cskr I hope these are not conflicting with any widely used OSS project.

kranurag7 commented 5 months ago

We can use GitHub search to find conflicting names.

csk: no conflicts (ref: https://github.com/search?q=%22shortName%3Dcsk%22+&type=code) cls: clusternet project uses it (ref: https://github.com/search?q=%22shortName%3Dcls%22+&type=code)

chess-knight commented 5 months ago

We can use GitHub search to find conflicting names.

csk: no conflicts (ref: https://github.com/search?q=%22shortName%3Dcsk%22+&type=code) cls: clusternet project uses it (ref: https://github.com/search?q=%22shortName%3Dcls%22+&type=code)

Then, csk looks good to me