This is an automated email from the ASF dual-hosted git repository.
villebro pushed a commit to branch main
in repository
https://gitbox.apache.org/repos/asf/superset-kubernetes-operator.git
The following commit(s) were added to refs/heads/main by this push:
new 94494a8 feat(api): add sup short name for Superset (#480)
94494a8 is described below
commit 94494a843b67b3e9e578d6c0c85ee804b96bc44d
Author: Younsung Lee <[email protected]>
AuthorDate: Sat Oct 24 08:11:31 2026 +0900
feat(api): add sup short name for Superset (#480)
* feat(api): add sup short name for the Superset resource
The Superset resource had no short name, so users had to type the
full "superset" or "supersets" in every kubectl command.
Add "sup" as the short name. It is the first three letters of the
kind, the same style that prometheus-operator uses for "prom". It
does not clash with any built-in Kubernetes resource. "sset" was
not used because it reads like a StatefulSet.
The CRD in config/crd/bases and the Helm chart CRD are regenerated
with make codegen. The installation guide now mentions the short
name. Existing resources and manifests are not affected.
Signed-off-by: younsl <[email protected]>
* docs(install): explain what to do when the sup short name collides
Short names are not unique across CRDs. If another CRD in the
cluster also registers "sup", kubectl resolves the short name to
only one of them, so "kubectl get sup" may list the wrong resource.
The installation guide now says this and tells users to fall back
to "superset" or the fully qualified "supersets.superset.apache.org"
name in that case.
Signed-off-by: younsl <[email protected]>
---------
Signed-off-by: younsl <[email protected]>
---
api/v1alpha1/superset_types.go | 1 +
charts/superset-operator/crds/superset.apache.org_supersets.yaml | 2 ++
config/crd/bases/superset.apache.org_supersets.yaml | 2 ++
docs/reference/releases.md | 1 +
docs/user-guide/installation.md | 2 ++
5 files changed, 8 insertions(+)
diff --git a/api/v1alpha1/superset_types.go b/api/v1alpha1/superset_types.go
index 385bf35..8e8a89a 100644
--- a/api/v1alpha1/superset_types.go
+++ b/api/v1alpha1/superset_types.go
@@ -980,6 +980,7 @@ type ComponentResourceStatus struct {
}
// +kubebuilder:object:root=true
+// +kubebuilder:resource:shortName=sup
// +kubebuilder:subresource:status
// +kubebuilder:printcolumn:name="Tag",type=string,JSONPath=`.status.tag`
// +kubebuilder:printcolumn:name="Phase",type=string,JSONPath=`.status.phase`
diff --git a/charts/superset-operator/crds/superset.apache.org_supersets.yaml
b/charts/superset-operator/crds/superset.apache.org_supersets.yaml
index 2a78744..f5e3b02 100644
--- a/charts/superset-operator/crds/superset.apache.org_supersets.yaml
+++ b/charts/superset-operator/crds/superset.apache.org_supersets.yaml
@@ -11,6 +11,8 @@ spec:
kind: Superset
listKind: SupersetList
plural: supersets
+ shortNames:
+ - sup
singular: superset
scope: Namespaced
versions:
diff --git a/config/crd/bases/superset.apache.org_supersets.yaml
b/config/crd/bases/superset.apache.org_supersets.yaml
index 2a78744..f5e3b02 100644
--- a/config/crd/bases/superset.apache.org_supersets.yaml
+++ b/config/crd/bases/superset.apache.org_supersets.yaml
@@ -11,6 +11,8 @@ spec:
kind: Superset
listKind: SupersetList
plural: supersets
+ shortNames:
+ - sup
singular: superset
scope: Namespaced
versions:
diff --git a/docs/reference/releases.md b/docs/reference/releases.md
index f2ffe8f..64d5791 100644
--- a/docs/reference/releases.md
+++ b/docs/reference/releases.md
@@ -29,6 +29,7 @@ This page tracks notable changes in Apache Superset
Kubernetes Operator releases
- **Helm `priorityClassName`.** The Helm chart now exposes a
[`priorityClassName`](https://kubernetes.io/docs/concepts/scheduling-eviction/pod-priority-preemption/)
value that sets the PriorityClass of the operator manager pods. Unset by
default, which keeps the cluster default priority
([#420](https://github.com/apache/superset-kubernetes-operator/pull/420),
[@younsl](https://github.com/younsl)).
- **Removing default probes.** Setting `livenessProbe`, `readinessProbe`, or
`startupProbe` to `{}` now removes the operator's default probe. It works on
every component and follows the usual top-level and per-component override
rules ([#427](https://github.com/apache/superset-kubernetes-operator/pull/427),
[@younsl](https://github.com/younsl)).
- **Helm `extraEnv`.** The Helm chart now exposes an `extraEnv` value that
appends environment variables to the operator manager container, for example a
`GOMEMLIMIT` derived from the memory limit. `WATCH_NAMESPACE` is rejected
because the `watch` block owns it
([#426](https://github.com/apache/superset-kubernetes-operator/pull/426),
[@younsl](https://github.com/younsl)).
+- **`sup` short name.** The `Superset` resource now has the short name `sup`,
so `kubectl get sup` works the same as `kubectl get superset`
([#480](https://github.com/apache/superset-kubernetes-operator/pull/480),
[@younsl](https://github.com/younsl)).
### Changed
diff --git a/docs/user-guide/installation.md b/docs/user-guide/installation.md
index 0d0d9f1..a29423f 100644
--- a/docs/user-guide/installation.md
+++ b/docs/user-guide/installation.md
@@ -191,6 +191,8 @@ kubectl get jobs -l superset.apache.org/init-task -w
kubectl get pods -w
```
+`sup` is the short name for the `Superset` resource, so `kubectl get sup`
works the same as `kubectl get superset`. Short names are not unique across
CRDs: if another CRD in the cluster also registers `sup`, kubectl resolves it
to only one of them. In that case, use `superset` or the fully qualified
`supersets.superset.apache.org` instead.
+
## 5. Access Superset
Port-forward to the web server service:
