Merge pull request #64949 from slovern/TELCODOCS-1085-fix

nit fixes: TELCODOCS-1085 - custom source CRs for PolicyGenTemplate CR

Author: jldohmann

modules/ztp-adding-new-content-to-gitops-ztp.adoc

@@ -11,9 +11,9 @@ Perform the following procedure to add new content to the {ztp} pipeline.
 
 .Procedure
 
-. Create a subdirectory,  `source-crs`,  in the directory containing the `kustomization.yaml` file for the `PolicyGenTemplate` CR. 
+. Create a subdirectory named `source-crs` in the directory that contains the `kustomization.yaml` file for the `PolicyGenTemplate` custom resource (CR).
 
-. Add your custom CRs to this folder, as shown in the following example:
+. Add your custom CRs to the `source-crs` subdirectory, as shown in the following example:
 +
 [source,text]
 ----
@@ -26,17 +26,17 @@ example
     └── source-crs <1>
         ├── PaoCatalogSource.yaml
         ├── PaoSubscription.yaml
-        ├── bell
+        ├── custom-crs
         |   ├── apiserver-config.yaml
         |   └── disable-nic-lldp.yaml
         └── elasticsearch
             ├── ElasticsearchNS.yaml
             └── ElasticsearchOperatorGroup.yaml
 ----
-<1> The `sources-crs` subdirectory is in the same directory as the `kustomization.yaml` file.
+<1> The `source-crs` subdirectory must be in the same directory as the `kustomization.yaml` file.
 
-. Update the required `PolicyGenTemplate` CRs to include references to the content you added in the `custom-crs` directory.
-+ 
+. Update the required `PolicyGenTemplate` CRs to include references to the content you added in the `source-crs/custom-crs` and `source-crs/elasticsearch` directories. For example:
++
 [source,yaml]
 ----
 apiVersion: ran.openshift.io/v1
@@ -68,8 +68,9 @@ spec:
       remediationAction: inform 
       policyName: "group-dev-lso-operator-group" 
     - fileName: StorageSubscription.yaml
-      remediationAction: inform 
-      policyName: "group-dev-lso-sub" 
+      remediationAction: inform
+      policyName: "group-dev-lso-sub"
+    #These are custom local polices that come from the source-crs directory in the git repo
     # Performance Addon Operator
     - fileName: PaoSubscriptionNS.yaml
       remediationAction: inform 
@@ -78,31 +79,30 @@ spec:
       remediationAction: inform 
       policyName: "group-dev-pao-cat-source" 
       spec:
-        image: <image URL here>
+        image: <image_URL_here>
     - fileName: PaoSubscription.yaml
-      remediationAction: inform 
-      policyName: "group-dev-pao-sub" 
-    #These are custom local polices that come from the source-crs directory in the git repo
+      remediationAction: inform
+      policyName: "group-dev-pao-sub"
     #Elasticsearch Operator
     - fileName: elasticsearch/ElasticsearchNS.yaml <1>
       remediationAction: inform 
       policyName: "group-dev-elasticsearch-ns" 
     - fileName: elasticsearch/ElasticsearchOperatorGroup.yaml
       remediationAction: inform 
       policyName: "group-dev-elasticsearch-operator-group" 
-    #Bell Custom Resources
-    - fileName: bell/apiserver-config.yaml
-      remediationAction: inform 
-      policyName: "group-dev-apiserver-config" 
-    - fileName: bell/disable-nic-lldp.yaml
-      remediationAction: inform 
-      policyName: "group-dev-disable-nic-lldp" 
+    #Custom Resources
+    - fileName: custom-crs/apiserver-config.yaml <1>
+      remediationAction: inform
+      policyName: "group-dev-apiserver-config"
+    - fileName: custom-crs/disable-nic-lldp.yaml
+      remediationAction: inform
+      policyName: "group-dev-disable-nic-lldp"
 ----
-<1> Set `fileName` to include the custom CR subfolder from the `/source-crs` parent.
+<1> Set `fileName` to include the relative path to the file from the `/source-crs` parent directory.
 
-. Commit the `PolicyGenTemplate` change in Git, and then push to the Git repository being monitored by the GitOps ZTP Argo CD policies application.
+. Commit the `PolicyGenTemplate` change in Git, and then push to the Git repository that is monitored by the GitOps ZTP Argo CD policies application.
 
-. Update the `ClusterGroupUpgrade` CR to include the changed `PolicyGenTemplate` and save it as `cgu-test.yaml`.
+. Update the `ClusterGroupUpgrade` CR to include the changed `PolicyGenTemplate` and save it as `cgu-test.yaml`. The following example shows a generated `cgu-test.yaml` file.
 +
 [source,yaml]
 ----
@@ -123,26 +123,26 @@ spec:
 ----
 
 . Apply the updated `ClusterGroupUpgrade` CR by running the following command:
-[source, terminal]
 +
+[source,terminal]
 ----
 $ oc apply -f cgu-test.yaml
 ----
 
 .Verification
 
-. Check that the updates have succeeded by running the following command:
+* Check that the updates have succeeded by running the following command:
 +
 [source, terminal]
 ----
-$ oc  get cgu -A
+$ oc get cgu -A
 ----
 +
 .Example output
 +
 [source, terminal]
 ----
 NAMESPACE     NAME               AGE   STATE        DETAILS
-ztp-clusters     custom-source-cr   6s    InProgress   Remediating non-compliant policies
+ztp-clusters  custom-source-cr   6s    InProgress   Remediating non-compliant policies
 ztp-install   cluster1           19h   Completed    All clusters are compliant with all the managed policies
 ----