From 478d03cd663c89bd86205dca0b45b48975b1cf49 Mon Sep 17 00:00:00 2001 From: Andrea Hoffer Date: Tue, 20 Oct 2020 15:53:32 -0400 Subject: [PATCH] Fixing build issues and warnings --- _topic_map.yml | 7 ++-- ...-logging-collector-log-forward-syslog.adoc | 24 +++++++------- ...bugging-low-latency-cnf-tuning-status.adoc | 2 +- ...tallation-adding-registry-pull-secret.adoc | 4 +-- ...gration-installing-cam-operator-ocp-3.adoc | 2 +- modules/nw-aws-nlb-new-cluster.adoc | 2 +- modules/olm-mirroring-catalog.adoc | 3 +- modules/olm-terms.adoc | 33 ++++++++++--------- .../update-configuring-image-signature.adoc | 2 +- operators/understanding/olm-common-terms.adoc | 2 +- .../storage-configuration.adoc | 12 +++---- serverless/networking/serverless-ossm.adoc | 2 +- 12 files changed, 49 insertions(+), 46 deletions(-) diff --git a/_topic_map.yml b/_topic_map.yml index 4c6515eb6a26..a06d5ddb92a0 100644 --- a/_topic_map.yml +++ b/_topic_map.yml @@ -1374,9 +1374,10 @@ Topics: File: cluster-logging-viewing - Name: Viewing cluster logs using Kibana File: cluster-logging-visualizer -- Name: Viewing cluster logs using Kibana - File: cluster-logging-kibana-interface - Distros: openshift-dedicated +# TODO: This file doesn't exist anymore - update if necessary for dedicated +# - Name: Viewing cluster logs using Kibana +# File: cluster-logging-kibana-interface +# Distros: openshift-dedicated - Name: Forwarding logs to third party systems File: cluster-logging-external Distros: openshift-enterprise,openshift-webscale,openshift-origin diff --git a/modules/cluster-logging-collector-log-forward-syslog.adoc b/modules/cluster-logging-collector-log-forward-syslog.adoc index a0a731bcd26f..1aff5a20f64e 100644 --- a/modules/cluster-logging-collector-log-forward-syslog.adoc +++ b/modules/cluster-logging-collector-log-forward-syslog.adoc @@ -3,7 +3,7 @@ // * logging/cluster-logging-external.adoc [id="cluster-logging-collector-log-forward-syslog_{context}"] -= Forwarding logs using the syslog protocol += Forwarding logs using the syslog protocol You can use the *syslog* link:https://tools.ietf.org/html/rfc3164[RFC3164] or link:https://tools.ietf.org/html/rfc5424[RFC5424] protocol to send a copy of your logs to an external log aggregator configured to accept the protocol instead of, or in addition to, the default Elasticsearch log store. You are responsible for configuring the external log aggregator to receive the logs from {product-title}. @@ -11,7 +11,7 @@ To configure log forwarding using the *syslog* protocol, create a `ClusterLogFor [NOTE] ==== -Alternately, you can use a ConfigMap to forward logs using the *syslog* RFC3164 protocols. However, this method is deprecated in {product-title} and will be removed in a future release. +Alternately, you can use a ConfigMap to forward logs using the *syslog* RFC3164 protocols. However, this method is deprecated in {product-title} and will be removed in a future release. ==== .Procedure @@ -30,13 +30,13 @@ spec: - name: rsyslog-east <3> type: syslog <4> syslog: <5> - facility: local0 - rfc: RFC3164 - payloadKey: message - severity: informational + facility: local0 + rfc: RFC3164 + payloadKey: message + severity: informational url: 'tls://rsyslogserver.east.example.com:514' <6> secret: <7> - name: syslog-secret + name: syslog-secret - name: rsyslog-west type: syslog syslog: @@ -46,7 +46,7 @@ spec: procID: myproc rfc: RFC5424 severity: debug - url: 'udp://rsyslogserver.west.example.com:514' + url: 'udp://rsyslogserver.west.example.com:514' pipelines: - name: syslog-east <8> inputRefs: <9> @@ -101,9 +101,9 @@ $ oc delete pod --selector logging-infra=fluentd ---- [id=cluster-logging-collector-log-forward-examples-syslog-parms] -=== Syslog parameters: +== Syslog parameters -You can configure the following for the `syslog` outputs. For more information, see the syslog link:https://tools.ietf.org/html/rfc3164[RFC3164] or link:https://tools.ietf.org/html/rfc5424[RFC5424] RFC. +You can configure the following for the `syslog` outputs. For more information, see the syslog link:https://tools.ietf.org/html/rfc3164[RFC3164] or link:https://tools.ietf.org/html/rfc5424[RFC5424] RFC. * facility: The link:https://tools.ietf.org/html/rfc5424#section-6.2.1[syslog facility]. The value can be a decimal integer or a case-insensitive keyword: ** `0` or `kern` for kernel messages @@ -138,12 +138,10 @@ You can configure the following for the `syslog` outputs. For more information, * trimPrefix: Remove the specified prefix from the tag. [id=cluster-logging-collector-log-forward-examples-syslog-5424] -=== Additional RFC5424 syslog parameters +== Additional RFC5424 syslog parameters The following parameters apply to RFC5424: * appName: The APP-NAME is a free-text string that identifies the application that sent the log. Must be specified for `RFC5424`. * msgID: The MSGID is a free-text string that identifies the type of message. Must be specified for `RFC5424`. * procID: The PROCID is a free-text string. A a change in the value indicates a discontinuity in syslog reporting. Must be specified for `RFC5424`. - - diff --git a/modules/cnf-debugging-low-latency-cnf-tuning-status.adoc b/modules/cnf-debugging-low-latency-cnf-tuning-status.adoc index 0580a6182aaf..512ef07fbf92 100644 --- a/modules/cnf-debugging-low-latency-cnf-tuning-status.adoc +++ b/modules/cnf-debugging-low-latency-cnf-tuning-status.adoc @@ -58,7 +58,7 @@ Each of these types contain the following fields: `Message string`:: The human readable reason describing the state and error details, if any. [id="cnf-debugging-low-latency-cnf-tuning-status-machineconfigpools_{context}"] -=== MachineConfigPools +== MachineConfigPools A performance profile and its created products are applied to a node according to an associated machine config pool (MCP). The MCP holds valuable information about the progress of applying the machine configurations created by performance addons that encompass kernel args, KubeConfig, huge pages allocation, and deployment of rt-kernel. The performance addons controller monitors changes in the MCP and updates the PerformanceProfile status accordingly. diff --git a/modules/installation-adding-registry-pull-secret.adoc b/modules/installation-adding-registry-pull-secret.adoc index 5100b5b43ba7..4ce9a5df6299 100644 --- a/modules/installation-adding-registry-pull-secret.adoc +++ b/modules/installation-adding-registry-pull-secret.adoc @@ -118,8 +118,8 @@ endif::[] ifdef::openshift-origin[] { "auths": { - "": { - "auth": "", + "": { <1> + "auth": "", <2> "email": "you@example.com" } } diff --git a/modules/migration-installing-cam-operator-ocp-3.adoc b/modules/migration-installing-cam-operator-ocp-3.adoc index 164e470ce13c..99872b2cce15 100644 --- a/modules/migration-installing-cam-operator-ocp-3.adoc +++ b/modules/migration-installing-cam-operator-ocp-3.adoc @@ -91,7 +91,7 @@ containers: ... env: - name: REGISTRY - value: <2> + value: <3> ---- <1> Specify your mirror registry and the `sha256` value of the Operator image in the `mapping.txt` file. <2> Specify your mirror registry and the `sha256` value of the Operator image in the `mapping.txt` file. diff --git a/modules/nw-aws-nlb-new-cluster.adoc b/modules/nw-aws-nlb-new-cluster.adoc index c85aeaad25eb..1c56b93d4be4 100644 --- a/modules/nw-aws-nlb-new-cluster.adoc +++ b/modules/nw-aws-nlb-new-cluster.adoc @@ -19,7 +19,7 @@ Create an Ingress Controller backed by an AWS NLB on a new cluster. + [source,terminal] ---- -$ ./openshift-install create manifests --dir= +$ ./openshift-install create manifests --dir= <1> ---- <1> For ``, specify the name of the directory that contains the `install-config.yaml` file for your cluster. diff --git a/modules/olm-mirroring-catalog.adoc b/modules/olm-mirroring-catalog.adoc index a2779cf3764b..d13667f3255e 100644 --- a/modules/olm-mirroring-catalog.adoc +++ b/modules/olm-mirroring-catalog.adoc @@ -84,7 +84,8 @@ $ oc adm catalog mirror \ [--filter-by-os="/"] \//<5> [--manifests-only] <6> ---- -<1> Specify the index image for the catalog you want to mirror. For example, this might be a pruned index image that you created previously, or one of the source index images for the default catalogs, such as `{index-image-pullspec}`. <2> Specify the target registry to mirror the Operator content to. +<1> Specify the index image for the catalog you want to mirror. For example, this might be a pruned index image that you created previously, or one of the source index images for the default catalogs, such as `{index-image-pullspec}`. +<2> Specify the target registry to mirror the Operator content to. <3> Optional: If required, specify the location of your registry credentials file. <4> Optional: If you do not want to configure trust for the target registry, add the `--insecure` flag. <5> Optional: Because the catalog might reference images that support multiple architectures and operating systems, you can filter by architecture and operating system to mirror only the images that match. Valid values are `linux/amd64`, `linux/ppc64le`, and `linux/s390x`. diff --git a/modules/olm-terms.adoc b/modules/olm-terms.adoc index 1033860ad413..c6d74ff7de21 100644 --- a/modules/olm-terms.adoc +++ b/modules/olm-terms.adoc @@ -2,32 +2,35 @@ // // * operators/understanding/olm/olm-common-terms.adoc +[id="olm-common-terms-glossary_{context}"] += Common Operator Framework terms + [id="olm-common-terms-bundle_{context}"] -= Bundle +== Bundle In the Bundle Format, a _bundle_ is a collection of an Operator CSV, manifests, and metadata. Together, they form a unique version of an Operator that can be installed onto the cluster. [id="olm-common-terms-bundle-image_{context}"] -= Bundle image +== Bundle image In the Bundle Format, a _bundle image_ is a container image that is built from Operator manifests and that contains one bundle. Bundle images are stored and distributed by Open Container Initiative (OCI) spec container registries, such as Quay.io or DockerHub. [id="olm-common-terms-catalogsource_{context}"] -= CatalogSource +== CatalogSource A _CatalogSource_ is a repository of CSVs, CRDs, and packages that define an application. [id="olm-common-terms-catalog-image_{context}"] -= Catalog image +== Catalog image In the Package Manifest Format, a _catalog image_ is a containerized datastore that describes a set of Operator metadata and update metadata that can be installed onto a cluster using OLM. [id="olm-common-terms-channel_{context}"] -= Channel +== Channel A _channel_ defines a stream of updates for an Operator and is used to roll out updates for subscribers. The head points to the latest version of that channel. For example, a `stable` channel would have all stable versions of an Operator @@ -37,11 +40,11 @@ An Operator can have several channels, and a Subscription binding to a certain channel would only look for updates in that channel. [id="olm-common-terms-channel-head_{context}"] -= Channel head +== Channel head A _channel head_ refers to the latest known update in a particular channel. [id="olm-common-terms-csv_{context}"] -= ClusterServiceVersion +== ClusterServiceVersion A _ClusterServiceVersion_ (CSV) is a YAML manifest created from Operator metadata that assists OLM in running the Operator in a cluster. It is the metadata that accompanies an Operator container image, used to populate user @@ -51,7 +54,7 @@ like the RBAC rules it requires and which custom resources (CRs) it manages or depends on. [id="olm-common-terms-dependency_{context}"] -= Dependency +== Dependency An Operator may have a _dependency_ on another Operator being present in the cluster. For example, the Vault Operator has a dependency on the etcd Operator for its data persistence layer. @@ -62,7 +65,7 @@ dependency is resolved by finding and installing an Operator in a Catalog that satisfies the required CRD API, and is not related to packages or bundles. [id="olm-common-terms-index-image_{context}"] -= Index image +== Index image In the Bundle Format, an _index image_ refers to an image of a database (a database snapshot) that contains information about Operator bundles including CSVs and CRDs of all versions. This index can host a history of Operators on a @@ -70,35 +73,35 @@ cluster and be maintained by adding or removing Operators using the `opm` CLI tool. [id="olm-common-terms-installplan_{context}"] -= InstallPlan +== InstallPlan An _InstallPlan_ is a calculated list of resources to be created to automatically install or upgrade a CSV. [id="olm-common-terms-operatorgroup_{context}"] -= OperatorGroup +== OperatorGroup An _OperatorGroup_ configures all Operators deployed in the same namespace as the OperatorGroup object to watch for their CR in a list of namespaces or cluster-wide. [id="olm-common-terms-package_{context}"] -= Package +== Package In the Bundle Format, a _package_ is a directory that encloses all released history of an Operator with each version. A released version of an Operator is described in a ClusterServiceVersion (CSV) manifest alongside the CustomResourceDefinitions (CRDs). [id="olm-common-terms-registry_{context}"] -= Registry +== Registry A _registry_ is a database that stores bundle images of Operators, each with all of its latest and historical versions in all channels. [id="olm-common-terms-subscription_{context}"] -= Subscription +== Subscription A _Subscription_ keeps CSVs up to date by tracking a channel in a package. [id="olm-common-terms-update-graph_{context}"] -= Update graph +== Update graph An _update graph_ links versions of CSVs together, similar to the update graph of any other packaged software. Operators can be installed sequentially, or certain versions can be skipped. The update graph is expected to grow only at diff --git a/modules/update-configuring-image-signature.adoc b/modules/update-configuring-image-signature.adoc index a513b601956b..b4c7d96cd08b 100644 --- a/modules/update-configuring-image-signature.adoc +++ b/modules/update-configuring-image-signature.adoc @@ -29,7 +29,7 @@ to update the cluster, such as `4.4.0`. + [source,terminal] ---- -$ ARCHITECTURE= <11> +$ ARCHITECTURE= <1> ---- <1> For `server_architecture`, specify the architecture of the server, such as `x86_64`. diff --git a/operators/understanding/olm-common-terms.adoc b/operators/understanding/olm-common-terms.adoc index 6e11885fe413..736c0966cb98 100644 --- a/operators/understanding/olm-common-terms.adoc +++ b/operators/understanding/olm-common-terms.adoc @@ -9,4 +9,4 @@ This topic provides a glossary of common terms related to the Operator Framework, including Operator Lifecycle Manager (OLM) and the Operator SDK, for both packaging formats: Package Manifest Format and Bundle Format. -include::modules/olm-terms.adoc[leveloffset=+3] +include::modules/olm-terms.adoc[leveloffset=+1] diff --git a/post_installation_configuration/storage-configuration.adoc b/post_installation_configuration/storage-configuration.adoc index 87e99ab87621..70fca1fe03f0 100644 --- a/post_installation_configuration/storage-configuration.adoc +++ b/post_installation_configuration/storage-configuration.adoc @@ -24,19 +24,19 @@ cluster to your requirements, including storage configuration. [id="post-install-dynamic-provisioning"] == Dynamic provisioning -include::modules/dynamic-provisioning-about.adoc[leveloffset=+3] +include::modules/dynamic-provisioning-about.adoc[leveloffset=+2] -include::modules/dynamic-provisioning-available-plugins.adoc[leveloffset=+3] +include::modules/dynamic-provisioning-available-plugins.adoc[leveloffset=+2] include::modules/dynamic-provisioning-defining-storage-class.adoc[leveloffset=+1] -include::modules/dynamic-provisioning-storage-class-definition.adoc[leveloffset=+3] +include::modules/dynamic-provisioning-storage-class-definition.adoc[leveloffset=+2] -include::modules/dynamic-provisioning-annotations.adoc[leveloffset=+3] +include::modules/dynamic-provisioning-annotations.adoc[leveloffset=+2] -include::modules/dynamic-provisioning-cinder-definition.adoc[leveloffset=+3] +include::modules/dynamic-provisioning-cinder-definition.adoc[leveloffset=+2] -include::modules/dynamic-provisioning-aws-definition.adoc[leveloffset=+3] +include::modules/dynamic-provisioning-aws-definition.adoc[leveloffset=+2] include::modules/dynamic-provisioning-azure-disk-definition.adoc[leveloffset=+2] diff --git a/serverless/networking/serverless-ossm.adoc b/serverless/networking/serverless-ossm.adoc index ad6a13260286..ec9f4e0791e4 100644 --- a/serverless/networking/serverless-ossm.adoc +++ b/serverless/networking/serverless-ossm.adoc @@ -82,7 +82,7 @@ spec: $ oc apply -f ---- -include::modules/serverless-service-mesh-enable-sidecar-injection.adoc[leveloffset=+2] +include::modules/serverless-service-mesh-enable-sidecar-injection.adoc[leveloffset=+1] [id="serverless-ossm-additional-resources"] == Additional resources