Add an (Internal) prefix to internal-objects

Signed-off-by: Richard Wall <[email protected]>
cert-manager · Feb 16, 2022 · 8e75b71 · 8e75b71
1 parent f09e04e
commit 8e75b71
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 14 deletions.
diff --git a/bundle/manifests/cert-manager.clusterserviceversion.yaml b/bundle/manifests/cert-manager.clusterserviceversion.yaml
@@ -68,12 +68,12 @@ metadata:
     capabilities: Full Lifecycle
     categories: Security
     containerImage: quay.io/jetstack/cert-manager-controller:v1.6.1
-    createdAt: '2022-02-16T07:26:24'
+    createdAt: '2022-02-16T09:25:32'
     operators.operatorframework.io/builder: operator-sdk-v1.13.0+git
     operators.operatorframework.io/internal-objects: |-
       [
-          "challenge.acme.cert-manager.io",
-          "order.acme.cert-manager.io"
+        "challenges.acme.cert-manager.io",
+        "orders.acme.cert-manager.io"
       ]
     operators.operatorframework.io/project_layout: unknown
     repository: https://github.com/jetstack/cert-manager
@@ -109,7 +109,7 @@ spec:
       version: v1
     - description: Challenge is a type to represent a Challenge request with an ACME
         server
-      displayName: Challenge
+      displayName: (Internal) Challenge
       kind: Challenge
       name: challenges.acme.cert-manager.io
       version: v1
@@ -129,7 +129,7 @@ spec:
       name: issuers.cert-manager.io
       version: v1
     - description: Order is a type to represent an Order with an ACME server
-      displayName: Order
+      displayName: (Internal) Order
       kind: Order
       name: orders.acme.cert-manager.io
       version: v1

diff --git a/global-csv-config.yaml b/global-csv-config.yaml
@@ -138,3 +138,9 @@ architectures:
   - arm64
   - ppc64le
   - s390x
+
+# A list of Kind.Group which are considered "internal-objects".
+# See https://docs.okd.io/4.9/operators/operator_sdk/osdk-generating-csvs.html#osdk-hiding-internal-objects_osdk-generating-csvs
+internal_objects:
+  - "challenges.acme.cert-manager.io"
+  - "orders.acme.cert-manager.io"
diff --git a/hack/fixup-csv b/hack/fixup-csv
@@ -61,14 +61,22 @@ def main():
         conf = yaml.safe_load(config_file)
     doc = yaml.safe_load(sys.stdin)
 
+    internal_objects = conf["internal_objects"]
+
     # Add displayName for the CRD preview in operatorhub.io.
+    # Add an (Internal) prefix to the kinds that are internal-objects.
     # Ideally operatorhub.io would just use the existing CRD name and
     # description.
     # See https://github.com/k8s-operatorhub/operatorhub.io/issues/2
     for crd in doc["spec"]["customresourcedefinitions"]["owned"]:
-        crd["displayName"] = crd["kind"]
-        kind, group = crd["name"].split(".", 1)
-        crdContent = yaml.safe_load(open(f"bundle/manifests/{group}_{kind}.yaml"))
+        kindAndGroup = crd["name"]
+        displayName = crd["kind"]
+        if kindAndGroup in internal_objects:
+            displayName = f"(Internal) {displayName}"
+        crd["displayName"] = displayName
+        kind, group = kindAndGroup.split(".", 1)
+        with open(f"bundle/manifests/{group}_{kind}.yaml") as f:
+            crdContent = yaml.safe_load(f)
         crd["description"] = crdContent["spec"]["versions"][-1]["schema"]["openAPIV3Schema"]["description"]
 
     # Add multiarch labels.
@@ -78,13 +86,13 @@ def main():
         for arch in conf["architectures"]
     })
 
-    # Hide some internal APIs from the OperatorHub UI
-    # https://docs.okd.io/4.9/operators/operator_sdk/osdk-generating-csvs.html#osdk-hiding-internal-objects_osdk-generating-csvs
+    # Hide some internal APIs from the OperatorHub UI.
+    # See https://docs.okd.io/4.9/operators/operator_sdk/osdk-generating-csvs.html#osdk-hiding-internal-objects_osdk-generating-csvs
+    # Ideally these would be hidden from the WebUI in operatorhub.io, but they
+    # are not.
+    # See https://github.com/k8s-operatorhub/operatorhub.io/issues/14
     doc["metadata"]["annotations"]["operators.operatorframework.io/internal-objects"] = literal(
-        json.dumps([
-            "challenge.acme.cert-manager.io",
-            "order.acme.cert-manager.io",
-        ], indent=4)
+        json.dumps(internal_objects, indent=2)
     )
     doc["metadata"]["annotations"]["capabilities"] = conf["capabilities"]
     doc["metadata"]["annotations"]["categories"] = ",".join(conf["categories"])