Introduce short names for Knative resources

[steren]

/area API

I suggest to introduce short names for the Knative resources ("Service", "Revision", "Configuration", "Route") for the following reasons:

• short names of 2-3 letters are faster to type than names like configurations
• the qualifier for "Service" is services.serving.knative.dev, which is long to type when using kubectl

Kubernetes allows to define short names. See here for an example.

Let's use this issue to suggest short names. We could use some user research to validate them if we need. CC @tliberman

[grantr]

Some obvious ones to start off:

• rev
• cfg
• svc (though ksvc might be less confusing)
• rt

[steren]

I was about to suggest the same.

In addition to cfg, I would suggest to also add config

[enisoc]

FYI svc is already a short name for the core Service. I tried adding svc as the short name of a CRD, and surprisingly the CRD now takes precedence over the core resource, which could be quite confusing and disruptive to kubectl users. Even if the precedence had gone the other way, it still wouldn't make sense to use svc since it would defeat the purpose of disambiguating from the core Service.

I do like the idea to add short names though.

[steren]

Yes, this is why @grantr suggested ksvc too.

Also, this is pattern we could use for all Knative resource short names: krev, kcfg, ksvc, krt. It reduces readability, but prevents current and future collisions.

[imikushin]

Should obviously all start with k

[steren]

I can read in another comment that the short names do not resolve to fully qualified names, and thus kservice is conflicting with service. We agree this is a but ob the Kubernetes side. What's the next step here?
@n3wscott Is there an existing issue tracking the problem?

[n3wscott]

I did not make a new issue for it. I just documented it in this issue #1397 (comment)

[n3wscott]

Update: it looks like upstream kubectl fixes the issue I have mentioned.

Current:

⦿ kubectl get svc
NAME                              TYPE        CLUSTER-IP      EXTERNAL-IP   PORT(S)   AGE
github-flow                       ClusterIP   10.19.245.231   <none>        80/TCP    8d
github-flow-channel               ClusterIP   10.19.252.196   <none>        80/TCP    7d
github-n3wscott-kopond-rcvadptr   ClusterIP   10.19.241.219   <none>        80/TCP    7d
kubernetes                        ClusterIP   10.19.240.1     <none>        443/TCP   38d
legit                             ClusterIP   10.19.255.95    <none>        80/TCP    8d
⦿ kubectl get ksvc
NAME                              TYPE        CLUSTER-IP      EXTERNAL-IP   PORT(S)   AGE
github-flow                       ClusterIP   10.19.245.231   <none>        80/TCP    8d
github-flow-channel               ClusterIP   10.19.252.196   <none>        80/TCP    7d
github-n3wscott-kopond-rcvadptr   ClusterIP   10.19.241.219   <none>        80/TCP    7d
kubernetes                        ClusterIP   10.19.240.1     <none>        443/TCP   38d
legit                             ClusterIP   10.19.255.95    <none>        80/TCP    8d

Updated:

⦿ ./_output/bin/kubectl get svc
NAME                              TYPE        CLUSTER-IP      EXTERNAL-IP   PORT(S)   AGE
github-flow                       ClusterIP   10.19.245.231   <none>        80/TCP    8d
github-flow-channel               ClusterIP   10.19.252.196   <none>        80/TCP    7d
github-n3wscott-kopond-rcvadptr   ClusterIP   10.19.241.219   <none>        80/TCP    7d
kubernetes                        ClusterIP   10.19.240.1     <none>        443/TCP   38d
legit                             ClusterIP   10.19.255.95    <none>        80/TCP    8d
⦿ ./_output/bin/kubectl get ksvc
NAME                              CREATED AT
github-n3wscott-kopond-rcvadptr   7d
legit                             8d