RHIDP-7564-1 - Support Pre-Configured RHDH Deployments in Operator

assemblies/dynamic-plugins/assembly-installing-rhdh-plugins.adoc

@@ -11,6 +11,9 @@ You can use the dynamic plugins that come preinstalled with {product} or install
 // Operator installation
 include::../modules/dynamic-plugins/proc-config-dynamic-plugins-rhdh-operator.adoc[leveloffset=+2]
 
+// Plugins dependency
+include::../modules/configuring/con-dynamic-plugins-dependencies.adoc[leveloffset=+2]
+
 // Helm installation
 include::../modules/dynamic-plugins/con-install-dynamic-plugin-helm.adoc[leveloffset=+2]
 //include::../modules/dynamic-plugins/proc-obtaining-integrity-checksum.adoc[leveloffset=+3] //from tkral:This is documented in a better way in "= Installing third-party plugins in {product}" we can remove this module. It is not even placed correctly here as this is not specific to helm chart in anyway

modules/configuring/con-dynamic-plugins-dependencies.adoc

@@ -0,0 +1,74 @@
+:_mod-docs-content-type: CONCEPT
+
+[id="dynamic-plugins-dependencies_{context}"]
+= Dynamic plugins dependency management
+Dynamic plugins configured for the {backstage} custom resource (CR) may require certain Kubernetes resources to be configured to make the plugin work. These resources are referred to as 'plugin dependencies'. In {product}({product-very-short}), you can automatically create these resources when the {backstage} CR is applied to the cluster.
+
+== Profile Configuration
+For a specific profile, you can configure plugin dependency by including the required Kubernetes resources in the `/config/profile/{PROFILE}/plugin-deps` directory. You must add the required resources as Kubernetes manifests in YAML format in the `plugin-deps` directory.
+
+.Example: Adding example-dep1.yaml and example-dep2.yaml as plugin dependencies
+[source,terminal,subs="+quotes"]
+----
+config/
+  profile/
+    rhdh/
+     kustomization.yaml
+     plugin-deps/
+        example-dep1.yaml
+        example-dep2.yaml
+----
+
+[NOTE]
+====
+* If a resource manifest does not specify a namespace, it will be created in the namespace of the {backstage} CR.
+* Resources may contain *{{backstage-name}}* and *{{backstage-ns}}* placeholders, which will be replaced with the name and namespace of the {backstage} CR, respectively.
+====
+
+The `kustomization.yaml` file must contain the following lines:
+[source,yaml,subs="+quotes"]
+----
+
+configMapGenerator:
+  - files:
+      - plugin-deps/example-dep1.yaml
+      - plugin-deps/example-dep2.yaml
+    name: plugin-deps
+----
+
+== Plugin dependencies infrastructure
+To install infrastructural resources that are required by plugin dependencies, for example, other operators or custom resources (CR), you can include these in the `/config/profile/{PROFILE}/plugin-infra` directory.
+
+To create these infrastructural resources (along with the operator deployment), use the `make plugin-infra` command. 
+
+[NOTE]
+====
+On a production cluster, use this command with caution as it may reconfigure cluster-scoped resources.
+====
+
+== Plugin configuration
+You must reference the plugin dependenciesin the `dependencies` field of the plugin configuration when the  {backstage} CR is applied. 
+
+The Operator creates the resources described in the files located in the `plugin-deps` directory. 
+
+You can reference plugin dependencies in the `dynamic-plugins` ConfigMap which can either be part of the default profile configuration for all {backstage} custom resources or part of the ConfigMap referenced in the {backstage} CR. In {product}, you can include plugin dependencies in the dynamic plugin configuration. 
+
+Each `dependencies.ref` value can either match the full file name or serve as a prefix for the file name. The operator will create the resources described in the files contained in the `plugin-deps` that start with the specified `ref` value or exactly match it 
+
+.Example: Adding example-dep plugin dependency 
+[source,yaml,subs="+quotes"]
+----
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: default-dynamic-plugins
+data:
+  dynamic-plugins.yaml: |
+    includes:
+      - dynamic-plugins.default.yaml
+    plugins:
+      - disabled: false
+        package: "path-or-url-to-example-plugin"
+        dependencies:
+          - ref: example-dep
+----

modules/dynamic-plugins/proc-config-dynamic-plugins-rhdh-operator.adoc

@@ -5,6 +5,10 @@
 
 You can store the configuration for dynamic plugins in a `ConfigMap` object that your `{product-custom-resource-type}` custom resource (CR) can reference.
 
+Dynamic plugins may require certain Kubernetes resources to be configured. These resources are referred to as 'plugin dependencies'. For more information, see xref:dynamic-plugins-dependencies_{context}[Dynamic plugins dependency management].
+
+In {product}({product-very-short}), you can automatically create these resources when the Backstage CR is applied to the cluster.
+
 [NOTE]
 ====
 If the `pluginConfig` field references environment variables, you must define the variables in your `_<my_product_secrets>_` secret.