From 781963a15e51664e44c123029555c3d6a071a6e6 Mon Sep 17 00:00:00 2001 From: JoeAldinger Date: Tue, 28 Oct 2025 14:17:37 -0400 Subject: [PATCH] OSDOCS-16696: updates j-n for content-type --- modules/kube-apiserver-operator.adoc | 1 + modules/kube-controller-manager-operator.adoc | 1 + modules/ldap-syncing-examples.adoc | 9 +++------ modules/ldap-syncing-pruning.adoc | 6 ++---- modules/ldap-syncing-running.adoc | 1 + modules/ldap-syncing-spec.adoc | 1 + modules/log-verbosity-descriptions.adoc | 5 +++++ .../logging-into-a-cluster-after-installation.adoc | 1 + modules/machine-api-operator.adoc | 1 + .../machine-config-daemon-metrics-understanding.adoc | 1 + modules/machine-config-operator.adoc | 1 + modules/machine-health-checks-resource.adoc | 6 +++--- modules/machineset-azure-accelerated-networking.adoc | 1 + modules/machineset-azure-ephemeral-os.adoc | 1 + modules/machineset-dedicated-instances.adoc | 1 + modules/machineset-delete-policy.adoc | 1 + modules/machineset-non-guaranteed-instance.adoc | 1 + modules/machineset-vsphere-required-permissions.adoc | 1 + modules/machineset-yaml-osp-sr-iov-port-security.adoc | 1 + modules/machineset-yaml-osp-sr-iov.adoc | 1 + modules/maintaining-bare-metal-hosts.adoc | 1 + modules/master-node-sizing.adoc | 1 + ...t-volume-migration-and-direct-image-migration.adoc | 1 + modules/migration-hooks.adoc | 1 + modules/migration-known-issues.adoc | 1 + ...ping-destination-namespaces-in-the-migplan-cr.adoc | 1 + modules/migration-mtc-cr-manifests.adoc | 1 + modules/migration-mtc-workflow.adoc | 1 + ...ration-network-traffic-redirection-strategies.adoc | 1 + modules/migration-prerequisites.adoc | 1 + modules/migration-provided-metrics.adoc | 1 + modules/migration-terminology.adoc | 1 + modules/migration-writing-ansible-playbook-hook.adoc | 1 + modules/minimum-required-permissions-upi-azure.adoc | 1 + modules/minimum-required-permissions-upi-gcp.adoc | 1 + ...de-deciding-the-number-of-tang-servers-to-use.adoc | 1 + .../nbde-disk-encryption-technology-comparison.adoc | 1 + ...de-emergency-recovery-of-network-connectivity.adoc | 1 + modules/nbde-http-versus-https.adoc | 3 ++- modules/nbde-installation-scenarios.adoc | 1 + modules/nbde-key-escrow.adoc | 1 + modules/nbde-locating-the-tang-servers.adoc | 1 + modules/nbde-logging-considerations.adoc | 1 + modules/nbde-loss-of-a-client-machine.adoc | 1 + modules/nbde-loss-of-a-network-segment.adoc | 1 + modules/nbde-loss-of-a-tang-server.adoc | 1 + modules/nbde-network-bound-disk-encryption.adoc | 1 + modules/nbde-secret-sharing-encryption.adoc | 1 + modules/nbde-tpm-encryption.adoc | 1 + .../nbde-unexpected-loss-of-network-connectivity.adoc | 1 + .../nbde-using-tang-servers-for-disk-encryption.adoc | 1 + ...ning-operator-supported-tuned-daemon-plug-ins.adoc | 1 + modules/nodes-cluster-limit-ranges-creating.adoc | 1 + modules/nodes-cluster-limit-ranges-deleting.adoc | 2 +- modules/nodes-cluster-limit-ranges-viewing.adoc | 1 + modules/nodes-cluster-node-overcommit.adoc | 1 + modules/nodes-containers-copying-files-rsync.adoc | 1 + modules/nodes-containers-downward-api-about.adoc | 1 + modules/nodes-containers-events-list.adoc | 1 + .../nodes-containers-port-forwarding-protocol.adoc | 1 + .../nodes-containers-remote-commands-protocol.adoc | 1 + modules/nodes-containers-volumes-cli.adoc | 1 + modules/nodes-edge-remote-workers-network.adoc | 11 ++++++----- modules/nodes-edge-remote-workers-power.adoc | 9 +++++---- modules/nodes-edge-remote-workers-strategies.adoc | 3 ++- modules/nodes-pods-configuring-restart.adoc | 1 + modules/nodes-pods-secrets-troubleshooting.adoc | 1 + modules/nodes-pods-using-example.adoc | 1 + modules/nodes-scheduler-node-affinity-example.adoc | 1 + modules/nodes-scheduler-pod-affinity-example.adoc | 1 + modules/nw-egress-router-cr.adoc | 1 + modules/nw-egressnetworkpolicy-object.adoc | 1 + modules/nw-endpoint-route53.adoc | 1 + modules/nw-externalip-object.adoc | 1 + modules/nw-high-performance-multicast.adoc | 1 + modules/nw-installation-ingress-config-asset.adoc | 2 +- modules/nw-ipfailover-environment-variables.adoc | 3 ++- modules/nw-metallb-bgp-limitations.adoc | 1 + modules/nw-metallb-collecting-data.adoc | 1 + modules/nw-metallb-extern-traffic-pol.adoc | 1 + modules/nw-metallb-infra-considerations.adoc | 1 + modules/nw-metallb-metrics.adoc | 1 + modules/nw-metallb-operator-custom-resources.adoc | 1 + ...perator-deployment-specifications-for-metallb.adoc | 1 + .../nw-metallb-operator-limit-speaker-to-nodes.adoc | 1 + modules/nw-metallb-software-components.adoc | 3 ++- modules/nw-ne-openshift-ingress.adoc | 2 +- modules/nw-network-config.adoc | 1 + modules/nw-network-flows-object.adoc | 1 + modules/nw-networkpolicy-optimize-ovn.adoc | 1 + modules/nw-ovn-k-anp-troubeshooting.adoc | 2 +- modules/nw-ovn-k-baseline-adminnetwork-policy.adoc | 2 +- modules/nw-sctp-about.adoc | 1 + modules/nw-sriov-app-netutil.adoc | 1 + modules/nw-sriov-device-discovery.adoc | 1 + modules/nw-sriov-example-vf-function-in-pod.adoc | 1 + modules/nw-sriov-huge-pages.adoc | 1 + modules/nw-sriov-ibnetwork-object.adoc | 1 + modules/nw-sriov-network-object.adoc | 1 + modules/nw-sriov-supported-devices.adoc | 1 + modules/nw-sriov-supported-platforms.adoc | 1 + modules/nw-troubleshoot-ovs.adoc | 5 +++++ modules/nw-using-ingress-and-routes.adoc | 1 + modules/nw-using-load-balancer-getting-traffic.adoc | 1 + modules/nw-using-nodeport.adoc | 1 + 105 files changed, 131 insertions(+), 31 deletions(-) diff --git a/modules/kube-apiserver-operator.adoc b/modules/kube-apiserver-operator.adoc index af829b7bbfbe..057962c6de07 100644 --- a/modules/kube-apiserver-operator.adoc +++ b/modules/kube-apiserver-operator.adoc @@ -2,6 +2,7 @@ // // * operators/operator-reference.adoc +:_mod-docs-content-type: CONCEPT [id="kube-apiserver-operator_{context}"] = Kubernetes API Server Operator diff --git a/modules/kube-controller-manager-operator.adoc b/modules/kube-controller-manager-operator.adoc index adc98b22090d..985e57c10731 100644 --- a/modules/kube-controller-manager-operator.adoc +++ b/modules/kube-controller-manager-operator.adoc @@ -2,6 +2,7 @@ // // * operators/operator-reference.adoc +:_mod-docs-content-type: CONCEPT [id="kube-controller-manager-operator_{context}"] = Kubernetes Controller Manager Operator diff --git a/modules/ldap-syncing-examples.adoc b/modules/ldap-syncing-examples.adoc index bbd308ee093c..62b857024808 100644 --- a/modules/ldap-syncing-examples.adoc +++ b/modules/ldap-syncing-examples.adoc @@ -2,17 +2,14 @@ // // * authentication/ldap-syncing.adoc +:_mod-docs-content-type: REFERENCE [id="ldap-syncing-examples_{context}"] = LDAP group sync examples -This section contains examples for the RFC 2307, Active Directory, and -augmented Active Directory schemas. +This section contains examples for the RFC 2307, Active Directory, and augmented Active Directory schemas. [NOTE] ==== -These examples assume that all users are direct members of their respective -groups. Specifically, no groups have other groups as members. See -the Nested Membership Sync Example for information on -how to sync nested groups. +These examples assume that all users are direct members of their respective groups. Specifically, no groups have other groups as members. See the Nested Membership Sync Example for information on how to sync nested groups. ==== diff --git a/modules/ldap-syncing-pruning.adoc b/modules/ldap-syncing-pruning.adoc index d1c70f572b47..e3937b805efb 100644 --- a/modules/ldap-syncing-pruning.adoc +++ b/modules/ldap-syncing-pruning.adoc @@ -2,13 +2,11 @@ // // * authentication/ldap-syncing.adoc +:_mod-docs-content-type: REFERENCE [id="ldap-syncing-pruning_{context}"] = Running a group pruning job -An administrator can also choose to remove groups from {product-title} records -if the records on the LDAP server that created them are no longer present. The -prune job will accept the same sync configuration file and whitelists or blacklists -as used for the sync job. +An administrator can also choose to remove groups from {product-title} records if the records on the LDAP server that created them are no longer present. The prune job will accept the same sync configuration file and whitelists or blacklists as used for the sync job. For example: diff --git a/modules/ldap-syncing-running.adoc b/modules/ldap-syncing-running.adoc index 1c92780034b8..f06004acf9a5 100644 --- a/modules/ldap-syncing-running.adoc +++ b/modules/ldap-syncing-running.adoc @@ -2,6 +2,7 @@ // // * authentication/ldap-syncing-groups.adoc +:_mod-docs-content-type: CONCEPT [id="ldap-syncing-running_{context}"] = Running LDAP sync diff --git a/modules/ldap-syncing-spec.adoc b/modules/ldap-syncing-spec.adoc index 9b2d4ee81bb5..37fb5ea85b0f 100644 --- a/modules/ldap-syncing-spec.adoc +++ b/modules/ldap-syncing-spec.adoc @@ -2,6 +2,7 @@ // // * authentication/ldap-syncing.adoc +:_mod-docs-content-type: REFERENCE [id="ldap-syncing-spec_{context}"] = LDAP sync configuration specification diff --git a/modules/log-verbosity-descriptions.adoc b/modules/log-verbosity-descriptions.adoc index 4c618949df16..21bb17fa4b97 100644 --- a/modules/log-verbosity-descriptions.adoc +++ b/modules/log-verbosity-descriptions.adoc @@ -1,3 +1,8 @@ +// Module included in the following assemblies: +// +//rest_api/overview/editing-kubelet-log-level-verbosity.adoc + +:_mod-docs-content-type: REFERENCE [id="log-verbosity-descriptions_{context}"] = Log verbosity descriptions diff --git a/modules/logging-into-a-cluster-after-installation.adoc b/modules/logging-into-a-cluster-after-installation.adoc index 41bc1cd41765..0d8fdaeed944 100644 --- a/modules/logging-into-a-cluster-after-installation.adoc +++ b/modules/logging-into-a-cluster-after-installation.adoc @@ -2,6 +2,7 @@ // // *installing/validation_and_troubleshooting/validating-an-installation.adoc +:_mod-docs-content-type: REFERENCE [id="logging-into-a-cluster-after-installation_{context}"] = Logging into a cluster after an installation diff --git a/modules/machine-api-operator.adoc b/modules/machine-api-operator.adoc index 3c0b860483f2..84d59a33ad7f 100644 --- a/modules/machine-api-operator.adoc +++ b/modules/machine-api-operator.adoc @@ -2,6 +2,7 @@ // // * operators/operator-reference.adoc +:_mod-docs-content-type: REFERENCE [id="machine-api-operator_{context}"] = Machine API Operator diff --git a/modules/machine-config-daemon-metrics-understanding.adoc b/modules/machine-config-daemon-metrics-understanding.adoc index b3d0a34a5d2b..33aa76a50ad2 100644 --- a/modules/machine-config-daemon-metrics-understanding.adoc +++ b/modules/machine-config-daemon-metrics-understanding.adoc @@ -2,6 +2,7 @@ // // * machine-config/machine-config-daemon-metrics.adoc +:_mod-docs-content-type: REFERENCE [id="machine-config-daemon-metrics-understanding_{context}"] = Understanding Machine Config Daemon metrics diff --git a/modules/machine-config-operator.adoc b/modules/machine-config-operator.adoc index ff42196bcd17..671697e9550d 100644 --- a/modules/machine-config-operator.adoc +++ b/modules/machine-config-operator.adoc @@ -2,6 +2,7 @@ // // * operators/operator-reference.adoc +:_mod-docs-content-type: REFERENCE [id="machine-config-operator_{context}"] = Machine Config Operator diff --git a/modules/machine-health-checks-resource.adoc b/modules/machine-health-checks-resource.adoc index fbfa75ef1a8f..6832ba038eed 100644 --- a/modules/machine-health-checks-resource.adoc +++ b/modules/machine-health-checks-resource.adoc @@ -3,7 +3,7 @@ // * machine_management/deploying-machine-health-checks.adoc // * post_installation_configuration/node-tasks.adoc - +:_mod-docs-content-type: CONCEPT [id="machine-health-checks-resource_{context}"] = Sample MachineHealthCheck resource @@ -61,9 +61,9 @@ The appropriate `maxUnhealthy` value depends on the scale of the cluster you dep [IMPORTANT] ==== -If you configure a `MachineHealthCheck` resource for the control plane, set the value of `maxUnhealthy` to `1`. +If you configure a `MachineHealthCheck` resource for the control plane, set the value of `maxUnhealthy` to `1`. -This configuration ensures that the machine health check takes no action when multiple control plane machines appear to be unhealthy. Multiple unhealthy control plane machines can indicate that the etcd cluster is degraded or that a scaling operation to replace a failed machine is in progress. +This configuration ensures that the machine health check takes no action when multiple control plane machines appear to be unhealthy. Multiple unhealthy control plane machines can indicate that the etcd cluster is degraded or that a scaling operation to replace a failed machine is in progress. If the etcd cluster is degraded, manual intervention might be required. If a scaling operation is in progress, the machine health check should allow it to finish. ==== diff --git a/modules/machineset-azure-accelerated-networking.adoc b/modules/machineset-azure-accelerated-networking.adoc index 711d8ce1349d..0d2ae238b49f 100644 --- a/modules/machineset-azure-accelerated-networking.adoc +++ b/modules/machineset-azure-accelerated-networking.adoc @@ -10,6 +10,7 @@ ifeval::["{context}" == "cpmso-config-options-azure"] :cpmso: endif::[] +:_mod-docs-content-type: REFERENCE [id="machineset-azure-accelerated-networking_{context}"] = Accelerated Networking for Microsoft Azure VMs diff --git a/modules/machineset-azure-ephemeral-os.adoc b/modules/machineset-azure-ephemeral-os.adoc index cd3f1d64f2c9..e2e79293c704 100644 --- a/modules/machineset-azure-ephemeral-os.adoc +++ b/modules/machineset-azure-ephemeral-os.adoc @@ -2,6 +2,7 @@ // // * machine_management/creating_machinesets/creating-machineset-azure.adoc +:_mod-docs-content-type: CONCEPT [id="machineset-azure-ephemeral-os_{context}"] = Machine sets that deploy machines on Ephemeral OS disks diff --git a/modules/machineset-dedicated-instances.adoc b/modules/machineset-dedicated-instances.adoc index 19cf71e5b65a..61067ec05278 100644 --- a/modules/machineset-dedicated-instances.adoc +++ b/modules/machineset-dedicated-instances.adoc @@ -3,6 +3,7 @@ // * machine_management/creating_machinesets/creating-machineset-aws.adoc // * machine_management/control_plane_machine_management/cpmso_provider_configurations/cpmso-config-options-aws.adoc +:_mod-docs-content-type: CONCEPT [id="machineset-dedicated-instance_{context}"] = Machine sets that deploy machines as Dedicated Instances diff --git a/modules/machineset-delete-policy.adoc b/modules/machineset-delete-policy.adoc index 5c63252cb821..b68cbef9e1f7 100644 --- a/modules/machineset-delete-policy.adoc +++ b/modules/machineset-delete-policy.adoc @@ -3,6 +3,7 @@ // * machine_management/manually-scaling-machineset.adoc // * post_installation_configuration/cluster-tasks.adoc +:_mod-docs-content-type: CONCEPT [id="machineset-delete-policy_{context}"] = The compute machine set deletion policy diff --git a/modules/machineset-non-guaranteed-instance.adoc b/modules/machineset-non-guaranteed-instance.adoc index 37e22498cd11..e2dc898834a8 100644 --- a/modules/machineset-non-guaranteed-instance.adoc +++ b/modules/machineset-non-guaranteed-instance.adoc @@ -14,6 +14,7 @@ ifeval::["{context}" == "creating-machineset-gcp"] :gcp: endif::[] +:_mod-docs-content-type: CONCEPT [id="machineset-non-guaranteed-instance_{context}"] ifdef::aws[= Machine sets that deploy machines as Spot Instances] ifdef::azure[= Machine sets that deploy machines as Spot VMs] diff --git a/modules/machineset-vsphere-required-permissions.adoc b/modules/machineset-vsphere-required-permissions.adoc index cca9e99b2d9e..15729a42ba98 100644 --- a/modules/machineset-vsphere-required-permissions.adoc +++ b/modules/machineset-vsphere-required-permissions.adoc @@ -2,6 +2,7 @@ // // * installing/installing_vsphere/installing-restricted-networks-vsphere.adoc +:_mod-docs-content-type: REFERENCE [id="machineset-vsphere-requirements-user-provisioned-machine-sets_{context}"] = Minimum required vCenter privileges for compute machine set management diff --git a/modules/machineset-yaml-osp-sr-iov-port-security.adoc b/modules/machineset-yaml-osp-sr-iov-port-security.adoc index 149244158a4d..be64b54f111c 100644 --- a/modules/machineset-yaml-osp-sr-iov-port-security.adoc +++ b/modules/machineset-yaml-osp-sr-iov-port-security.adoc @@ -2,6 +2,7 @@ // // * machine_management/creating_machinesets/creating-machineset-osp.adoc +:_mod-docs-content-type: CONCEPT [id="machineset-yaml-osp-sr-iov-port-security_{context}"] = Sample YAML for SR-IOV deployments where port security is disabled diff --git a/modules/machineset-yaml-osp-sr-iov.adoc b/modules/machineset-yaml-osp-sr-iov.adoc index 6715fa59f6c6..70c20d82fa16 100644 --- a/modules/machineset-yaml-osp-sr-iov.adoc +++ b/modules/machineset-yaml-osp-sr-iov.adoc @@ -2,6 +2,7 @@ // // * machine_management/creating_machinesets/creating-machineset-osp.adoc +:_mod-docs-content-type: CONCEPT [id="machineset-yaml-osp-sr-iov_{context}"] = Sample YAML for a compute machine set custom resource that uses SR-IOV on {rh-openstack} diff --git a/modules/maintaining-bare-metal-hosts.adoc b/modules/maintaining-bare-metal-hosts.adoc index 7de4a21ff3f3..821bdaf26f5e 100644 --- a/modules/maintaining-bare-metal-hosts.adoc +++ b/modules/maintaining-bare-metal-hosts.adoc @@ -2,6 +2,7 @@ // // scalability_and_performance/managing-bare-metal-hosts.adoc +:_mod-docs-content-type: CONCEPT [id="maintaining-bare-metal-hosts_{context}"] = Maintaining bare metal hosts diff --git a/modules/master-node-sizing.adoc b/modules/master-node-sizing.adoc index 1e0fa40b2471..9468a58dd22d 100644 --- a/modules/master-node-sizing.adoc +++ b/modules/master-node-sizing.adoc @@ -3,6 +3,7 @@ // * scalability_and_performance/recommended-performance-scale-practices/recommended-control-plane-practices.adoc // * post_installation_configuration/node-tasks.adoc +:_mod-docs-content-type: REFERENCE [id="master-node-sizing_{context}"] = Control plane node sizing diff --git a/modules/migration-direct-volume-migration-and-direct-image-migration.adoc b/modules/migration-direct-volume-migration-and-direct-image-migration.adoc index d54976499cc1..1af8df41e473 100644 --- a/modules/migration-direct-volume-migration-and-direct-image-migration.adoc +++ b/modules/migration-direct-volume-migration-and-direct-image-migration.adoc @@ -3,6 +3,7 @@ // * migrating_from_ocp_3_to_4/migrating-applications-3-4.adoc // * migration_toolkit_for_containers/migrating-applications-with-mtc.adoc +:_mod-docs-content-type: CONCEPT [id="migration-direct-volume-migration-and-direct-image-migration_{context}"] = Direct volume migration and direct image migration diff --git a/modules/migration-hooks.adoc b/modules/migration-hooks.adoc index dd8517fa407b..77261c96dfea 100644 --- a/modules/migration-hooks.adoc +++ b/modules/migration-hooks.adoc @@ -3,6 +3,7 @@ // * migrating_from_ocp_3_to_4/advanced-migration-options-3-4.adoc // * migration_toolkit_for_containers/advanced-migration-options-mtc.adoc +:_mod-docs-content-type: CONCEPT [id="migration-hooks_{context}"] = Migration hooks diff --git a/modules/migration-known-issues.adoc b/modules/migration-known-issues.adoc index 1a54ea7c8dcf..dc84c8cc6e78 100644 --- a/modules/migration-known-issues.adoc +++ b/modules/migration-known-issues.adoc @@ -3,6 +3,7 @@ // * migrating_from_ocp_3_to_4/troubleshooting-3-4.adoc // * migration_toolkit_for_containers/troubleshooting-mtc +:_mod-docs-content-type: CONCEPT [id="migration-known-issues_{context}"] = Known issues diff --git a/modules/migration-mapping-destination-namespaces-in-the-migplan-cr.adoc b/modules/migration-mapping-destination-namespaces-in-the-migplan-cr.adoc index b1b56cd4b996..279bf9e3b8d1 100644 --- a/modules/migration-mapping-destination-namespaces-in-the-migplan-cr.adoc +++ b/modules/migration-mapping-destination-namespaces-in-the-migplan-cr.adoc @@ -2,6 +2,7 @@ // // * migrating_from_ocp_3_to_4/advanced-migration-options-3-4.adoc +:_mod-docs-content-type: CONCEPT [id="migration-mapping-destination-namespaces-in-the-migplan-cr_{context}"] = Mapping namespaces diff --git a/modules/migration-mtc-cr-manifests.adoc b/modules/migration-mtc-cr-manifests.adoc index 50f63e2c3a4f..53917ad041e9 100644 --- a/modules/migration-mtc-cr-manifests.adoc +++ b/modules/migration-mtc-cr-manifests.adoc @@ -3,6 +3,7 @@ // * migrating_from_ocp_3_to_4/migrating-applications-3-4.adoc // * migration_toolkit_for_containers/migrating-applications-with-mtc +:_mod-docs-content-type: CONCEPT [id="migration-mtc-cr-manifests_{context}"] = {mtc-full} custom resource manifests diff --git a/modules/migration-mtc-workflow.adoc b/modules/migration-mtc-workflow.adoc index bbb671783a4f..82d939e857ab 100644 --- a/modules/migration-mtc-workflow.adoc +++ b/modules/migration-mtc-workflow.adoc @@ -5,6 +5,7 @@ // * migration_toolkit_for_containers/about-mtc.adoc // * migration_toolkit_for_containers/advanced-migration-options-mtc.adoc +:_mod-docs-content-type: PROCEDURE [id="migration-mtc-workflow_{context}"] = {mtc-short} workflow diff --git a/modules/migration-network-traffic-redirection-strategies.adoc b/modules/migration-network-traffic-redirection-strategies.adoc index 5045afa1b73d..565a5477691d 100644 --- a/modules/migration-network-traffic-redirection-strategies.adoc +++ b/modules/migration-network-traffic-redirection-strategies.adoc @@ -3,6 +3,7 @@ // * migrating_from_ocp_3_to_4/planning-considerations-3-4.adoc // * migration_toolkit_for_containers/network-considerations-mtc.adoc +:_mod-docs-content-type: CONCEPT [id="migration-network-traffic-redirection-strategies_{context}"] = Network traffic redirection strategies diff --git a/modules/migration-prerequisites.adoc b/modules/migration-prerequisites.adoc index 451cbda7fb50..a122860d4813 100644 --- a/modules/migration-prerequisites.adoc +++ b/modules/migration-prerequisites.adoc @@ -5,6 +5,7 @@ // * migration_toolkit_for_containers/migrating-applications-with-mtc // * migration_toolkit_for_containers/advanced-migration-options-mtc.adoc +:_mod-docs-content-type: REFERENCE [id="migration-prerequisites_{context}"] = Migration prerequisites diff --git a/modules/migration-provided-metrics.adoc b/modules/migration-provided-metrics.adoc index 84c8741f68e2..45d900b9f6f0 100644 --- a/modules/migration-provided-metrics.adoc +++ b/modules/migration-provided-metrics.adoc @@ -3,6 +3,7 @@ // * migrating_from_ocp_3_to_4/troubleshooting-3-4.adoc // * migration-toolkit-for-containers/troubleshooting-mtc.adoc +:_mod-docs-content-type: REFERENCE [id="migration-provided-metrics_{context}"] = Provided metrics diff --git a/modules/migration-terminology.adoc b/modules/migration-terminology.adoc index e31bd5b6eddf..b2738fc609ce 100644 --- a/modules/migration-terminology.adoc +++ b/modules/migration-terminology.adoc @@ -5,6 +5,7 @@ // * migration_toolkit_for_containers/about-mtc.adoc // * migration_toolkit_for_containers/advanced-migration-options-mtc.adoc +:_mod-docs-content-type: REFERENCE [id="migration-terminology_{context}"] = Terminology diff --git a/modules/migration-writing-ansible-playbook-hook.adoc b/modules/migration-writing-ansible-playbook-hook.adoc index f2238d0a8446..fd79e3639f2b 100644 --- a/modules/migration-writing-ansible-playbook-hook.adoc +++ b/modules/migration-writing-ansible-playbook-hook.adoc @@ -3,6 +3,7 @@ // * migrating_from_ocp_3_to_4/advanced-migration-options-3-4.adoc // * migration_toolkit_for_containers/advanced-migration-options-mtc.adoc +:_mod-docs-content-type: CONCEPT [id="migration-writing-ansible-playbook-hook_{context}"] = Writing an Ansible playbook for a migration hook diff --git a/modules/minimum-required-permissions-upi-azure.adoc b/modules/minimum-required-permissions-upi-azure.adoc index 4f8fd2eedf84..2b5a357351f4 100644 --- a/modules/minimum-required-permissions-upi-azure.adoc +++ b/modules/minimum-required-permissions-upi-azure.adoc @@ -3,6 +3,7 @@ // * installing/installing_azure/installing-azure-user-infra.adoc // * installing/installing_azure/installing-restricted-networks-azure-user-provisioned.adoc +:_mod-docs-content-type: REFERENCE [id="minimum-required-permissions-upi-azure_{context}"] = Required Azure permissions for user-provisioned infrastructure diff --git a/modules/minimum-required-permissions-upi-gcp.adoc b/modules/minimum-required-permissions-upi-gcp.adoc index 115a5e68ab13..6d9756090277 100644 --- a/modules/minimum-required-permissions-upi-gcp.adoc +++ b/modules/minimum-required-permissions-upi-gcp.adoc @@ -4,6 +4,7 @@ // * installing/installing_gcp/installing-restricted-networks-gcp.adoc // * installing/installing_gcp/installing-gcp-user-infra-vpc.adoc +:_mod-docs-content-type: REFERENCE [id="minimum-required-permissions-upi-gcp_{context}"] = Required {gcp-short} permissions for user-provisioned infrastructure diff --git a/modules/nbde-deciding-the-number-of-tang-servers-to-use.adoc b/modules/nbde-deciding-the-number-of-tang-servers-to-use.adoc index 844fd08eac86..b3ff27d53aac 100644 --- a/modules/nbde-deciding-the-number-of-tang-servers-to-use.adoc +++ b/modules/nbde-deciding-the-number-of-tang-servers-to-use.adoc @@ -2,6 +2,7 @@ // // security/nbde-implementation-guide.adoc +:_mod-docs-content-type: CONCEPT [id="nbde-deciding-the-number-of-tang-servers-to-use_{context}"] = Tang server sizing requirements diff --git a/modules/nbde-disk-encryption-technology-comparison.adoc b/modules/nbde-disk-encryption-technology-comparison.adoc index 775298bdb5f0..84674db3c781 100644 --- a/modules/nbde-disk-encryption-technology-comparison.adoc +++ b/modules/nbde-disk-encryption-technology-comparison.adoc @@ -2,6 +2,7 @@ // // security/nbde-implementation-guide.adoc +:_mod-docs-content-type: REFERENCE [id="nbde-disk-encryption-technology-comparison_{context}"] = Disk encryption technology comparison diff --git a/modules/nbde-emergency-recovery-of-network-connectivity.adoc b/modules/nbde-emergency-recovery-of-network-connectivity.adoc index 473bb402647e..2d083ef661a8 100644 --- a/modules/nbde-emergency-recovery-of-network-connectivity.adoc +++ b/modules/nbde-emergency-recovery-of-network-connectivity.adoc @@ -2,6 +2,7 @@ // // security/nbde-implementation-guide.adoc +:_mod-docs-content-type: REFERENCE [id="nbde-emergency-recovery-of-network-connectivity_{context}"] = Emergency recovery of network connectivity diff --git a/modules/nbde-http-versus-https.adoc b/modules/nbde-http-versus-https.adoc index 2cfebe3aecd9..cd611eb37173 100644 --- a/modules/nbde-http-versus-https.adoc +++ b/modules/nbde-http-versus-https.adoc @@ -2,10 +2,11 @@ // // security/nbde-implementation-guide.adoc +:_mod-docs-content-type: REFERENCE [id="nbde-http-versus-https_{context}"] = HTTP versus HTTPS -Traffic to the Tang server can be encrypted (HTTPS) or plaintext (HTTP). There are no significant security advantages of encrypting this traffic, and leaving it decrypted removes any complexity or failure conditions related to Transport Layer Security (TLS) certificate checking in the node running a Clevis client. +Traffic to the Tang server can be encrypted (HTTPS) or plain text (HTTP). There are no significant security advantages of encrypting this traffic, and leaving it decrypted removes any complexity or failure conditions related to Transport Layer Security (TLS) certificate checking in the node running a Clevis client. While it is possible to perform passive monitoring of unencrypted traffic between the node’s Clevis client and the Tang server, the ability to use this traffic to determine the key material is at best a future theoretical concern. Any such traffic analysis would require large quantities of captured data. Key rotation would immediately invalidate it. Finally, any threat actor able to perform passive monitoring has already obtained the necessary network access to perform manual connections to the Tang server and can perform the simpler manual decryption of captured Clevis headers. diff --git a/modules/nbde-installation-scenarios.adoc b/modules/nbde-installation-scenarios.adoc index 3b18acf675d5..6a874d96417a 100644 --- a/modules/nbde-installation-scenarios.adoc +++ b/modules/nbde-installation-scenarios.adoc @@ -2,6 +2,7 @@ // // security/nbde-implementation-guide.adoc +:_mod-docs-content-type: REFERENCE [id="nbde-installation-scenarios_{context}"] = Installation scenarios diff --git a/modules/nbde-key-escrow.adoc b/modules/nbde-key-escrow.adoc index f51783627e92..6b0d4e211f11 100644 --- a/modules/nbde-key-escrow.adoc +++ b/modules/nbde-key-escrow.adoc @@ -2,6 +2,7 @@ // // security/nbde-implementation-guide.adoc +:_mod-docs-content-type: REFERENCE [id="nbde-key-escrow_{context}"] = Key escrow diff --git a/modules/nbde-locating-the-tang-servers.adoc b/modules/nbde-locating-the-tang-servers.adoc index 50c5f68e917a..ef1d894cd708 100644 --- a/modules/nbde-locating-the-tang-servers.adoc +++ b/modules/nbde-locating-the-tang-servers.adoc @@ -2,6 +2,7 @@ // // security/nbde-implementation-guide.adoc +:_mod-docs-content-type: REFERENCE [id="nbde-locating-the-tang-servers_{context}"] = Tang server location planning diff --git a/modules/nbde-logging-considerations.adoc b/modules/nbde-logging-considerations.adoc index 2dbc8409dfbe..3bbbd1083247 100644 --- a/modules/nbde-logging-considerations.adoc +++ b/modules/nbde-logging-considerations.adoc @@ -2,6 +2,7 @@ // // security/nbde-implementation-guide.adoc +:_mod-docs-content-type: CONCEPT [id="nbde-logging-considerations_{context}"] = Logging considerations diff --git a/modules/nbde-loss-of-a-client-machine.adoc b/modules/nbde-loss-of-a-client-machine.adoc index a20ac2ab40cc..ad7f9cfcd88c 100644 --- a/modules/nbde-loss-of-a-client-machine.adoc +++ b/modules/nbde-loss-of-a-client-machine.adoc @@ -2,6 +2,7 @@ // // security/nbde-implementation-guide.adoc +:_mod-docs-content-type: CONCEPT [id="nbde-loss-of-a-client-machine_{context}"] = Loss of a client machine diff --git a/modules/nbde-loss-of-a-network-segment.adoc b/modules/nbde-loss-of-a-network-segment.adoc index 146a9ae9ea77..7323922f2841 100644 --- a/modules/nbde-loss-of-a-network-segment.adoc +++ b/modules/nbde-loss-of-a-network-segment.adoc @@ -2,6 +2,7 @@ // // security/nbde-implementation-guide.adoc +:_mod-docs-content-type: CONCEPT [id="nbde-loss-of-a-network-segment_{context}"] = Loss of a network segment diff --git a/modules/nbde-loss-of-a-tang-server.adoc b/modules/nbde-loss-of-a-tang-server.adoc index ffafffc74f32..1fe6a411e385 100644 --- a/modules/nbde-loss-of-a-tang-server.adoc +++ b/modules/nbde-loss-of-a-tang-server.adoc @@ -2,6 +2,7 @@ // // security/nbde-implementation-guide.adoc +:_mod-docs-content-type: CONCEPT [id="nbde-loss-of-a-tang-server_{context}"] = Loss of a Tang server diff --git a/modules/nbde-network-bound-disk-encryption.adoc b/modules/nbde-network-bound-disk-encryption.adoc index 100729b68bf6..7d5af3d4519a 100644 --- a/modules/nbde-network-bound-disk-encryption.adoc +++ b/modules/nbde-network-bound-disk-encryption.adoc @@ -2,6 +2,7 @@ // // security/nbde-implementation-guide.adoc +:_mod-docs-content-type: CONCEPT [id="nbde-network-bound-disk-encryption_{context}"] = Network-Bound Disk Encryption (NBDE) diff --git a/modules/nbde-secret-sharing-encryption.adoc b/modules/nbde-secret-sharing-encryption.adoc index 9168ec0f82a1..d17764dc68f7 100644 --- a/modules/nbde-secret-sharing-encryption.adoc +++ b/modules/nbde-secret-sharing-encryption.adoc @@ -2,6 +2,7 @@ // // security/nbde-implementation-guide.adoc +:_mod-docs-content-type: CONCEPT [id="nbde-secret-sharing-encryption_{context}"] = Secret sharing encryption diff --git a/modules/nbde-tpm-encryption.adoc b/modules/nbde-tpm-encryption.adoc index b98fee78f358..c1e410e19075 100644 --- a/modules/nbde-tpm-encryption.adoc +++ b/modules/nbde-tpm-encryption.adoc @@ -2,6 +2,7 @@ // // security/nbde-implementation-guide.adoc +:_mod-docs-content-type: REFERENCE [id="nbde-tpm-encryption_{context}"] = TPM encryption diff --git a/modules/nbde-unexpected-loss-of-network-connectivity.adoc b/modules/nbde-unexpected-loss-of-network-connectivity.adoc index ec0218a745ba..a6f5fea732a4 100644 --- a/modules/nbde-unexpected-loss-of-network-connectivity.adoc +++ b/modules/nbde-unexpected-loss-of-network-connectivity.adoc @@ -2,6 +2,7 @@ // // security/nbde-implementation-guide.adoc +:_mod-docs-content-type: CONCEPT [id="nbde-unexpected-loss-of-network-connectivity_{context}"] = Unexpected loss of network connectivity diff --git a/modules/nbde-using-tang-servers-for-disk-encryption.adoc b/modules/nbde-using-tang-servers-for-disk-encryption.adoc index cc04dce21b51..dcbd7fb2fadb 100644 --- a/modules/nbde-using-tang-servers-for-disk-encryption.adoc +++ b/modules/nbde-using-tang-servers-for-disk-encryption.adoc @@ -2,6 +2,7 @@ // // security/nbde-implementation-guide.adoc +:_mod-docs-content-type: REFERENCE [id="nbde-using-tang-servers-for-disk-encryption_{context}"] = Tang server disk encryption diff --git a/modules/node-tuning-operator-supported-tuned-daemon-plug-ins.adoc b/modules/node-tuning-operator-supported-tuned-daemon-plug-ins.adoc index 0ecc1ec2f817..c25d09bc7769 100644 --- a/modules/node-tuning-operator-supported-tuned-daemon-plug-ins.adoc +++ b/modules/node-tuning-operator-supported-tuned-daemon-plug-ins.adoc @@ -4,6 +4,7 @@ // * post_installation_configuration/node-tasks.adoc // * nodes/nodes/nodes-node-tuning-operator.adoc +:_mod-docs-content-type: REFERENCE [id="supported-tuned-daemon-plug-ins_{context}"] = Supported TuneD daemon plugins diff --git a/modules/nodes-cluster-limit-ranges-creating.adoc b/modules/nodes-cluster-limit-ranges-creating.adoc index e82b4d70f40d..e0da82a4303d 100644 --- a/modules/nodes-cluster-limit-ranges-creating.adoc +++ b/modules/nodes-cluster-limit-ranges-creating.adoc @@ -2,6 +2,7 @@ // // * nodes/cluster/limit-ranges.adoc +:_mod-docs-content-type: PROCEDURE [id="nodes-cluster-limit-creating_{context}"] = Creating a Limit Range diff --git a/modules/nodes-cluster-limit-ranges-deleting.adoc b/modules/nodes-cluster-limit-ranges-deleting.adoc index b23d30252026..1ee3d00a31df 100644 --- a/modules/nodes-cluster-limit-ranges-deleting.adoc +++ b/modules/nodes-cluster-limit-ranges-deleting.adoc @@ -2,10 +2,10 @@ // // * nodes/cluster/limit-ranges.adoc +:_mod-docs-content-type: PROCEDURE [id="nodes-cluster-limit-ranges-deleting_{context}"] = Deleting a Limit Range - To remove any active `LimitRange` object to no longer enforce the limits in a project: * Run the following command: diff --git a/modules/nodes-cluster-limit-ranges-viewing.adoc b/modules/nodes-cluster-limit-ranges-viewing.adoc index 49c9457d9f7a..8e8001df85c5 100644 --- a/modules/nodes-cluster-limit-ranges-viewing.adoc +++ b/modules/nodes-cluster-limit-ranges-viewing.adoc @@ -2,6 +2,7 @@ // // * nodes/cluster/limit-ranges.adoc +:_mod-docs-content-type: PROCEDURE [id="nodes-cluster-limit-viewing_{context}"] = Viewing a limit diff --git a/modules/nodes-cluster-node-overcommit.adoc b/modules/nodes-cluster-node-overcommit.adoc index 4c09d4c871a1..bc052a635adf 100644 --- a/modules/nodes-cluster-node-overcommit.adoc +++ b/modules/nodes-cluster-node-overcommit.adoc @@ -3,6 +3,7 @@ // * nodes/clusters/nodes-cluster-overcommit.adoc // * post_installation_configuration/node-tasks.adoc +:_mod-docs-content-type: CONCEPT [id="nodes-cluster-node-overcommit_{context}"] = Node-level overcommit diff --git a/modules/nodes-containers-copying-files-rsync.adoc b/modules/nodes-containers-copying-files-rsync.adoc index 74e41a7d9770..f4d95ef8213e 100644 --- a/modules/nodes-containers-copying-files-rsync.adoc +++ b/modules/nodes-containers-copying-files-rsync.adoc @@ -2,6 +2,7 @@ // // * nodes/nodes-containers-copying-files.adoc +:_mod-docs-content-type: CONCEPT [id="nodes-containers-copying-files-rsync_{context}"] = Using advanced Rsync features diff --git a/modules/nodes-containers-downward-api-about.adoc b/modules/nodes-containers-downward-api-about.adoc index 60f308e18cba..31b207fc7907 100644 --- a/modules/nodes-containers-downward-api-about.adoc +++ b/modules/nodes-containers-downward-api-about.adoc @@ -2,6 +2,7 @@ // // * nodes/nodes-containers-downward-api.adoc +:_mod-docs-content-type: REFERENCE [id="nodes-containers-projected-volumes-about_{context}"] = Expose pod information to Containers using the Downward API diff --git a/modules/nodes-containers-events-list.adoc b/modules/nodes-containers-events-list.adoc index 2a9d58384057..fad26dc9fd3f 100644 --- a/modules/nodes-containers-events-list.adoc +++ b/modules/nodes-containers-events-list.adoc @@ -2,6 +2,7 @@ // // * nodes/nodes-containers-events.adoc +:_mod-docs-content-type: REFERENCE [id="nodes-containers-events-list_{context}"] = List of events diff --git a/modules/nodes-containers-port-forwarding-protocol.adoc b/modules/nodes-containers-port-forwarding-protocol.adoc index aaac02a2d582..188cf044120f 100644 --- a/modules/nodes-containers-port-forwarding-protocol.adoc +++ b/modules/nodes-containers-port-forwarding-protocol.adoc @@ -2,6 +2,7 @@ // // * nodes/nodes-containers-port-forwarding.adoc +:_mod-docs-content-type: CONCEPT [id="nodes-containers-port-forwarding-protocol_{context}"] = Protocol for initiating port forwarding from a client diff --git a/modules/nodes-containers-remote-commands-protocol.adoc b/modules/nodes-containers-remote-commands-protocol.adoc index cc253b65793b..49626ce0c88e 100644 --- a/modules/nodes-containers-remote-commands-protocol.adoc +++ b/modules/nodes-containers-remote-commands-protocol.adoc @@ -2,6 +2,7 @@ // // * nodes/nodes-containers-remote-commands.adoc +:_mod-docs-content-type: CONCEPT [id="nodes-containers-remote-commands-protocol_{context}"] = Protocol for initiating a remote command from a client diff --git a/modules/nodes-containers-volumes-cli.adoc b/modules/nodes-containers-volumes-cli.adoc index f922926e9b8e..f8e4b16324b0 100644 --- a/modules/nodes-containers-volumes-cli.adoc +++ b/modules/nodes-containers-volumes-cli.adoc @@ -2,6 +2,7 @@ // // * nodes/nodes-containers-volumes.adoc +:_mod-docs-content-type: REFERENCE [id="nodes-containers-volumes-cli_{context}"] = Working with volumes using the {product-title} CLI diff --git a/modules/nodes-edge-remote-workers-network.adoc b/modules/nodes-edge-remote-workers-network.adoc index 6029aec4e808..da15cdf3f095 100644 --- a/modules/nodes-edge-remote-workers-network.adoc +++ b/modules/nodes-edge-remote-workers-network.adoc @@ -2,21 +2,22 @@ // // * logging/nodes-edge-remote-workers.adoc +:_mod-docs-content-type: CONCEPT [id="nodes-edge-remote-workers-network_{context}"] = Network separation with remote worker nodes All nodes send heartbeats to the Kubernetes Controller Manager Operator (kube controller) in the {product-title} cluster every 10 seconds. If the cluster does not receive heartbeats from a node, {product-title} responds using several default mechanisms. - -{product-title} is designed to be resilient to network partitions and other disruptions. You can mitigate some of the more common disruptions, such as interruptions from software upgrades, network splits, and routing issues. Mitigation strategies include ensuring that pods on remote worker nodes request the correct amount of CPU and memory resources, configuring an appropriate replication policy, using redundancy across zones, and using Pod Disruption Budgets on workloads. -If the kube controller loses contact with a node after a configured period, the node controller on the control plane updates the node health to `Unhealthy` and marks the node `Ready` condition as `Unknown`. In response, the scheduler stops scheduling pods to that node. The on-premise node controller adds a `node.kubernetes.io/unreachable` taint with a `NoExecute` effect to the node and schedules pods on the node for eviction after five minutes, by default. +{product-title} is designed to be resilient to network partitions and other disruptions. You can mitigate some of the more common disruptions, such as interruptions from software upgrades, network splits, and routing issues. Mitigation strategies include ensuring that pods on remote worker nodes request the correct amount of CPU and memory resources, configuring an appropriate replication policy, using redundancy across zones, and using Pod Disruption Budgets on workloads. + +If the kube controller loses contact with a node after a configured period, the node controller on the control plane updates the node health to `Unhealthy` and marks the node `Ready` condition as `Unknown`. In response, the scheduler stops scheduling pods to that node. The on-premise node controller adds a `node.kubernetes.io/unreachable` taint with a `NoExecute` effect to the node and schedules pods on the node for eviction after five minutes, by default. If a workload controller, such as a `Deployment` object or `StatefulSet` object, is directing traffic to pods on the unhealthy node and other nodes can reach the cluster, {product-title} routes the traffic away from the pods on the node. Nodes that cannot reach the cluster do not get updated with the new traffic routing. As a result, the workloads on those nodes might continue to attempt to reach the unhealthy node. -You can mitigate the effects of connection loss by: +You can mitigate the effects of connection loss by: * using daemon sets to create pods that tolerate the taints * using static pods that automatically restart if a node goes down * using Kubernetes zones to control pod eviction * configuring pod tolerations to delay or avoid pod eviction -* configuring the kubelet to control the timing of when it marks nodes as unhealthy. +* configuring the kubelet to control the timing of when it marks nodes as unhealthy. diff --git a/modules/nodes-edge-remote-workers-power.adoc b/modules/nodes-edge-remote-workers-power.adoc index b48d1311150b..9584d069346b 100644 --- a/modules/nodes-edge-remote-workers-power.adoc +++ b/modules/nodes-edge-remote-workers-power.adoc @@ -2,10 +2,11 @@ // // * logging/nodes-edge-remote-workers.adoc +:_mod-docs-content-type: CONCEPT [id="nodes-edge-remote-workers-power_{context}"] = Power loss on remote worker nodes -If a remote worker node loses power or restarts ungracefully, {product-title} responds using several default mechanisms. +If a remote worker node loses power or restarts ungracefully, {product-title} responds using several default mechanisms. If the Kubernetes Controller Manager Operator (kube controller) loses contact with a node after a configured period, the control plane updates the node health to `Unhealthy` and marks the node `Ready` condition as `Unknown`. In response, the scheduler stops scheduling pods to that node. The on-premise node controller adds a `node.kubernetes.io/unreachable` taint with a `NoExecute` effect to the node and schedules pods on the node for eviction after five minutes, by default. @@ -16,12 +17,12 @@ On the node, the pods must be restarted when the node recovers power and reconne If you want the pods to restart immediately upon restart, use static pods. ==== -After the node restarts, the kubelet also restarts and attempts to restart the pods that were scheduled on the node. If the connection to the control plane takes longer than the default five minutes, the control plane cannot update the node health and remove the `node.kubernetes.io/unreachable` taint. On the node, the kubelet terminates any running pods. When these conditions are cleared, the scheduler can start scheduling pods to that node. +After the node restarts, the kubelet also restarts and attempts to restart the pods that were scheduled on the node. If the connection to the control plane takes longer than the default five minutes, the control plane cannot update the node health and remove the `node.kubernetes.io/unreachable` taint. On the node, the kubelet terminates any running pods. When these conditions are cleared, the scheduler can start scheduling pods to that node. -You can mitigate the effects of power loss by: +You can mitigate the effects of power loss by: * using daemon sets to create pods that tolerate the taints * using static pods that automatically restart with a node * configuring pods tolerations to delay or avoid pod eviction -* configuring the kubelet to control the timing of when the node controller marks nodes as unhealthy. +* configuring the kubelet to control the timing of when the node controller marks nodes as unhealthy. diff --git a/modules/nodes-edge-remote-workers-strategies.adoc b/modules/nodes-edge-remote-workers-strategies.adoc index 979bcd4acad6..9b3427901261 100644 --- a/modules/nodes-edge-remote-workers-strategies.adoc +++ b/modules/nodes-edge-remote-workers-strategies.adoc @@ -2,6 +2,7 @@ // // * logging/nodes-edge-remote-workers.adoc +:_mod-docs-content-type: CONCEPT [id="nodes-edge-remote-workers-strategies_{context}"] = Remote worker node strategies @@ -135,7 +136,7 @@ A taint with the `NoExecute` effect affects pods that are running on the node in [NOTE] ==== -Unless tolerations are explicitly set, Kubernetes automatically adds a toleration for `node.kubernetes.io/not-ready` and `node.kubernetes.io/unreachable` with `tolerationSeconds=300`, meaning that pods remain bound for 5 minutes if either of these taints is detected. +Unless tolerations are explicitly set, Kubernetes automatically adds a toleration for `node.kubernetes.io/not-ready` and `node.kubernetes.io/unreachable` with `tolerationSeconds=300`, meaning that pods remain bound for 5 minutes if either of these taints is detected. ==== You can delay or avoid pod eviction by configuring pods tolerations with the `NoExecute` effect for the `node.kubernetes.io/unreachable` and `node.kubernetes.io/not-ready` taints. diff --git a/modules/nodes-pods-configuring-restart.adoc b/modules/nodes-pods-configuring-restart.adoc index 1f9bc53e5e59..47e87a80f094 100644 --- a/modules/nodes-pods-configuring-restart.adoc +++ b/modules/nodes-pods-configuring-restart.adoc @@ -3,6 +3,7 @@ // * nodes/nodes-pods-configuring.adoc // * nodes/nodes-cluster-pods-configuring +:_mod-docs-content-type: CONCEPT [id="nodes-pods-configuring-restart_{context}"] = Configuring how pods behave after restart diff --git a/modules/nodes-pods-secrets-troubleshooting.adoc b/modules/nodes-pods-secrets-troubleshooting.adoc index e20241c4d028..fdf2eecc4be5 100644 --- a/modules/nodes-pods-secrets-troubleshooting.adoc +++ b/modules/nodes-pods-secrets-troubleshooting.adoc @@ -2,6 +2,7 @@ // // * nodes/nodes-pods-secrets.adoc +:_mod-docs-content-type: PROCEDURE [id="nodes-pods-secrets-troubleshooting_{context}"] = Troubleshooting secrets diff --git a/modules/nodes-pods-using-example.adoc b/modules/nodes-pods-using-example.adoc index ef7a18391e44..d3d6fe919369 100644 --- a/modules/nodes-pods-using-example.adoc +++ b/modules/nodes-pods-using-example.adoc @@ -2,6 +2,7 @@ // // * nodes/nodes-pods-using.adoc +:_mod-docs-content-type: REFERENCE [id="nodes-pods-using-example_{context}"] = Example pod configurations diff --git a/modules/nodes-scheduler-node-affinity-example.adoc b/modules/nodes-scheduler-node-affinity-example.adoc index abaf4459a13f..62933e0db22f 100644 --- a/modules/nodes-scheduler-node-affinity-example.adoc +++ b/modules/nodes-scheduler-node-affinity-example.adoc @@ -2,6 +2,7 @@ // // * nodes/nodes-scheduler-node-affinity.adoc +:_mod-docs-content-type: REFERENCE [id="nodes-scheduler-node-affinity-example_{context}"] = Sample node affinity rules diff --git a/modules/nodes-scheduler-pod-affinity-example.adoc b/modules/nodes-scheduler-pod-affinity-example.adoc index 67873d8689a1..4c680ad0a236 100644 --- a/modules/nodes-scheduler-pod-affinity-example.adoc +++ b/modules/nodes-scheduler-pod-affinity-example.adoc @@ -2,6 +2,7 @@ // // * nodes/nodes-scheduler-node-affinity.adoc +:_mod-docs-content-type: REFERENCE [id="nodes-scheduler-pod-affinity-example_{context}"] = Sample pod affinity and anti-affinity rules diff --git a/modules/nw-egress-router-cr.adoc b/modules/nw-egress-router-cr.adoc index 4592c35c17bd..841acab05eef 100644 --- a/modules/nw-egress-router-cr.adoc +++ b/modules/nw-egress-router-cr.adoc @@ -8,6 +8,7 @@ ifeval::["{context}" == "deploying-egress-router-ovn-redirection"] endif::[] :router-name: egress-router-{router-type} +:_mod-docs-content-type: REFERENCE [id="nw-egress-router-ovn-cr_{context}"] = Egress router custom resource diff --git a/modules/nw-egressnetworkpolicy-object.adoc b/modules/nw-egressnetworkpolicy-object.adoc index 29b7b9bd48a3..0bfe691bdfe1 100644 --- a/modules/nw-egressnetworkpolicy-object.adoc +++ b/modules/nw-egressnetworkpolicy-object.adoc @@ -2,6 +2,7 @@ // // * networking/openshift_sdn/configuring-egress-firewall.adoc +:_mod-docs-content-type: REFERENCE [id="nw-egressnetworkpolicy-object_{context}"] = EgressNetworkPolicy custom resource (CR) diff --git a/modules/nw-endpoint-route53.adoc b/modules/nw-endpoint-route53.adoc index 99c99fbc33f1..fcfce67e5e4d 100644 --- a/modules/nw-endpoint-route53.adoc +++ b/modules/nw-endpoint-route53.adoc @@ -2,6 +2,7 @@ // // * installing/installing_aws/installing-aws-government-region.adoc +:_mod-docs-content-type: REFERENCE [id="nw-endpoint-route53_{context}"] = Ingress Operator endpoint configuration for AWS Route 53 diff --git a/modules/nw-externalip-object.adoc b/modules/nw-externalip-object.adoc index a78cf606d9d8..f7355c7e5236 100644 --- a/modules/nw-externalip-object.adoc +++ b/modules/nw-externalip-object.adoc @@ -2,6 +2,7 @@ // // * networking/configuring_ingress_cluster_traffic/configuring-externalip.adoc +:_mod-docs-content-type: REFERENCE [id="nw-externalip-object_{context}"] = ExternalIP address block configuration diff --git a/modules/nw-high-performance-multicast.adoc b/modules/nw-high-performance-multicast.adoc index c2da2a6d3d5a..56d6c258db52 100644 --- a/modules/nw-high-performance-multicast.adoc +++ b/modules/nw-high-performance-multicast.adoc @@ -2,6 +2,7 @@ // // * networking/hardware_networks/using-sriov-multicast.adoc +:_mod-docs-content-type: REFERENCE [id="nw-high-performance-multicast_{context}"] = High performance multicast diff --git a/modules/nw-installation-ingress-config-asset.adoc b/modules/nw-installation-ingress-config-asset.adoc index 4609568221e4..a8a113bf068f 100644 --- a/modules/nw-installation-ingress-config-asset.adoc +++ b/modules/nw-installation-ingress-config-asset.adoc @@ -2,7 +2,7 @@ // // * networking/ingress/configuring_ingress_operator.adoc - +:_mod-docs-content-type: REFERENCE [id="nw-installation-ingress-config-asset_{context}"] = The Ingress configuration asset diff --git a/modules/nw-ipfailover-environment-variables.adoc b/modules/nw-ipfailover-environment-variables.adoc index 3ecc907593cc..68c982cab426 100644 --- a/modules/nw-ipfailover-environment-variables.adoc +++ b/modules/nw-ipfailover-environment-variables.adoc @@ -2,6 +2,7 @@ // // * networking/configuring-ipfailover.adoc +:_mod-docs-content-type: REFERENCE [id="nw-ipfailover-environment-variables_{context}"] = IP failover environment variables @@ -19,7 +20,7 @@ The following table contains the variables used to configure IP failover. |`OPENSHIFT_HA_NETWORK_INTERFACE` | -|The interface name that IP failover uses to send Virtual Router Redundancy Protocol (VRRP) traffic. The default value is `eth0`. +|The interface name that IP failover uses to send Virtual Router Redundancy Protocol (VRRP) traffic. The default value is `eth0`. If your cluster uses the OVN-Kubernetes network plugin, set this value to `br-ex` to avoid packet loss. For a cluster that uses the OVN-Kubernetes network plugin, all listening interfaces do not serve VRRP but instead expect inbound traffic over a `br-ex` bridge. diff --git a/modules/nw-metallb-bgp-limitations.adoc b/modules/nw-metallb-bgp-limitations.adoc index 6c972156ade5..66f51dfb9d2c 100644 --- a/modules/nw-metallb-bgp-limitations.adoc +++ b/modules/nw-metallb-bgp-limitations.adoc @@ -2,6 +2,7 @@ // // * networking/metallb/about-metallb.adoc +:_mod-docs-content-type: CONCEPT [id="nw-metallb-bgp-limitations_{context}"] = Limitations for BGP mode diff --git a/modules/nw-metallb-collecting-data.adoc b/modules/nw-metallb-collecting-data.adoc index d3d8b26ce8a7..8a9f462e732b 100644 --- a/modules/nw-metallb-collecting-data.adoc +++ b/modules/nw-metallb-collecting-data.adoc @@ -2,6 +2,7 @@ // // * networking/metallb/metallb-troubleshoot-support.adoc +:_mod-docs-content-type: CONCEPT [id="nw-metallb-collecting-data_{context}"] = About collecting MetalLB data diff --git a/modules/nw-metallb-extern-traffic-pol.adoc b/modules/nw-metallb-extern-traffic-pol.adoc index 2089879e0a9e..5a53f5e056aa 100644 --- a/modules/nw-metallb-extern-traffic-pol.adoc +++ b/modules/nw-metallb-extern-traffic-pol.adoc @@ -2,6 +2,7 @@ // // * networking/metallb/about-metallb.adoc +:_mod-docs-content-type: CONCEPT [id="nw-metallb-extern-traffic-pol_{context}"] = MetalLB and external traffic policy diff --git a/modules/nw-metallb-infra-considerations.adoc b/modules/nw-metallb-infra-considerations.adoc index 457e3bcbaaf7..3722d2551d93 100644 --- a/modules/nw-metallb-infra-considerations.adoc +++ b/modules/nw-metallb-infra-considerations.adoc @@ -2,6 +2,7 @@ // // * networking/metallb/about-metallb.adoc +:_mod-docs-content-type: CONCEPT [id="nw-metallb-infra-considerations_{context}"] = Infrastructure considerations for MetalLB diff --git a/modules/nw-metallb-metrics.adoc b/modules/nw-metallb-metrics.adoc index 889a03ae3816..9f01e7d21b2e 100644 --- a/modules/nw-metallb-metrics.adoc +++ b/modules/nw-metallb-metrics.adoc @@ -2,6 +2,7 @@ // // * networking/metallb/metallb-troubleshoot-support.adoc +:_mod-docs-content-type: REFERENCE [id="nw-metallb-metrics_{context}"] = MetalLB metrics for BGP and BFD diff --git a/modules/nw-metallb-operator-custom-resources.adoc b/modules/nw-metallb-operator-custom-resources.adoc index fafda7961e86..154b2ed4abd8 100644 --- a/modules/nw-metallb-operator-custom-resources.adoc +++ b/modules/nw-metallb-operator-custom-resources.adoc @@ -2,6 +2,7 @@ // // * networking/metallb/about-metallb.adoc +:_mod-docs-content-type: REFERENCE [id="nw-metallb-operator-custom-resources_{context}"] = MetalLB Operator custom resources diff --git a/modules/nw-metallb-operator-deployment-specifications-for-metallb.adoc b/modules/nw-metallb-operator-deployment-specifications-for-metallb.adoc index 3f91c567ec9a..071456d11a42 100644 --- a/modules/nw-metallb-operator-deployment-specifications-for-metallb.adoc +++ b/modules/nw-metallb-operator-deployment-specifications-for-metallb.adoc @@ -2,6 +2,7 @@ // // * networking/metallb/metallb-operator-install.adoc +:_mod-docs-content-type: REFERENCE [id="nw-metallb-operator-deployment-specifications-for-metallb_{context}"] = Deployment specifications for MetalLB diff --git a/modules/nw-metallb-operator-limit-speaker-to-nodes.adoc b/modules/nw-metallb-operator-limit-speaker-to-nodes.adoc index 1b69d1fffc1e..e1e6efb2384b 100644 --- a/modules/nw-metallb-operator-limit-speaker-to-nodes.adoc +++ b/modules/nw-metallb-operator-limit-speaker-to-nodes.adoc @@ -2,6 +2,7 @@ // // * networking/metallb/metallb-operator-install.adoc +:_mod-docs-content-type: CONCEPT [id="nw-metallb-operator-limit-speaker-to-nodes_{context}"] = Limit speaker pods to specific nodes diff --git a/modules/nw-metallb-software-components.adoc b/modules/nw-metallb-software-components.adoc index 4698e0ce3758..c72133ac8d45 100644 --- a/modules/nw-metallb-software-components.adoc +++ b/modules/nw-metallb-software-components.adoc @@ -2,12 +2,13 @@ // // * networking/metallb/about-metallb.adoc +:_mod-docs-content-type: CONCEPT [id="nw-metallb-software-components_{context}"] = MetalLB software components When you install the MetalLB Operator, the `metallb-operator-controller-manager` deployment starts a pod. The pod is the implementation of the Operator. The pod monitors for changes to all the relevant resources. -When the Operator starts an instance of MetalLB, it starts a `controller` deployment and a `speaker` daemon set. +When the Operator starts an instance of MetalLB, it starts a `controller` deployment and a `speaker` daemon set. [NOTE] ==== diff --git a/modules/nw-ne-openshift-ingress.adoc b/modules/nw-ne-openshift-ingress.adoc index 5a264b1730f5..98fd372059d4 100644 --- a/modules/nw-ne-openshift-ingress.adoc +++ b/modules/nw-ne-openshift-ingress.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: // * understanding-networking.adoc - +:_mod-docs-content-type: REFERENCE [id="nw-ne-openshift-ingress_{context}"] = {product-title} Ingress Operator diff --git a/modules/nw-network-config.adoc b/modules/nw-network-config.adoc index 24bea7bad24b..117f5d6af2e4 100644 --- a/modules/nw-network-config.adoc +++ b/modules/nw-network-config.adoc @@ -13,6 +13,7 @@ // * installing/installing_gcp/installing-gcp-network-customizations.adoc // * installing/installing_azure_stack_hub/installing-azure-stack-hub-network-customizations.adoc +:_mod-docs-content-type: REFERENCE [id="nw-network-config_{context}"] = Network configuration phases diff --git a/modules/nw-network-flows-object.adoc b/modules/nw-network-flows-object.adoc index c9f82c13f3fb..18f39d99893a 100644 --- a/modules/nw-network-flows-object.adoc +++ b/modules/nw-network-flows-object.adoc @@ -2,6 +2,7 @@ // // * networking/ovn_kubernetes_network_provider/tracking-network-flows.adoc +:_mod-docs-content-type: REFERENCE [id="nw-network-flows-object_{context}"] = Network object configuration for tracking network flows diff --git a/modules/nw-networkpolicy-optimize-ovn.adoc b/modules/nw-networkpolicy-optimize-ovn.adoc index d91d78278914..c49a3336dfc1 100644 --- a/modules/nw-networkpolicy-optimize-ovn.adoc +++ b/modules/nw-networkpolicy-optimize-ovn.adoc @@ -2,6 +2,7 @@ // // * networking/network_security/network_policy/about-network-policy.adoc +:_mod-docs-content-type: CONCEPT [id="nw-networkpolicy-optimize-ovn_{context}"] = Optimizations for network policy with OVN-Kubernetes network plugin diff --git a/modules/nw-ovn-k-anp-troubeshooting.adoc b/modules/nw-ovn-k-anp-troubeshooting.adoc index a38ef43de232..8e76e9e34eef 100644 --- a/modules/nw-ovn-k-anp-troubeshooting.adoc +++ b/modules/nw-ovn-k-anp-troubeshooting.adoc @@ -1,7 +1,7 @@ //module included in the following assemblies: // //networking/network_security/AdminNetworkPolicy/nw-ovn-k-anp-troubleshooting.adoc -:_mod-docs-content-type: REFRENCE +:_mod-docs-content-type: REFERENCE [id="anp-troubleshooting_{context}"] = Checking creation of ANP diff --git a/modules/nw-ovn-k-baseline-adminnetwork-policy.adoc b/modules/nw-ovn-k-baseline-adminnetwork-policy.adoc index 893c8e01b736..2733601055c4 100644 --- a/modules/nw-ovn-k-baseline-adminnetwork-policy.adoc +++ b/modules/nw-ovn-k-baseline-adminnetwork-policy.adoc @@ -2,7 +2,7 @@ // // * networking/network-policy-apis.adoc -:_mod-docs-content-type: Concept +:_mod-docs-content-type: CONCEPT [id="BaselineAdminNetworkPolicy"_{context}"] = BaselineAdminNetworkPolicy diff --git a/modules/nw-sctp-about.adoc b/modules/nw-sctp-about.adoc index 24ea5e630a97..c715f6a0dd1a 100644 --- a/modules/nw-sctp-about.adoc +++ b/modules/nw-sctp-about.adoc @@ -2,6 +2,7 @@ // // * networking/using-sctp.adoc +:_mod-docs-content-type: REFERENCE [id="nw-sctp-about_{context}"] = Support for SCTP on {product-title} diff --git a/modules/nw-sriov-app-netutil.adoc b/modules/nw-sriov-app-netutil.adoc index 5b7d29069f0e..9ca61b9bf824 100644 --- a/modules/nw-sriov-app-netutil.adoc +++ b/modules/nw-sriov-app-netutil.adoc @@ -2,6 +2,7 @@ // // * networking/hardware_networks/about-sriov.adoc +:_mod-docs-content-type: REFERENCE [id="nw-sriov-app-netutil_{context}"] = DPDK library for use with container applications diff --git a/modules/nw-sriov-device-discovery.adoc b/modules/nw-sriov-device-discovery.adoc index a67d3cd3ef76..5e5ad983406d 100644 --- a/modules/nw-sriov-device-discovery.adoc +++ b/modules/nw-sriov-device-discovery.adoc @@ -3,6 +3,7 @@ // * networking/hardware_networks/about-sriov.adoc // * virt/vm_networking/virt-connecting-vm-to-sriov.adoc +:_mod-docs-content-type: REFERENCE [id="discover-sr-iov-devices_{context}"] = Automated discovery of SR-IOV network devices diff --git a/modules/nw-sriov-example-vf-function-in-pod.adoc b/modules/nw-sriov-example-vf-function-in-pod.adoc index ef82f935b7ac..71f1d58eec95 100644 --- a/modules/nw-sriov-example-vf-function-in-pod.adoc +++ b/modules/nw-sriov-example-vf-function-in-pod.adoc @@ -2,6 +2,7 @@ // // * networking/hardware_networks/about-sriov.adoc +:_mod-docs-content-type: REFERENCE [id="example-vf-use-in-pod_{context}"] = Example use of a virtual function in a pod diff --git a/modules/nw-sriov-huge-pages.adoc b/modules/nw-sriov-huge-pages.adoc index 06913a25882b..d401e2633dad 100644 --- a/modules/nw-sriov-huge-pages.adoc +++ b/modules/nw-sriov-huge-pages.adoc @@ -2,6 +2,7 @@ // // * networking/hardware_networks/about-sriov.adoc +:_mod-docs-content-type: REFERENCE [id="nw-sriov-hugepages_{context}"] = Huge pages resource injection for Downward API diff --git a/modules/nw-sriov-ibnetwork-object.adoc b/modules/nw-sriov-ibnetwork-object.adoc index 00ee9bf15b92..24acb01ac94e 100644 --- a/modules/nw-sriov-ibnetwork-object.adoc +++ b/modules/nw-sriov-ibnetwork-object.adoc @@ -2,6 +2,7 @@ // // * networking/hardware_networks/configuring-sriov-ib-attach.adoc +:_mod-docs-content-type: REFERENCE [id="nw-sriov-ibnetwork-object_{context}"] = InfiniBand device configuration object diff --git a/modules/nw-sriov-network-object.adoc b/modules/nw-sriov-network-object.adoc index 1f062f27f858..cd5c02af3fbc 100644 --- a/modules/nw-sriov-network-object.adoc +++ b/modules/nw-sriov-network-object.adoc @@ -18,6 +18,7 @@ ifeval::["{context}" == "virt-connecting-vm-to-sriov"] :object: pods or virtual machines endif::[] +:_mod-docs-content-type: REFERENCE [id="nw-sriov-network-object_{context}"] = Ethernet device configuration object diff --git a/modules/nw-sriov-supported-devices.adoc b/modules/nw-sriov-supported-devices.adoc index 5266fc8a5a05..98f6f84874b6 100644 --- a/modules/nw-sriov-supported-devices.adoc +++ b/modules/nw-sriov-supported-devices.adoc @@ -2,6 +2,7 @@ // // * networking/hardware_networks/about-sriov.adoc +:_mod-docs-content-type: REFERENCE [id="supported-devices_{context}"] = Supported devices diff --git a/modules/nw-sriov-supported-platforms.adoc b/modules/nw-sriov-supported-platforms.adoc index 898c736a175d..fd42615551fc 100644 --- a/modules/nw-sriov-supported-platforms.adoc +++ b/modules/nw-sriov-supported-platforms.adoc @@ -2,6 +2,7 @@ // // * networking/hardware_networks/about-sriov.adoc +:_mod-docs-content-type: REFERENCE [id="nw-sriov-supported-platforms_{context}"] = Supported platforms diff --git a/modules/nw-troubleshoot-ovs.adoc b/modules/nw-troubleshoot-ovs.adoc index 309bae0abbe3..f33e8007e827 100644 --- a/modules/nw-troubleshoot-ovs.adoc +++ b/modules/nw-troubleshoot-ovs.adoc @@ -1,3 +1,8 @@ +// Module included in the following assemblies: +// +//nw-troubleshooting-ovs.adoc + +:_mod-docs-content-type: REFERENCE [id="nw-troubleshoot-ovs_{context}"] = Troubleshooting Open vSwitch issues diff --git a/modules/nw-using-ingress-and-routes.adoc b/modules/nw-using-ingress-and-routes.adoc index 90793167f59b..274eb05b965e 100644 --- a/modules/nw-using-ingress-and-routes.adoc +++ b/modules/nw-using-ingress-and-routes.adoc @@ -2,6 +2,7 @@ // // * ingress/configuring-ingress-cluster-traffic-ingress-controller.adoc +:_mod-docs-content-type: CONCEPT [id="nw-using-ingress-and-routes_{context}"] = Using Ingress Controllers and routes diff --git a/modules/nw-using-load-balancer-getting-traffic.adoc b/modules/nw-using-load-balancer-getting-traffic.adoc index 7e37be14ecf3..bb37e1e1b8e5 100644 --- a/modules/nw-using-load-balancer-getting-traffic.adoc +++ b/modules/nw-using-load-balancer-getting-traffic.adoc @@ -2,6 +2,7 @@ // // * ingress/getting-traffic-cluster.adoc +:_mod-docs-content-type: CONCEPT [id="nw-using-load-balancer-getting-traffic_{context}"] = Using a load balancer to get traffic into the cluster diff --git a/modules/nw-using-nodeport.adoc b/modules/nw-using-nodeport.adoc index d5f4b53cf188..9431d68c4f76 100644 --- a/modules/nw-using-nodeport.adoc +++ b/modules/nw-using-nodeport.adoc @@ -2,6 +2,7 @@ // // * networking/configuring_ingress_cluster_traffic/configuring-ingress-cluster-traffic-nodeport.adoc +:_mod-docs-content-type: CONCEPT [id="nw-using-nodeport_{context}"] = Using a NodePort to get traffic into the cluster