weaveworks / gitopssets-controller

Manages the GitOpsSet CRDs.
Apache License 2.0
9 stars 5 forks source link

Add shortName alias for GitOpsSets #21

Closed bigkevmcd closed 1 year ago

bigkevmcd commented 1 year ago

This configures the shortName to be gs which means that you can do kubectl get gs.

gss might be more mnemonic (or might not).

foot commented 1 year ago

gss might be more mnemonic (or might not).

cert-manager / capi nab both

certificaterequests            cr,crs       cert-manager.io/v1                         true         CertificateRequest
certificates                   cert,certs   cert-manager.io/v1                         true         Certificate
machinehealthchecks            mhc,mhcs     cluster.x-k8s.io/v1beta1                   true         MachineHealthCheck

flux goes for singular, except for kustomizations

helmreleases                   hr           helm.toolkit.fluxcd.io/v2beta1             true         HelmRelease
terraforms                     tf           infra.contrib.fluxcd.io/v1alpha1           true         Terraform
kustomizations                 ks           kustomize.toolkit.fluxcd.io/v1beta2        true         Kustomization
alerts                                      notification.toolkit.fluxcd.io/v1beta1     true         Alert
providers                                   notification.toolkit.fluxcd.io/v1beta1     true         Provider
receivers                                   notification.toolkit.fluxcd.io/v1beta1     true         Receiver
buckets                                     source.toolkit.fluxcd.io/v1beta2           true         Bucket
gitrepositories                gitrepo      source.toolkit.fluxcd.io/v1beta2           true         GitRepository
helmcharts                     hc           source.toolkit.fluxcd.io/v1beta2           true         HelmChart
helmrepositories               helmrepo     source.toolkit.fluxcd.io/v1beta2           true         HelmRepository
ocirepositories                ocirepo      source.toolkit.fluxcd.io/v1beta2           true         OCIRepository
bigkevmcd commented 1 year ago

@foot I put this up mostly to trigger discussion about what the right thing shortName is :-)

is gs right? should we include other things gitset ?

foot commented 1 year ago

is gs right? should we include other things gitset ?

I like gs! After doing a lot of get ks, get hr now get gs feels very natural/snappy and I've done it a couple of times and have been surprised it doesn't work. Having to type out gitrepo instead of gr feels so slow. But there is probably a balance here, I/users can also set up bash alias etc themselves ofc..

Middlegrounds