From 371021a0b9991c7b4e0670e08318607b0fd21eff Mon Sep 17 00:00:00 2001 From: OpenShift Cherrypick Robot Date: Wed, 29 Jan 2025 11:35:50 +0100 Subject: [PATCH] [release-1.4] RHIDP-5374: Consistent mentions to the product custom resource (#890) Co-authored-by: Priyanka Abel --- ...rizations-in-external-files-by-using-the-operator.adoc | 4 ++-- .../proc-configuring-proxy-in-operator-deployment.adoc | 2 +- ...proc-configuring-deployment-by-using-the-operator.adoc | 6 +++--- ...onfiguring-postgresql-instance-using-the-operator.adoc | 2 +- .../proc-migrating-databases-to-an-external-server.adoc | 2 +- ...erator-to-run-rhdh-with-your-custom-configuration.adoc | 8 ++++---- .../proc-techdocs-configure-odf-operator.adoc | 4 ++-- .../proc-config-dynamic-plugins-rhdh-operator.adoc | 4 ++-- modules/dynamic-plugins/proc-topology-configure.adoc | 2 +- modules/installation/proc-deploy-rhdh-instance-eks.adoc | 4 ++-- modules/installation/proc-deploy-rhdh-instance-gke.adoc | 6 +++--- modules/installation/proc-rhdh-deploy-aks-operator.adoc | 2 +- .../observe/proc-admin-enabling-metrics-ocp-operator.adoc | 2 +- ...proc-customizing-telemetry-segment-using-operator.adoc | 2 +- .../observe/proc-disabling-telemetry-using-operator.adoc | 2 +- .../observe/proc-enabling-telemetry-using-operator.adoc | 2 +- 16 files changed, 27 insertions(+), 27 deletions(-) diff --git a/modules/authorization/proc-defining-authorizations-in-external-files-by-using-the-operator.adoc b/modules/authorization/proc-defining-authorizations-in-external-files-by-using-the-operator.adoc index 570beecbb..da928f2b9 100644 --- a/modules/authorization/proc-defining-authorizations-in-external-files-by-using-the-operator.adoc +++ b/modules/authorization/proc-defining-authorizations-in-external-files-by-using-the-operator.adoc @@ -75,9 +75,9 @@ $ oc create configmap rbac-policies \ --from-file=rbac-conditional-policies.yaml ---- -. Update your {product-short} `Backstage` custom resource to mount in the {product-short} filesystem your files from the `rbac-policies` config map: +. Update link:{configuring-book-url}[your `{product-custom-resource-type}` custom resource] to mount in the {product-short} filesystem your files from the `rbac-policies` config map: + -.`Backstage` Custom resource fragment +.`{product-custom-resource-type}` custom resource fragment [source,yaml] ---- apiVersion: rhdh.redhat.com/v1alpha3 diff --git a/modules/configuring-a-proxy/proc-configuring-proxy-in-operator-deployment.adoc b/modules/configuring-a-proxy/proc-configuring-proxy-in-operator-deployment.adoc index 8e741ec5f..d94542307 100644 --- a/modules/configuring-a-proxy/proc-configuring-proxy-in-operator-deployment.adoc +++ b/modules/configuring-a-proxy/proc-configuring-proxy-in-operator-deployment.adoc @@ -59,7 +59,7 @@ For Operator-based deployment, the approach you use for proxy configuration is b ---- -* As a developer, set the proxy information in your custom resource (CR) file as shown in the following example: +* As a developer, set the proxy information in your `{product-custom-resource-type}` CR file as shown in the following example: + .Example: Setting proxy variables in a CR file [source, yaml] diff --git a/modules/configuring-deployment/proc-configuring-deployment-by-using-the-operator.adoc b/modules/configuring-deployment/proc-configuring-deployment-by-using-the-operator.adoc index 0e637c224..ebdcaf963 100644 --- a/modules/configuring-deployment/proc-configuring-deployment-by-using-the-operator.adoc +++ b/modules/configuring-deployment/proc-configuring-deployment-by-using-the-operator.adoc @@ -1,11 +1,11 @@ [id="configuring-the-deployment"] -= Configuring {product} deployment when using the operator += Configuring {product} deployment when using the Operator -The {product} operator exposes a `rhdh.redhat.com/v1alpha2` API Version of its Custom Resource Definition (CRD). This CRD 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/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. .Procedure -. Create a {product-short} Custom Resource Definition with the following fields: +. Create a `{product-custom-resource-type}` CR with the following fields: -- .Example diff --git a/modules/configuring-external-databases/proc-configuring-postgresql-instance-using-the-operator.adoc b/modules/configuring-external-databases/proc-configuring-postgresql-instance-using-the-operator.adoc index 2d7d3f72c..53f8b0d12 100644 --- a/modules/configuring-external-databases/proc-configuring-postgresql-instance-using-the-operator.adoc +++ b/modules/configuring-external-databases/proc-configuring-postgresql-instance-using-the-operator.adoc @@ -74,7 +74,7 @@ EOF <3> Optional: Provide the value based on the required link:https://www.postgresql.org/docs/15/libpq-connect.html#LIBPQ-CONNECT-SSLMODE[Secure Sockets Layer (SSL) mode]. <4> Optional: Provide the value only if you need a TLS connection for your PostgreSQL instance. -. Create a `{product-custom-resource-type}` custom resource (CR): +. Create your `{product-custom-resource-type}` custom resource (CR): + [source,terminal,subs="+attributes,+quotes"] ---- diff --git a/modules/configuring-external-databases/proc-migrating-databases-to-an-external-server.adoc b/modules/configuring-external-databases/proc-migrating-databases-to-an-external-server.adoc index 75bf7d164..f2ab5c382 100644 --- a/modules/configuring-external-databases/proc-migrating-databases-to-an-external-server.adoc +++ b/modules/configuring-external-databases/proc-migrating-databases-to-an-external-server.adoc @@ -78,7 +78,7 @@ done You can stop port forwarding when the copying of the data is complete. For more information about handling large databases and using the compression tools, see the link:https://www.postgresql.org/docs/current/backup-dump.html#BACKUP-DUMP-LARGE[Handling Large Databases] section on the PostgreSQL website. ==== -. Reconfigure your `Backstage` custom resource (CR). For more information, see link:{configuring-book-url}#proc-configuring-postgresql-instance-using-operator_configuring-external-postgresql-databases[Configuring an external PostgreSQL instance using the Operator]. +. Reconfigure your `{product-custom-resource-type}` custom resource (CR). For more information, see link:{configuring-book-url}#proc-configuring-postgresql-instance-using-operator_configuring-external-postgresql-databases[Configuring an external PostgreSQL instance using the Operator]. . Check that the following code is present at the end of your `Backstage` CR after reconfiguration: + [source,yaml] diff --git a/modules/configuring/proc-using-the-operator-to-run-rhdh-with-your-custom-configuration.adoc b/modules/configuring/proc-using-the-operator-to-run-rhdh-with-your-custom-configuration.adoc index 8c5929fdc..a67cf7d70 100644 --- a/modules/configuring/proc-using-the-operator-to-run-rhdh-with-your-custom-configuration.adoc +++ b/modules/configuring/proc-using-the-operator-to-run-rhdh-with-your-custom-configuration.adoc @@ -1,7 +1,7 @@ [id="using-the-operator-to-run-rhdh-with-your-custom-configuration"] = Using the {product} operator to run {product-short} with your custom configuration -To use the {product-short} operator to run {product} with your custom configuration, create a {product-custom-resource-type} custom resource that: +To use the {product-short} operator to run {product} with your custom configuration, create your {product-custom-resource-type} custom resource (CR) that: * Mounts files provisioned in your custom config maps. * Injects environment variables provisioned in your custom secrets. @@ -13,7 +13,7 @@ To use the {product-short} operator to run {product} with your custom configurat .Procedure -. Author your {product-custom-resource-type} custom resource in a `{my-product-cr-name}.yaml` file to use your custom config maps and secrets. +. Author your {product-custom-resource-type} CR in a `{my-product-cr-name}.yaml` file to use your custom config maps and secrets. + .Minimal `{my-product-cr-name}.yaml` custom resource example ==== @@ -78,7 +78,7 @@ spec: Mandatory fields:: No fields are mandatory. -You can create an empty {product-custom-resource-type} custom resource +You can create an empty {product-custom-resource-type} CR and run {product-short} with the default configuration. Optional fields:: @@ -198,7 +198,7 @@ spec: `spec.deployment`::: Optionally, xref:configuring-the-deployment[enter your deployment configuration]. -. Apply your {product-custom-resource-type} custom resource to start or update your {product-short} instance. +. Apply your {product-custom-resource-type} CR to start or update your {product-short} instance. + [source,terminal,subs="+attributes,+quotes"] ---- diff --git a/modules/customizing-techdocs/proc-techdocs-configure-odf-operator.adoc b/modules/customizing-techdocs/proc-techdocs-configure-odf-operator.adoc index d903c5308..5ae25d195 100644 --- a/modules/customizing-techdocs/proc-techdocs-configure-odf-operator.adoc +++ b/modules/customizing-techdocs/proc-techdocs-configure-odf-operator.adoc @@ -2,7 +2,7 @@ [id="proc-techdocs-configure-odf-operator_{context}"] = Making object storage accessible to containers by using the Operator -Creating a `ObjectBucketClaim` Custom Resource (CR) automatically generates both the {product-short} `ObjectBucketClaim` config map and secret. The config map and secret contain `ObjectBucket` access information. Adding the access information to the Operator configuration makes it accessible to the {product-short} container by adding the following environment variables to the container: +Creating a `ObjectBucketClaim` custom resource (CR) automatically generates both the {product-short} `ObjectBucketClaim` config map and secret. The config map and secret contain `ObjectBucket` access information. Adding the access information to the Operator configuration makes it accessible to the {product-short} container by adding the following environment variables to the container: * `BUCKET_NAME` * `BUCKET_HOST` @@ -21,7 +21,7 @@ These variables are then used in the TechDocs plugin configuration. .Procedure -* In the {product-short} `Backstage` CR, enter the name of the {product-short} `ObjectBucketClaim` config map as the value for the `spec.application.extraEnvs.configMaps` field and enter the {product-short} `ObjectBucketClaim` secret name as the value for the `spec.application.extraEnvs.secrets` field. For example: +* In your `{product-custom-resource-type}` CR, enter the name of the {product-short} `ObjectBucketClaim` config map as the value for the `spec.application.extraEnvs.configMaps` field and enter the {product-short} `ObjectBucketClaim` secret name as the value for the `spec.application.extraEnvs.secrets` field. For example: + [source,yaml] ---- diff --git a/modules/dynamic-plugins/proc-config-dynamic-plugins-rhdh-operator.adoc b/modules/dynamic-plugins/proc-config-dynamic-plugins-rhdh-operator.adoc index b10d15dac..d2cfd3dbf 100644 --- a/modules/dynamic-plugins/proc-config-dynamic-plugins-rhdh-operator.adoc +++ b/modules/dynamic-plugins/proc-config-dynamic-plugins-rhdh-operator.adoc @@ -6,7 +6,7 @@ [id="proc-config-dynamic-plugins-rhdh-operator_{context}"] = Installing dynamic plugins with the {product} Operator -You can store the configuration for dynamic plugins in a `ConfigMap` object that your `Backstage` custom resource (CR) can reference. +You can store the configuration for dynamic plugins in a `ConfigMap` object that your `{product-custom-resource-type}` custom resource (CR) can reference. [NOTE] ==== @@ -50,7 +50,7 @@ data: + image::rhdh/operator-install-2.png[] -. Add the `dynamicPluginsConfigMapName` field to your `Backstage` CR. For example: +. Add the `dynamicPluginsConfigMapName` field to your `{product-custom-resource-type}` CR. For example: + [source,yaml] ---- diff --git a/modules/dynamic-plugins/proc-topology-configure.adoc b/modules/dynamic-plugins/proc-topology-configure.adoc index 897f966e6..96781c5fd 100644 --- a/modules/dynamic-plugins/proc-topology-configure.adoc +++ b/modules/dynamic-plugins/proc-topology-configure.adoc @@ -231,7 +231,7 @@ annotations: The Red Hat OpenShift Dev Spaces instance is not accessible using the source code editor if the `backstage.io/kubernetes-namespace` annotation is added to the `catalog-info.yaml` file. -To retrieve the instance URL, you require the CheCluster Custom Resource (CR). As the CheCluster CR is created in the openshift-devspaces namespace, the instance URL is not retrieved if the namespace annotation value is not openshift-devspaces. +To retrieve the instance URL, you require the CheCluster custom resource (CR). As the CheCluster CR is created in the openshift-devspaces namespace, the instance URL is not retrieved if the namespace annotation value is not openshift-devspaces. === Label selector query annotation You can write your own custom label, which RHDH uses to find the Kubernetes resources. The label selector takes precedence over the ID annotations: diff --git a/modules/installation/proc-deploy-rhdh-instance-eks.adoc b/modules/installation/proc-deploy-rhdh-instance-eks.adoc index 548aafe4e..8f4646deb 100644 --- a/modules/installation/proc-deploy-rhdh-instance-eks.adoc +++ b/modules/installation/proc-deploy-rhdh-instance-eks.adoc @@ -82,7 +82,7 @@ kubectl patch serviceaccount default \ ---- -- -. Create a Custom Resource file using the following template: +. Create your `{product-custom-resource-type}` custom resource using the following template: + -- [source,yaml,subs="+attributes,+quotes"] @@ -143,7 +143,7 @@ spec: pathType: Prefix backend: service: - # TODO: my-rhdh is the name of your Backstage Custom Resource. + # TODO: my-rhdh is the name of your `{product-custom-resource-type}` custom resource. # Adjust if you changed it! name: backstage-my-rhdh port: diff --git a/modules/installation/proc-deploy-rhdh-instance-gke.adoc b/modules/installation/proc-deploy-rhdh-instance-gke.adoc index c67d58068..d50e9cc61 100644 --- a/modules/installation/proc-deploy-rhdh-instance-gke.adoc +++ b/modules/installation/proc-deploy-rhdh-instance-gke.adoc @@ -84,10 +84,10 @@ kubectl patch serviceaccount default \ ---- -- -. Create a Custom Resource file using the following template: +. Create your `{product-custom-resource-type}` custom resource (CR) file using the following template: + -- -.Custom Resource fragment +.Custom resource fragment [source,yaml,subs="attributes+"] ---- apiVersion: rhdh.redhat.com/v1alpha3 @@ -173,7 +173,7 @@ spec: pathType: Prefix backend: service: - # TODO: my-rhdh is the name of your Backstage Custom Resource. + # TODO: my-rhdh is the name of your `{product-custom-resource-type}` custom resource. # Adjust if you changed it! name: backstage-my-rhdh port: diff --git a/modules/installation/proc-rhdh-deploy-aks-operator.adoc b/modules/installation/proc-rhdh-deploy-aks-operator.adoc index 15d3d7b2e..0bc3fc947 100644 --- a/modules/installation/proc-rhdh-deploy-aks-operator.adoc +++ b/modules/installation/proc-rhdh-deploy-aks-operator.adoc @@ -128,7 +128,7 @@ stringData: ---- -- -. Create a Custom Resource (CR) manifest file named `rhdh.yaml` and include the previously created `rhdh-pull-secret` as follows: +. Create your `{product-custom-resource-type}` custom resource (CR) manifest file named `rhdh.yaml` and include the previously created `rhdh-pull-secret` as follows: + -- [source,yaml] diff --git a/modules/observe/proc-admin-enabling-metrics-ocp-operator.adoc b/modules/observe/proc-admin-enabling-metrics-ocp-operator.adoc index 44d94ef4b..f169e2f3a 100644 --- a/modules/observe/proc-admin-enabling-metrics-ocp-operator.adoc +++ b/modules/observe/proc-admin-enabling-metrics-ocp-operator.adoc @@ -41,7 +41,7 @@ spec: - port: http-metrics path: '/metrics' ---- -<1> Replace `` with the name of your {product} CR. +<1> Replace `` with the name of your `{product-custom-resource-type}` custom resource. <2> Replace `` with the name of the {ocp-short} project where your {product} instance is running. . Apply the `ServiceMonitor` CR by running the following command: diff --git a/modules/observe/proc-customizing-telemetry-segment-using-operator.adoc b/modules/observe/proc-customizing-telemetry-segment-using-operator.adoc index b3ecb6a50..0d08938f2 100644 --- a/modules/observe/proc-customizing-telemetry-segment-using-operator.adoc +++ b/modules/observe/proc-customizing-telemetry-segment-using-operator.adoc @@ -10,7 +10,7 @@ You can configure integration with your Segment source by using the Operator. .Procedure -. Add the following YAML code in your `Backstage` custom resource (CR): +. Add the following YAML code in your `{product-custom-resource-type}` custom resource (CR): + [source,yaml] ---- diff --git a/modules/observe/proc-disabling-telemetry-using-operator.adoc b/modules/observe/proc-disabling-telemetry-using-operator.adoc index 04bb977e7..9622935d4 100644 --- a/modules/observe/proc-disabling-telemetry-using-operator.adoc +++ b/modules/observe/proc-disabling-telemetry-using-operator.adoc @@ -33,7 +33,7 @@ data: disabled: true ---- -. Set the value of the `dynamicPluginsConfigMapName` parameter to the name of the ConfigMap file in your `Backstage` custom resource: +. Set the value of the `dynamicPluginsConfigMapName` parameter to the name of your `dynamic-plugins-rhdh` config map in your `{product-custom-resource-type}` custom resource: + [source,yaml] ---- diff --git a/modules/observe/proc-enabling-telemetry-using-operator.adoc b/modules/observe/proc-enabling-telemetry-using-operator.adoc index a87fd29fb..beddcdf01 100644 --- a/modules/observe/proc-enabling-telemetry-using-operator.adoc +++ b/modules/observe/proc-enabling-telemetry-using-operator.adoc @@ -33,7 +33,7 @@ data: disabled: false ---- -. Set the value of the `dynamicPluginsConfigMapName` parameter to the name of the ConfigMap file in your `Backstage` custom resource: +. Set the value of the `dynamicPluginsConfigMapName` parameter to the name of your `dynamic-plugins-rhdh` config map in your `{product-custom-resource-type}` custom resource: + [source,yaml] ----