Optimize and document configuration profiles

[gazarenkov]

This PR:

• splits manager.yaml to namespace and deployment resources
• moves deployment on top to config/manager directory. Presumable all the profiles (including externals) will use the same deployment manifest as a base (otherwise it is too complex to support)
• leaves namespace.yaml for particular profile. We can see per-profile operator namespace name and metadata (labels)
• adds env var patch for rhdh profile
• removes some commented scripts for clarity
• replaces deprecated kustomize tags in config/scorecard
• adds "how to create a profile" and "external profile" docs

PR acceptance criteria

• Documentation

[github-actions]

⚠️ Files changed in bundle generation!

Those changes to the operator bundle manifests should have been pushed automatically to your PR branch.
You might also need to manually update the .rhdh/bundle/manifests/rhdh-operator.clusterserviceversion.yaml CSV file accordingly.

[github-actions]

⚠️ Files changed in bundle generation!

Those changes to the operator bundle manifests should have been pushed automatically to your PR branch.
You might also need to manually update the .rhdh/bundle/manifests/rhdh-operator.clusterserviceversion.yaml CSV file accordingly.

[rm3l]

/lgtm

[openshift-ci]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: rm3l

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

• OWNERS [rm3l]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[github-actions]

⚠️ Files changed in bundle generation!

Those changes to the operator bundle manifests should have been pushed automatically to your PR branch.
You might also need to manually update the .rhdh/bundle/manifests/rhdh-operator.clusterserviceversion.yaml CSV file accordingly.

[github-actions]

⚠️ Files changed in bundle generation!

Those changes to the operator bundle manifests should have been pushed automatically to your PR branch.
You might also need to manually update the .rhdh/bundle/manifests/rhdh-operator.clusterserviceversion.yaml CSV file accordingly.

[rm3l]

/override "PR Bundle Diff"

Should be fixed with #625
I also checked locally, and no diff was reported (other than the createdAt field):

$ make bundle  
/home/asoro/work/projects/backstage/janus-idp/operator/bin/controller-gen-v0.14.0 rbac:roleName=manager-role crd webhook paths="./..." output:crd:artifacts:config=config/crd/bases
#/home/asoro/.local/share/mise/installs/operator-sdk/v1.37.0/operator-sdk generate kustomize manifests -q
cd config/profile/rhdh && /home/asoro/work/projects/backstage/janus-idp/operator/bin/kustomize-v5.4.2 edit set image controller=quay.io/rhdh-community/operator:0.5.0
/home/asoro/work/projects/backstage/janus-idp/operator/bin/kustomize-v5.4.2 build config/manifests/rhdh | /home/asoro/.local/share/mise/installs/operator-sdk/v1.37.0/operator-sdk generate bundle --kustomize-dir config/manifests/rhdh -q --overwrite --version 0.5.0 --output-dir bundle/rhdh  
INFO[0000] Creating bundle/rhdh/metadata/annotations.yaml 
INFO[0000] Creating bundle.Dockerfile                   
INFO[0000] Bundle metadata generated successfully       
/home/asoro/.local/share/mise/installs/operator-sdk/v1.37.0/operator-sdk bundle validate ./bundle/rhdh
INFO[0000] All validation tests have completed successfully 
mv -f bundle.Dockerfile ./bundle/rhdh/bundle.Dockerfile

$ git diff
diff --git a/bundle/rhdh/manifests/backstage-operator.clusterserviceversion.yaml b/bundle/rhdh/manifests/backstage-operator.clusterserviceversion.yaml
index 1f3a115d..9d51b67b 100644
--- a/bundle/rhdh/manifests/backstage-operator.clusterserviceversion.yaml
+++ b/bundle/rhdh/manifests/backstage-operator.clusterserviceversion.yaml
@@ -39,7 +39,7 @@ metadata:
     categories: Developer Tools
     certified: "true"
     containerImage: registry-proxy.engineering.redhat.com/rh-osbs/rhdh-rhdh-rhel9-operator:1.3
-    createdAt: "2024-12-13T14:46:16Z"
+    createdAt: "2025-01-06T22:22:34Z"
     description: Red Hat Developer Hub is a Red Hat supported version of Backstage.
       It comes with pre-built plug-ins and configuration settings, supports use of
       an external database, and can help streamline the process of setting up a self-managed

[openshift-ci]

@rm3l: Overrode contexts on behalf of rm3l: PR Bundle Diff

In response to this:

/override "PR Bundle Diff"

Should be fixed with #625
I also checked locally, and no diff was reported (other than the createdAt field):

$ make bundle  
/home/asoro/work/projects/backstage/janus-idp/operator/bin/controller-gen-v0.14.0 rbac:roleName=manager-role crd webhook paths="./..." output:crd:artifacts:config=config/crd/bases
#/home/asoro/.local/share/mise/installs/operator-sdk/v1.37.0/operator-sdk generate kustomize manifests -q
cd config/profile/rhdh && /home/asoro/work/projects/backstage/janus-idp/operator/bin/kustomize-v5.4.2 edit set image controller=quay.io/rhdh-community/operator:0.5.0
/home/asoro/work/projects/backstage/janus-idp/operator/bin/kustomize-v5.4.2 build config/manifests/rhdh | /home/asoro/.local/share/mise/installs/operator-sdk/v1.37.0/operator-sdk generate bundle --kustomize-dir config/manifests/rhdh -q --overwrite --version 0.5.0 --output-dir bundle/rhdh  
INFO[0000] Creating bundle/rhdh/metadata/annotations.yaml 
INFO[0000] Creating bundle.Dockerfile                   
INFO[0000] Bundle metadata generated successfully       
/home/asoro/.local/share/mise/installs/operator-sdk/v1.37.0/operator-sdk bundle validate ./bundle/rhdh
INFO[0000] All validation tests have completed successfully 
mv -f bundle.Dockerfile ./bundle/rhdh/bundle.Dockerfile

$ git diff
diff --git a/bundle/rhdh/manifests/backstage-operator.clusterserviceversion.yaml b/bundle/rhdh/manifests/backstage-operator.clusterserviceversion.yaml
index 1f3a115d..9d51b67b 100644
--- a/bundle/rhdh/manifests/backstage-operator.clusterserviceversion.yaml
+++ b/bundle/rhdh/manifests/backstage-operator.clusterserviceversion.yaml
@@ -39,7 +39,7 @@ metadata:
    categories: Developer Tools
    certified: "true"
    containerImage: registry-proxy.engineering.redhat.com/rh-osbs/rhdh-rhdh-rhel9-operator:1.3
-    createdAt: "2024-12-13T14:46:16Z"
+    createdAt: "2025-01-06T22:22:34Z"
    description: Red Hat Developer Hub is a Red Hat supported version of Backstage.
      It comes with pre-built plug-ins and configuration settings, supports use of
      an external database, and can help streamline the process of setting up a self-managed

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.