Merge branch 'release-1.4' into add-security-fixes-for-release-1.4.2

Author: nickboldt

modules/authentication/proc-enabling-authentication-with-github.adoc

@@ -55,7 +55,7 @@ TIP: If you plan to make changes using the GitHub API, ensure that `Read and wri
 +
 `AUTH_GITHUB_APP_ID`:: Enter the saved **App ID**.
 `AUTH_GITHUB_CLIENT_ID`:: Enter the saved **Client ID**.
-`GITHUB_HOST_DOMAIN`:: Enter your GitHub host domain: `github.com` unless you are using GitHub Enterprise.
+//`GITHUB_HOST_DOMAIN`:: Enter your GitHub host domain: `github.com` unless you are using GitHub Enterprise.
 `GITHUB_ORGANIZATION`:: Enter your GitHub organization name, such as `__<your_github_organization_name>__'.
 `GITHUB_ORG_URL`:: Enter `$GITHUB_HOST_DOMAIN/$GITHUB_ORGANIZATION`.
 `GITHUB_CLIENT_SECRET`:: Enter the saved **Client Secret**.
@@ -145,6 +145,7 @@ auth:
         callbackUrl: __<your_intermediate_service_url/handler>__
 ----
 
+////
 `enterpriseInstanceUrl`::
 Your GitHub Enterprise URL.
 Requires you defined the `GITHUB_HOST_DOMAIN` secret in the previous step.
@@ -158,6 +159,7 @@ auth:
       production:
         enterpriseInstanceUrl: ${GITHUB_HOST_DOMAIN}
 ----
+////
 
 [TIP]
 ====

modules/configuring-deployment/proc-configuring-deployment-by-using-the-operator.adoc

@@ -1,7 +1,7 @@
 [id="configuring-the-deployment"]
 = Configuring {product} deployment when using the Operator
 
-The {product} Operator exposes a `rhdh.redhat.com/v1alpha2` API Version of its custom resource (CR). This CR exposes a generic `spec.deployment.patch` field, which gives you full control over the {product-short} Deployment resource. This field can be a fragment of the standard `apps.Deployment` Kubernetes object.
+The {product} Operator exposes a `rhdh.redhat.com/v1alpha3` API Version of its custom resource (CR). This CR exposes a generic `spec.deployment.patch` field, which gives you full control over the {product-short} Deployment resource. This field can be a fragment of the standard `apps.Deployment` Kubernetes object.
 
 .Procedure
 
@@ -11,7 +11,7 @@ The {product} Operator exposes a `rhdh.redhat.com/v1alpha2` API Version of its c
 .Example
 [source, yaml]
 ----
-apiVersion: rhdh.redhat.com/v1alpha2
+apiVersion: rhdh.redhat.com/v1alpha3
 kind: Backstage
 metadata:
   name: developer-hub
@@ -28,7 +28,7 @@ Add labels to the {product-short} pod.
 .Example adding the label `my=true`
 [source, yaml]
 ----
-apiVersion: rhdh.redhat.com/v1alpha2
+apiVersion: rhdh.redhat.com/v1alpha3
 kind: Backstage
 metadata:
   name: developer-hub
@@ -50,7 +50,7 @@ Add an additional volume named `my-volume` and mount it under `/my/path` in the
 .Example additional volume
 [source, yaml]
 ----
-apiVersion: rhdh.redhat.com/v1alpha2
+apiVersion: rhdh.redhat.com/v1alpha3
 kind: Backstage
 metadata:
   name: developer-hub
@@ -78,7 +78,7 @@ Replace the default `dynamic-plugins-root` volume with a persistent volume claim
 .Example `dynamic-plugins-root` volume replacement
 [source, yaml]
 ----
-apiVersion: rhdh.redhat.com/v1alpha2
+apiVersion: rhdh.redhat.com/v1alpha3
 kind: Backstage
 metadata:
   name: developer-hub
@@ -103,7 +103,7 @@ Set the CPU request for the {product-short} application container to 250m.
 .Example CPU request
 [source, yaml]
 ----
-apiVersion: rhdh.redhat.com/v1alpha2
+apiVersion: rhdh.redhat.com/v1alpha3
 kind: Backstage
 metadata:
   name: developer-hub
@@ -127,7 +127,7 @@ Add a new `my-sidecar` sidecar container into the {product-short} Pod.
 .Example side car container
 [source, yaml]
 ----
-apiVersion: rhdh.redhat.com/v1alpha2
+apiVersion: rhdh.redhat.com/v1alpha3
 kind: Backstage
 metadata:
   name: developer-hub

modules/dynamic-plugins/con-dynamic-plugins-cache.adoc

@@ -32,7 +32,7 @@ spec:
 
 ---
 
-apiVersion: rhdh.redhat.com/v1alpha2
+apiVersion: rhdh.redhat.com/v1alpha3
 kind: Backstage
 metadata:
   name: developer-hub

modules/installation/proc-install-rhdh-airgapped-environment-ocp-operator.adoc

@@ -45,7 +45,7 @@ The internal {ocp-short} cluster image registry cannot be used as a target mirro
 +
 [source,yaml,subs="attributes+"]
 ----
-curl -sSLO https://raw.githubusercontent.com/redhat-developer/rhdh-operator/{product-version}.x/.rhdh/scripts/prepare-restricted-environment.sh
+curl -sSLO https://raw.githubusercontent.com/redhat-developer/rhdh-operator/release-{product-version}/.rhdh/scripts/prepare-restricted-environment.sh
 
 # if you do not already have a target mirror registry
 # and want the script to create one for you

modules/observe/proc-admin-enabling-metrics-ocp-operator.adoc

@@ -25,24 +25,34 @@ Currently, the {product} Operator does not support creating a `ServiceMonitor` c
 apiVersion: monitoring.coreos.com/v1
 kind: ServiceMonitor
 metadata:
-  name: <custom_resource_name> # <1>
-  namespace: {my-product-namespace} # <2>
+  name: _<developer_hub_service_monitor_name>_ <1>
+  namespace: _<rhdh_namespace_name>_ <2>
   labels:
-    app.kubernetes.io/instance: <custom_resource_name>
-    app.kubernetes.io/name: backstage
+    app.kubernetes.io/instance: _<rhdh_cr_name>_ <3>
+    app.kubernetes.io/name: {product-custom-resource-type}
 spec:
   namespaceSelector:
     matchNames:
-      - {my-product-namespace}
+      - _<rhdh_namespace_name>_ <4>
   selector:
     matchLabels:
-      rhdh.redhat.com/app: backstage-<custom_resource_name>
+      app.kubernetes.io/instance: _<deployment_name>_ <5>
+      app.kubernetes.io/name: _<rhdh_cr_type>_ <6>
   endpoints:
   - port: http-metrics
     path: '/metrics'
 ----
-<1> Replace `<custom_resource_name>` with the name of your `{product-custom-resource-type}` custom resource.
-<2> Replace `<project_name>` with the name of the {ocp-short} project where your {product} instance is running.
+<1> The name of your `ServiceMonitor` resource, for example, `developer_hub_service_monitor`.
+<2> The namespace where your `ServiceMonitor` will live, for example, `{my-product-namespace}`.
+<3> The label name identifying the `ServiceMonitor` CR instance, for example, `{my-product-cr-name}`.
+<4> The namespace where your {product-very-short} instance is installed, for example, `{my-product-namespace}`.
+<5> The name of your {product-very-short} deployment, for example, `developer-hub`.
+<6> The name of your {product-very-short} application, for example, `backstage`.
++
+[NOTE]
+====
+`spec.selector.matchLabels` configuration must match the labels of your {product-very-short} installation.
+==== 
 
 . Apply the `ServiceMonitor` CR by running the following command:
 +
@@ -55,3 +65,4 @@ oc apply -f <filename>
 
 . From the *Developer* perspective in the {ocp-short} web console, select the *Observe* view.
 . Click the *Metrics* tab to view metrics for {product} pods.
+. From the Developer perspective in the {ocp-short} web console, click **Project > Services** and verify the labels for `backstage-developer-hub`.