Merge pull request #34352 from jboxman/make-it-right-make-it-good

jboxman · web-flow · commit b55311c11115 · 2021-08-23T16:15:27.000-04:00
Fix invalid YAML
diff --git a/modules/admission-webhook-types.adoc b/modules/admission-webhook-types.adoc
@@ -27,7 +27,7 @@ webhooks:
     service:
       namespace: default <5>
       name: kubernetes <6>
-     path: <webhook_url> <7>
+      path: <webhook_url> <7>
     caBundle: <ca_signing_certificate> <8>
   rules: <9>
   - operations: <10>
@@ -81,7 +81,7 @@ webhooks:
     service:
       namespace: default  <5>
       name: kubernetes <6>
-     path: <webhook_url> <7>
+      path: <webhook_url> <7>
     caBundle: <ca_signing_certificate> <8>
   rules: <9>
   - operations: <10>
diff --git a/modules/authentication-configmap-creating-from-directories.adoc b/modules/authentication-configmap-creating-from-directories.adoc
@@ -119,7 +119,7 @@ metadata:
   creationTimestamp: 2016-02-18T18:34:05Z
   name: game-config
   namespace: default
-  resourceVersion: "407"-
+  resourceVersion: "407"
   selflink: /api/v1/namespaces/default/configmaps/game-config
   uid: 30944725-d66e-11e5-8cd0-68f728db1985
 ----
diff --git a/modules/builds-gitconfig-file.adoc b/modules/builds-gitconfig-file.adoc
@@ -21,7 +21,7 @@ $ oc create secret generic <secret_name> --from-file=<path/to/.gitconfig>
 SSL verification can be turned off if `sslVerify=false` is set for the `http`
 section in your `.gitconfig` file:
 
-[source,yaml]
+[source,text]
 ----
 [http]
         sslVerify=false
diff --git a/modules/deployments-exec-cmd-in-container.adoc b/modules/deployments-exec-cmd-in-container.adoc
@@ -15,8 +15,7 @@ You can add a command to a container, which modifies the container's start-up be
 ----
 spec:
   containers:
-    -
-    name: <container_name>
+  - name: <container_name>
     image: 'image'
     command:
       - '<command>'
@@ -32,8 +31,7 @@ For example, to execute the `java` command with the `-jar` and `/opt/app-root/sp
 ----
 spec:
   containers:
-    -
-    name: example-spring-boot
+  - name: example-spring-boot
     image: 'image'
     command:
       - java
diff --git a/modules/gitops-release-notes-1-1.adoc b/modules/gitops-release-notes-1-1.adoc
@@ -78,46 +78,47 @@ This is a breaking change and needs the following steps to be performed manually
 .Example argocd config map YAML
 [source,yaml]
 ----
-    kind: ConfigMap
-    apiVersion: v1
-    metadata:
-     selfLink: /api/v1/namespaces/openshift-gitops/configmaps/argocd-cm
-     resourceVersion: '112532'
-     name: argocd-cm
-     uid: f5226fbc-883d-47db-8b53-b5e363f007af
-     creationTimestamp: '2021-04-16T19:24:08Z'
-     managedFields:
-    ...
-     namespace: openshift-gitops
-     labels:
-       app.kubernetes.io/managed-by: argocd-cluster
-       app.kubernetes.io/name: argocd-cm
-       app.kubernetes.io/part-of: argocd
-    data:                                            "" <1>
-     admin.enabled: 'true'
-     statusbadge.enabled: 'false'
-     resource.exclusions: |
-       - apiGroups:
-         - tekton.dev
-         clusters:
-         - '*'
-         kinds:
-         - TaskRun
-         - PipelineRun
-     ga.trackingid: ''
-     repositories: |
-       - type: git
-         url: https://github.com/user-name/argocd-example-apps
-     ga.anonymizeusers: 'false'
-     help.chatUrl: ''
-     url: >-  https://argocd-cluster-server-openshift-gitops.apps.dev-svc-4.7-041614.devcluster.openshift.com   "" <2>
-     help.chatText: ''
-     kustomize.buildOptions: ''
-     resource.inclusions: ''
-     repository.credentials: ''
-     users.anonymous.enabled: 'false'
-     configManagementPlugins: ''
-     application.instanceLabelKey: ''
+kind: ConfigMap
+apiVersion: v1
+metadata:
+selfLink: /api/v1/namespaces/openshift-gitops/configmaps/argocd-cm
+resourceVersion: '112532'
+name: argocd-cm
+uid: f5226fbc-883d-47db-8b53-b5e363f007af
+creationTimestamp: '2021-04-16T19:24:08Z'
+managedFields:
+...
+namespace: openshift-gitops
+labels:
+  app.kubernetes.io/managed-by: argocd-cluster
+  app.kubernetes.io/name: argocd-cm
+  app.kubernetes.io/part-of: argocd
+data: "" <1>
+admin.enabled: 'true'
+statusbadge.enabled: 'false'
+resource.exclusions: |
+  - apiGroups:
+    - tekton.dev
+    clusters:
+    - '*'
+    kinds:
+    - TaskRun
+    - PipelineRun
+ga.trackingid: ''
+repositories: |
+  - type: git
+    url: https://github.com/user-name/argocd-example-apps
+ga.anonymizeusers: 'false'
+help.chatUrl: ''
+url: >-
+  https://argocd-cluster-server-openshift-gitops.apps.dev-svc-4.7-041614.devcluster.openshift.com   "" <2>
+help.chatText: ''
+kustomize.buildOptions: ''
+resource.inclusions: ''
+repository.credentials: ''
+users.anonymous.enabled: 'false'
+configManagementPlugins: ''
+application.instanceLabelKey: ''
 ----
 <1> Restore only the `data` section of the content in the `argocd-cm.yml` config map file manually.
 <2> Replace the URL value in the config map entry with the new instance name `openshift-gitops`.
@@ -128,6 +129,7 @@ This is a breaking change and needs the following steps to be performed manually
 +
 [source,yaml]
 ----
-url: >-  https://openshift-gitops-server-openshift-gitops.apps.dev-svc-4.7-041614.devcluster.openshift.com
+url: >-
+  https://openshift-gitops-server-openshift-gitops.apps.dev-svc-4.7-041614.devcluster.openshift.com
 ----
 . Login to the Argo CD cluster and verify that the previous configurations are present.
diff --git a/modules/metering-troubleshooting.adoc b/modules/metering-troubleshooting.adoc
@@ -158,21 +158,21 @@ $ oc edit meteringconfig/operator-metering
 .Example `MeteringConfig` resource
 [source,yaml]
 ----
-  kind: MeteringConfig
-  metadata:
+kind: MeteringConfig
+metadata:
   name: operator-metering
-   namespace: openshift-metering
+  namespace: openshift-metering
+spec:
+  reporting-operator:
   spec:
-   reporting-operator:
-     spec:
-       resources: <1>
-         limits:
-           cpu: 1
-           memory: 750Mi
-         requests:
-           cpu: 500m
-           memory: 500Mi
-  ...
+    resources: <1>
+      limits:
+        cpu: 1
+        memory: 750Mi
+      requests:
+        cpu: 500m
+        memory: 500Mi
+...
 ----
 <1> Add or increase memory limits within the `resources` field of the `MeteringConfig` resource.
 +
diff --git a/modules/nodes-scheduler-taints-tolerations-about.adoc b/modules/nodes-scheduler-taints-tolerations-about.adoc
@@ -33,7 +33,7 @@ spec:
 ....
   template:
 ....
-    spec
+    spec:
       tolerations:
       - key: "key1"
         operator: "Equal"
@@ -145,7 +145,7 @@ spec:
 ....
   template:
 ....
-    spec
+    spec:
       tolerations:
       - key: "key1"
         operator: "Equal"
@@ -201,7 +201,7 @@ spec:
 ....
   template:
 ....
-    spec
+    spec:
       tolerations:
       - key: "key1"
         operator: "Equal"
@@ -258,7 +258,7 @@ spec:
 ....
   template:
 ....
-    spec
+    spec:
       tolerations:
       - key: node.kubernetes.io/not-ready
         operator: Exists
@@ -294,7 +294,7 @@ spec:
 ....
   template:
 ....
-    spec
+    spec:
       tolerations:
       - operator: "Exists"
 ----
diff --git a/modules/nw-endpoint-route53.adoc b/modules/nw-endpoint-route53.adoc
@@ -24,13 +24,13 @@ platform:
     region: us-gov-west-1
     serviceEndpoints:
     - name: ec2
-       url: https://ec2.us-gov-west-1.amazonaws.com
+      url: https://ec2.us-gov-west-1.amazonaws.com
     - name: elasticloadbalancing
-       url: https://elasticloadbalancing.us-gov-west-1.amazonaws.com
+      url: https://elasticloadbalancing.us-gov-west-1.amazonaws.com
     - name: route53
-       url: https://route53.us-gov.amazonaws.com <1>
+      url: https://route53.us-gov.amazonaws.com <1>
     - name: tagging
-       url: https://tagging.us-gov-west-1.amazonaws.com <2>
+      url: https://tagging.us-gov-west-1.amazonaws.com <2>
 ----
 <1> Route 53 defaults to `https://route53.us-gov.amazonaws.com` for both AWS GovCloud (US) regions.
 <2> Only the US-West region has endpoints for tagging. Omit this parameter if your cluster is in another region.
diff --git a/modules/op-about-workspace.adoc b/modules/op-about-workspace.adoc
@@ -43,27 +43,27 @@ spec:
 ...
   tasks: <2>
   - name: build-image
-   taskRef:
-     name: buildah
-     kind: ClusterTask
-   params:
-   - name: TLSVERIFY
-     value: "false"
-   - name: IMAGE
-     value: $(params.IMAGE)
-   workspaces: <3>
-   - name: source <4>
-     workspace: shared-workspace <5>
-   runAfter:
-   - fetch-repository
- - name: apply-manifests
-   taskRef:
-     name: apply-manifests
-   workspaces: <6>
-   - name: source
-     workspace: shared-workspace
-   runAfter:
-    - build-image
+    taskRef:
+      name: buildah
+      kind: ClusterTask
+    params:
+    - name: TLSVERIFY
+      value: "false"
+    - name: IMAGE
+      value: $(params.IMAGE)
+    workspaces: <3>
+    - name: source <4>
+      workspace: shared-workspace <5>
+    runAfter:
+    - fetch-repository
+  - name: apply-manifests
+    taskRef:
+      name: apply-manifests
+    workspaces: <6>
+    - name: source
+      workspace: shared-workspace
+    runAfter:
+      - build-image
 ...
 ----
 <1> List of Workspaces shared between the Tasks defined in the Pipeline. A Pipeline can define as many Workspaces as required. In this example, only one Workspace named `shared-workspace` is declared.
diff --git a/modules/osdk-ansible-extra-variables.adoc b/modules/osdk-ansible-extra-variables.adoc
@@ -18,7 +18,7 @@ kind: "Database"
 metadata:
   name: "example"
 spec:
-  message:"Hello world 2"
+  message: "Hello world 2"
   newParameter: "newParam"
 ----
 
diff --git a/modules/ossm-threescale-authentication.adoc b/modules/ossm-threescale-authentication.adoc
@@ -11,7 +11,6 @@ This release supports the following authentication methods:
 * *Application identifier and key pairs*: immutable identifier and mutable secret key strings.
 * *OpenID authentication method*: client ID string parsed from the JSON Web Token.
 
-
 [id="ossm-threescale-authentication-patterns_{context}"]
 == Applying authentication patterns
 Modify the `instance` custom resource, as illustrated in the following authentication method examples, to configure authentication behavior. You can accept the authentication credentials from:
@@ -90,21 +89,21 @@ You can manipulate this object using the methods described previously. In the ex
 
 [source,yaml]
 ----
-  apiVersion: "config.istio.io/v1alpha2"
-  kind: instance
-  metadata:
-    name: threescale-authorization
-  spec:
-    template: threescale-authorization
-    params:
-      Subject:
-  properties:
-          app_key: request.query_params["app_key"] | request.headers["app-key"] | ""
-          client_id: request.auth.claims["azp"] | ""
+apiVersion: "config.istio.io/v1alpha2"
+kind: instance
+metadata:
+  name: threescale-authorization
+spec:
+  template: threescale-authorization
+  params:
+    subject:
+      properties:
+        app_key: request.query_params["app_key"] | request.headers["app-key"] | ""
+        client_id: request.auth.claims["azp"] | ""
       action:
         path: request.url_path
         method: request.method | "get"
-          service: destination.labels["service-mesh.3scale.net/service-id"] | ""
+        service: destination.labels["service-mesh.3scale.net/service-id"] | ""
 ----
 
 For this integration to work correctly, OIDC must still be done in 3scale for the client to be created in the identity provider (IdP). You should create a link:https://istio.io/latest/docs/tasks/security/authorization/authz-jwt/[Request authorization] for the service you want to protect in the same namespace as that service. The JWT is passed in the `Authorization` header of the request.
diff --git a/modules/persistent-storage-csi-manila-dynamic-provisioning.adoc b/modules/persistent-storage-csi-manila-dynamic-provisioning.adoc
@@ -64,7 +64,7 @@ spec:
     - ReadWriteMany
   resources:
     requests:
-  	storage: 10Gi
+      storage: 10Gi
   storageClassName: csi-manila-gold <2>
 ----
 +
diff --git a/modules/serverless-sinkbinding-kn.adoc b/modules/serverless-sinkbinding-kn.adoc
@@ -50,7 +50,6 @@ apiVersion: batch/v1
 kind: CronJob
 metadata:
   name: heartbeat-cron
-spec:
 spec:
   # Run every minute
   schedule: "* * * * *"
diff --git a/modules/serverless-sinkbinding-yaml.adoc b/modules/serverless-sinkbinding-yaml.adoc
@@ -94,7 +94,6 @@ apiVersion: batch/v1
 kind: CronJob
 metadata:
   name: heartbeat-cron
-spec:
 spec:
   # Run every minute
   schedule: "* * * * *"
diff --git a/modules/templates-rails-configuring-application.adoc b/modules/templates-rails-configuring-application.adoc
@@ -11,7 +11,7 @@ To have your application communicate with the PostgreSQL database service runnin
 * Edit the `default` section in your `config/database.yml` with pre-defined variables as follows:
 +
 .Sample `config/database` YAML file
-[source,yaml]
+[source,eruby]
 ----
 <% user = ENV.key?("POSTGRESQL_ADMIN_PASSWORD") ? "root" : ENV["POSTGRESQL_USER"] %>
 <% password = ENV.key?("POSTGRESQL_ADMIN_PASSWORD") ? ENV["POSTGRESQL_ADMIN_PASSWORD"] : ENV["POSTGRESQL_PASSWORD"] %>
diff --git a/modules/understanding-quick-start-elements.adoc b/modules/understanding-quick-start-elements.adoc
@@ -19,7 +19,7 @@ summary:
   success: Your Spring application is running.
 title: Run the Spring application
 conclusion: >-
-Your Spring application is deployed and ready. <1>
+  Your Spring application is deployed and ready. <1>
 ----
 <1> conclusion text
 
diff --git a/modules/virt-checking_status_of_node_maintenance_cr_tasks.adoc b/modules/virt-checking_status_of_node_maintenance_cr_tasks.adoc
diff --git a/modules/virt-viewing-vmi-ip-cli.adoc b/modules/virt-viewing-vmi-ip-cli.adoc
