From 81e6f47d7ff1547ff46202e0d3f44fcdcda33eea Mon Sep 17 00:00:00 2001 From: Andrea Hoffer Date: Mon, 2 Aug 2021 14:28:45 -0400 Subject: [PATCH] Fixing build and some other minor issues --- ...ecuring-webhooks-with-event-listeners.adoc | 2 +- ...g-troubleshooting-for-critical-alerts.adoc | 2 +- ...lds-identifying-image-change-triggers.adoc | 2 +- ...c-queues-with-the-performance-profile.adoc | 2 +- ...-associated-with-adjusting-nic-queues.adoc | 2 +- modules/cnf-verifying-queue-status.adoc | 2 +- ...config-crd-to-edit-kubelet-parameters.adoc | 4 ++-- modules/nw-router-configuring-dual-stack.adoc | 2 +- modules/op-providing-secure-connection.adoc | 4 ++-- modules/op-release-notes-1-5.adoc | 2 +- modules/op-sample-eventlistener-resource.adoc | 24 +++++++++---------- modules/ossm-observability-visual.adoc | 7 +++--- modules/ossm-rn-technology-preview.adoc | 2 +- modules/tls-profiles-ingress-configuring.adoc | 2 +- modules/virt-cloning-a-datavolume.adoc | 2 +- ...-acm-adding-images-to-mirror-registry.adoc | 2 +- .../serverless-ossm-with-kourier-jwt.adoc | 2 +- service_mesh/v2x/ossm-deploy-production.adoc | 9 +++---- service_mesh/v2x/ossm-reference-smcp.adoc | 11 +++++---- welcome/oke_about.adoc | 2 +- 20 files changed, 44 insertions(+), 43 deletions(-) diff --git a/cicd/pipelines/securing-webhooks-with-event-listeners.adoc b/cicd/pipelines/securing-webhooks-with-event-listeners.adoc index 2a3876c500..6077b78049 100644 --- a/cicd/pipelines/securing-webhooks-with-event-listeners.adoc +++ b/cicd/pipelines/securing-webhooks-with-event-listeners.adoc @@ -13,7 +13,7 @@ Triggers in {pipelines-title} support insecure HTTP and secure HTTPS connections {pipelines-title} runs a `tekton-operator-proxy-webhook` pod that watches for the labels in the namespace. When you add the label to the namespace, the webhook sets the `service.beta.openshift.io/serving-cert-secret-name=` annotation on the `EventListener` object. This, in turn, creates secrets and the required certificates. -[source,terminal,subs="atrributes+"] +[source,terminal,subs="attributes+"] ---- service.beta.openshift.io/serving-cert-secret-name= ---- diff --git a/logging/troubleshooting/cluster-logging-troubleshooting-for-critical-alerts.adoc b/logging/troubleshooting/cluster-logging-troubleshooting-for-critical-alerts.adoc index 7c1a628820..f62fc76ee4 100644 --- a/logging/troubleshooting/cluster-logging-troubleshooting-for-critical-alerts.adoc +++ b/logging/troubleshooting/cluster-logging-troubleshooting-for-critical-alerts.adoc @@ -188,7 +188,7 @@ Replica shards for at least one primary shard are not allocated to nodes. // // .Troubleshooting // TBD -// Note for writer: This is a warning alert and we haven't documented troubleshooting steps for warning alerts yet. I guess you can skip this in currrent release. +// Note for writer: This is a warning alert and we haven't documented troubleshooting steps for warning alerts yet. I guess you can skip this in current release. [id="elasticsearch-node-disk-low-watermark-reached"] == Elasticsearch Node Disk Low Watermark Reached diff --git a/modules/builds-identifying-image-change-triggers.adoc b/modules/builds-identifying-image-change-triggers.adoc index b85cd5bede..cd4cc11237 100644 --- a/modules/builds-identifying-image-change-triggers.adoc +++ b/modules/builds-identifying-image-change-triggers.adoc @@ -51,7 +51,7 @@ kind: BuildConfig This example omits elements that are not related to image change triggers. ==== -.Prerequisite +.Prerequisites * You have configured multiple image change triggers. These triggers have triggered one or more builds. diff --git a/modules/cnf-adjusting-nic-queues-with-the-performance-profile.adoc b/modules/cnf-adjusting-nic-queues-with-the-performance-profile.adoc index 5d04c58793..9d825f090a 100644 --- a/modules/cnf-adjusting-nic-queues-with-the-performance-profile.adoc +++ b/modules/cnf-adjusting-nic-queues-with-the-performance-profile.adoc @@ -3,7 +3,7 @@ // * scalability_and_performance/cnf-performance-addon-operator-for-low-latency-nodes.adoc [id="adjusting-nic-queues-with-the-performance-profile_{context}"] -== Adjusting the NIC queues with the performance profile += Adjusting the NIC queues with the performance profile The performance profile lets you adjust the queue count for each network device. diff --git a/modules/cnf-logging-associated-with-adjusting-nic-queues.adoc b/modules/cnf-logging-associated-with-adjusting-nic-queues.adoc index 2dee7e26c5..80d1eac099 100644 --- a/modules/cnf-logging-associated-with-adjusting-nic-queues.adoc +++ b/modules/cnf-logging-associated-with-adjusting-nic-queues.adoc @@ -3,7 +3,7 @@ // * scalability_and_performance/cnf-performance-addon-operator-for-low-latency-nodes.adoc [id="logging-associated-with-adjusting-nic-queues_{context}"] -== Logging associated with adjusting NIC queues += Logging associated with adjusting NIC queues Log messages detailing the assigned devices are recorded in the respective Tuned daemon logs. The following messages might be recorded to the `/var/log/tuned/tuned.log` file: diff --git a/modules/cnf-verifying-queue-status.adoc b/modules/cnf-verifying-queue-status.adoc index 1a9e229775..a04b4c0de2 100644 --- a/modules/cnf-verifying-queue-status.adoc +++ b/modules/cnf-verifying-queue-status.adoc @@ -3,7 +3,7 @@ // * scalability_and_performance/cnf-performance-addon-operator-for-low-latency-nodes.adoc [id="verifying-queue-status_{context}"] -== Verifying the queue status += Verifying the queue status In this section, a number of examples illustrate different performance profiles and how to verify the changes are applied. diff --git a/modules/create-a-kubeletconfig-crd-to-edit-kubelet-parameters.adoc b/modules/create-a-kubeletconfig-crd-to-edit-kubelet-parameters.adoc index e2a3a46d5e..432dd50825 100644 --- a/modules/create-a-kubeletconfig-crd-to-edit-kubelet-parameters.adoc +++ b/modules/create-a-kubeletconfig-crd-to-edit-kubelet-parameters.adoc @@ -10,7 +10,7 @@ The kubelet configuration is currently serialized as an Ignition configuration, so it can be directly edited. However, there is also a new `kubelet-config-controller` added to the Machine Config Controller (MCC). This allows you to use a `KubeletConfig` custom resource (CR) to edit the kubelet parameters. -You should have one `KubeletConfig` CR for each machine config pool with all the config changes you want for that pool. If you are applying the same content to all the pools, you only need one `KubeletConfig` CR for all the pools. +You should have one `KubeletConfig` CR for each machine config pool with all the config changes you want for that pool. If you are applying the same content to all the pools, you only need one `KubeletConfig` CR for all the pools. You should edit an existing `KubeletConfig` CR to modify existing settings or add new settings instead of creating a new CR for each change. It is recommended to create a new CR only to modify a different machine config pool, or for changes that are intended to be temporary so that you can revert the changes. @@ -220,7 +220,7 @@ Allocatable: pods: 500 <1> ... ---- -<1> In this example, the `pods` parameter should report the value you set in the `KubletConfig` object. +<1> In this example, the `pods` parameter should report the value you set in the `KubeletConfig` object. . Verify the change in the `KubeletConfig` object: + diff --git a/modules/nw-router-configuring-dual-stack.adoc b/modules/nw-router-configuring-dual-stack.adoc index 7025990209..ace7b4a885 100644 --- a/modules/nw-router-configuring-dual-stack.adoc +++ b/modules/nw-router-configuring-dual-stack.adoc @@ -5,7 +5,7 @@ [id="nw-router-configuring-dual-stack_{context}"] = Configuring the {product-title} Ingress Controller for dual-stack networking -If your {product-title} cluster is configured for IPv4 and IPv6 dual-stack networking, your cluster is is externally reachable by {product-title} routes. +If your {product-title} cluster is configured for IPv4 and IPv6 dual-stack networking, your cluster is externally reachable by {product-title} routes. The Ingress Controller automatically serves services that have both IPv4 and IPv6 endpoints, but you can configure the Ingress Controller for single-stack or dual-stack services. diff --git a/modules/op-providing-secure-connection.adoc b/modules/op-providing-secure-connection.adoc index a4cf098a01..fd70f23eb9 100644 --- a/modules/op-providing-secure-connection.adoc +++ b/modules/op-providing-secure-connection.adoc @@ -3,9 +3,9 @@ To create a route with the re-encrypted TLS termination, run: -[source,terminal,subs="atrributes+"] +[source,terminal,subs="attributes+"] ---- -oc create route reencrypt --service= --cert=tls.crt --key=tls.key --ca-cert=ca.crt --hostname= +$ oc create route reencrypt --service= --cert=tls.crt --key=tls.key --ca-cert=ca.crt --hostname= ---- Alternatively, you can create a re-encrypted TLS termination YAML file to create a secure route. diff --git a/modules/op-release-notes-1-5.adoc b/modules/op-release-notes-1-5.adoc index 54a14fa114..d2c0f06018 100644 --- a/modules/op-release-notes-1-5.adoc +++ b/modules/op-release-notes-1-5.adoc @@ -123,7 +123,7 @@ spec: * Support for optional workspaces are added to the `start` command. -* If the plugins are are not present in the `plugins` directory, they are searched in the current path. +* If the plugins are not present in the `plugins` directory, they are searched in the current path. * The `tkn start [task | clustertask | pipeline]` command starts interactively and ask for the `params` value, even when you specify the default parameters are specified. To stop the interactive prompts, pass the `--use-param-defaults` flag at the time of invoking the command. For example: + diff --git a/modules/op-sample-eventlistener-resource.adoc b/modules/op-sample-eventlistener-resource.adoc index ba5a3f371b..39228f911e 100644 --- a/modules/op-sample-eventlistener-resource.adoc +++ b/modules/op-sample-eventlistener-resource.adoc @@ -7,43 +7,43 @@ This section uses the link:https://github.com/openshift/pipelines-tutorial[pipel . Create the `TriggerBinding` resource from the YAML file available in the pipelines-tutorial repository: + -[source,terminal,subs="atrributes+"] +[source,terminal,subs="attributes+"] ---- -oc create -f https://raw.githubusercontent.com/openshift/pipelines-tutorial/master/03_triggers/01_binding.yaml +$ oc create -f https://raw.githubusercontent.com/openshift/pipelines-tutorial/master/03_triggers/01_binding.yaml ---- . Create the `TriggerTemplate` resource from the YAML file available in the pipelines-tutorial repository: + -[source,terminal,subs="atrributes+"] +[source,terminal,subs="attributes+"] ---- -oc create -f https://raw.githubusercontent.com/openshift/pipelines-tutorial/master/03_triggers/02_template.yaml +$ oc create -f https://raw.githubusercontent.com/openshift/pipelines-tutorial/master/03_triggers/02_template.yaml ---- . Create the `Trigger` resource directly from the pipelines-tutorial repository: + -[source,terminal,subs="atrributes+"] +[source,terminal,subs="attributes+"] ---- -oc create -f https://raw.githubusercontent.com/openshift/pipelines-tutorial/master/03_triggers/03_trigger.yaml +$ oc create -f https://raw.githubusercontent.com/openshift/pipelines-tutorial/master/03_triggers/03_trigger.yaml ---- . Create an `EventListener` resource using a secure HTTPS connection: .. Add a label to enable the secure HTTPS connection to the `Eventlistener` resource: + -[source,terminal,subs="atrributes+"] +[source,terminal,subs="attributes+"] ---- -oc label namespace operator.tekton.dev/enable-annotation=enabled +$ oc label namespace operator.tekton.dev/enable-annotation=enabled ---- .. Create the `EventListener` resource from the YAML file available in the pipelines-tutorial repository: + -[source,terminal,subs="atrributes+"] +[source,terminal,subs="attributes+"] ---- -oc create -f https://raw.githubusercontent.com/openshift/pipelines-tutorial/master/03_triggers/04_event_listener.yaml +$ oc create -f https://raw.githubusercontent.com/openshift/pipelines-tutorial/master/03_triggers/04_event_listener.yaml ---- .. Create a route with the re-encrypted TLS termination: + -[source,terminal,subs="atrributes+"] +[source,terminal,subs="attributes+"] ---- -oc create route reencrypt --service= --cert=tls.crt --key=tls.key --ca-cert=ca.crt --hostname= +$ oc create route reencrypt --service= --cert=tls.crt --key=tls.key --ca-cert=ca.crt --hostname= ---- diff --git a/modules/ossm-observability-visual.adoc b/modules/ossm-observability-visual.adoc index 2907742e09..5ddcf1017e 100644 --- a/modules/ossm-observability-visual.adoc +++ b/modules/ossm-observability-visual.adoc @@ -24,13 +24,13 @@ To view a summary of metrics, select any node or edge in the graph to display it [id="ossm-observability-topology_{context}"] == Namespace graphs -The namespace graph is a map of the services, deployments, and workflows in your namespace and arrows that show how data flows through them. +The namespace graph is a map of the services, deployments, and workflows in your namespace and arrows that show how data flows through them. -.Prerequisite +.Prerequisites * Install the Bookinfo sample application. -.Procedure +.Procedure . Send traffic to the mesh by entering the following command several times. + @@ -44,4 +44,3 @@ This command simulates a user visiting the `productpage` microservice of the app . In the main navigation, click *Graph* to view a namespace graph. . Select `bookinfo` from the *Namespace* menu. - diff --git a/modules/ossm-rn-technology-preview.adoc b/modules/ossm-rn-technology-preview.adoc index 46764ef4ee..e16a3bf353 100644 --- a/modules/ossm-rn-technology-preview.adoc +++ b/modules/ossm-rn-technology-preview.adoc @@ -16,7 +16,7 @@ These features provide early access to upcoming product features, enabling custo {ProductName} 2.0.1 introduces technology preview support for the OVN-Kubernetes network type on {product-title} 4.6 and 4.7. -== WebAsssembly technology preview +== WebAssembly technology preview {ProductName} 2.0.0 introduces support for WebAssembly extensions to Envoy Proxy. diff --git a/modules/tls-profiles-ingress-configuring.adoc b/modules/tls-profiles-ingress-configuring.adoc index 96d85b40df..49a64c9dab 100644 --- a/modules/tls-profiles-ingress-configuring.adoc +++ b/modules/tls-profiles-ingress-configuring.adoc @@ -69,7 +69,7 @@ spec: * `old: {}` * `intermediate: {}` * `custom:` -<2> For the `custom` type, specify a list of TLS ciphers and minimum accepted TLS version. +<3> For the `custom` type, specify a list of TLS ciphers and minimum accepted TLS version. . Save the file to apply the changes. diff --git a/modules/virt-cloning-a-datavolume.adoc b/modules/virt-cloning-a-datavolume.adoc index 463355bb2b..8450929064 100644 --- a/modules/virt-cloning-a-datavolume.adoc +++ b/modules/virt-cloning-a-datavolume.adoc @@ -30,7 +30,7 @@ spec: source: pvc: namespace: "" <2> - name: "" <3>) + name: "" <3> storage: <4> resources: requests: diff --git a/modules/ztp-acm-adding-images-to-mirror-registry.adoc b/modules/ztp-acm-adding-images-to-mirror-registry.adoc index 98ef299f6a..f3ce00ab18 100644 --- a/modules/ztp-acm-adding-images-to-mirror-registry.adoc +++ b/modules/ztp-acm-adding-images-to-mirror-registry.adoc @@ -9,7 +9,7 @@ Before you install a cluster on infrastructure that you provision, you must crea .Prerequisites -* Deploy and configure a HTTP server to host the {op-system} image resources on the network. You must be able to access the HTTP server from your computer, and from the machines that you create. +* Deploy and configure an HTTP server to host the {op-system} image resources on the network. You must be able to access the HTTP server from your computer, and from the machines that you create. [IMPORTANT] ==== diff --git a/serverless/knative_serving/serverless-ossm-with-kourier-jwt.adoc b/serverless/knative_serving/serverless-ossm-with-kourier-jwt.adoc index 87518c56e7..6efaa3ee9d 100644 --- a/serverless/knative_serving/serverless-ossm-with-kourier-jwt.adoc +++ b/serverless/knative_serving/serverless-ossm-with-kourier-jwt.adoc @@ -11,7 +11,7 @@ After the {ProductShortName} integration with {ServerlessProductName} and Kourie [IMPORTANT] ==== -You must set the annotation `sidecar.istio.io/rewriteAppHTTPProbers: "true"` in your Knative service as {ServerlessProductName} versions 1.14.0 and higher use a HTTP probe as the readiness probe for Knative services by default. +You must set the annotation `sidecar.istio.io/rewriteAppHTTPProbers: "true"` in your Knative service as {ServerlessProductName} versions 1.14.0 and higher use an HTTP probe as the readiness probe for Knative services by default. ==== include::modules/serverless-ossm-enable-sidecar-injection-with-kourier.adoc[leveloffset=+1] diff --git a/service_mesh/v2x/ossm-deploy-production.adoc b/service_mesh/v2x/ossm-deploy-production.adoc index 118c8fad10..215117d07a 100644 --- a/service_mesh/v2x/ossm-deploy-production.adoc +++ b/service_mesh/v2x/ossm-deploy-production.adoc @@ -1,10 +1,10 @@ [id="ossm-production"] include::modules/ossm-document-attributes.adoc[] -= Configuring Service Mesh for production += Configuring Service Mesh for production :context: ossm-architecture toc::[] -When you are ready to move from a basic installation to production, you must configure your control plane, tracing, and security certificates to meet production requirements. +When you are ready to move from a basic installation to production, you must configure your control plane, tracing, and security certificates to meet production requirements. .Prerequisites @@ -13,6 +13,7 @@ When you are ready to move from a basic installation to production, you must con include::modules/ossm-smcp-prod.adoc[leveloffset=+1] -= Additional resources +[id="additional-resources_ossm-production"] +== Additional resources -For more information about tuning {ProductShortName} for performance, see xref:../../service_mesh/v2x/ossm-performance-scalability.adoc#ossm-performance-scalability[Performance and Scalability]. +* For more information about tuning {ProductShortName} for performance, see xref:../../service_mesh/v2x/ossm-performance-scalability.adoc#ossm-performance-scalability[Performance and scalability]. diff --git a/service_mesh/v2x/ossm-reference-smcp.adoc b/service_mesh/v2x/ossm-reference-smcp.adoc index 6a2e8095ee..b4e2950c9c 100644 --- a/service_mesh/v2x/ossm-reference-smcp.adoc +++ b/service_mesh/v2x/ossm-reference-smcp.adoc @@ -7,12 +7,13 @@ include::modules/ossm-cr-example.adoc[leveloffset=+1] include::modules/ossm-cr-threescale.adoc[leveloffset=+1] -== More information +[id="additional-resources_ossm-reference"] +== Additional resources -For more information about how to configure the features in the `ServiceMeshControlPlane` see the following link. +* For more information about how to configure the features in the `ServiceMeshControlPlane`, see the following links: -* xref:../../service_mesh/v2x/ossm-security.adoc#ossm-security-mtls_ossm-security[Security] +** xref:../../service_mesh/v2x/ossm-security.adoc#ossm-security-mtls_ossm-security[Security] -* xref:../../service_mesh/v2x/ossm-traffic-manage.adoc#ossm-routing-bookinfo_routing-traffic[Traffic management] +** xref:../../service_mesh/v2x/ossm-traffic-manage.adoc#ossm-routing-bookinfo_routing-traffic[Traffic management] -* xref:../../service_mesh/v2x/ossm-observability.adoc#ossm-observability[Metrics and traces] +** xref:../../service_mesh/v2x/ossm-observability.adoc#ossm-observability[Metrics and traces] diff --git a/welcome/oke_about.adoc b/welcome/oke_about.adoc index 316d200585..56b6ccba03 100644 --- a/welcome/oke_about.adoc +++ b/welcome/oke_about.adoc @@ -317,7 +317,7 @@ s| Feature s| {oke} s| {product-title} s| Operator name | OpenShift Container Storage | Not Included - Requires separate subscription | Not Included - Requires separate subscription | OpenShift Container Storage s| Feature s| {oke} s| {product-title} s| Operator name | Ansible Automation Platform Resource Operator | Not Included - Requires separate subscription | Not Included - Requires separate subscription | Ansible Automation Platform Resource Operator -| Business Automation provided by Red hat | Not Included - Requires separate subscription | Not Included - Requires separate subscription | Business Automation Operator +| Business Automation provided by Red Hat | Not Included - Requires separate subscription | Not Included - Requires separate subscription | Business Automation Operator | Data Grid provided by Red Hat | Not Included - Requires separate subscription | Not Included - Requires separate subscription | Data Grid Operator | Red Hat Integration provided by Red Hat | Not Included - Requires separate subscription | Not Included - Requires separate subscription | Red Hat Integration Operator | Red Hat Integration - 3Scale provided by Red Hat | Not Included - Requires separate subscription | Not Included - Requires separate subscription | 3scale