add descriptins to printcolumn, add categories

withlazers · Nov 13, 2024 · b54f063 · b54f063
1 parent 19a3e62
commit b54f063
Show file tree

Hide file tree

Showing 38 changed files with 148 additions and 107 deletions.
diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml
@@ -3,6 +3,7 @@ on:
   push:
     tags:
     - 'v[0-9]*.[0-9]*.[0-9]*'
+    - 'snapshot-*'
 
 jobs:
   prepare:
@@ -24,6 +25,7 @@ jobs:
         test "${helm_appversion}" = "${GITHUB_REF_NAME}"
 
   build:
+    if: contains(github.ref_name, 'snapshot') == false
     needs: prepare
     runs-on: 'ubuntu-latest'
     strategy:
@@ -57,6 +59,7 @@ jobs:
 
 
   release:
+    if: contains(github.ref_name, 'snapshot') == false
     needs:
     - container
     - build

diff --git a/charts/rustcloak-operator/crds/keycloakapiobjects.rustcloak.k8s.eboland.de.yaml b/charts/rustcloak-operator/crds/keycloakapiobjects.rustcloak.k8s.eboland.de.yaml
@@ -18,15 +18,15 @@ spec:
       jsonPath: .spec.endpoint.instanceRef
       name: Instance
       type: string
-    - description: ''
+    - description: true if the realm is ready
       jsonPath: .status.ready
       name: Ready
       type: boolean
-    - description: ''
+    - description: Status String of the resource
       jsonPath: .status.status
       name: Status
       type: string
-    - description: ''
+    - description: time since the realm was created
       jsonPath: .metadata.creationTimestamp
       name: Age
       type: date

diff --git a/charts/rustcloak-operator/crds/keycloakauthenticationflows.rustcloak.k8s.eboland.de.yaml b/charts/rustcloak-operator/crds/keycloakauthenticationflows.rustcloak.k8s.eboland.de.yaml
@@ -14,15 +14,15 @@ spec:
   scope: Namespaced
   versions:
   - additionalPrinterColumns:
-    - description: ''
+    - description: true if the realm is ready
       jsonPath: .status.ready
       name: Ready
       type: boolean
-    - description: ''
+    - description: Status String of the resource
       jsonPath: .status.status
       name: Status
       type: string
-    - description: ''
+    - description: time since the realm was created
       jsonPath: .metadata.creationTimestamp
       name: Age
       type: date

diff --git a/charts/rustcloak-operator/crds/keycloakauthenticatorconfigs.rustcloak.k8s.eboland.de.yaml b/charts/rustcloak-operator/crds/keycloakauthenticatorconfigs.rustcloak.k8s.eboland.de.yaml
@@ -14,15 +14,15 @@ spec:
   scope: Namespaced
   versions:
   - additionalPrinterColumns:
-    - description: ''
+    - description: true if the realm is ready
       jsonPath: .status.ready
       name: Ready
       type: boolean
-    - description: ''
+    - description: Status String of the resource
       jsonPath: .status.status
       name: Status
       type: string
-    - description: ''
+    - description: time since the realm was created
       jsonPath: .metadata.creationTimestamp
       name: Age
       type: date

diff --git a/charts/rustcloak-operator/crds/keycloakclients.rustcloak.k8s.eboland.de.yaml b/charts/rustcloak-operator/crds/keycloakclients.rustcloak.k8s.eboland.de.yaml
@@ -14,15 +14,15 @@ spec:
   scope: Namespaced
   versions:
   - additionalPrinterColumns:
-    - description: ''
+    - description: true if the realm is ready
       jsonPath: .status.ready
       name: Ready
       type: boolean
-    - description: ''
+    - description: Status String of the resource
       jsonPath: .status.status
       name: Status
       type: string
-    - description: ''
+    - description: time since the realm was created
       jsonPath: .metadata.creationTimestamp
       name: Age
       type: date

diff --git a/charts/rustcloak-operator/crds/keycloakclientscopes.rustcloak.k8s.eboland.de.yaml b/charts/rustcloak-operator/crds/keycloakclientscopes.rustcloak.k8s.eboland.de.yaml
@@ -14,15 +14,15 @@ spec:
   scope: Namespaced
   versions:
   - additionalPrinterColumns:
-    - description: ''
+    - description: true if the realm is ready
       jsonPath: .status.ready
       name: Ready
       type: boolean
-    - description: ''
+    - description: Status String of the resource
       jsonPath: .status.status
       name: Status
       type: string
-    - description: ''
+    - description: time since the realm was created
       jsonPath: .metadata.creationTimestamp
       name: Age
       type: date

diff --git a/charts/rustcloak-operator/crds/keycloakcomponents.rustcloak.k8s.eboland.de.yaml b/charts/rustcloak-operator/crds/keycloakcomponents.rustcloak.k8s.eboland.de.yaml
@@ -14,15 +14,15 @@ spec:
   scope: Namespaced
   versions:
   - additionalPrinterColumns:
-    - description: ''
+    - description: true if the realm is ready
       jsonPath: .status.ready
       name: Ready
       type: boolean
-    - description: ''
+    - description: Status String of the resource
       jsonPath: .status.status
       name: Status
       type: string
-    - description: ''
+    - description: time since the realm was created
       jsonPath: .metadata.creationTimestamp
       name: Age
       type: date

diff --git a/charts/rustcloak-operator/crds/keycloakgroups.rustcloak.k8s.eboland.de.yaml b/charts/rustcloak-operator/crds/keycloakgroups.rustcloak.k8s.eboland.de.yaml
@@ -14,15 +14,15 @@ spec:
   scope: Namespaced
   versions:
   - additionalPrinterColumns:
-    - description: ''
+    - description: true if the realm is ready
       jsonPath: .status.ready
       name: Ready
       type: boolean
-    - description: ''
+    - description: Status String of the resource
       jsonPath: .status.status
       name: Status
       type: string
-    - description: ''
+    - description: time since the realm was created
       jsonPath: .metadata.creationTimestamp
       name: Age
       type: date

diff --git a/charts/rustcloak-operator/crds/keycloakidentityprovidermappers.rustcloak.k8s.eboland.de.yaml b/charts/rustcloak-operator/crds/keycloakidentityprovidermappers.rustcloak.k8s.eboland.de.yaml
@@ -14,15 +14,15 @@ spec:
   scope: Namespaced
   versions:
   - additionalPrinterColumns:
-    - description: ''
+    - description: true if the realm is ready
       jsonPath: .status.ready
       name: Ready
       type: boolean
-    - description: ''
+    - description: Status String of the resource
       jsonPath: .status.status
       name: Status
       type: string
-    - description: ''
+    - description: time since the realm was created
       jsonPath: .metadata.creationTimestamp
       name: Age
       type: date

diff --git a/charts/rustcloak-operator/crds/keycloakidentityproviders.rustcloak.k8s.eboland.de.yaml b/charts/rustcloak-operator/crds/keycloakidentityproviders.rustcloak.k8s.eboland.de.yaml
@@ -14,15 +14,15 @@ spec:
   scope: Namespaced
   versions:
   - additionalPrinterColumns:
-    - description: ''
+    - description: true if the realm is ready
       jsonPath: .status.ready
       name: Ready
       type: boolean
-    - description: ''
+    - description: Status String of the resource
       jsonPath: .status.status
       name: Status
       type: string
-    - description: ''
+    - description: time since the realm was created
       jsonPath: .metadata.creationTimestamp
       name: Age
       type: date

diff --git a/charts/rustcloak-operator/crds/keycloakinstances.rustcloak.k8s.eboland.de.yaml b/charts/rustcloak-operator/crds/keycloakinstances.rustcloak.k8s.eboland.de.yaml
@@ -18,11 +18,11 @@ spec:
       jsonPath: .spec.baseUrl
       name: Base URL
       type: string
-    - description: ''
+    - description: true if the realm is ready
       jsonPath: .status.ready
       name: Ready
       type: boolean
-    - description: ''
+    - description: Status String of the resource
       jsonPath: .status.status
       name: Status
       type: string

diff --git a/charts/rustcloak-operator/crds/keycloakorganizations.rustcloak.k8s.eboland.de.yaml b/charts/rustcloak-operator/crds/keycloakorganizations.rustcloak.k8s.eboland.de.yaml
@@ -14,15 +14,15 @@ spec:
   scope: Namespaced
   versions:
   - additionalPrinterColumns:
-    - description: ''
+    - description: true if the realm is ready
       jsonPath: .status.ready
       name: Ready
       type: boolean
-    - description: ''
+    - description: Status String of the resource
       jsonPath: .status.status
       name: Status
       type: string
-    - description: ''
+    - description: time since the realm was created
       jsonPath: .metadata.creationTimestamp
       name: Age
       type: date

diff --git a/charts/rustcloak-operator/crds/keycloakprotocolmappers.rustcloak.k8s.eboland.de.yaml b/charts/rustcloak-operator/crds/keycloakprotocolmappers.rustcloak.k8s.eboland.de.yaml
@@ -14,15 +14,15 @@ spec:
   scope: Namespaced
   versions:
   - additionalPrinterColumns:
-    - description: ''
+    - description: true if the realm is ready
       jsonPath: .status.ready
       name: Ready
       type: boolean
-    - description: ''
+    - description: Status String of the resource
       jsonPath: .status.status
       name: Status
       type: string
-    - description: ''
+    - description: time since the realm was created
       jsonPath: .metadata.creationTimestamp
       name: Age
       type: date

diff --git a/charts/rustcloak-operator/crds/keycloakrealms.rustcloak.k8s.eboland.de.yaml b/charts/rustcloak-operator/crds/keycloakrealms.rustcloak.k8s.eboland.de.yaml
@@ -14,15 +14,15 @@ spec:
   scope: Namespaced
   versions:
   - additionalPrinterColumns:
-    - description: ''
+    - description: true if the realm is ready
       jsonPath: .status.ready
       name: Ready
       type: boolean
-    - description: ''
+    - description: Status String of the resource
       jsonPath: .status.status
       name: Status
       type: string
-    - description: ''
+    - description: time since the realm was created
       jsonPath: .metadata.creationTimestamp
       name: Age
       type: date

diff --git a/charts/rustcloak-operator/crds/keycloakrequiredactionproviders.rustcloak.k8s.eboland.de.yaml b/charts/rustcloak-operator/crds/keycloakrequiredactionproviders.rustcloak.k8s.eboland.de.yaml
@@ -14,15 +14,15 @@ spec:
   scope: Namespaced
   versions:
   - additionalPrinterColumns:
-    - description: ''
+    - description: true if the realm is ready
       jsonPath: .status.ready
       name: Ready
       type: boolean
-    - description: ''
+    - description: Status String of the resource
       jsonPath: .status.status
       name: Status
       type: string
-    - description: ''
+    - description: time since the realm was created
       jsonPath: .metadata.creationTimestamp
       name: Age
       type: date

diff --git a/charts/rustcloak-operator/crds/keycloakresources.rustcloak.k8s.eboland.de.yaml b/charts/rustcloak-operator/crds/keycloakresources.rustcloak.k8s.eboland.de.yaml
@@ -14,15 +14,15 @@ spec:
   scope: Namespaced
   versions:
   - additionalPrinterColumns:
-    - description: ''
+    - description: true if the realm is ready
       jsonPath: .status.ready
       name: Ready
       type: boolean
-    - description: ''
+    - description: Status String of the resource
       jsonPath: .status.status
       name: Status
       type: string
-    - description: ''
+    - description: time since the realm was created
       jsonPath: .metadata.creationTimestamp
       name: Age
       type: date

diff --git a/charts/rustcloak-operator/crds/keycloakroles.rustcloak.k8s.eboland.de.yaml b/charts/rustcloak-operator/crds/keycloakroles.rustcloak.k8s.eboland.de.yaml
@@ -14,15 +14,15 @@ spec:
   scope: Namespaced
   versions:
   - additionalPrinterColumns:
-    - description: ''
+    - description: true if the realm is ready
       jsonPath: .status.ready
       name: Ready
       type: boolean
-    - description: ''
+    - description: Status String of the resource
       jsonPath: .status.status
       name: Status
       type: string
-    - description: ''
+    - description: time since the realm was created
       jsonPath: .metadata.creationTimestamp
       name: Age
       type: date

diff --git a/charts/rustcloak-operator/crds/keycloakscopes.rustcloak.k8s.eboland.de.yaml b/charts/rustcloak-operator/crds/keycloakscopes.rustcloak.k8s.eboland.de.yaml
@@ -14,15 +14,15 @@ spec:
   scope: Namespaced
   versions:
   - additionalPrinterColumns:
-    - description: ''
+    - description: true if the realm is ready
       jsonPath: .status.ready
       name: Ready
       type: boolean
-    - description: ''
+    - description: Status String of the resource
       jsonPath: .status.status
       name: Status
       type: string
-    - description: ''
+    - description: time since the realm was created
       jsonPath: .metadata.creationTimestamp
       name: Age
       type: date

diff --git a/charts/rustcloak-operator/crds/keycloakusers.rustcloak.k8s.eboland.de.yaml b/charts/rustcloak-operator/crds/keycloakusers.rustcloak.k8s.eboland.de.yaml
@@ -14,15 +14,15 @@ spec:
   scope: Namespaced
   versions:
   - additionalPrinterColumns:
-    - description: ''
+    - description: true if the realm is ready
       jsonPath: .status.ready
       name: Ready
       type: boolean
-    - description: ''
+    - description: Status String of the resource
       jsonPath: .status.status
       name: Status
       type: string
-    - description: ''
+    - description: time since the realm was created
       jsonPath: .metadata.creationTimestamp
       name: Age
       type: date

diff --git a/docs/src/configuration.md b/docs/src/configuration.md
@@ -1,3 +1,5 @@
 # Configuration
 
-Here be dragons.
+`Rustcloak` itself is configured using [Helm Charts][1]
+
+[1]: https://github.com/withlazers/rustcloak-operator/tree/main/charts/rustcloak-operator
diff --git a/src/crd/api_object.rs b/src/crd/api_object.rs
@@ -14,6 +14,8 @@ use std::ops::Add;
     version = "v1",
     namespaced,
     status = "KeycloakApiStatus",
+    category = "keycloak",
+    category = "all",
     printcolumn = r#"{
             "name":"Instance",
             "type":"string",
@@ -23,19 +25,19 @@ use std::ops::Add;
     printcolumn = r#"{
             "name":"Ready",
             "type":"boolean",
-            "description":"",
+            "description":"true if the realm is ready",
             "jsonPath":".status.ready"
         }"#,
     printcolumn = r#"{
             "name":"Status",
             "type":"string",
-            "description":"",
+            "description":"Status String of the resource",
             "jsonPath":".status.status"
         }"#,
     printcolumn = r#"{
             "name":"Age",
             "type":"date",
-            "description":"",
+            "description":"time since the realm was created",
             "jsonPath":".metadata.creationTimestamp"
         }"#
 )]