diff --git a/applications/application-health.adoc b/applications/application-health.adoc index 42fefe17fd..0dfb790784 100644 --- a/applications/application-health.adoc +++ b/applications/application-health.adoc @@ -24,6 +24,7 @@ include::modules/odc-monitoring-application-health-using-developer-perspective.a // cannot add health checks in web console ifdef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] include::modules/odc-adding-health-checks.adoc[leveloffset=+1] + endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] include::modules/odc-editing-health-checks.adoc[leveloffset=+1] diff --git a/applications/connecting_applications_to_services/binding-workloads-using-sbo.adoc b/applications/connecting_applications_to_services/binding-workloads-using-sbo.adoc index 8c00878a9e..db7e507dc7 100644 --- a/applications/connecting_applications_to_services/binding-workloads-using-sbo.adoc +++ b/applications/connecting_applications_to_services/binding-workloads-using-sbo.adoc @@ -37,8 +37,11 @@ spec: As shown in the previous example, you can also directly use a `ConfigMap` or a `Secret` itself as a service resource to be used as a source of binding data. include::modules/sbo-naming-strategies.adoc[leveloffset=+1] + include::modules/sbo-advanced-binding-options.adoc[leveloffset=+1] + include::modules/sbo-binding-workloads-that-are-not-compliant-with-PodSpec.adoc[leveloffset=+1] + include::modules/sbo-unbinding-workloads-from-a-backing-service.adoc[leveloffset=+1] [role="_additional-resources"] diff --git a/applications/connecting_applications_to_services/exposing-binding-data-from-a-service.adoc b/applications/connecting_applications_to_services/exposing-binding-data-from-a-service.adoc index 4bc0cf51d6..229189aa33 100644 --- a/applications/connecting_applications_to_services/exposing-binding-data-from-a-service.adoc +++ b/applications/connecting_applications_to_services/exposing-binding-data-from-a-service.adoc @@ -13,9 +13,13 @@ Application developers need access to backing services to build and connect work The {servicebinding-title} enables application developers to easily bind workloads together with operator-managed backing services, without any manual procedures to configure the binding connection. For the {servicebinding-title} to provide the binding data, as an Operator provider or user who creates backing services, you must expose the binding data to be automatically detected by the {servicebinding-title}. Then, the {servicebinding-title} automatically collects the binding data from the backing service and shares it with a workload to provide a consistent and predictable experience. include::modules/sbo-methods-of-exposing-binding-data.adoc[leveloffset=+1] + include::modules/sbo-data-model.adoc[leveloffset=+1] + include::modules/sbo-setting-annotations-mapping-optional.adoc[leveloffset=+1] + include::modules/sbo-rbac-requirements.adoc[leveloffset=+1] + include::modules/sbo-categories-of-exposable-binding-data.adoc[leveloffset=+1] [role="_additional-resources"] diff --git a/applications/connecting_applications_to_services/projecting-binding-data.adoc b/applications/connecting_applications_to_services/projecting-binding-data.adoc index dc23b0b2b0..6d4dbbdc6b 100644 --- a/applications/connecting_applications_to_services/projecting-binding-data.adoc +++ b/applications/connecting_applications_to_services/projecting-binding-data.adoc @@ -17,6 +17,7 @@ After the backing service exposes the binding data, for a workload to access and . As environment variables, after you configure the `.spec.bindAsFiles` parameter from the `ServiceBinding` resource. include::modules/sbo-configuration-of-directory-path-to-project-binding-data.adoc[leveloffset=+1] + include::modules/sbo-projecting-the-binding-data.adoc[leveloffset=+1] [role="_additional-resources"] diff --git a/applications/connecting_applications_to_services/understanding-service-binding-operator.adoc b/applications/connecting_applications_to_services/understanding-service-binding-operator.adoc index 0e05be3306..703be8fc87 100644 --- a/applications/connecting_applications_to_services/understanding-service-binding-operator.adoc +++ b/applications/connecting_applications_to_services/understanding-service-binding-operator.adoc @@ -13,8 +13,11 @@ Application developers need access to backing services to build and connect work The {servicebinding-title} enables application developers to easily bind workloads together with Operator-managed backing services, without any manual procedures to configure the binding connection. include::modules/sbo-service-binding-terminology.adoc[leveloffset=+1] + include::modules/sbo-about-service-binding-operator.adoc[leveloffset=+1] + include::modules/sbo-key-features.adoc[leveloffset=+1] + include::modules/sbo-api-differences.adoc[leveloffset=+1] [role="_additional-resources"] diff --git a/applications/deployments/deployment-strategies.adoc b/applications/deployments/deployment-strategies.adoc index 0af104aa2b..88e4f23a42 100644 --- a/applications/deployments/deployment-strategies.adoc +++ b/applications/deployments/deployment-strategies.adoc @@ -27,12 +27,16 @@ A deployment strategy uses readiness checks to determine if a new pod is ready f // Rolling strategies include::modules/deployments-rolling-strategy.adoc[leveloffset=+1] + include::modules/deployments-canary-deployments.adoc[leveloffset=+2] + // Creating rolling deployments include::modules/creating-rolling-deployments-CLI.adoc[leveloffset=+2] + // Editing a deployment :context: rolling-strategy include::modules/odc-editing-deployments.adoc[leveloffset=+2] + // Starting a deployment include::modules/odc-starting-rolling-deployment.adoc[leveloffset=+2] @@ -43,9 +47,11 @@ include::modules/odc-starting-rolling-deployment.adoc[leveloffset=+2] // Recreate strategies include::modules/deployments-recreate-strategy.adoc[leveloffset=+1] + // Editing a deployment :context: recreate-strategy include::modules/odc-editing-deployments.adoc[leveloffset=+2] + // Starting a deployment include::modules/odc-starting-recreate-deployment.adoc[leveloffset=+2] @@ -56,6 +62,7 @@ include::modules/odc-starting-recreate-deployment.adoc[leveloffset=+2] // Custom strategies include::modules/deployments-custom-strategy.adoc[leveloffset=+1] + // Editing a deployment :context: custom-strategy include::modules/odc-editing-deployments.adoc[leveloffset=+2] diff --git a/applications/deployments/managing-deployment-processes.adoc b/applications/deployments/managing-deployment-processes.adoc index 030ba3f103..2035382a01 100644 --- a/applications/deployments/managing-deployment-processes.adoc +++ b/applications/deployments/managing-deployment-processes.adoc @@ -14,13 +14,21 @@ include::snippets/deployment-config-deprecated.adoc[] `DeploymentConfig` objects can be managed from the {product-title} web console's *Workloads* page or using the `oc` CLI. The following procedures show CLI usage unless otherwise stated. include::modules/deployments-starting-deployment.adoc[leveloffset=+2] + include::modules/deployments-viewing-deployment.adoc[leveloffset=+2] + include::modules/deployments-retrying-deployment.adoc[leveloffset=+2] + include::modules/deployments-rolling-back.adoc[leveloffset=+2] + include::modules/deployments-exec-cmd-in-container.adoc[leveloffset=+2] + include::modules/deployments-viewing-logs.adoc[leveloffset=+2] + include::modules/deployments-triggers.adoc[leveloffset=+2] + include::modules/deployments-setting-triggers.adoc[leveloffset=+3] + include::modules/deployments-setting-resources.adoc[leveloffset=+2] // When the Nodes book is added to ROSA/OSD, check if this link is valid. @@ -32,14 +40,17 @@ ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] include::modules/deployments-scaling-manually.adoc[leveloffset=+2] + include::modules/deployments-accessing-private-repos.adoc[leveloffset=+2] ifdef::openshift-enterprise,openshift-webscale,openshift-origin[] include::modules/deployments-assigning-pods-to-nodes.adoc[leveloffset=+2] + endif::[] ifndef::openshift-online[] include::modules/deployments-running-pod-svc-acct.adoc[leveloffset=+2] + endif::[] //// diff --git a/applications/deployments/rosa-config-custom-domains-applications.adoc b/applications/deployments/rosa-config-custom-domains-applications.adoc index 8b89532e4d..28c852d9a0 100644 --- a/applications/deployments/rosa-config-custom-domains-applications.adoc +++ b/applications/deployments/rosa-config-custom-domains-applications.adoc @@ -14,4 +14,5 @@ Starting with {product-title} 4.14, the Custom Domain Operator is deprecated. To You can configure a custom domain for your applications. Custom domains are specific wildcard domains that can be used with {product-title} applications. include::modules/rosa-applications-config-custom-domains.adoc[leveloffset=+1] + include::modules/rosa-applications-renew-custom-domains.adoc[leveloffset=+1] \ No newline at end of file diff --git a/applications/deployments/route-based-deployment-strategies.adoc b/applications/deployments/route-based-deployment-strategies.adoc index 430db58f6b..60ae7a1a72 100644 --- a/applications/deployments/route-based-deployment-strategies.adoc +++ b/applications/deployments/route-based-deployment-strategies.adoc @@ -28,10 +28,15 @@ A canary deployment tests the new version but when a problem is detected it quic The route-based deployment strategies do not scale the number of pods in the services. To maintain desired performance characteristics the deployment configurations might have to be scaled. include::modules/deployments-proxy-shards.adoc[leveloffset=+1] + include::modules/deployments-n1-compatibility.adoc[leveloffset=+1] + include::modules/deployments-graceful-termination.adoc[leveloffset=+1] + include::modules/deployments-blue-green.adoc[leveloffset=+1] + include::modules/deployments-ab-testing.adoc[leveloffset=+1] + include::modules/deployments-ab-testing-lb.adoc[leveloffset=+2] ifndef::openshift-rosa-hcp[] diff --git a/applications/deployments/what-deployments-are.adoc b/applications/deployments/what-deployments-are.adoc index 3576a3966c..b48941f11a 100644 --- a/applications/deployments/what-deployments-are.adoc +++ b/applications/deployments/what-deployments-are.adoc @@ -45,13 +45,17 @@ If the existing deployment strategies are not suited for your use case and you m The following sections provide further details on these objects. include::modules/deployments-replicasets.adoc[leveloffset=+2] + include::modules/deployments-replicationcontrollers.adoc[leveloffset=+2] include::modules/deployments-kube-deployments.adoc[leveloffset=+1] + include::modules/deployments-deploymentconfigs.adoc[leveloffset=+1] include::modules/deployments-comparing-deploymentconfigs.adoc[leveloffset=+1] + include::modules/deployment-specific-features.adoc[leveloffset=+2] + include::modules/deploymentconfig-object-specific-features.adoc[leveloffset=+2] //// diff --git a/applications/idling-applications.adoc b/applications/idling-applications.adoc index 8f163c4463..25375c9dcb 100644 --- a/applications/idling-applications.adoc +++ b/applications/idling-applications.adoc @@ -13,4 +13,5 @@ If any scalable resources are not in use, {product-title} discovers and idles th Applications are made of services, as well as other scalable resources, such as deployment configs. The action of idling an application involves idling all associated resources. include::modules/idle-idling-applications.adoc[leveloffset=+1] + include::modules/idle-unidling-applications.adoc[leveloffset=+1] diff --git a/applications/projects/configuring-project-creation.adoc b/applications/projects/configuring-project-creation.adoc index 9b42423613..97711cb7e0 100644 --- a/applications/projects/configuring-project-creation.adoc +++ b/applications/projects/configuring-project-creation.adoc @@ -16,6 +16,9 @@ a cluster administrator, you can allow and configure how developers and service accounts can create, or _self-provision_, their own projects. include::modules/about-project-creation.adoc[leveloffset=+1] + include::modules/modifying-template-for-new-projects.adoc[leveloffset=+1] + include::modules/disabling-project-self-provisioning.adoc[leveloffset=+1] + include::modules/customizing-project-request-message.adoc[leveloffset=+1] diff --git a/applications/projects/working-with-projects.adoc b/applications/projects/working-with-projects.adoc index 6dea112749..4416117591 100644 --- a/applications/projects/working-with-projects.adoc +++ b/applications/projects/working-with-projects.adoc @@ -29,6 +29,7 @@ endif::openshift-dedicated[] ifndef::openshift-dedicated[] include::snippets/default-projects.adoc[] + endif::openshift-dedicated[] ifdef::openshift-dedicated[] [NOTE] diff --git a/applications/pruning-objects.adoc b/applications/pruning-objects.adoc index 60758faffe..83e695bbea 100644 --- a/applications/pruning-objects.adoc +++ b/applications/pruning-objects.adoc @@ -24,8 +24,11 @@ space. endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] include::modules/pruning-basic-operations.adoc[leveloffset=+1] + include::modules/pruning-groups.adoc[leveloffset=+1] + include::modules/pruning-deployments.adoc[leveloffset=+1] + include::modules/pruning-builds.adoc[leveloffset=+1] ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] @@ -35,15 +38,21 @@ ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] include::modules/pruning-images.adoc[leveloffset=+1] + //cannot create resource "serviceaccounts". cannot create resource "cronjobs" ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] include::modules/pruning-images-manual.adoc[leveloffset=+1] + //include::modules/pruning-images-job-cronjob.adoc[leveloffset=+2] include::modules/pruning-images-conditions.adoc[leveloffset=+2] + include::modules/pruning-images-running-operation.adoc[leveloffset=+2] + include::modules/pruning-images-secure-insecure.adoc[leveloffset=+2] + include::modules/pruning-images-options.adoc[leveloffset=+2] + include::modules/pruning-images-troubleshooting.adoc[leveloffset=+2] [role="_additional-resources"] @@ -60,6 +69,7 @@ endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] include::modules/pruning-hard-pruning-registry.adoc[leveloffset=+1] + endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] include::modules/pruning-cronjobs.adoc[leveloffset=+1] diff --git a/applications/quotas/quotas-setting-across-multiple-projects.adoc b/applications/quotas/quotas-setting-across-multiple-projects.adoc index a4a4330ca1..4c6a0250f2 100644 --- a/applications/quotas/quotas-setting-across-multiple-projects.adoc +++ b/applications/quotas/quotas-setting-across-multiple-projects.adoc @@ -13,5 +13,7 @@ This guide describes how cluster administrators can set and manage resource quot include::snippets/default-projects.adoc[] include::modules/quotas-selecting-projects.adoc[leveloffset=+1] + include::modules/quotas-viewing-clusterresourcequotas.adoc[leveloffset=+1] + include::modules/quotas-selection-granularity.adoc[leveloffset=+1] diff --git a/applications/quotas/quotas-setting-per-project.adoc b/applications/quotas/quotas-setting-per-project.adoc index 472879c2fe..8885853f69 100644 --- a/applications/quotas/quotas-setting-per-project.adoc +++ b/applications/quotas/quotas-setting-per-project.adoc @@ -11,12 +11,21 @@ A _resource quota_, defined by a `ResourceQuota` object, provides constraints th This guide describes how resource quotas work, how cluster administrators can set and manage resource quotas on a per project basis, and how developers and cluster administrators can view them. include::modules/quotas-resources-managed.adoc[leveloffset=+1] + include::modules/quotas-scopes.adoc[leveloffset=+1] + include::modules/quotas-enforcement.adoc[leveloffset=+1] + include::modules/quotas-requests-vs-limits.adoc[leveloffset=+1] + include::modules/quotas-sample-resource-quotas-def.adoc[leveloffset=+1] + include::modules/quotas-creating-a-quota.adoc[leveloffset=+1] + include::modules/quotas-creating-object-count-quotas.adoc[leveloffset=+2] + include::modules/setting-resource-quota-for-extended-resources.adoc[leveloffset=+2] + include::modules/quotas-viewing-quotas.adoc[leveloffset=+1] + include::modules/quotas-requiring-explicit-quota.adoc[leveloffset=+1] diff --git a/applications/working-with-quotas.adoc b/applications/working-with-quotas.adoc index 85715c12eb..e6a52e273e 100644 --- a/applications/working-with-quotas.adoc +++ b/applications/working-with-quotas.adoc @@ -20,7 +20,11 @@ This guide describes how resource quotas work and how developers can work with and view them. include::modules/quotas-viewing-quotas.adoc[leveloffset=+1] + include::modules/quotas-resources-managed.adoc[leveloffset=+1] + include::modules/quotas-scopes.adoc[leveloffset=+1] + include::modules/quotas-enforcement.adoc[leveloffset=+1] + include::modules/quotas-requests-vs-limits.adoc[leveloffset=+1] diff --git a/applications/working_with_helm_charts/configuring-custom-helm-chart-repositories.adoc b/applications/working_with_helm_charts/configuring-custom-helm-chart-repositories.adoc index 823d7ce3e2..99e4ee00cb 100644 --- a/applications/working_with_helm_charts/configuring-custom-helm-chart-repositories.adoc +++ b/applications/working_with_helm_charts/configuring-custom-helm-chart-repositories.adoc @@ -31,6 +31,7 @@ In the *Developer* perspective of the web console, you can use the *Helm* page t // clusterroles.rbac.authorization.k8s.io is forbidden: user (groups=["dedicated-admins" "system:authenticated:oauth" "system:authenticated"]) is attempting to grant RBAC permissions not currently held: ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] include::modules/helm-installing-a-helm-chart-on-an-openshift-cluster.adoc[leveloffset=+1] + endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] include::modules/odc-creating-helm-releases-using-developer-perspective.adoc[leveloffset=+1] @@ -50,18 +51,23 @@ include::modules/helm-creating-a-custom-helm-chart-on-openshift.adoc[leveloffset //cannot create resource "helmchartrepositories" in API group "helm.openshift.io" ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] include::modules/helm-adding-helm-chart-repositories.adoc[leveloffset=+1] + endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] //projecthelmchartrepositories.helm.openshift.io "azure-sample-repo" is forbidden: User cannot get resource "projecthelmchartrepositories" in API group "helm.openshift.io" ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] include::modules/helm-adding-namespace-scoped-helm-chart-repositories.adoc[leveloffset=+1] + endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] //cannot create resource "helmchartrepositories" in API group "helm.openshift.io" ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] include::modules/helm-creating-credentials-and-certificates-to-add-helm-repositories.adoc[leveloffset=+1] + endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] include::modules/helm-filtering-helm-charts-by-certification-level.adoc[leveloffset=+1] + ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] //cannot patch resource "helmchartrepositories" in API group "helm.openshift.io" include::modules/helm-disabling-helm-chart-repositories.adoc[leveloffset=+1] + endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] diff --git a/architecture/admission-plug-ins.adoc b/architecture/admission-plug-ins.adoc index 700c382dd6..4ff0210c54 100644 --- a/architecture/admission-plug-ins.adoc +++ b/architecture/admission-plug-ins.adoc @@ -21,6 +21,7 @@ include::modules/admission-webhook-types.adoc[leveloffset=+1] ifndef::openshift-rosa,openshift-dedicated[] // Procedure module include::modules/configuring-dynamic-admission.adoc[leveloffset=+1] + endif::openshift-rosa,openshift-dedicated[] [role="_additional-resources"] diff --git a/architecture/architecture-rhcos.adoc b/architecture/architecture-rhcos.adoc index 1954f535e3..007ba696a9 100644 --- a/architecture/architecture-rhcos.adoc +++ b/architecture/architecture-rhcos.adoc @@ -7,5 +7,7 @@ include::_attributes/common-attributes.adoc[] toc::[] include::modules/rhcos-about.adoc[leveloffset=+1] + include::modules/ignition-config-viewing.adoc[leveloffset=+1] + include::modules/digging-into-machine-config.adoc[leveloffset=+1] diff --git a/architecture/architecture.adoc b/architecture/architecture.adoc index 515126dbc9..be5ea0e4eb 100644 --- a/architecture/architecture.adoc +++ b/architecture/architecture.adoc @@ -19,6 +19,7 @@ include::modules/architecture-kubernetes-introduction.adoc[leveloffset=+2] include::modules/architecture-container-application-benefits.adoc[leveloffset=+2] include::modules/architecture-platform-benefits.adoc[leveloffset=+2] + //// == User facing components * Workloads (Deployments, Jobs, ReplicaSets, etc) @@ -43,4 +44,5 @@ notification when an image is updated with a new version. ifndef::openshift-dedicated,openshift-rosa[] include::modules/cluster-entitlements.adoc[leveloffset=+2] + endif::openshift-dedicated,openshift-rosa[] diff --git a/architecture/control-plane.adoc b/architecture/control-plane.adoc index 123a02a277..e06e609e22 100644 --- a/architecture/control-plane.adoc +++ b/architecture/control-plane.adoc @@ -18,11 +18,13 @@ and a set of individual Operators. ifdef::openshift-rosa[] :FeatureName: This control plane architecture include::snippets/rosa-classic-support.adoc[] + endif::openshift-rosa[] // This module does not apply to OSD/ROSA ifndef::openshift-dedicated,openshift-rosa[] include::modules/architecture-machine-config-pools.adoc[leveloffset=+1] + endif::openshift-dedicated,openshift-rosa[] ifndef::openshift-dedicated,openshift-rosa[] @@ -62,7 +64,9 @@ include::modules/etcd-overview.adoc[leveloffset=+1] // These modules only apply to ROSA/OSD ifdef::openshift-dedicated,openshift-rosa[] include::modules/cpmso-feat-auto-update.adoc[leveloffset=+1] + include::modules/cpmso-control-plane-recovery.adoc[leveloffset=+1] + endif::openshift-dedicated,openshift-rosa[] // These xrefs do not apply to OSD/ROSA diff --git a/architecture/index.adoc b/architecture/index.adoc index 479124681c..4cb3468c7e 100644 --- a/architecture/index.adoc +++ b/architecture/index.adoc @@ -32,6 +32,7 @@ endif::openshift-dedicated,openshift-rosa[] ifdef::openshift-dedicated,openshift-rosa[] include::modules/sd-vs-ocp.adoc[leveloffset=+1] + endif::openshift-dedicated,openshift-rosa[] ifndef::openshift-dedicated,openshift-rosa[] diff --git a/architecture/nvidia-gpu-architecture-overview.adoc b/architecture/nvidia-gpu-architecture-overview.adoc index 11d53f8200..6dc5b65e39 100644 --- a/architecture/nvidia-gpu-architecture-overview.adoc +++ b/architecture/nvidia-gpu-architecture-overview.adoc @@ -24,26 +24,31 @@ ifndef::openshift-dedicated,openshift-rosa[] include::modules/nvidia-gpu-enablement.adoc[leveloffset=+1] include::modules/nvidia-gpu-bare-metal.adoc[leveloffset=+2] + [role="_additional-resources"] .Additional resources * link:https://docs.nvidia.com/ai-enterprise/deployment-guide-openshift-on-bare-metal/0.1.0/on-bare-metal.html[Red Hat OpenShift on Bare Metal Stack] include::modules/nvidia-gpu-virtualization.adoc[leveloffset=+2] + [role="_additional-resources"] .Additional resources * link:https://docs.nvidia.com/datacenter/cloud-native/gpu-operator/latest/openshift/openshift-virtualization.html[NVIDIA GPU Operator with OpenShift Virtualization] include::modules/nvidia-gpu-vsphere.adoc[leveloffset=+2] + [role="_additional-resources"] .Additional resources * link:https://docs.nvidia.com/datacenter/cloud-native/gpu-operator/latest/openshift/nvaie-with-ocp.html#openshift-container-platform-on-vmware-vsphere-with-nvidia-vgpus[OpenShift Container Platform on VMware vSphere with NVIDIA vGPUs] include::modules/nvidia-gpu-kvm.adoc[leveloffset=+2] + [role="_additional-resources"] .Additional resources * link:https://computingforgeeks.com/how-to-deploy-openshift-container-platform-on-kvm/[How To Deploy OpenShift Container Platform 4.13 on KVM] include::modules/nvidia-gpu-csps.adoc[leveloffset=+2] + [role="_additional-resources"] .Additional resources * link:https://docs.nvidia.com/ai-enterprise/deployment-guide-cloud/0.1.0/aws-redhat-openshift.html[Red Hat Openshift in the Cloud] @@ -52,6 +57,7 @@ endif::openshift-dedicated,openshift-rosa[] // Include this module at a higher leveloffset for OSD/ROSA. ifdef::openshift-dedicated,openshift-rosa[] include::modules/nvidia-gpu-csps.adoc[leveloffset=+1] + [role="_additional-resources"] .Additional resources * link:https://docs.nvidia.com/ai-enterprise/deployment-guide-cloud/0.1.0/aws-redhat-openshift.html[Red Hat Openshift in the Cloud] @@ -59,6 +65,7 @@ endif::openshift-dedicated,openshift-rosa[] ifndef::openshift-dedicated,openshift-rosa[] include::modules/nvidia-gpu-red-hat-device-edge.adoc[leveloffset=+2] + [role="_additional-resources"] .Additional resources * link:https://cloud.redhat.com/blog/how-to-accelerate-workloads-with-nvidia-gpus-on-red-hat-device-edge[How to accelerate workloads with NVIDIA GPUs on Red Hat Device Edge] @@ -66,28 +73,34 @@ endif::openshift-dedicated,openshift-rosa[] // TELCODOCS-1092 GPU sharing methods include::modules/nvidia-gpu-sharing-methods.adoc[leveloffset=+1] + .Additional resources * link:https://developer.nvidia.com/blog/improving-gpu-utilization-in-kubernetes/[Improving GPU Utilization] include::modules/nvidia-gpu-cuda-streams.adoc[leveloffset=+2] + .Additional resources * link:https://docs.nvidia.com/cuda/cuda-c-programming-guide/index.html#asynchronous-concurrent-execution[Asynchronous Concurrent Execution] include::modules/nvidia-gpu-time-slicing.adoc[leveloffset=+2] include::modules/nvidia-gpu-cuda-mps.adoc[leveloffset=+2] + .Additional resources * link:https://docs.nvidia.com/deploy/mps/index.html[CUDA MPS] include::modules/nvidia-gpu-mig-gpu.adoc[leveloffset=+2] + .Additional resources * link:https://docs.nvidia.com/datacenter/tesla/mig-user-guide/[NVIDIA Multi-Instance GPU User Guide] include::modules/nvidia-gpu-virtualization-with-gpu.adoc[leveloffset=+2] + .Additional resources * link:https://www.nvidia.com/en-us/data-center/virtual-solutions/[Virtual GPUs] include::modules/nvidia-gpu-features.adoc[leveloffset=+1] + [role="_additional-resources"] .Additional resources diff --git a/architecture/ocm-overview-ocp.adoc b/architecture/ocm-overview-ocp.adoc index f04783eb62..52d8ec054e 100644 --- a/architecture/ocm-overview-ocp.adoc +++ b/architecture/ocm-overview-ocp.adoc @@ -44,11 +44,17 @@ Selecting an active, installed cluster shows tabs associated with that cluster. * Settings include::modules/ocm-overview-tab.adoc[leveloffset=+2] + include::modules/ocm-accesscontrol-tab.adoc[leveloffset=+2] + include::modules/ocm-addons-tab.adoc[leveloffset=+2] + include::modules/ocm-insightsadvisor-tab.adoc[leveloffset=+2] + include::modules/ocm-machinepools-tab.adoc[leveloffset=+2] + include::modules/ocm-support-tab.adoc[leveloffset=+2] + include::modules/ocm-settings-tab.adoc[leveloffset=+2] [id="ocm-additional-resources-ocp"] diff --git a/authentication/assuming-an-aws-iam-role-for-a-service-account.adoc b/authentication/assuming-an-aws-iam-role-for-a-service-account.adoc index fde642119d..7c3af6167b 100644 --- a/authentication/assuming-an-aws-iam-role-for-a-service-account.adoc +++ b/authentication/assuming-an-aws-iam-role-for-a-service-account.adoc @@ -17,12 +17,19 @@ endif::openshift-rosa,openshift-rosa-hcp[] You can use the pod identity webhook to project service account tokens to assume an AWS Identity and Access Management (IAM) role for your own workloads. If the assumed IAM role has the required AWS permissions, the pods can run AWS SDK operations by using temporary STS credentials. include::modules/how-service-accounts-assume-aws-iam-roles-in-sre-owned-projects.adoc[leveloffset=+1] + include::modules/understanding-pod-identity-webhook-workflow-in-user-defined-projects.adoc[leveloffset=+1] + include::modules/assuming-an-aws-iam-role-in-your-own-pods.adoc[leveloffset=+1] + include::modules/setting-up-an-aws-iam-role-a-service-account.adoc[leveloffset=+2] + include::modules/creating-a-service-account-in-your-project.adoc[leveloffset=+2] + include::modules/creating-an-example-aws-sdk-container-image.adoc[leveloffset=+2] + include::modules/deploying-a-pod-that-includes-an-aws-sdk.adoc[leveloffset=+2] + include::modules/verifying-the-assumed-iam-role-in-your-pod.adoc[leveloffset=+2] [role="_additional-resources"] diff --git a/authentication/identity_providers/configuring-github-identity-provider.adoc b/authentication/identity_providers/configuring-github-identity-provider.adoc index e170b8ff62..659883219c 100644 --- a/authentication/identity_providers/configuring-github-identity-provider.adoc +++ b/authentication/identity_providers/configuring-github-identity-provider.adoc @@ -17,6 +17,7 @@ The following steps apply to both GitHub and GitHub Enterprise unless noted. ifdef::openshift-origin,openshift-enterprise,openshift-webscale[] include::modules/identity-provider-overview.adoc[leveloffset=+1] + endif::openshift-origin,openshift-enterprise,openshift-webscale[] include::modules/identity-provider-github-about.adoc[leveloffset=+1] @@ -37,4 +38,5 @@ include::modules/identity-provider-github-CR.adoc[leveloffset=+1] * See xref:../../authentication/understanding-identity-provider.adoc#identity-provider-parameters_understanding-identity-provider[Identity provider parameters] for information on parameters, such as `mappingMethod`, that are common to all identity providers. include::modules/identity-provider-add.adoc[leveloffset=+1] + endif::[] diff --git a/authentication/identity_providers/configuring-gitlab-identity-provider.adoc b/authentication/identity_providers/configuring-gitlab-identity-provider.adoc index 75f8dc914a..565a3ebdb0 100644 --- a/authentication/identity_providers/configuring-gitlab-identity-provider.adoc +++ b/authentication/identity_providers/configuring-gitlab-identity-provider.adoc @@ -10,6 +10,7 @@ Configure the `gitlab` identity provider using link:https://gitlab.com/[GitLab.c ifdef::openshift-origin,openshift-enterprise,openshift-webscale[] include::modules/identity-provider-overview.adoc[leveloffset=+1] + endif::openshift-origin,openshift-enterprise,openshift-webscale[] include::modules/identity-provider-gitlab-about.adoc[leveloffset=+1] diff --git a/authentication/identity_providers/configuring-google-identity-provider.adoc b/authentication/identity_providers/configuring-google-identity-provider.adoc index b447062ec2..1efd3bae38 100644 --- a/authentication/identity_providers/configuring-google-identity-provider.adoc +++ b/authentication/identity_providers/configuring-google-identity-provider.adoc @@ -10,6 +10,7 @@ Configure the `google` identity provider using the link:https://developers.googl ifdef::openshift-origin,openshift-enterprise,openshift-webscale[] include::modules/identity-provider-overview.adoc[leveloffset=+1] + endif::openshift-origin,openshift-enterprise,openshift-webscale[] include::modules/identity-provider-google-about.adoc[leveloffset=+1] @@ -26,4 +27,5 @@ include::modules/identity-provider-google-CR.adoc[leveloffset=+1] * See xref:../../authentication/understanding-identity-provider.adoc#identity-provider-parameters_understanding-identity-provider[Identity provider parameters] for information on parameters, such as `mappingMethod`, that are common to all identity providers. include::modules/identity-provider-add.adoc[leveloffset=+1] + endif::[] diff --git a/authentication/identity_providers/configuring-htpasswd-identity-provider.adoc b/authentication/identity_providers/configuring-htpasswd-identity-provider.adoc index 2a7a2882f7..4b1f5db553 100644 --- a/authentication/identity_providers/configuring-htpasswd-identity-provider.adoc +++ b/authentication/identity_providers/configuring-htpasswd-identity-provider.adoc @@ -19,6 +19,7 @@ the default OAuth configuration to add the identity provider. ifdef::openshift-origin,openshift-enterprise,openshift-webscale[] include::modules/identity-provider-overview.adoc[leveloffset=+1] + endif::openshift-origin,openshift-enterprise,openshift-webscale[] include::modules/identity-provider-htpasswd-about.adoc[leveloffset=+1] diff --git a/authentication/identity_providers/configuring-ldap-identity-provider.adoc b/authentication/identity_providers/configuring-ldap-identity-provider.adoc index dce6d697af..f06101f6a6 100644 --- a/authentication/identity_providers/configuring-ldap-identity-provider.adoc +++ b/authentication/identity_providers/configuring-ldap-identity-provider.adoc @@ -10,6 +10,7 @@ Configure the `ldap` identity provider to validate user names and passwords agai ifdef::openshift-origin,openshift-enterprise,openshift-webscale[] include::modules/identity-provider-overview.adoc[leveloffset=+1] + endif::openshift-origin,openshift-enterprise,openshift-webscale[] include::modules/identity-provider-about-ldap.adoc[leveloffset=+1] @@ -28,4 +29,5 @@ include::modules/identity-provider-ldap-CR.adoc[leveloffset=+1] * See xref:../../authentication/understanding-identity-provider.adoc#identity-provider-parameters_understanding-identity-provider[Identity provider parameters] for information on parameters, such as `mappingMethod`, that are common to all identity providers. include::modules/identity-provider-add.adoc[leveloffset=+1] + endif::[] diff --git a/authentication/identity_providers/configuring-oidc-identity-provider.adoc b/authentication/identity_providers/configuring-oidc-identity-provider.adoc index 9482be8b00..eda44c3fc2 100644 --- a/authentication/identity_providers/configuring-oidc-identity-provider.adoc +++ b/authentication/identity_providers/configuring-oidc-identity-provider.adoc @@ -10,12 +10,14 @@ Configure the `oidc` identity provider to integrate with an OpenID Connect ident ifdef::openshift-origin,openshift-enterprise,openshift-webscale[] include::modules/identity-provider-overview.adoc[leveloffset=+1] + endif::openshift-origin,openshift-enterprise,openshift-webscale[] include::modules/identity-provider-oidc-about.adoc[leveloffset=+1] ifdef::openshift-enterprise[] include::modules/identity-provider-oidc-supported.adoc[leveloffset=+1] + endif::openshift-enterprise[] ifdef::openshift-enterprise,openshift-webscale,openshift-origin[] @@ -34,4 +36,5 @@ include::modules/identity-provider-oidc-CR.adoc[leveloffset=+1] include::modules/identity-provider-add.adoc[leveloffset=+1] include::modules/identity-provider-configuring-using-web-console.adoc[leveloffset=+1] + endif::[] diff --git a/authentication/ldap-syncing.adoc b/authentication/ldap-syncing.adoc index a1bbda824c..8c30a2813f 100644 --- a/authentication/ldap-syncing.adoc +++ b/authentication/ldap-syncing.adoc @@ -44,13 +44,21 @@ You must have `dedicated-admin` privileges to sync groups. endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] include::modules/ldap-syncing-about.adoc[leveloffset=+1] + include::modules/ldap-syncing-config-rfc2307.adoc[leveloffset=+2] + include::modules/ldap-syncing-config-activedir.adoc[leveloffset=+2] + include::modules/ldap-syncing-config-augmented-activedir.adoc[leveloffset=+2] + include::modules/ldap-syncing-running.adoc[leveloffset=+1] + include::modules/ldap-syncing-running-all-ldap.adoc[leveloffset=+2] + include::modules/ldap-syncing-running-openshift.adoc[leveloffset=+2] + include::modules/ldap-syncing-running-subset.adoc[leveloffset=+2] + include::modules/ldap-syncing-pruning.adoc[leveloffset=+1] // OSD and ROSA dedicated-admins cannot create the cluster roles and cluster role bindings required for this procedure. @@ -66,10 +74,17 @@ include::modules/ldap-auto-syncing.adoc[leveloffset=+1] endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] include::modules/ldap-syncing-examples.adoc[leveloffset=+1] + include::modules/ldap-syncing-rfc2307.adoc[leveloffset=+2] + include::modules/ldap-syncing-rfc2307-user-defined.adoc[leveloffset=+2] + include::modules/ldap-syncing-rfc2307-user-defined-error.adoc[leveloffset=+2] + include::modules/ldap-syncing-activedir.adoc[leveloffset=+2] + include::modules/ldap-syncing-augmented-activedir.adoc[leveloffset=+2] + include::modules/ldap-syncing-nesting.adoc[leveloffset=+2] + include::modules/ldap-syncing-spec.adoc[leveloffset=+1] diff --git a/authentication/managing-security-context-constraints.adoc b/authentication/managing-security-context-constraints.adoc index 372257e1ff..08ff4b1e46 100644 --- a/authentication/managing-security-context-constraints.adoc +++ b/authentication/managing-security-context-constraints.adoc @@ -34,13 +34,18 @@ In {product-title} deployments, you can create your own SCCs only for clusters t endif::openshift-dedicated[] include::modules/security-context-constraints-about.adoc[leveloffset=+1] + include::modules/security-context-constraints-pre-allocated-values.adoc[leveloffset=+1] + include::modules/security-context-constraints-example.adoc[leveloffset=+1] + include::modules/security-context-constraints-creating.adoc[leveloffset=+1] // Configuring a workload to require a specific SCC include::modules/security-context-constraints-requiring.adoc[leveloffset=+1] + include::modules/security-context-constraints-rbac.adoc[leveloffset=+1] + include::modules/security-context-constraints-command-reference.adoc[leveloffset=+1] [role="_additional-resources"] diff --git a/authentication/understanding-and-managing-pod-security-admission.adoc b/authentication/understanding-and-managing-pod-security-admission.adoc index c4ecac8a8f..257dcb65be 100644 --- a/authentication/understanding-and-managing-pod-security-admission.adoc +++ b/authentication/understanding-and-managing-pod-security-admission.adoc @@ -37,6 +37,7 @@ include::modules/security-context-constraints-psa-rectifying.adoc[leveloffset=+1 ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] // Identifying pod security violations include::modules/security-context-constraints-psa-alert-eval.adoc[leveloffset=+2] + endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] [role="_additional-resources"] diff --git a/authentication/understanding-authentication.adoc b/authentication/understanding-authentication.adoc index 975a771f01..9d8145c988 100644 --- a/authentication/understanding-authentication.adoc +++ b/authentication/understanding-authentication.adoc @@ -29,4 +29,5 @@ ifdef::openshift-enterprise,openshift-webscale,openshift-origin[] include::modules/authentication-api-impersonation.adoc[leveloffset=+3] include::modules/authentication-prometheus-system-metrics.adoc[leveloffset=+3] + endif::[] diff --git a/authentication/using-rbac.adoc b/authentication/using-rbac.adoc index acefe675e3..9e04e28e1d 100644 --- a/authentication/using-rbac.adoc +++ b/authentication/using-rbac.adoc @@ -22,25 +22,31 @@ ifdef::openshift-enterprise,openshift-webscale,openshift-origin,openshift-dedica include::modules/rbac-creating-local-role.adoc[leveloffset=+1] include::modules/rbac-creating-cluster-role.adoc[leveloffset=+1] + endif::[] include::modules/rbac-local-role-binding-commands.adoc[leveloffset=+1] ifdef::openshift-enterprise,openshift-webscale,openshift-origin,openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] include::modules/rbac-cluster-role-binding-commands.adoc[leveloffset=+1] + endif::[] ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] include::modules/rbac-creating-cluster-admin.adoc[leveloffset=+1] + endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] ifdef::openshift-rosa,openshift-rosa-hcp[] include::modules/rosa-create-cluster-admins.adoc[leveloffset=+1] + include::modules/rosa-create-dedicated-cluster-admins.adoc[leveloffset=+1] + endif::openshift-rosa,openshift-rosa-hcp[] ifdef::openshift-dedicated[] include::modules/osd-grant-admin-privileges.adoc[leveloffset=+1] + endif::openshift-dedicated[] include::modules/unauthenticated-users-cluster-role-binding-con.adoc[leveloffset=+1] \ No newline at end of file diff --git a/backup_and_restore/control_plane_backup_and_restore/backing-up-etcd.adoc b/backup_and_restore/control_plane_backup_and_restore/backing-up-etcd.adoc index 14c83d7b0e..b309ee6787 100644 --- a/backup_and_restore/control_plane_backup_and_restore/backing-up-etcd.adoc +++ b/backup_and_restore/control_plane_backup_and_restore/backing-up-etcd.adoc @@ -33,5 +33,7 @@ include::modules/backup-etcd.adoc[leveloffset=+1] // Creating automated etcd backups include::modules/etcd-creating-automated-backups.adoc[leveloffset=+1] + include::modules/creating-single-etcd-backup.adoc[leveloffset=+2] + include::modules/creating-recurring-etcd-backups.adoc[leveloffset=+2] \ No newline at end of file diff --git a/backup_and_restore/control_plane_backup_and_restore/disaster_recovery/about-disaster-recovery.adoc b/backup_and_restore/control_plane_backup_and_restore/disaster_recovery/about-disaster-recovery.adoc index 856228c109..ddf8f62f5d 100644 --- a/backup_and_restore/control_plane_backup_and_restore/disaster_recovery/about-disaster-recovery.adoc +++ b/backup_and_restore/control_plane_backup_and_restore/disaster_recovery/about-disaster-recovery.adoc @@ -51,6 +51,7 @@ expired control plane certificates. // Testing restore procedures include::modules/dr-testing-restore-procedures.adoc[leveloffset=+1] + [role="_additional-resources"] .Additional resources * xref:../../../backup_and_restore/control_plane_backup_and_restore/disaster_recovery/scenario-2-restoring-cluster-state.adoc#dr-restoring-cluster-state[Restoring to a previous cluster state] \ No newline at end of file diff --git a/backup_and_restore/control_plane_backup_and_restore/replacing-unhealthy-etcd-member.adoc b/backup_and_restore/control_plane_backup_and_restore/replacing-unhealthy-etcd-member.adoc index eb9906840c..2033f302b2 100644 --- a/backup_and_restore/control_plane_backup_and_restore/replacing-unhealthy-etcd-member.adoc +++ b/backup_and_restore/control_plane_backup_and_restore/replacing-unhealthy-etcd-member.adoc @@ -44,6 +44,7 @@ Depending on the state of your unhealthy etcd member, use one of the following p // Replacing an unhealthy etcd member whose machine is not running or whose node is not ready include::modules/restore-replace-stopped-etcd-member.adoc[leveloffset=+2] + [role="_additional-resources"] .Additional resources * xref:../../machine_management/control_plane_machine_management/cpmso-troubleshooting.adoc#cpmso-ts-etcd-degraded_cpmso-troubleshooting[Recovering a degraded etcd Operator] diff --git a/cli_reference/openshift_cli/getting-started-cli.adoc b/cli_reference/openshift_cli/getting-started-cli.adoc index df45ceb9b5..6315353503 100644 --- a/cli_reference/openshift_cli/getting-started-cli.adoc +++ b/cli_reference/openshift_cli/getting-started-cli.adoc @@ -33,6 +33,7 @@ include::modules/cli-installing-cli-web-console-macos.adoc[leveloffset=+3] ifndef::openshift-origin[] // Installing the CLI by using an RPM include::modules/cli-installing-cli-rpm.adoc[leveloffset=+2] + endif::[] // Installing the CLI by using Homebrew diff --git a/cli_reference/opm/cli-opm-install.adoc b/cli_reference/opm/cli-opm-install.adoc index fe80190213..c7ae675aca 100644 --- a/cli_reference/opm/cli-opm-install.adoc +++ b/cli_reference/opm/cli-opm-install.adoc @@ -17,6 +17,7 @@ ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] include::modules/olm-installing-opm.adoc[leveloffset=+1] + ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] [role="_additional-resources"] [id="opm-addtl-resources"] diff --git a/cli_reference/opm/cli-opm-ref.adoc b/cli_reference/opm/cli-opm-ref.adoc index 9576bfeb98..3410bc003e 100644 --- a/cli_reference/opm/cli-opm-ref.adoc +++ b/cli_reference/opm/cli-opm-ref.adoc @@ -36,6 +36,7 @@ The `opm` CLI is not forward compatible. The version of the `opm` CLI used to ge include::snippets/deprecated-feature.adoc[] include::modules/opm-cli-ref-generate.adoc[leveloffset=+1] + include::modules/opm-cli-ref-index.adoc[leveloffset=+1] ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] @@ -48,7 +49,11 @@ ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] include::modules/opm-cli-ref-init.adoc[leveloffset=+1] + include::modules/opm-cli-ref-migrate.adoc[leveloffset=+1] + include::modules/opm-cli-ref-render.adoc[leveloffset=+1] + include::modules/opm-cli-ref-serve.adoc[leveloffset=+1] + include::modules/opm-cli-ref-validate.adoc[leveloffset=+1] diff --git a/cli_reference/tkn_cli/installing-tkn.adoc b/cli_reference/tkn_cli/installing-tkn.adoc index afdf468f6e..cc234a801a 100644 --- a/cli_reference/tkn_cli/installing-tkn.adoc +++ b/cli_reference/tkn_cli/installing-tkn.adoc @@ -32,6 +32,7 @@ endif::openshift-rosa,openshift-dedicated[] ifndef::openshift-rosa,openshift-dedicated[] :FeatureName: Running {pipelines-title} with the `opc` CLI tool include::snippets/technology-preview.adoc[] + endif::openshift-rosa,openshift-dedicated[] // Install tkn on Linux include::modules/op-installing-tkn-on-linux.adoc[leveloffset=+1] diff --git a/disconnected/about-installing-oc-mirror-v2.adoc b/disconnected/about-installing-oc-mirror-v2.adoc index a3ff69dee3..234abe7b36 100644 --- a/disconnected/about-installing-oc-mirror-v2.adoc +++ b/disconnected/about-installing-oc-mirror-v2.adoc @@ -59,7 +59,9 @@ include::modules/oc-mirror-workflows-partially-disconnected-v2.adoc[leveloffset= //Mirroring an image set in a fully disconnected environment: include::modules/oc-mirror-workflows-fully-disconnected-v2.adoc[leveloffset=+2] + include::modules/oc-mirror-mirror-to-disk-v2.adoc[leveloffset=+2] + include::modules/oc-mirror-disk-to-mirror-v2.adoc[leveloffset=+2] // About custom resources generated by oc-mirror plugin v2 @@ -126,7 +128,9 @@ include::modules/oc-mirror-proxy-support.adoc[leveloffset=+1] //signature mirroring include::modules/oc-mirror-signature-mirroring.adoc[leveloffset=+1] + include::modules/oc-mirror-signature-mirroring-procedure.adoc[leveloffset=+2] + include::modules/oc-mirror-signature-verification.adoc[leveloffset=+2] // Operator catalog filtering @@ -137,7 +141,9 @@ include::modules/oc-mirror-imageset-config-parameters-v2.adoc[leveloffset=+1] // Command reference for oc-mirror v2 include::modules/oc-mirror-command-reference-v2.adoc[leveloffset=+1] + include::modules/oc-mirror-command-reference-v2-delete.adoc[leveloffset=+2] + include::modules/oc-mirror-about-cache-and-workspace-dirs.adoc[leveloffset=+2] [role="_additional-resources"] diff --git a/disconnected/connected-to-disconnected.adoc b/disconnected/connected-to-disconnected.adoc index 064e3a7a30..d2c6782276 100644 --- a/disconnected/connected-to-disconnected.adoc +++ b/disconnected/connected-to-disconnected.adoc @@ -41,6 +41,7 @@ If you have a subscription to Red{nbsp}Hat Quay, see the documentation on deploy * Access to the internet to obtain the necessary container images. include::modules/connected-to-disconnected-prepare-mirror.adoc[leveloffset=+1] + include::modules/connected-to-disconnected-mirror-images.adoc[leveloffset=+1] [role="_additional-resources"] @@ -50,7 +51,9 @@ include::modules/connected-to-disconnected-mirror-images.adoc[leveloffset=+1] * For more information about the `oc adm catalog mirror` command, see the xref:../cli_reference/openshift_cli/administrator-cli-commands.adoc#oc-adm-catalog-mirror[OpenShift CLI administrator command reference]. include::modules/connected-to-disconnected-config-registry.adoc[leveloffset=+1] + include::modules/connected-to-disconnected-verify.adoc[leveloffset=+1] + include::modules/connected-to-disconnected-disconnect.adoc[leveloffset=+1] [NOTE] @@ -59,4 +62,5 @@ The {insights-operator} is degraded when the cluster loses its Internet connecti ==== include::modules/connected-to-disconnected-restore-insights.adoc[leveloffset=+1] + include::modules/connected-to-disconnected-restore.adoc[leveloffset=+1] diff --git a/disconnected/installing-mirroring-creating-registry.adoc b/disconnected/installing-mirroring-creating-registry.adoc index b92f229b58..8cf8fc7ef4 100644 --- a/disconnected/installing-mirroring-creating-registry.adoc +++ b/disconnected/installing-mirroring-creating-registry.adoc @@ -34,18 +34,31 @@ The _mirror registry for Red{nbsp}Hat OpenShift_ is not intended to be a substit ==== include::modules/mirror-registry-introduction.adoc[leveloffset=+1] + include::modules/mirror-registry-localhost.adoc[leveloffset=+1] + include::modules/mirror-registry-localhost-update.adoc[leveloffset=+1] + include::modules/mirror-registry-remote.adoc[leveloffset=+1] + include::modules/mirror-registry-remote-host-update.adoc[leveloffset=+1] + include::modules/mirror-registry-ssl-cert-replace.adoc[leveloffset=+1] + include::modules/mirror-registry-uninstall.adoc[leveloffset=+1] + include::modules/mirror-registry-flags.adoc[leveloffset=+1] + include::modules/mirror-registry-release-notes.adoc[leveloffset=+1] + include::modules/mirror-registry-release-notes-2-0.adoc[leveloffset=+2] + include::modules/mirror-registry-release-notes-1-3.adoc[leveloffset=+2] + include::modules/mirror-registry-release-notes-1-2.adoc[leveloffset=+2] + include::modules/mirror-registry-release-notes-1-1.adoc[leveloffset=+2] + include::modules/mirror-registry-troubleshooting.adoc[leveloffset=+1] [id="additional-resources_installing-mirroring-creating-registry"] diff --git a/disconnected/installing-mirroring-installation-images.adoc b/disconnected/installing-mirroring-installation-images.adoc index 7e779b426f..045ff3a282 100644 --- a/disconnected/installing-mirroring-installation-images.adoc +++ b/disconnected/installing-mirroring-installation-images.adoc @@ -117,11 +117,13 @@ $ REG_CREDS=${XDG_RUNTIME_DIR}/containers/auth.json ---- include::modules/olm-mirroring-catalog-extracting.adoc[leveloffset=+2] + include::modules/olm-mirroring-catalog-colocated.adoc[leveloffset=+3] include::modules/olm-mirroring-catalog-airgapped.adoc[leveloffset=+3] include::modules/olm-mirroring-catalog-manifests.adoc[leveloffset=+2] + include::modules/olm-mirroring-catalog-post.adoc[leveloffset=+2] [role="_additional-resources"] diff --git a/etcd/etcd-backup-restore/etcd-backup.adoc b/etcd/etcd-backup-restore/etcd-backup.adoc index 5af8153ad4..cff537b79b 100644 --- a/etcd/etcd-backup-restore/etcd-backup.adoc +++ b/etcd/etcd-backup-restore/etcd-backup.adoc @@ -32,5 +32,7 @@ include::modules/backup-etcd.adoc[leveloffset=+1] // Creating automated etcd backups include::modules/etcd-creating-automated-backups.adoc[leveloffset=+1] + include::modules/creating-single-etcd-backup.adoc[leveloffset=+2] + include::modules/creating-recurring-etcd-backups.adoc[leveloffset=+2] \ No newline at end of file diff --git a/extensions/arch/catalogd.adoc b/extensions/arch/catalogd.adoc index e06d7ef790..be350020d1 100644 --- a/extensions/arch/catalogd.adoc +++ b/extensions/arch/catalogd.adoc @@ -9,6 +9,7 @@ toc::[] {olmv1-first} uses the catalogd component and its resources to manage Operator and extension catalogs. include::modules/olmv1-about-catalogs.adoc[leveloffset=+1] + [role="_additional-resources"] .Additional resources * xref:../../extensions/catalogs/fbc.adoc#fbc[File-based catalogs] diff --git a/extensions/arch/operator-controller.adoc b/extensions/arch/operator-controller.adoc index c2710f7f62..2063145ba1 100644 --- a/extensions/arch/operator-controller.adoc +++ b/extensions/arch/operator-controller.adoc @@ -9,6 +9,7 @@ toc::[] Operator Controller is the central component of {olmv1-first} and consumes the other {olmv1} component, catalogd. It extends Kubernetes with an API through which users can install Operators and extensions. include::modules/olmv1-clusterextension-api.adoc[leveloffset=+1] + [role="_additional-resources"] .Additional resources diff --git a/extensions/catalogs/fbc.adoc b/extensions/catalogs/fbc.adoc index a44f038e3c..e58443685d 100644 --- a/extensions/catalogs/fbc.adoc +++ b/extensions/catalogs/fbc.adoc @@ -13,17 +13,24 @@ include::modules/olm-fb-catalogs.adoc[leveloffset=+1] include::modules/olm-fb-catalogs-structure.adoc[leveloffset=+1] include::modules/olm-fb-catalogs-schemas.adoc[leveloffset=+1] + include::modules/olm-package-schema.adoc[leveloffset=+2] + include::modules/olm-channel-schema.adoc[leveloffset=+2] + include::modules/olm-bundle-schema.adoc[leveloffset=+2] + include::modules/olm-deprecations-schema.adoc[leveloffset=+2] + [role="_additional-resources"] .Additional resources * xref:../../operators/admin/olm-managing-custom-catalogs.adoc#olm-filtering-fbc_olm-managing-custom-catalogs[Updating or filtering a file-based catalog image] include::modules/olm-fb-catalogs-prop.adoc[leveloffset=+1] + include::modules/olm-fb-catalogs-example.adoc[leveloffset=+1] + include::modules/olm-fb-catalogs-guidelines.adoc[leveloffset=+1] [id="olm-fb-catalogs-cli"] diff --git a/extensions/catalogs/managing-catalogs.adoc b/extensions/catalogs/managing-catalogs.adoc index 297924b695..8bb12d7b2b 100644 --- a/extensions/catalogs/managing-catalogs.adoc +++ b/extensions/catalogs/managing-catalogs.adoc @@ -24,6 +24,9 @@ include::modules/olmv1-about-catalogs.adoc[leveloffset=+1] * xref:../../extensions/catalogs/fbc.adoc#fbc[File-based catalogs] include::modules/olmv1-red-hat-catalogs.adoc[leveloffset=+1] + include::modules/olmv1-adding-a-catalog.adoc[leveloffset=+1] + include::modules/olmv1-deleting-catalog.adoc[leveloffset=+1] + include::modules/olmv1-disabling-a-default-catalog.adoc[leveloffset=+1] diff --git a/extensions/ce/crd-upgrade-safety.adoc b/extensions/ce/crd-upgrade-safety.adoc index f8098b61e5..7ecf8a3a19 100644 --- a/extensions/ce/crd-upgrade-safety.adoc +++ b/extensions/ce/crd-upgrade-safety.adoc @@ -13,6 +13,9 @@ When you update a custom resource definition (CRD) that is provided by a cluster * xref:../../extensions/ce/managing-ce.adoc#olmv1-updating-an-operator_managing-ce[Updating a cluster extension] include::modules/prohibited-crd-upgrades.adoc[leveloffset=+1] + include::modules/allowed-crd-upgrades.adoc[leveloffset=+1] + include::modules/disabling-crd-preflight.adoc[leveloffset=+1] + include::modules/examples-unsafe-crd-upgrades.adoc[leveloffset=+1] diff --git a/extensions/ce/update-paths.adoc b/extensions/ce/update-paths.adoc index f7379c311f..43b7bd2c0b 100644 --- a/extensions/ce/update-paths.adoc +++ b/extensions/ce/update-paths.adoc @@ -41,7 +41,9 @@ If `1.0.0` is installed, {olmv1} behavior differs in the following ways: include::modules/olmv1-version-range-support.adoc[leveloffset=+1] include::modules/olmv1-version-range-comparisons.adoc[leveloffset=+1] + include::modules/olmv1-about-target-versions.adoc[leveloffset=+1] + include::modules/olmv1-forcing-an-update-or-rollback.adoc[leveloffset=+1] [role="_additional-resources"] diff --git a/extensions/ce/user-access-resources.adoc b/extensions/ce/user-access-resources.adoc index 22efc68738..656bdc5c79 100644 --- a/extensions/ce/user-access-resources.adoc +++ b/extensions/ce/user-access-resources.adoc @@ -26,7 +26,9 @@ include::modules/olmv1-default-cluster-roles-users.adoc[leveloffset=+1] * link:https://kubernetes.io/docs/reference/access-authn-authz/rbac/#user-facing-roles[User-facing roles] (Kubernetes documentation) include::modules/olmv1-finding-ce-resources.adoc[leveloffset=+1] + include::modules/olmv1-granting-user-access-binding.adoc[leveloffset=+1] + include::modules/olmv1-granting-user-access-aggregated.adoc[leveloffset=+1] [role="_additional-resources"] diff --git a/hardware_accelerators/das-about-dynamic-accelerator-slicer-operator.adoc b/hardware_accelerators/das-about-dynamic-accelerator-slicer-operator.adoc index eb26fe079b..d73217c9c6 100644 --- a/hardware_accelerators/das-about-dynamic-accelerator-slicer-operator.adoc +++ b/hardware_accelerators/das-about-dynamic-accelerator-slicer-operator.adoc @@ -38,6 +38,7 @@ include::modules/das-operator-installing.adoc[leveloffset=+1] //Installing the Dynamic Accelerator Slicer Operator using the web console include::modules/das-operator-installing-web-console.adoc[leveloffset=+2] + [role="_additional-resources"] .Additional resources ** xref:../security/cert_manager_operator/cert-manager-operator-install.adoc#cert-manager-operator-install[{cert-manager-operator}] @@ -48,6 +49,7 @@ include::modules/das-operator-installing-web-console.adoc[leveloffset=+2] //Installing the Dynamic Accelerator Slicer Operator using the CLI include::modules/das-operator-installing-cli.adoc[leveloffset=+2] + [role="_additional-resources"] .Additional resources * xref:../security/cert_manager_operator/cert-manager-operator-install.adoc#cert-manager-operator-install[{cert-manager-operator}] diff --git a/hardware_accelerators/nvidia-gpu-architecture.adoc b/hardware_accelerators/nvidia-gpu-architecture.adoc index 3ce6e0d0ac..e0619bfed2 100644 --- a/hardware_accelerators/nvidia-gpu-architecture.adoc +++ b/hardware_accelerators/nvidia-gpu-architecture.adoc @@ -24,17 +24,21 @@ include::modules/nvidia-gpu-prerequisites.adoc[leveloffset=+1] // New enablement modules ifndef::openshift-dedicated,openshift-rosa[] include::modules/nvidia-gpu-enablement.adoc[leveloffset=+1] + include::modules/nvidia-gpu-bare-metal.adoc[leveloffset=+2] + [role="_additional-resources"] .Additional resources * link:https://docs.nvidia.com/ai-enterprise/deployment-guide-openshift-on-bare-metal/0.1.0/on-bare-metal.html[Red Hat OpenShift on Bare Metal Stack] include::modules/nvidia-gpu-virtualization.adoc[leveloffset=+2] + [role="_additional-resources"] .Additional resources * link:https://docs.nvidia.com/datacenter/cloud-native/gpu-operator/latest/openshift/openshift-virtualization.html[NVIDIA GPU Operator with OpenShift Virtualization] include::modules/nvidia-gpu-vsphere.adoc[leveloffset=+2] + [role="_additional-resources"] .Additional resources * link:https://docs.nvidia.com/datacenter/cloud-native/gpu-operator/latest/openshift/nvaie-with-ocp.html#openshift-container-platform-on-vmware-vsphere-with-nvidia-vgpus[OpenShift Container Platform on VMware vSphere with NVIDIA vGPUs] @@ -43,6 +47,7 @@ include::modules/nvidia-gpu-vsphere.adoc[leveloffset=+2] include::modules/nvidia-gpu-kvm.adoc[leveloffset=+2] include::modules/nvidia-gpu-csps.adoc[leveloffset=+2] + [role="_additional-resources"] .Additional resources * link:https://docs.nvidia.com/ai-enterprise/deployment-guide-cloud/0.1.0/aws-redhat-openshift.html[Red Hat Openshift in the Cloud] @@ -51,6 +56,7 @@ endif::openshift-dedicated,openshift-rosa[] // Include this module at a higher leveloffset for OSD/ROSA. ifdef::openshift-dedicated,openshift-rosa[] include::modules/nvidia-gpu-csps.adoc[leveloffset=+1] + [role="_additional-resources"] .Additional resources * link:https://docs.nvidia.com/ai-enterprise/deployment-guide-cloud/0.1.0/aws-redhat-openshift.html[Red Hat Openshift in the Cloud] @@ -58,6 +64,7 @@ endif::openshift-dedicated,openshift-rosa[] ifndef::openshift-dedicated,openshift-rosa[] include::modules/nvidia-gpu-red-hat-device-edge.adoc[leveloffset=+2] + [role="_additional-resources"] .Additional resources * link:https://cloud.redhat.com/blog/how-to-accelerate-workloads-with-nvidia-gpus-on-red-hat-device-edge[How to accelerate workloads with NVIDIA GPUs on Red Hat Device Edge] @@ -65,28 +72,34 @@ endif::openshift-dedicated,openshift-rosa[] // TELCODOCS-1092 GPU sharing methods include::modules/nvidia-gpu-sharing-methods.adoc[leveloffset=+1] + .Additional resources * link:https://developer.nvidia.com/blog/improving-gpu-utilization-in-kubernetes/[Improving GPU Utilization] include::modules/nvidia-gpu-cuda-streams.adoc[leveloffset=+2] + .Additional resources * link:https://docs.nvidia.com/cuda/cuda-c-programming-guide/index.html#asynchronous-concurrent-execution[Asynchronous Concurrent Execution] include::modules/nvidia-gpu-time-slicing.adoc[leveloffset=+2] include::modules/nvidia-gpu-cuda-mps.adoc[leveloffset=+2] + .Additional resources * link:https://docs.nvidia.com/deploy/mps/index.html[CUDA MPS] include::modules/nvidia-gpu-mig-gpu.adoc[leveloffset=+2] + .Additional resources * link:https://docs.nvidia.com/datacenter/tesla/mig-user-guide/[NVIDIA Multi-Instance GPU User Guide] include::modules/nvidia-gpu-virtualization-with-gpu.adoc[leveloffset=+2] + .Additional resources * link:https://www.nvidia.com/en-us/data-center/virtual-solutions/[Virtual GPUs] include::modules/nvidia-gpu-features.adoc[leveloffset=+1] + [role="_additional-resources"] .Additional resources diff --git a/hardware_enablement/kmm-kernel-module-management.adoc b/hardware_enablement/kmm-kernel-module-management.adoc index 34ac7ca36c..94eab5ad1a 100644 --- a/hardware_enablement/kmm-kernel-module-management.adoc +++ b/hardware_enablement/kmm-kernel-module-management.adoc @@ -11,20 +11,27 @@ Learn about the Kernel Module Management (KMM) Operator and how you can use it t :FeatureName: Kernel Module Management Operator include::modules/kmm-about-kmm.adoc[leveloffset=+1] + include::modules/kmm-installation.adoc[leveloffset=+1] + include::modules/kmm-installing-using-web-console.adoc[leveloffset=+2] + include::modules/kmm-installing-using-cli.adoc[leveloffset=+2] + include::modules/kmm-installing-older-versions.adoc[leveloffset=+2] // Added for TELCODOCS-1823 include::modules/kmm-configuring-kmmo.adoc[leveloffset=+1] + [role="_additional-resources"] .Additional resources * For more information, see xref:../hardware_enablement/kmm-kernel-module-management.adoc#kmm-install_kernel-module-management-operator[Installing the Kernel Module Management Operator]. include::modules/kmm-unloading-kernel-module.adoc[leveloffset=+2] + include::modules/kmm-setting-kernel-firmware-search-path.adoc[leveloffset=+2] + [role="_additional-resources"] .Additional resources @@ -32,14 +39,18 @@ include::modules/kmm-setting-kernel-firmware-search-path.adoc[leveloffset=+2] // Added for TELCODOCS-1309 include::modules/kmm-uninstalling-kmm.adoc[leveloffset=+1] + include::modules/kmm-uninstalling-kmmo-red-hat-catalog.adoc[leveloffset=+2] + include::modules/kmm-uninstalling-kmmo-cli.adoc[leveloffset=+2] include::modules/kmm-deploying-modules.adoc[leveloffset=+1] + include::modules/kmm-creating-module-cr.adoc[leveloffset=+2] // Added for TELCODOCS-1280 include::modules/kmm-setting-soft-dependencies-between-kernel-modules.adoc[leveloffset=+2] + include::modules/kmm-security.adoc[leveloffset=+1] [role="_additional-resources"] @@ -54,6 +65,7 @@ include::modules/kmm-replacing-in-tree-modules-with-out-of-tree-modules.adoc[lev * link:https://fastbitlab.com/building-a-linux-kernel-module/[Building a linux kernel module] include::modules/kmm-example-module-cr.adoc[leveloffset=+2] + // Added for MGMT-16631 [role="_additional-resources"] .Additional resources @@ -66,6 +78,7 @@ include::modules/kmm-using-intree-modules.adoc[leveloffset=+1] include::modules/kmm-symbolic-links-for-in-tree-dependencies.adoc[leveloffset=+1] include::modules/kmm-creating-kmod-image.adoc[leveloffset=+1] + include::modules/kmm-running-depmod.adoc[leveloffset=+2] [role="_additional-resources"] @@ -99,10 +112,15 @@ include::modules/kmm-using-driver-toolkit.adoc[leveloffset=+2] // Added for TELCODOCS-1065 include::modules/kmm-using-signing-with-kmm.adoc[leveloffset=+1] + include::modules/kmm-adding-the-keys-for-secureboot.adoc[leveloffset=+1] + include::modules/kmm-checking-the-keys.adoc[leveloffset=+2] + include::modules/kmm-signing-kmods-in-a-prebuilt-image.adoc[leveloffset=+1] + include::modules/kmm-building-and-signing-a-kmod-image.adoc[leveloffset=+1] + [role="_additional-resources"] .Additional resources @@ -110,31 +128,38 @@ include::modules/kmm-building-and-signing-a-kmod-image.adoc[leveloffset=+1] // Added for TELCODOCS-2197 include::modules/kmm-using-tolerations-for-kernel-module-scheduling.adoc[leveloffset=+1] + include::modules/kmm-applying-tolerations-to-kernel-module-pods.adoc[leveloffset=+1] + [role="_additional-resources"] .Additional resources * link:https://docs.openshift.com/container-platform/4.17/nodes/scheduling/nodes-scheduler-taints-tolerations.html#nodes-scheduler-taints-tolerations-about_nodes-scheduler-taints-tolerations[Understanding taints and tolerations] // Added for TELCODOCS-1109 include::modules/kmm-hub-hub-and-spoke.adoc[leveloffset=+1] + [role="_additional-resources"] .Additional resources * link:https://www.redhat.com/en/technologies/management/advanced-cluster-management[Red{nbsp}Hat Advanced Cluster Management (RHACM)] include::modules/kmm-hub-kmm-hub.adoc[leveloffset=+2] + [role="_additional-resources"] .Additional resources * link:https://openshift-kmm.netlify.app/documentation/install/[Installing KMM] include::modules/kmm-hub-installing-kmm-hub.adoc[leveloffset=+2] + [role="_additional-resources"] .Additional resources * link:https://catalog.redhat.com/software/containers/kmm/kernel-module-management-hub-operator-bundle/63d84cc33862da54bb19b8c6?architecture=amd64&image=654273ac86f7e537ae452f6ehttps://catalog.redhat.com/software/containers/kmm/kernel-module-management-hub-operator-bundle/63d84cc33862da54bb19b8c6?architecture=amd64&image=654273ac86f7e537ae452f6e[KMM Operator bundle] include::modules/kmm-hub-installing-kmm-hub-olm.adoc[leveloffset=+3] + include::modules/kmm-hub-installing-kmm-hub-creating-resources.adoc[leveloffset=+3] include::modules/kmm-hub-using-the-managedclustermodule.adoc[leveloffset=+2] + include::modules/kmm-hub-running-kmm-on-the-spoke.adoc[leveloffset=+2] // Added for TELCODOCS-1277 @@ -142,19 +167,25 @@ include::modules/kmm-customizing-upgrades-for-kernel-modules.adoc[leveloffset=+1 // Added for TELCODOCS-1278 include::modules/kmm-day1-kernel-module-loading.adoc[leveloffset=+1] + [role="_additional-resources"] .Additional resources * xref:../machine_configuration/index.adoc#machine-config-index[Machine Config Operator] include::modules/kmm-day1-supported-use-cases.adoc[leveloffset=+2] + include::modules/kmm-day1-oot-kernel-module-loading-flow.adoc[leveloffset=+2] + include::modules/kmm-day1-kernel-module-image.adoc[leveloffset=+2] + [role="_additional-resources"] .Additional resources * xref:../hardware_enablement/psap-driver-toolkit.adoc#driver-toolkit[Driver Toolkit] include::modules/kmm-day1-in-tree-module-replacement.adoc[leveloffset=+2] + include::modules/kmm-day1-mco-yaml-creation.adoc[leveloffset=+2] + include::modules/kmm-day1-machineconfigpool.adoc[leveloffset=+2] [role="_additional-resources"] @@ -165,31 +196,40 @@ include::modules/kmm-debugging-and-troubleshooting.adoc[leveloffset=+1] // Added for TELCODOCS-1067 include::modules/kmm-firmware-support.adoc[leveloffset=+1] + [role="_additional-resources"] include::modules/kmm-configuring-the-lookup-path-on-nodes.adoc[leveloffset=+2] + [role="_additional-resources"] .Additional resources * xref:../machine_configuration/index.adoc#machine-config-operator_machine-config-overview[Machine Config Operator]. include::modules/kmm-building-a-kmod-image.adoc[leveloffset=+2] + include::modules/kmm-tuning-the-module-resource.adoc[leveloffset=+2] // Added for TELCODOCS-1826 include::modules/kmm-day0-day2-installation.adoc[leveloffset=+1] + include::modules/kmm-layering-background.adoc[leveloffset=+2] + include::modules/kmm-day0-day2-lifecycle-management.adoc[leveloffset=+2] // Added for TELCODOCS-1059 include::modules/kmm-troubleshooting.adoc[leveloffset=+1] + // Added for TELCODOCS-1820 include::modules/kmm-reading-operator-logs.adoc[leveloffset=+2] + include::modules/kmm-observing-events.adoc[leveloffset=+2] include::modules/kmm-must-gather-tool.adoc[leveloffset=+2] + [role="_additional-resources"] .Additional resources * xref:../support/gathering-cluster-data.adoc#about-must-gather_gathering-cluster-data[About the must-gather tool] include::modules/kmm-gathering-data-for-kmm.adoc[leveloffset=+3] + include::modules/kmm-gathering-data-for-kmm-hub.adoc[leveloffset=+3] diff --git a/hardware_enablement/psap-node-feature-discovery-operator.adoc b/hardware_enablement/psap-node-feature-discovery-operator.adoc index 3523f9eaae..e51fbe7ac9 100644 --- a/hardware_enablement/psap-node-feature-discovery-operator.adoc +++ b/hardware_enablement/psap-node-feature-discovery-operator.adoc @@ -26,7 +26,9 @@ Starting with version 4.12, the `operand.image` field in the `NodeFeatureDiscove ==== include::modules/creating-nfd-cr-cli.adoc[leveloffset=+2] + include::modules/creating-nfd-cr-cli-disconnected.adoc[leveloffset=+2] + include::modules/creating-nfd-cr-web-console.adoc[leveloffset=+2] include::modules/psap-configuring-node-feature-discovery.adoc[leveloffset=+1] diff --git a/hosted_control_planes/hcp-authentication-authorization.adoc b/hosted_control_planes/hcp-authentication-authorization.adoc index 5487a74048..c26ae9e37a 100644 --- a/hosted_control_planes/hcp-authentication-authorization.adoc +++ b/hosted_control_planes/hcp-authentication-authorization.adoc @@ -28,6 +28,7 @@ The CCO supports a manual mode only for hosted clusters on {aws-short}. By defau ==== include::modules/hcp-cco-verify-aws-sts.adoc[leveloffset=+1] + include::modules/osdk-cco-aws-sts-enabling.adoc[leveloffset=+1] [role="_additional-resources"] diff --git a/hosted_control_planes/hcp-deploy/hcp-deploy-aws.adoc b/hosted_control_planes/hcp-deploy/hcp-deploy-aws.adoc index d739f966b6..d0f426b67c 100644 --- a/hosted_control_planes/hcp-deploy/hcp-deploy-aws.adoc +++ b/hosted_control_planes/hcp-deploy/hcp-deploy-aws.adoc @@ -11,7 +11,9 @@ A _hosted cluster_ is an {product-title} cluster with its API endpoint and contr You can use the {mce-short} console or the hosted control plane command-line interface (CLI), `hcp`, to create a hosted cluster. The hosted cluster is automatically imported as a managed cluster. However, you can xref:../../hosted_control_planes/hcp-import.adoc#hcp-import-disable_hcp-import[disable this automatic import feature into {mce-short}]. include::modules/hcp-aws-prepare.adoc[leveloffset=+1] + include::modules/hcp-aws-prereqs.adoc[leveloffset=+2] + include::modules/hcp-access-hc-aws-hcpcli.adoc[leveloffset=+1] [role="_additional-resources"] diff --git a/hosted_control_planes/hcp-deploy/hcp-deploy-ibmz.adoc b/hosted_control_planes/hcp-deploy/hcp-deploy-ibmz.adoc index b189c1a841..b94a4cc12f 100644 --- a/hosted_control_planes/hcp-deploy/hcp-deploy-ibmz.adoc +++ b/hosted_control_planes/hcp-deploy/hcp-deploy-ibmz.adoc @@ -41,6 +41,7 @@ include::modules/hcp-ibm-z-infra-reqs.adoc[leveloffset=+1] * xref:../../hosted_control_planes/hcp-prepare/hcp-enable-disable.adoc[Enabling or disabling the {hcp} feature] include::modules/hcp-ibm-z-dns.adoc[leveloffset=+1] + include::modules/hcp-custom-dns.adoc[leveloffset=+2] include::modules/hcp-bm-hc.adoc[leveloffset=+1] @@ -61,6 +62,7 @@ To attach compute nodes to a hosted control plane, create agents that help you t Unless stated otherwise, these procedures apply to both z/VM and RHEL KVM installations on {ibm-z-title} and {ibm-linuxone-title}. include::modules/hcp-ibm-z-kvm-agents.adoc[leveloffset=+2] + include::modules/hcp-ibm-z-lpar-agents.adoc[leveloffset=+2] [role="_additional-resources"] diff --git a/hosted_control_planes/hcp-deploy/hcp-deploy-virt.adoc b/hosted_control_planes/hcp-deploy/hcp-deploy-virt.adoc index 39d2420c66..47f8de3222 100644 --- a/hosted_control_planes/hcp-deploy/hcp-deploy-virt.adoc +++ b/hosted_control_planes/hcp-deploy/hcp-deploy-virt.adoc @@ -53,7 +53,9 @@ include::modules/hcp-virt-live-migration.adoc[leveloffset=+1] With {product-title} 4.14 and later, you can create a cluster with KubeVirt, to include creating with an external infrastructure. include::modules/hcp-virt-create-hc-cli.adoc[leveloffset=+2] + include::modules/hcp-virt-create-hc-ext-infra.adoc[leveloffset=+2] + include::modules/hcp-virt-create-hc-console.adoc[leveloffset=+2] [role="_additional-resources"] @@ -64,6 +66,7 @@ include::modules/hcp-virt-create-hc-console.adoc[leveloffset=+2] * xref:../../hosted_control_planes/hcp-manage/hcp-manage-virt.adoc#hcp-virt-access_hcp-manage-virt[Accessing the hosted cluster] include::modules/hcp-virt-ingress-dns.adoc[leveloffset=+1] + include::modules/hcp-custom-dns.adoc[leveloffset=+2] [id="hcp-virt-ingress-dns-custom"] @@ -72,7 +75,9 @@ include::modules/hcp-custom-dns.adoc[leveloffset=+2] If you do not want to use the default ingress and DNS behavior, you can configure a KubeVirt hosted cluster with a unique base domain at creation time. This option requires manual configuration steps during creation and involves three main steps: cluster creation, load balancer creation, and wildcard DNS configuration. include::modules/hcp-virt-hc-base-domain.adoc[leveloffset=+2] + include::modules/hcp-virt-load-balancer.adoc[leveloffset=+2] + include::modules/hcp-virt-wildcard-dns.adoc[leveloffset=+2] include::modules/hcp-metallb.adoc[leveloffset=+1] @@ -88,11 +93,15 @@ include::modules/hcp-metallb.adoc[leveloffset=+1] If you need to configure additional networks for node pools, request a guaranteed CPU access for Virtual Machines (VMs), or manage scheduling of KubeVirt VMs, see the following procedures. include::modules/hcp-virt-add-networks.adoc[leveloffset=+2] + include::modules/hcp-virt-addl-network.adoc[leveloffset=+3] + include::modules/hcp-virt-guaranteed-cpus.adoc[leveloffset=+2] + include::modules/hcp-virt-sched-vms.adoc[leveloffset=+2] include::modules/hcp-virt-scale-nodepool.adoc[leveloffset=+1] + include::modules/hcp-virt-add-node.adoc[leveloffset=+2] [role="_additional-resources"] diff --git a/hosted_control_planes/hcp-destroy/hcp-destroy-bm.adoc b/hosted_control_planes/hcp-destroy/hcp-destroy-bm.adoc index 2bc5928138..cf87b3efff 100644 --- a/hosted_control_planes/hcp-destroy/hcp-destroy-bm.adoc +++ b/hosted_control_planes/hcp-destroy/hcp-destroy-bm.adoc @@ -9,4 +9,5 @@ toc::[] You can destroy hosted clusters on bare metal by using the command-line interface (CLI) or the {mce-short} web console. include::modules/destroy-hc-bm-cli.adoc[leveloffset=+1] + include::modules/destroy-hc-bm-console.adoc[leveloffset=+1] diff --git a/hosted_control_planes/hcp-disconnected/hcp-dc-monitor.adoc b/hosted_control_planes/hcp-disconnected/hcp-dc-monitor.adoc index ae143cb6bf..48f1b31d63 100644 --- a/hosted_control_planes/hcp-disconnected/hcp-dc-monitor.adoc +++ b/hosted_control_planes/hcp-disconnected/hcp-dc-monitor.adoc @@ -9,5 +9,7 @@ toc::[] The `hypershift-addon` managed cluster add-on enables the `--enable-uwm-telemetry-remote-write` option in the HyperShift Operator. By enabling that option, you ensure that user workload monitoring is enabled and that it can remotely write telemetry metrics from control planes. include::modules/hcp-dc-usr-wkld.adoc[leveloffset=+1] + include::modules/hcp-dc-verify.adoc[leveloffset=+1] + include::modules/hcp-dc-addon.adoc[leveloffset=+1] \ No newline at end of file diff --git a/hosted_control_planes/hcp-disconnected/hcp-deploy-dc-bm.adoc b/hosted_control_planes/hcp-disconnected/hcp-deploy-dc-bm.adoc index 493670b9ee..2424a7da54 100644 --- a/hosted_control_planes/hcp-disconnected/hcp-deploy-dc-bm.adoc +++ b/hosted_control_planes/hcp-disconnected/hcp-deploy-dc-bm.adoc @@ -9,10 +9,15 @@ toc::[] When you provision {hcp} on bare metal, you use the Agent platform. The Agent platform and {mce} work together to enable disconnected deployments. The Agent platform uses the central infrastructure management service to add worker nodes to a hosted cluster. For an introduction to the central infrastructure management service, see link:https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.14/html/clusters/cluster_mce_overview#enable-cim[Enabling the central infrastructure management service]. include::modules/hcp-dc-bm-arch.adoc[leveloffset=+1] + include::modules/hcp-dc-bm-reqs.adoc[leveloffset=+1] + include::modules/hcp-dc-extract.adoc[leveloffset=+1] + include::modules/hcp-bm-dns.adoc[leveloffset=+1] + include::modules/hcp-dc-registry.adoc[leveloffset=+1] + include::modules/hcp-dc-mgmt-cluster.adoc[leveloffset=+1] [role="_additional-resources"] @@ -22,6 +27,7 @@ include::modules/hcp-dc-mgmt-cluster.adoc[leveloffset=+1] * link:https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.14/html/clusters/cluster_mce_overview#mce-intro[About cluster lifecycle with multicluster engine operator] include::modules/hcp-dc-web-server.adoc[leveloffset=+1] + include::modules/hcp-dc-image-mirror.adoc[leveloffset=+1] [role="_additional-resources"] @@ -43,6 +49,7 @@ include::modules/hcp-agentserviceconfig.adoc[leveloffset=+1] To ensure proper function in a disconnected deployment, you need to configure the registry CA certificates in the management cluster and the worker nodes for the hosted cluster. include::modules/hcp-dc-tls-mgmt.adoc[leveloffset=+2] + include::modules/hcp-dc-tls-hosted.adoc[leveloffset=+2] [id="hcp-dc-bm-hosted"] @@ -51,8 +58,11 @@ include::modules/hcp-dc-tls-hosted.adoc[leveloffset=+2] A hosted cluster is an {product-title} cluster with its control plane and API endpoint hosted on a management cluster. The hosted cluster includes the control plane and its corresponding data plane. include::modules/hcp-hc-objects.adoc[leveloffset=+2] + include::modules/hcp-nodepool-hc.adoc[leveloffset=+2] + include::modules/hcp-dc-infraenv.adoc[leveloffset=+2] + include::modules/hcp-bm-hosts.adoc[leveloffset=+2] [role="_additional-resources"] diff --git a/hosted_control_planes/hcp-disconnected/hcp-deploy-dc-virt.adoc b/hosted_control_planes/hcp-disconnected/hcp-deploy-dc-virt.adoc index 6d5ffca7ae..0e056425cc 100644 --- a/hosted_control_planes/hcp-disconnected/hcp-deploy-dc-virt.adoc +++ b/hosted_control_planes/hcp-disconnected/hcp-deploy-dc-virt.adoc @@ -41,6 +41,7 @@ The {mce} plays a crucial role in deploying clusters across providers. If you do To ensure proper function in a disconnected deployment, you need to configure the registry CA certificates in the management cluster and the worker nodes for the hosted cluster. include::modules/hcp-dc-tls-mgmt.adoc[leveloffset=+2] + include::modules/hcp-dc-tls-hosted.adoc[leveloffset=+2] [id="hcp-dc-virt-hosted"] @@ -49,7 +50,9 @@ include::modules/hcp-dc-tls-hosted.adoc[leveloffset=+2] A hosted cluster is an {product-title} cluster with its control plane and API endpoint hosted on a management cluster. The hosted cluster includes the control plane and its corresponding data plane. include::modules/hcp-virt-reqs.adoc[leveloffset=+2] + include::modules/hcp-virt-create-hc-cli.adoc[leveloffset=+2] + include::modules/hcp-virt-ingress-dns.adoc[leveloffset=+2] [id="hcp-dc-virt-ingress-dns-custom"] @@ -58,7 +61,9 @@ include::modules/hcp-virt-ingress-dns.adoc[leveloffset=+2] If you do not want to use the default ingress and DNS behavior, you can configure a KubeVirt hosted cluster with a unique base domain at creation time. This option requires manual configuration steps during creation and involves three main steps: cluster creation, load balancer creation, and wildcard DNS configuration. include::modules/hcp-virt-hc-base-domain.adoc[leveloffset=+3] + include::modules/hcp-virt-load-balancer.adoc[leveloffset=+3] + include::modules/hcp-virt-wildcard-dns.adoc[leveloffset=+3] [id="hcp-dc-finish"] @@ -67,4 +72,5 @@ include::modules/hcp-virt-wildcard-dns.adoc[leveloffset=+3] You can monitor the deployment of a hosted cluster from two perspectives: the control plane and the data plane. include::modules/hcp-monitor-cp.adoc[leveloffset=+2] + include::modules/hcp-monitor-dp.adoc[leveloffset=+2] diff --git a/hosted_control_planes/hcp-import.adoc b/hosted_control_planes/hcp-import.adoc index d7c831f78b..8b53437fe2 100644 --- a/hosted_control_planes/hcp-import.adoc +++ b/hosted_control_planes/hcp-import.adoc @@ -18,5 +18,7 @@ include::modules/hcp-import-limitations.adoc[leveloffset=+1] * link:https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.11/html/clusters/cluster_mce_overview#discover-hosted-acm[Discovering {mce} hosted clusters in {rh-rhacm-title}] include::modules/hcp-import-manual.adoc[leveloffset=+1] + include::modules/hcp-import-manual-aws.adoc[leveloffset=+1] + include::modules/hcp-import-disable.adoc[leveloffset=+1] diff --git a/hosted_control_planes/hcp-manage/hcp-manage-bm.adoc b/hosted_control_planes/hcp-manage/hcp-manage-bm.adoc index 2d4692a870..3b2c924a27 100644 --- a/hosted_control_planes/hcp-manage/hcp-manage-bm.adoc +++ b/hosted_control_planes/hcp-manage/hcp-manage-bm.adoc @@ -9,9 +9,13 @@ toc::[] After you deploy {hcp} on bare metal, you can manage a hosted cluster by completing the following tasks. include::modules/hcp-bm-access.adoc[leveloffset=+1] + include::modules/hcp-bm-scale-np.adoc[leveloffset=+1] + include::modules/hcp-bm-add-np.adoc[leveloffset=+2] + include::modules/hcp-bm-autoscale.adoc[leveloffset=+2] + include::modules/hcp-bm-autoscale-disable.adoc[leveloffset=+2] [role="_additional-resources"] @@ -27,6 +31,7 @@ include::modules/hcp-bm-ingress.adoc[leveloffset=+1] * xref:../../networking/networking_operators/metallb-operator/about-metallb.adoc#about-metallb_about-metallb[About MetalLB and the MetalLB Operator] include::modules/hcp-bm-machine-health.adoc[leveloffset=+1] + include::modules/hcp-bm-machine-health-disable.adoc[leveloffset=+1] [role="_additional-resources"] diff --git a/hosted_control_planes/hcp-manage/hcp-manage-non-bm.adoc b/hosted_control_planes/hcp-manage/hcp-manage-non-bm.adoc index 29069979c9..0aecb6285a 100644 --- a/hosted_control_planes/hcp-manage/hcp-manage-non-bm.adoc +++ b/hosted_control_planes/hcp-manage/hcp-manage-non-bm.adoc @@ -9,9 +9,13 @@ toc::[] After you deploy {hcp} on non-bare-metal agent machines, you can manage a hosted cluster by completing the following tasks. include::modules/hcp-bm-access.adoc[leveloffset=+1] + include::modules/hcp-bm-scale-np.adoc[leveloffset=+1] + include::modules/hcp-bm-add-np.adoc[leveloffset=+2] + include::modules/hcp-bm-autoscale.adoc[leveloffset=+2] + include::modules/hcp-bm-autoscale-disable.adoc[leveloffset=+2] [role="_additional-resources"] @@ -27,6 +31,7 @@ include::modules/hcp-bm-ingress.adoc[leveloffset=+1] * xref:../../networking/networking_operators/metallb-operator/about-metallb.adoc#about-metallb_about-metallb[About MetalLB and the MetalLB Operator] include::modules/hcp-bm-machine-health.adoc[leveloffset=+1] + include::modules/hcp-bm-machine-health-disable.adoc[leveloffset=+1] [role="_additional-resources"] diff --git a/hosted_control_planes/hcp-manage/hcp-manage-virt.adoc b/hosted_control_planes/hcp-manage/hcp-manage-virt.adoc index 8ef7c54166..8634e2c0f3 100644 --- a/hosted_control_planes/hcp-manage/hcp-manage-virt.adoc +++ b/hosted_control_planes/hcp-manage/hcp-manage-virt.adoc @@ -9,6 +9,7 @@ toc::[] After you deploy a hosted cluster on {VirtProductName}, you can manage the cluster by completing the following procedures. include::modules/hcp-virt-access.adoc[leveloffset=+1] + include::modules/hcp-bm-autoscale.adoc[leveloffset=+1] [id="hcp-virt-storage"] @@ -43,10 +44,15 @@ a| ==== include::modules/hcp-virt-map-storage.adoc[leveloffset=+2] + include::modules/hcp-virt-csi-snapshot.adoc[leveloffset=+2] + include::modules/hcp-virt-multiple-snapshots.adoc[leveloffset=+2] + include::modules/hcp-virt-root-volume.adoc[leveloffset=+2] + include::modules/hcp-virt-image-caching.adoc[leveloffset=+2] + include::modules/hcp-virt-storage-security-isolation.adoc[leveloffset=+2] [role="_additional-resources"] diff --git a/hosted_control_planes/hcp-networking.adoc b/hosted_control_planes/hcp-networking.adoc index f4e420c1e9..a0ba437463 100644 --- a/hosted_control_planes/hcp-networking.adoc +++ b/hosted_control_planes/hcp-networking.adoc @@ -12,12 +12,16 @@ For {hcp}, proxy support involves the following additional use cases. //cp workloads that need to use a proxy to access external services include::modules/hcp-proxy-cp-workloads.adoc[leveloffset=+1] + //workers need a proxy to communicate with ignition endpoint include::modules/hcp-proxy-ignition.adoc[leveloffset=+1] + //workers need proxy to communicate with cp include::modules/hcp-proxy-api.adoc[leveloffset=+1] + //cp workloads that need access to external services and must use the proxy for the management cluster include::modules/hcp-proxy-mgmt-cluster.adoc[leveloffset=+1] + //proxy configuration on the mgmt cluster when the hosted cluster has a secondary network and no default pod network include::modules/hcp-proxy-addl-network.adoc[leveloffset=+1] diff --git a/hosted_control_planes/hcp-observability.adoc b/hosted_control_planes/hcp-observability.adoc index 78d059f34b..bb86c08730 100644 --- a/hosted_control_planes/hcp-observability.adoc +++ b/hosted_control_planes/hcp-observability.adoc @@ -9,4 +9,5 @@ toc::[] You can gather metrics for {hcp} by configuring metrics sets. The HyperShift Operator can create or delete monitoring dashboards in the management cluster for each hosted cluster that it manages. include::modules/hosted-control-planes-metrics-sets.adoc[leveloffset=+1] + include::modules/hosted-control-planes-monitoring-dashboard.adoc[leveloffset=+1] diff --git a/hosted_control_planes/hcp-prepare/hcp-cli.adoc b/hosted_control_planes/hcp-prepare/hcp-cli.adoc index 5a1a12042f..fe475267df 100644 --- a/hosted_control_planes/hcp-prepare/hcp-cli.adoc +++ b/hosted_control_planes/hcp-prepare/hcp-cli.adoc @@ -9,5 +9,7 @@ toc::[] The {hcp} command-line interface, `hcp`, is a tool that you can use to get started with {hcp}. For Day 2 operations, such as management and configuration, use GitOps or your own automation tool. include::modules/hcp-cli-terminal.adoc[leveloffset=+1] + include::modules/hcp-cli-console.adoc[leveloffset=+1] + include::modules/hcp-cli-gateway.adoc[leveloffset=+1] diff --git a/hosted_control_planes/hcp-prepare/hcp-distribute-workloads.adoc b/hosted_control_planes/hcp-prepare/hcp-distribute-workloads.adoc index 4d7255708c..f2df84ad89 100644 --- a/hosted_control_planes/hcp-prepare/hcp-distribute-workloads.adoc +++ b/hosted_control_planes/hcp-prepare/hcp-distribute-workloads.adoc @@ -24,6 +24,9 @@ Do not use the management cluster for your workload. Workloads must not run on n ==== include::modules/hcp-labels-taints.adoc[leveloffset=+1] + include::modules/hcp-priority-classes.adoc[leveloffset=+1] + include::modules/hcp-virt-taints-tolerations.adoc[leveloffset=+1] + include::modules/hcp-isolation.adoc[leveloffset=+1] \ No newline at end of file diff --git a/hosted_control_planes/hcp-prepare/hcp-enable-disable.adoc b/hosted_control_planes/hcp-prepare/hcp-enable-disable.adoc index 2753e00017..f8b03d620b 100644 --- a/hosted_control_planes/hcp-prepare/hcp-enable-disable.adoc +++ b/hosted_control_planes/hcp-prepare/hcp-enable-disable.adoc @@ -9,6 +9,7 @@ toc::[] The {hcp} feature, as well as the `hypershift-addon` managed cluster add-on, are enabled by default. If you want to disable the feature, or if you disabled it and want to manually enable it, see the following procedures. include::modules/hcp-enable-manual.adoc[leveloffset=+1] + include::modules/hcp-enable-manual-addon.adoc[leveloffset=+2] [id="hcp-disable_{context}"] @@ -17,4 +18,5 @@ include::modules/hcp-enable-manual-addon.adoc[leveloffset=+2] You can uninstall the HyperShift Operator and disable the {hcp} feature. When you disable the {hcp} feature, you must destroy the hosted cluster and the managed cluster resource on {mce-short}, as described in the _Managing hosted clusters_ topics. include::modules/hcp-uninstall-operator.adoc[leveloffset=+2] + include::modules/hcp-disable-feature.adoc[leveloffset=+2] \ No newline at end of file diff --git a/hosted_control_planes/hcp-prepare/hcp-override-resource-util.adoc b/hosted_control_planes/hcp-prepare/hcp-override-resource-util.adoc index c92c79a1be..3c24d9f4e7 100644 --- a/hosted_control_planes/hcp-prepare/hcp-override-resource-util.adoc +++ b/hosted_control_planes/hcp-prepare/hcp-override-resource-util.adoc @@ -9,4 +9,5 @@ toc::[] The set of baseline measurements for resource utilization can vary in each hosted cluster. include::modules/hcp-override.adoc[leveloffset=+1] + include::modules/hcp-disable-metrics.adoc[leveloffset=+1] \ No newline at end of file diff --git a/hosted_control_planes/hcp-prepare/hcp-requirements.adoc b/hosted_control_planes/hcp-prepare/hcp-requirements.adoc index 79c20a505b..2ab3c78d89 100644 --- a/hosted_control_planes/hcp-prepare/hcp-requirements.adoc +++ b/hosted_control_planes/hcp-prepare/hcp-requirements.adoc @@ -23,6 +23,7 @@ The following requirements apply to {hcp}: * In Bare Metal Host (BMH) deployments, where the Bare Metal Operator starts machines, the hosted control plane must be able to reach baseboard management controllers (BMCs). If your security profile does not permit the Cluster Baremetal Operator to access the network where the BMHs have their BMCs in order to enable Redfish automation, you can use BYO ISO support. However, in BYO mode, {product-title} cannot automate the powering on of BMHs. include::modules/hcp-support-matrix.adoc[leveloffset=+1] + include::modules/hcp-fips.adoc[leveloffset=+1] [role="_additional-resources"] diff --git a/hosted_control_planes/hcp-prepare/hcp-sizing-guidance.adoc b/hosted_control_planes/hcp-prepare/hcp-sizing-guidance.adoc index b1ae9643a4..bb4e95c8b4 100644 --- a/hosted_control_planes/hcp-prepare/hcp-sizing-guidance.adoc +++ b/hosted_control_planes/hcp-prepare/hcp-sizing-guidance.adoc @@ -31,8 +31,11 @@ include::modules/hcp-pod-limits.adoc[leveloffset=+1] * xref:../../nodes/nodes/nodes-nodes-managing-max-pods.adoc#nodes-nodes-managing-max-pods-proc_nodes-nodes-managing-max-pods[Configuring the maximum number of pods per node] include::modules/hcp-resource-limit.adoc[leveloffset=+1] + include::modules/hcp-load-based-limit.adoc[leveloffset=+1] + include::modules/hcp-sizing-calculation.adoc[leveloffset=+1] + include::modules/hcp-shared-infra.adoc[leveloffset=+1] [role="_additional-resources"] diff --git a/hosted_control_planes/hcp-troubleshooting.adoc b/hosted_control_planes/hcp-troubleshooting.adoc index b7155f7893..4da1771b2a 100644 --- a/hosted_control_planes/hcp-troubleshooting.adoc +++ b/hosted_control_planes/hcp-troubleshooting.adoc @@ -20,6 +20,7 @@ include::modules/hosted-control-planes-troubleshooting.adoc[leveloffset=+1] You can gather {product-title} debugging information for a hosted cluster by using the {mce-short} web console or by using the CLI. include::modules/hcp-must-gather-cli.adoc[leveloffset=+2] + include::modules/hcp-must-gather-console.adoc[leveloffset=+2] include::modules/hcp-must-gather-dc.adoc[leveloffset=+1] @@ -34,6 +35,7 @@ include::modules/hcp-must-gather-dc.adoc[leveloffset=+1] When you troubleshoot a hosted cluster on {VirtProductName}, start with the top-level `HostedCluster` and `NodePool` resources and then work down the stack until you find the root cause. The following steps can help you discover the root cause of common issues. include::modules/hcp-ts-hc-stuck.adoc[leveloffset=+2] + include::modules/hcp-ts-no-nodes-reg.adoc[leveloffset=+2] [role="_additional-resources"] @@ -41,11 +43,17 @@ include::modules/hcp-ts-no-nodes-reg.adoc[leveloffset=+2] * link:https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.14/html/clusters/cluster_mce_overview#identifying-vm-console-logs[Identifying the problem: Access the VM console logs] include::modules/hcp-ts-nodes-stuck.adoc[leveloffset=+2] + include::modules/hcp-ts-ingress-not-online.adoc[leveloffset=+2] + include::modules/hcp-ts-load-balancer-svcs.adoc[leveloffset=+2] + include::modules/hcp-ts-pvcs-not-avail.adoc[leveloffset=+2] + include::modules/hcp-ts-vm-nodes.adoc[leveloffset=+2] + include::modules/hcp-ts-rhcos.adoc[leveloffset=+2] + include::modules/hcp-ts-non-bm.adoc[leveloffset=+2] [role="_additional-resources"] @@ -64,6 +72,9 @@ include::modules/hcp-ts-bm-nodes-not-added.adoc[leveloffset=+2] * link:https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.14/html-single/clusters/index#on-prem-creating-your-cluster-with-the-cli-pull-secret[Add the pull secret to the namespace] include::modules/hosted-restart-hcp-components.adoc[leveloffset=+1] + include::modules/hosted-control-planes-pause-reconciliation.adoc[leveloffset=+1] + include::modules/scale-down-data-plane.adoc[leveloffset=+1] + include::modules/agent-service-failure.adoc[leveloffset=+1] \ No newline at end of file diff --git a/hosted_control_planes/index.adoc b/hosted_control_planes/index.adoc index 09f8254068..2f59e46bf7 100644 --- a/hosted_control_planes/index.adoc +++ b/hosted_control_planes/index.adoc @@ -9,6 +9,7 @@ You can deploy {product-title} clusters by using two different control plane con toc::[] include::modules/hosted-control-planes-overview.adoc[leveloffset=+1] + include::modules/hcp-ocp-differences.adoc[leveloffset=+1] [role="_additional-resources"] @@ -16,7 +17,9 @@ include::modules/hcp-ocp-differences.adoc[leveloffset=+1] * xref:../etcd/etcd-encrypt.adoc#etcd-encrypt[Enabling etcd encryption] include::modules/hcp-mce-acm-relationship-intro.adoc[leveloffset=+1] + include::modules/hcp-acm-discover.adoc[leveloffset=+2] + include::modules/hosted-control-planes-version-support.adoc[leveloffset=+1] [role="_additional-resources"] diff --git a/installing/install_config/installing-customizing.adoc b/installing/install_config/installing-customizing.adoc index cc683ed522..2419804c54 100644 --- a/installing/install_config/installing-customizing.adoc +++ b/installing/install_config/installing-customizing.adoc @@ -28,8 +28,11 @@ The following sections describe features that you might want to configure on your nodes in this way. include::modules/installation-special-config-butane.adoc[leveloffset=+1] + include::modules/installation-special-config-butane-about.adoc[leveloffset=+2] + include::modules/installation-special-config-butane-install.adoc[leveloffset=+2] + include::modules/installation-special-config-butane-create.adoc[leveloffset=+2] [role="_additional-resources"] @@ -39,13 +42,19 @@ include::modules/installation-special-config-butane-create.adoc[leveloffset=+2] * xref:../../installing/install_config/installing-customizing.adoc#installation-special-config-storage_installing-customizing[Encrypting and mirroring disks during installation] include::modules/installation-special-config-kargs.adoc[leveloffset=+1] + ifdef::openshift-webscale[] include::modules/installation-special-config-rtkernel.adoc[leveloffset=+1] + endif::openshift-webscale[] include::modules/installation-special-config-kmod.adoc[leveloffset=+1] + include::modules/installation-special-config-storage.adoc[leveloffset=+1] + include::modules/installation-special-config-raid.adoc[leveloffset=+1] + include::modules/installation-special-config-raid-intel-vroc.adoc[leveloffset=+1] + include::modules/installation-special-config-chrony.adoc[leveloffset=+1] [role="_additional-resources"] diff --git a/installing/installing_aws/aws-compute-edge-zone-tasks.adoc b/installing/installing_aws/aws-compute-edge-zone-tasks.adoc index 0b5dd4eb67..ee20234ec8 100644 --- a/installing/installing_aws/aws-compute-edge-zone-tasks.adoc +++ b/installing/installing_aws/aws-compute-edge-zone-tasks.adoc @@ -31,9 +31,13 @@ include::modules/nw-cluster-mtu-change-about.adoc[leveloffset=+2] // Changing the cluster network MTU include::modules/nw-cluster-mtu-change.adoc[leveloffset=+2] + include::modules/nw-cluster-mtu-checking.adoc[leveloffset=+3] + include::modules/nw-cluster-mtu-migration.adoc[leveloffset=+3] + include::modules/nw-cluster-mtu-verifying-configuration.adoc[leveloffset=+3] + include::modules/nw-cluster-mtu-finalizing-migration.adoc[leveloffset=+3] // Opting in to AWS Local Zones or Wavelength Zones diff --git a/installing/installing_aws/installing-aws-account.adoc b/installing/installing_aws/installing-aws-account.adoc index 670a73d022..ae42b1f1c6 100644 --- a/installing/installing_aws/installing-aws-account.adoc +++ b/installing/installing_aws/installing-aws-account.adoc @@ -22,6 +22,7 @@ include::modules/installation-aws-iam-user.adoc[leveloffset=+1] include::modules/installation-aws-iam-policies-about.adoc[leveloffset=+1] include::modules/installation-aws-permissions-iam-roles.adoc[leveloffset=+2] + include::modules/installation-aws-add-iam-roles.adoc[leveloffset=+2] [role="_additional-resources"] diff --git a/installing/installing_aws/ipi/installing-aws-customizations.adoc b/installing/installing_aws/ipi/installing-aws-customizations.adoc index 2d49794d7d..7b76a535ea 100644 --- a/installing/installing_aws/ipi/installing-aws-customizations.adoc +++ b/installing/installing_aws/ipi/installing-aws-customizations.adoc @@ -103,6 +103,7 @@ include::modules/cco-ccoctl-install-creating-manifests.adoc[leveloffset=+3] // Network Operator specific configuration include::modules/nw-operator-cr.adoc[leveloffset=+1] + include::modules/nw-modifying-operator-install-config.adoc[leveloffset=+1] [NOTE] diff --git a/installing/installing_aws/ipi/installing-aws-outposts.adoc b/installing/installing_aws/ipi/installing-aws-outposts.adoc index 90dcf8daed..f301bd8930 100644 --- a/installing/installing_aws/ipi/installing-aws-outposts.adoc +++ b/installing/installing_aws/ipi/installing-aws-outposts.adoc @@ -15,6 +15,7 @@ For more information, see the link:https://docs.aws.amazon.com/outposts/[AWS Out //AWS Outposts on {product-title} requirements and limitations include::modules/aws-outposts-requirements-limitations.adoc[leveloffset=+1] + [role="_additional-resources"] .Additional resources * xref:../../../installing/installing_aws/ipi/installing-aws-outposts.adoc#nw-aws-load-balancer-with-outposts_installing-aws-outposts[Using the AWS Load Balancer Operator in an AWS VPC cluster extended into an Outpost] @@ -42,10 +43,15 @@ To extend your VPC cluster into an Outpost, you must complete the following netw //Changing the Cluster Network MTU to support AWS Outposts include::modules/nw-cluster-mtu-change.adoc[leveloffset=+2] + include::modules/nw-cluster-mtu-checking.adoc[leveloffset=+3] + include::modules/nw-cluster-mtu-migration.adoc[leveloffset=+3] + include::modules/nw-cluster-mtu-verifying-configuration.adoc[leveloffset=+3] + include::modules/nw-cluster-mtu-finalizing-migration.adoc[leveloffset=+3] + [role="_additional-resources"] .Additional resources * xref:../../../networking/advanced_networking/changing-cluster-network-mtu.adoc#changing-cluster-network-mtu[Changing the MTU for the cluster network] @@ -61,6 +67,7 @@ include::modules/aws-outposts-machine-set.adoc[leveloffset=+1] //Creating user workloads in an Outpost include::modules/create-user-workloads-aws-edge.adoc[leveloffset=+1] + //To-do: reintegrate installation-extend-edge-nodes-aws-local-zones.adoc with create-user-workloads-aws-edge.adoc. Requires global repo update of any xrefs/includes. [id="aws-outposts-network-scheduling-workloads_{context}"] diff --git a/installing/installing_aws/ipi/installing-aws-private.adoc b/installing/installing_aws/ipi/installing-aws-private.adoc index 9d670d2241..6836f49a05 100644 --- a/installing/installing_aws/ipi/installing-aws-private.adoc +++ b/installing/installing_aws/ipi/installing-aws-private.adoc @@ -26,6 +26,7 @@ include::modules/private-clusters-default.adoc[leveloffset=+1] include::modules/private-clusters-about-aws.adoc[leveloffset=+2] include::modules/installation-custom-aws-vpc.adoc[leveloffset=+1] + include::modules/installation-aws-security-groups.adoc[leveloffset=+2] include::modules/installation-initializing-manual.adoc[leveloffset=+1] @@ -42,6 +43,7 @@ include::modules/installation-minimum-resource-requirements.adoc[leveloffset=+2] * xref:../../../scalability_and_performance/optimization/optimizing-storage.adoc#optimizing-storage[Optimizing storage] include::modules/installation-aws-tested-machine-types.adoc[leveloffset=+2] + include::modules/installation-aws-arm-tested-machine-types.adoc[leveloffset=+2] include::modules/installation-aws-config-yaml-customizations.adoc[leveloffset=+2] diff --git a/installing/installing_aws/ipi/installing-aws-specialized-region.adoc b/installing/installing_aws/ipi/installing-aws-specialized-region.adoc index c038bf1304..7e68e5de9c 100644 --- a/installing/installing_aws/ipi/installing-aws-specialized-region.adoc +++ b/installing/installing_aws/ipi/installing-aws-specialized-region.adoc @@ -60,6 +60,7 @@ If you have an AWS profile stored on your computer, it must not use a temporary ==== include::modules/installation-aws-about-government-region.adoc[leveloffset=+1] + include::modules/installation-aws-marketplace-government.adoc[leveloffset=+1] [role="_additional-resources"] @@ -69,9 +70,11 @@ include::modules/installation-aws-marketplace-government.adoc[leveloffset=+1] include::modules/installation-aws-regions-with-no-ami.adoc[leveloffset=+1] include::modules/private-clusters-default.adoc[leveloffset=+1] + include::modules/private-clusters-about-aws.adoc[leveloffset=+2] include::modules/installation-custom-aws-vpc.adoc[leveloffset=+1] + include::modules/installation-aws-security-groups.adoc[leveloffset=+2] include::modules/installation-aws-upload-custom-rhcos-ami.adoc[leveloffset=+1] @@ -97,6 +100,7 @@ include::modules/installation-minimum-resource-requirements.adoc[leveloffset=+2] * xref:../../../scalability_and_performance/optimization/optimizing-storage.adoc#optimizing-storage[Optimizing storage] include::modules/installation-aws-tested-machine-types.adoc[leveloffset=+2] + include::modules/installation-aws-arm-tested-machine-types.adoc[leveloffset=+2] include::modules/installation-configure-proxy.adoc[leveloffset=+2] diff --git a/installing/installing_aws/ipi/installing-aws-vpc.adoc b/installing/installing_aws/ipi/installing-aws-vpc.adoc index 4cbdb1d12a..226219d85a 100644 --- a/installing/installing_aws/ipi/installing-aws-vpc.adoc +++ b/installing/installing_aws/ipi/installing-aws-vpc.adoc @@ -23,7 +23,9 @@ If you have an AWS profile stored on your computer, it must not use a temporary * If you use a firewall, you xref:../../../installing/install_config/configuring-firewall.adoc#configuring-firewall[configured it to allow the sites] that your cluster requires access to. include::modules/installation-custom-aws-vpc.adoc[leveloffset=+1] + include::modules/installation-aws-security-groups.adoc[leveloffset=+2] + include::modules/installation-aws-permissions-iam-shared-vpc.adoc[leveloffset=+2] include::modules/installation-initializing.adoc[leveloffset=+1] @@ -40,6 +42,7 @@ include::modules/installation-minimum-resource-requirements.adoc[leveloffset=+2] * xref:../../../scalability_and_performance/optimization/optimizing-storage.adoc#optimizing-storage[Optimizing storage] include::modules/installation-aws-tested-machine-types.adoc[leveloffset=+2] + include::modules/installation-aws-arm-tested-machine-types.adoc[leveloffset=+2] include::modules/installation-aws-config-yaml-customizations.adoc[leveloffset=+2] diff --git a/installing/installing_aws/upi/upi-aws-installation-reqs.adoc b/installing/installing_aws/upi/upi-aws-installation-reqs.adoc index 6364d09d34..e22728b994 100644 --- a/installing/installing_aws/upi/upi-aws-installation-reqs.adoc +++ b/installing/installing_aws/upi/upi-aws-installation-reqs.adoc @@ -13,6 +13,7 @@ of the required machines. include::modules/installation-machine-requirements.adoc[leveloffset=+1] + include::modules/installation-minimum-resource-requirements.adoc[leveloffset=+2] [role="_additional-resources"] @@ -21,6 +22,7 @@ include::modules/installation-minimum-resource-requirements.adoc[leveloffset=+2] * xref:../../../scalability_and_performance/optimization/optimizing-storage.adoc#optimizing-storage[Optimizing storage] include::modules/installation-aws-tested-machine-types.adoc[leveloffset=+2] + include::modules/installation-aws-arm-tested-machine-types.adoc[leveloffset=+2] include::modules/csr-management.adoc[leveloffset=+1] diff --git a/installing/installing_azure/ipi/installing-azure-government-region.adoc b/installing/installing_azure/ipi/installing-azure-government-region.adoc index ae886e5f9c..7be61eb62f 100644 --- a/installing/installing_azure/ipi/installing-azure-government-region.adoc +++ b/installing/installing_azure/ipi/installing-azure-government-region.adoc @@ -44,6 +44,7 @@ include::modules/installation-minimum-resource-requirements.adoc[leveloffset=+2] include::modules/installation-azure-tested-machine-types.adoc[leveloffset=+2] include::modules/installation-azure-trusted-launch.adoc[leveloffset=+2] + include::modules/installation-azure-confidential-vms.adoc[leveloffset=+2] include::modules/installation-azure-config-yaml.adoc[leveloffset=+2] diff --git a/installing/installing_azure/ipi/installing-azure-private.adoc b/installing/installing_azure/ipi/installing-azure-private.adoc index 8cff096888..5626c82ef2 100644 --- a/installing/installing_azure/ipi/installing-azure-private.adoc +++ b/installing/installing_azure/ipi/installing-azure-private.adoc @@ -41,6 +41,7 @@ include::modules/installation-azure-tested-machine-types.adoc[leveloffset=+2] include::modules/installation-azure-arm-tested-machine-types.adoc[leveloffset=+2] include::modules/installation-azure-trusted-launch.adoc[leveloffset=+2] + include::modules/installation-azure-confidential-vms.adoc[leveloffset=+2] include::modules/installation-azure-config-yaml.adoc[leveloffset=+2] diff --git a/installing/installing_azure/ipi/installing-azure-vnet.adoc b/installing/installing_azure/ipi/installing-azure-vnet.adoc index 5995e0744a..df88f44811 100644 --- a/installing/installing_azure/ipi/installing-azure-vnet.adoc +++ b/installing/installing_azure/ipi/installing-azure-vnet.adoc @@ -35,6 +35,7 @@ include::modules/installation-azure-tested-machine-types.adoc[leveloffset=+2] include::modules/installation-azure-arm-tested-machine-types.adoc[leveloffset=+2] include::modules/installation-azure-trusted-launch.adoc[leveloffset=+2] + include::modules/installation-azure-confidential-vms.adoc[leveloffset=+2] include::modules/installation-azure-config-yaml.adoc[leveloffset=+2] diff --git a/installing/installing_azure/ipi/installing-restricted-networks-azure-installer-provisioned.adoc b/installing/installing_azure/ipi/installing-restricted-networks-azure-installer-provisioned.adoc index c558a973d0..334a86e84d 100644 --- a/installing/installing_azure/ipi/installing-restricted-networks-azure-installer-provisioned.adoc +++ b/installing/installing_azure/ipi/installing-restricted-networks-azure-installer-provisioned.adoc @@ -52,6 +52,7 @@ include::modules/installation-azure-tested-machine-types.adoc[leveloffset=+2] include::modules/installation-azure-arm-tested-machine-types.adoc[leveloffset=+2] include::modules/installation-azure-trusted-launch.adoc[leveloffset=+2] + include::modules/installation-azure-confidential-vms.adoc[leveloffset=+2] include::modules/installation-azure-dedicated-disks.adoc[leveloffset=+2] diff --git a/installing/installing_azure/upi/installing-azure-user-infra.adoc b/installing/installing_azure/upi/installing-azure-user-infra.adoc index f7ec42b5bb..3c5d9b8d03 100644 --- a/installing/installing_azure/upi/installing-azure-user-infra.adoc +++ b/installing/installing_azure/upi/installing-azure-user-infra.adoc @@ -81,6 +81,7 @@ of the required machines. This section describes the requirements for deploying {product-title} on user-provisioned infrastructure. include::modules/installation-machine-requirements.adoc[leveloffset=+2] + include::modules/installation-minimum-resource-requirements.adoc[leveloffset=+2] [role="_additional-resources"] @@ -89,6 +90,7 @@ include::modules/installation-minimum-resource-requirements.adoc[leveloffset=+2] * xref:../../../scalability_and_performance/optimization/optimizing-storage.adoc#optimizing-storage[Optimizing storage] include::modules/installation-azure-tested-machine-types.adoc[leveloffset=+2] + include::modules/installation-azure-arm-tested-machine-types.adoc[leveloffset=+2] include::modules/installation-azure-marketplace-subscribe.adoc[leveloffset=+1] @@ -98,11 +100,16 @@ include::modules/installation-obtaining-installer.adoc[leveloffset=+1] include::modules/ssh-agent-using.adoc[leveloffset=+1] include::modules/installation-user-infra-generate.adoc[leveloffset=+1] + include::modules/installation-disk-partitioning-upi-templates.adoc[leveloffset=+2] + include::modules/installation-initializing.adoc[leveloffset=+2] + include::modules/installation-configure-proxy.adoc[leveloffset=+2] + //include::modules/installation-three-node-cluster.adoc[leveloffset=+2] include::modules/installation-user-infra-exporting-common-variables-arm-templates.adoc[leveloffset=+2] + include::modules/installation-user-infra-generate-k8s-manifest-ignition.adoc[leveloffset=+2] include::modules/installation-azure-create-resource-group-and-identity.adoc[leveloffset=+1] @@ -114,25 +121,31 @@ include::modules/installation-azure-create-dns-zones.adoc[leveloffset=+1] You can learn more about xref:installation-azure-network-config_{context}[configuring a public DNS zone in Azure] by visiting that section. include::modules/installation-creating-azure-vnet.adoc[leveloffset=+1] + include::modules/installation-arm-vnet.adoc[leveloffset=+2] include::modules/installation-azure-user-infra-deploying-rhcos.adoc[leveloffset=+1] + include::modules/installation-arm-image-storage.adoc[leveloffset=+2] include::modules/installation-network-user-infra.adoc[leveloffset=+1] include::modules/installation-creating-azure-dns.adoc[leveloffset=+1] + include::modules/installation-arm-dns.adoc[leveloffset=+2] include::modules/installation-creating-azure-bootstrap.adoc[leveloffset=+1] + include::modules/installation-arm-bootstrap.adoc[leveloffset=+2] include::modules/installation-creating-azure-control-plane.adoc[leveloffset=+1] + include::modules/installation-arm-control-plane.adoc[leveloffset=+2] include::modules/installation-azure-user-infra-wait-for-bootstrap.adoc[leveloffset=+1] include::modules/installation-creating-azure-worker.adoc[leveloffset=+1] + include::modules/installation-arm-worker.adoc[leveloffset=+2] include::modules/cli-installing-cli.adoc[leveloffset=+1] diff --git a/installing/installing_azure/upi/installing-restricted-networks-azure-user-provisioned.adoc b/installing/installing_azure/upi/installing-restricted-networks-azure-user-provisioned.adoc index 2fffa9793f..a7795a109a 100644 --- a/installing/installing_azure/upi/installing-restricted-networks-azure-user-provisioned.adoc +++ b/installing/installing_azure/upi/installing-restricted-networks-azure-user-provisioned.adoc @@ -93,10 +93,15 @@ include::modules/installation-obtaining-installer.adoc[leveloffset=+2] include::modules/ssh-agent-using.adoc[leveloffset=+2] include::modules/installation-user-infra-generate.adoc[leveloffset=+1] + include::modules/installation-disk-partitioning-upi-templates.adoc[leveloffset=+2] + include::modules/installation-initializing.adoc[leveloffset=+2] + include::modules/installation-configure-proxy.adoc[leveloffset=+2] + include::modules/installation-user-infra-exporting-common-variables-arm-templates.adoc[leveloffset=+2] + include::modules/installation-user-infra-generate-k8s-manifest-ignition.adoc[leveloffset=+2] include::modules/installation-azure-create-resource-group-and-identity.adoc[leveloffset=+1] @@ -108,25 +113,31 @@ include::modules/installation-azure-create-dns-zones.adoc[leveloffset=+1] You can learn more about xref:installation-azure-network-config_{context}[configuring a public DNS zone in Azure] by visiting that section. include::modules/installation-creating-azure-vnet.adoc[leveloffset=+1] + include::modules/installation-arm-vnet.adoc[leveloffset=+2] include::modules/installation-azure-user-infra-deploying-rhcos.adoc[leveloffset=+1] + include::modules/installation-arm-image-storage.adoc[leveloffset=+2] include::modules/installation-network-user-infra.adoc[leveloffset=+1] include::modules/installation-creating-azure-dns.adoc[leveloffset=+1] + include::modules/installation-arm-dns.adoc[leveloffset=+2] include::modules/installation-creating-azure-bootstrap.adoc[leveloffset=+1] + include::modules/installation-arm-bootstrap.adoc[leveloffset=+2] include::modules/installation-creating-azure-control-plane.adoc[leveloffset=+1] + include::modules/installation-arm-control-plane.adoc[leveloffset=+2] include::modules/installation-azure-user-infra-wait-for-bootstrap.adoc[leveloffset=+1] include::modules/installation-creating-azure-worker.adoc[leveloffset=+1] + include::modules/installation-arm-worker.adoc[leveloffset=+2] include::modules/cli-installing-cli.adoc[leveloffset=+1] diff --git a/installing/installing_azure_stack_hub/ipi/installing-azure-stack-hub-network-customizations.adoc b/installing/installing_azure_stack_hub/ipi/installing-azure-stack-hub-network-customizations.adoc index 1525b56af1..13884bddb0 100644 --- a/installing/installing_azure_stack_hub/ipi/installing-azure-stack-hub-network-customizations.adoc +++ b/installing/installing_azure_stack_hub/ipi/installing-azure-stack-hub-network-customizations.adoc @@ -49,8 +49,11 @@ include::modules/azure-stack-hub-internal-ca.adoc[leveloffset=+1] // Network Operator specific configuration include::modules/nw-network-config.adoc[leveloffset=+1] + include::modules/nw-modifying-operator-install-config.adoc[leveloffset=+1] + include::modules/nw-operator-cr.adoc[leveloffset=+1] + include::modules/configuring-hybrid-ovnkubernetes.adoc[leveloffset=+1] //// diff --git a/installing/installing_azure_stack_hub/upi/installing-azure-stack-hub-user-infra.adoc b/installing/installing_azure_stack_hub/upi/installing-azure-stack-hub-user-infra.adoc index 0b1bdc1957..725043dbcc 100644 --- a/installing/installing_azure_stack_hub/upi/installing-azure-stack-hub-user-infra.adoc +++ b/installing/installing_azure_stack_hub/upi/installing-azure-stack-hub-user-infra.adoc @@ -54,6 +54,7 @@ You can view Azure's DNS solution by visiting this xref:installation-azure-creat include::modules/csr-management.adoc[leveloffset=+2] include::modules/installation-azure-stack-hub-permissions.adoc[leveloffset=+2] + include::modules/installation-azure-service-principal.adoc[leveloffset=+2] [role="_additional-resources"] @@ -62,6 +63,7 @@ include::modules/installation-azure-service-principal.adoc[leveloffset=+2] * xref:../../../authentication/managing_cloud_provider_credentials/about-cloud-credential-operator.adoc#about-cloud-credential-operator-modes[About the Cloud Credential Operator] include::modules/installation-user-infra-generate.adoc[leveloffset=+1] + include::modules/installation-initializing-manual.adoc[leveloffset=+2] [role="_additional-resources"] @@ -71,6 +73,7 @@ include::modules/installation-initializing-manual.adoc[leveloffset=+2] include::modules/installation-azure-stack-hub-config-yaml.adoc[leveloffset=+2] include::modules/installation-configure-proxy.adoc[leveloffset=+2] + include::modules/installation-user-infra-exporting-common-variables-arm-templates.adoc[leveloffset=+2] // Creating the Kubernetes manifest and Ignition config files @@ -91,25 +94,31 @@ include::modules/installation-azure-create-dns-zones.adoc[leveloffset=+1] You can learn more about xref:installation-azure-stack-hub-network-config_{context}[configuring a DNS zone in Azure Stack Hub] by visiting that section. include::modules/installation-creating-azure-vnet.adoc[leveloffset=+1] + include::modules/installation-arm-vnet.adoc[leveloffset=+2] include::modules/installation-azure-user-infra-deploying-rhcos.adoc[leveloffset=+1] + include::modules/installation-arm-image-storage.adoc[leveloffset=+2] include::modules/installation-network-user-infra.adoc[leveloffset=+1] include::modules/installation-creating-azure-dns.adoc[leveloffset=+1] + include::modules/installation-arm-dns.adoc[leveloffset=+2] include::modules/installation-creating-azure-bootstrap.adoc[leveloffset=+1] + include::modules/installation-arm-bootstrap.adoc[leveloffset=+2] include::modules/installation-creating-azure-control-plane.adoc[leveloffset=+1] + include::modules/installation-arm-control-plane.adoc[leveloffset=+2] include::modules/installation-azure-user-infra-wait-for-bootstrap.adoc[leveloffset=+1] include::modules/installation-creating-azure-worker.adoc[leveloffset=+1] + include::modules/installation-arm-worker.adoc[leveloffset=+2] include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1] diff --git a/installing/installing_bare_metal/bare-metal-postinstallation-configuration.adoc b/installing/installing_bare_metal/bare-metal-postinstallation-configuration.adoc index d30ce03af4..d7d666c8db 100644 --- a/installing/installing_bare_metal/bare-metal-postinstallation-configuration.adoc +++ b/installing/installing_bare_metal/bare-metal-postinstallation-configuration.adoc @@ -54,45 +54,66 @@ include::modules/nw-osp-configuring-external-load-balancer.adoc[leveloffset=+2] // Using the Bare Metal Operator include::modules/bmo-config-using-bare-metal-operator.adoc[leveloffset=+1] + // Bare Metal Operator architecture include::modules/bmo-bare-metal-operator-architecture.adoc[leveloffset=+2] + // About the BareMetalHost resource include::modules/bmo-about-the-baremetalhost-resource.adoc[leveloffset=+2] + // Getting the BareMetalHost resource include::modules/bmo-getting-the-baremetalhost-resource.adoc[leveloffset=+2] + // Editing a BareMetalHost resource include::modules/bmo-editing-a-baremetalhost-resource.adoc[leveloffset=+2] + // Troubleshooting latency. include::modules/bmo-troubleshooting-latency-when-deleting-a-baremetalhost-resource.adoc[leveloffset=+2] + // Attaching a non-bootable ISO to a bare-metal node include::modules/bmo-attaching-a-non-bootable-iso-to-a-bare-metal-node.adoc[leveloffset=+2] + // Configuring NC-SI and DisablePowerOff for shared NICs include::modules/bmo-configuring-ncsi-disable-poweroff.adoc[leveloffset=+2] + // About the HostFirmwareSettings resource include::modules/bmo-about-the-hostfirmwaresettings-resource.adoc[leveloffset=+2] + // Getting the HostFirmwareSettings resource include::modules/bmo-getting-the-hostfirmwaresettings-resource.adoc[leveloffset=+2] + // Editing the HostFirmwareSettings resource include::modules/bmo-editing-the-hostfirmwaresettings-resource-of-a-provisioned-host.adoc[leveloffset=+2] + // Patching the HostFirmawareSettings resource include::modules/bmo-performing-a-live-update-to-the-hostfirmwaresettings-resource.adoc[leveloffset=+2] + // Verifying the HostFirmware Settings resource is valid include::modules/bmo-verifying-the-hostfirmware-settings-resource-is-valid.adoc[leveloffset=+2] + // About the FirmwareSchema resource include::modules/bmo-about-the-firmwareschema-resource.adoc[leveloffset=+2] + // Getting the FirmwareSchema resource include::modules/bmo-getting-the-firmwareschema-resource.adoc[leveloffset=+2] + // About the HostFirmwareComponents resource include::modules/bmo-about-the-hostfirmwarecomponents-resource.adoc[leveloffset=+2] + // Getting the HostFirmwareComponents resource include::modules/bmo-getting-the-hostfirmwarecomponents-resource.adoc[leveloffset=+2] + // Editing the HostFirmwareComponents resource include::modules/bmo-editing-the-hostfirmwarecomponents-resource-of-a-provisioned-host.adoc[leveloffset=+2] + // Patching the HostFirmawareComponents resource include::modules/bmo-performing-a-live-update-to-the-hostfirmwarecomponents-resource.adoc[leveloffset=+2] + // Identifying the NICs `HostFirmwareComponents` resources you can update include::modules/bmo-getting-the-hostfirmwarecomponents-resource_nic.adoc[leveloffset=+2] + // About the HostUpdatePolicy resource include::modules/bmo-about-the-hostupdatepolicy-resource.adoc[leveloffset=+2] + // Setting the HostUpdatePolicy resource include::modules/bmo-setting-the-hostupdatepolicy-resource.adoc[leveloffset=+2] \ No newline at end of file diff --git a/installing/installing_bare_metal/bare-metal-using-bare-metal-as-a-service.adoc b/installing/installing_bare_metal/bare-metal-using-bare-metal-as-a-service.adoc index a35e09d1df..1689187af2 100644 --- a/installing/installing_bare_metal/bare-metal-using-bare-metal-as-a-service.adoc +++ b/installing/installing_bare_metal/bare-metal-using-bare-metal-as-a-service.adoc @@ -15,6 +15,7 @@ As standalone systems, these hosts operate independently of the {product-title} :FeatureName: BMaaS include::snippets/technology-preview.adoc[] + :!FeatureName: include::modules/bmaas-prerequisites.adoc[leveloffset=+1] diff --git a/installing/installing_bare_metal/ipi/ipi-install-troubleshooting.adoc b/installing/installing_bare_metal/ipi/ipi-install-troubleshooting.adoc index 8a89bde1fb..d67232bd71 100644 --- a/installing/installing_bare_metal/ipi/ipi-install-troubleshooting.adoc +++ b/installing/installing_bare_metal/ipi/ipi-install-troubleshooting.adoc @@ -30,23 +30,42 @@ xref:investigating-an-unavailable-kubernetes-api_ipi-install-troubleshooting[ a include::modules/ipi-install-troubleshooting-install-config.adoc[leveloffset=+1] + include::modules/ipi-install-troubleshooting-bootstrap-vm.adoc[leveloffset=+1] + include::modules/ipi-install-troubleshooting-bootstrap-vm-cannot-boot.adoc[leveloffset=+2] + include::modules/ipi-install-troubleshooting-bootstrap-vm-inspecting-logs.adoc[leveloffset=+2] + include::modules/ipi-install-troubleshooting-investigating-an-unavailable-kubernetes-api.adoc[leveloffset=+1] + include::modules/ipi-install-troubleshooting-troubleshooting-failure-to-initialize-the-cluster.adoc[leveloffset=+1] + include::modules/ipi-install-troubleshooting-troubleshooting-failure-to-fetch-the-console-url.adoc[leveloffset=+1] + include::modules/ipi-install-troubleshooting-troubleshooting-failure-to-add-the-ingress-certificate-to-kubeconfig.adoc[leveloffset=+1] + include::modules/ipi-install-troubleshooting-troubleshooting-ssh-access-to-cluster-nodes.adoc[leveloffset=+1] + include::modules/ipi-install-troubleshooting-cluster-nodes-will-not-pxe.adoc[leveloffset=+1] + include::modules/ipi-install-troubleshooting-installing-creates-no-worker-nodes.adoc[leveloffset=+1] + include::modules/ipi-install-troubleshooting-troubleshooting-the-cluster-network-operator.adoc[leveloffset=+1] + include::modules/ipi-install-troubleshooting_unable-to-discover-new-bare-metal-hosts-using-the-bmc.adoc[leveloffset=+1] + include::modules/ipi-install-troubleshooting_proc_worker-nodes-cannot-join-the-cluster.adoc[leveloffset=+1] + include::modules/ipi-install-troubleshooting-cleaning-up-previous-installations.adoc[leveloffset=+1] + include::modules/ipi-install-troubleshooting-registry-issues.adoc[leveloffset=+1] + include::modules/ipi-install-troubleshooting-misc-issues.adoc[leveloffset=+1] + include::modules/ipi-install-troubleshooting-failed-ignition-during-firstboot.adoc[leveloffset=+2] + include::modules/ipi-install-troubleshooting-ntp-out-of-sync.adoc[leveloffset=+2] + include::modules/ipi-install-troubleshooting-reviewing-the-installation.adoc[leveloffset=+1] diff --git a/installing/installing_bare_metal/upi/installing-bare-metal-network-customizations.adoc b/installing/installing_bare_metal/upi/installing-bare-metal-network-customizations.adoc index 79de273f8a..1feecf7de2 100644 --- a/installing/installing_bare_metal/upi/installing-bare-metal-network-customizations.adoc +++ b/installing/installing_bare_metal/upi/installing-bare-metal-network-customizations.adoc @@ -37,6 +37,7 @@ of the required machines. This section describes the requirements for deploying {product-title} on user-provisioned infrastructure. include::modules/installation-machine-requirements.adoc[leveloffset=+2] + include::modules/installation-minimum-resource-requirements.adoc[leveloffset=+2] [role="_additional-resources"] @@ -130,7 +131,9 @@ include::modules/installation-bare-metal-config-yaml.adoc[leveloffset=+2] // Network Operator specific configuration include::modules/nw-network-config.adoc[leveloffset=+1] + include::modules/nw-modifying-operator-install-config.adoc[leveloffset=+1] + include::modules/nw-operator-cr.adoc[leveloffset=+1] include::modules/installation-generate-ignition-configs.adoc[leveloffset=+1] @@ -162,6 +165,7 @@ include::modules/installation-user-infra-machines-advanced-customizing-live-netw include::modules/installation-user-infra-machines-advanced-customizing-live-iscsi-manual.adoc[leveloffset=+4] include::modules/installation-user-infra-machines-advanced-customizing-live-iscsi-ibft.adoc[leveloffset=+4] + :boot-media!: :boot!: @@ -178,6 +182,7 @@ include::modules/installation-user-infra-machines-advanced-customizing-live-netw include::modules/installation-user-infra-machines-advanced-customizing-live-iscsi-manual.adoc[leveloffset=+4] include::modules/installation-user-infra-machines-advanced-customizing-live-iscsi-ibft.adoc[leveloffset=+4] + :boot-media!: :boot!: diff --git a/installing/installing_bare_metal/upi/installing-bare-metal.adoc b/installing/installing_bare_metal/upi/installing-bare-metal.adoc index dcd851d29d..c191111405 100644 --- a/installing/installing_bare_metal/upi/installing-bare-metal.adoc +++ b/installing/installing_bare_metal/upi/installing-bare-metal.adoc @@ -45,6 +45,7 @@ of the required machines. This section describes the requirements for deploying {product-title} on user-provisioned infrastructure. include::modules/installation-machine-requirements.adoc[leveloffset=+2] + include::modules/installation-minimum-resource-requirements.adoc[leveloffset=+2] [role="_additional-resources"] @@ -189,6 +190,7 @@ include::modules/installation-user-infra-machines-advanced-customizing-live-netw include::modules/installation-user-infra-machines-advanced-customizing-live-iscsi-manual.adoc[leveloffset=+4] include::modules/installation-user-infra-machines-advanced-customizing-live-iscsi-ibft.adoc[leveloffset=+4] + :boot-media!: :boot!: @@ -205,6 +207,7 @@ include::modules/installation-user-infra-machines-advanced-customizing-live-netw include::modules/installation-user-infra-machines-advanced-customizing-live-iscsi-manual.adoc[leveloffset=+4] include::modules/installation-user-infra-machines-advanced-customizing-live-iscsi-ibft.adoc[leveloffset=+4] + :boot-media!: :boot!: diff --git a/installing/installing_bare_metal/upi/installing-restricted-networks-bare-metal.adoc b/installing/installing_bare_metal/upi/installing-restricted-networks-bare-metal.adoc index a121cb919d..0e4d27a350 100644 --- a/installing/installing_bare_metal/upi/installing-restricted-networks-bare-metal.adoc +++ b/installing/installing_bare_metal/upi/installing-restricted-networks-bare-metal.adoc @@ -49,6 +49,7 @@ of the required machines. This section describes the requirements for deploying {product-title} on user-provisioned infrastructure. include::modules/installation-machine-requirements.adoc[leveloffset=+2] + include::modules/installation-minimum-resource-requirements.adoc[leveloffset=+2] [role="_additional-resources"] @@ -183,6 +184,7 @@ include::modules/installation-user-infra-machines-advanced-customizing-live-netw include::modules/installation-user-infra-machines-advanced-customizing-live-iscsi-manual.adoc[leveloffset=+4] include::modules/installation-user-infra-machines-advanced-customizing-live-iscsi-ibft.adoc[leveloffset=+4] + :boot-media!: :boot!: @@ -199,6 +201,7 @@ include::modules/installation-user-infra-machines-advanced-customizing-live-netw include::modules/installation-user-infra-machines-advanced-customizing-live-iscsi-manual.adoc[leveloffset=+4] include::modules/installation-user-infra-machines-advanced-customizing-live-iscsi-ibft.adoc[leveloffset=+4] + :boot-media!: :boot!: diff --git a/installing/installing_bare_metal/upi/scaling-a-user-provisioned-cluster-with-the-bare-metal-operator.adoc b/installing/installing_bare_metal/upi/scaling-a-user-provisioned-cluster-with-the-bare-metal-operator.adoc index e7b8f356c3..50b9265107 100644 --- a/installing/installing_bare_metal/upi/scaling-a-user-provisioned-cluster-with-the-bare-metal-operator.adoc +++ b/installing/installing_bare_metal/upi/scaling-a-user-provisioned-cluster-with-the-bare-metal-operator.adoc @@ -9,9 +9,13 @@ toc::[] After deploying a user-provisioned infrastructure cluster, you can use the Bare Metal Operator (BMO) and other metal^3^ components to scale bare-metal hosts in the cluster. This approach helps you to scale a user-provisioned cluster in a more automated way. include::modules/about-scaling-a-user-provisioned-installation-with-the-bare-metal-operator.adoc[leveloffset=+1] + include::modules/upi-prerequisites-for-scaling-a-upi-cluster.adoc[leveloffset=+2] + include::modules/upi-limitations-for-scaling-a-upi-cluster.adoc[leveloffset=+2] + include::modules/configuring-a-provisioning-resource-to-scale-user-provisioned-clusters.adoc[leveloffset=+1] + include::modules/upi-provisioning-new-hosts-in-a-upi-cluster.adoc[leveloffset=+1] [role="_additional-resources"] diff --git a/installing/installing_gcp/installing-gcp-user-infra-vpc.adoc b/installing/installing_gcp/installing-gcp-user-infra-vpc.adoc index 124180047e..4ebbf4c921 100644 --- a/installing/installing_gcp/installing-gcp-user-infra-vpc.adoc +++ b/installing/installing_gcp/installing-gcp-user-infra-vpc.adoc @@ -43,11 +43,17 @@ include::modules/cluster-entitlements.adoc[leveloffset=+1] Before you can install {product-title}, you must configure a {gcp-full} project to host it. include::modules/installation-gcp-project.adoc[leveloffset=+2] + include::modules/installation-gcp-enabling-api-services.adoc[leveloffset=+2] + include::modules/installation-gcp-limits.adoc[leveloffset=+2] + include::modules/installation-gcp-service-account.adoc[leveloffset=+2] + include::modules/installation-gcp-permissions.adoc[leveloffset=+3] + include::modules/installation-gcp-regions.adoc[leveloffset=+2] + include::modules/installation-gcp-install-cli.adoc[leveloffset=+2] [id="installation-requirements-user-infra_{context}"] @@ -59,6 +65,7 @@ of the required machines. This section describes the requirements for deploying {product-title} on user-provisioned infrastructure. include::modules/installation-machine-requirements.adoc[leveloffset=+2] + include::modules/installation-minimum-resource-requirements.adoc[leveloffset=+2] [role="_additional-resources"] @@ -67,11 +74,15 @@ include::modules/installation-minimum-resource-requirements.adoc[leveloffset=+2] * xref:../../scalability_and_performance/optimization/optimizing-storage.adoc#optimizing-storage[Optimizing storage] include::modules/installation-gcp-tested-machine-types.adoc[leveloffset=+2] + include::modules/installation-using-gcp-custom-machine-types.adoc[leveloffset=+2] include::modules/installation-gcp-user-infra-config-host-project-vpc.adoc[leveloffset=+1] + include::modules/installation-gcp-dns.adoc[leveloffset=+2] + include::modules/installation-creating-gcp-vpc.adoc[leveloffset=+2] + include::modules/installation-deployment-manager-vpc.adoc[leveloffset=+3] include::modules/installation-user-infra-generate.adoc[leveloffset=+1] @@ -83,6 +94,7 @@ include::modules/installation-initializing-manual.adoc[leveloffset=+2] * xref:../../installing/installing_gcp/installation-config-parameters-gcp.adoc#installation-config-parameters-gcp[Installation configuration parameters for {gcp-short}] include::modules/installation-gcp-enabling-shielded-vms.adoc[leveloffset=+2] + include::modules/installation-gcp-enabling-confidential-vms.adoc[leveloffset=+2] [role="_additional-resources"] @@ -106,35 +118,44 @@ include::modules/installation-user-infra-generate-k8s-manifest-ignition.adoc[lev == Exporting common variables include::modules/installation-extracting-infraid.adoc[leveloffset=+2] + include::modules/installation-user-infra-exporting-common-variables.adoc[leveloffset=+2] include::modules/installation-network-user-infra.adoc[leveloffset=+1] include::modules/installation-creating-gcp-lb.adoc[leveloffset=+1] + include::modules/installation-deployment-manager-ext-lb.adoc[leveloffset=+2] + include::modules/installation-deployment-manager-int-lb.adoc[leveloffset=+2] include::modules/installation-creating-gcp-private-dns.adoc[leveloffset=+1] + include::modules/installation-deployment-manager-private-dns.adoc[leveloffset=+2] include::modules/installation-creating-gcp-firewall-rules-vpc.adoc[leveloffset=+1] + include::modules/installation-deployment-manager-firewall-rules.adoc[leveloffset=+2] include::modules/installation-creating-gcp-iam-shared-vpc.adoc[leveloffset=+1] + include::modules/installation-deployment-manager-iam-shared-vpc.adoc[leveloffset=+2] include::modules/installation-gcp-user-infra-rhcos.adoc[leveloffset=+1] include::modules/installation-creating-gcp-bootstrap.adoc[leveloffset=+1] + include::modules/installation-deployment-manager-bootstrap.adoc[leveloffset=+2] include::modules/installation-creating-gcp-control-plane.adoc[leveloffset=+1] + include::modules/installation-deployment-manager-control-plane.adoc[leveloffset=+2] // Removing bootstrap resources in GCP include::modules/installation-gcp-user-infra-wait-for-bootstrap.adoc[leveloffset=+1] include::modules/installation-creating-gcp-worker.adoc[leveloffset=+1] + include::modules/installation-deployment-manager-worker.adoc[leveloffset=+2] include::modules/cli-installing-cli.adoc[leveloffset=+1] diff --git a/installing/installing_gcp/installing-gcp-user-infra.adoc b/installing/installing_gcp/installing-gcp-user-infra.adoc index 27465e0305..640ae0d481 100644 --- a/installing/installing_gcp/installing-gcp-user-infra.adoc +++ b/installing/installing_gcp/installing-gcp-user-infra.adoc @@ -38,11 +38,17 @@ include::modules/cluster-entitlements.adoc[leveloffset=+1] Before you can install {product-title}, you must configure a {gcp-first} project to host it. include::modules/installation-gcp-project.adoc[leveloffset=+2] + include::modules/installation-gcp-enabling-api-services.adoc[leveloffset=+2] + include::modules/installation-gcp-dns.adoc[leveloffset=+2] + include::modules/installation-gcp-limits.adoc[leveloffset=+2] + include::modules/installation-gcp-service-account.adoc[leveloffset=+2] + include::modules/installation-gcp-permissions.adoc[leveloffset=+2] + include::modules/minimum-required-permissions-upi-gcp.adoc[leveloffset=+2] [role="_additional-resources"] @@ -51,6 +57,7 @@ include::modules/minimum-required-permissions-upi-gcp.adoc[leveloffset=+2] * xref:../../scalability_and_performance/optimization/optimizing-storage.adoc#optimizing-storage[Optimizing storage] include::modules/installation-gcp-regions.adoc[leveloffset=+2] + include::modules/installation-gcp-install-cli.adoc[leveloffset=+2] [id="installation-requirements-user-infra_{context}"] @@ -62,6 +69,7 @@ of the required machines. This section describes the requirements for deploying {product-title} on user-provisioned infrastructure. include::modules/installation-machine-requirements.adoc[leveloffset=+2] + include::modules/installation-minimum-resource-requirements.adoc[leveloffset=+2] [role="_additional-resources"] @@ -70,11 +78,15 @@ include::modules/installation-minimum-resource-requirements.adoc[leveloffset=+2] * xref:../../scalability_and_performance/optimization/optimizing-storage.adoc#optimizing-storage[Optimizing storage] include::modules/installation-gcp-tested-machine-types.adoc[leveloffset=+2] + include::modules/installation-gcp-tested-machine-types-arm.adoc[leveloffset=+2] + include::modules/installation-using-gcp-custom-machine-types.adoc[leveloffset=+2] include::modules/installation-user-infra-generate.adoc[leveloffset=+1] + include::modules/installation-disk-partitioning-upi-templates.adoc[leveloffset=+2] + include::modules/installation-initializing.adoc[leveloffset=+2] [role="_additional-resources"] @@ -82,6 +94,7 @@ include::modules/installation-initializing.adoc[leveloffset=+2] * xref:../../installing/installing_gcp/installation-config-parameters-gcp.adoc#installation-config-parameters-gcp[Installation configuration parameters for {gcp-short}] include::modules/installation-gcp-enabling-shielded-vms.adoc[leveloffset=+2] + include::modules/installation-gcp-enabling-confidential-vms.adoc[leveloffset=+2] [role="_additional-resources"] @@ -89,6 +102,7 @@ include::modules/installation-gcp-enabling-confidential-vms.adoc[leveloffset=+2] * xref:../../installing/installing_gcp/installation-config-parameters-gcp.adoc#installation-configuration-parameters-additional-gcp_installation-config-parameters-gcp[Additional {gcp-first} configuration parameters] include::modules/installation-configure-proxy.adoc[leveloffset=+2] + //include::modules/installation-three-node-cluster.adoc[leveloffset=+2] include::modules/installation-user-infra-generate-k8s-manifest-ignition.adoc[leveloffset=+2] @@ -101,38 +115,48 @@ include::modules/installation-user-infra-generate-k8s-manifest-ignition.adoc[lev == Exporting common variables include::modules/installation-extracting-infraid.adoc[leveloffset=+2] + include::modules/installation-user-infra-exporting-common-variables.adoc[leveloffset=+2] include::modules/installation-creating-gcp-vpc.adoc[leveloffset=+1] + include::modules/installation-deployment-manager-vpc.adoc[leveloffset=+2] include::modules/installation-network-user-infra.adoc[leveloffset=+1] include::modules/installation-creating-gcp-lb.adoc[leveloffset=+1] + include::modules/installation-deployment-manager-ext-lb.adoc[leveloffset=+2] + include::modules/installation-deployment-manager-int-lb.adoc[leveloffset=+2] include::modules/installation-creating-gcp-private-dns.adoc[leveloffset=+1] + include::modules/installation-deployment-manager-private-dns.adoc[leveloffset=+2] include::modules/installation-creating-gcp-firewall-rules-vpc.adoc[leveloffset=+1] + include::modules/installation-deployment-manager-firewall-rules.adoc[leveloffset=+2] include::modules/installation-creating-gcp-iam-shared-vpc.adoc[leveloffset=+1] + include::modules/installation-deployment-manager-iam-shared-vpc.adoc[leveloffset=+2] include::modules/installation-gcp-user-infra-rhcos.adoc[leveloffset=+1] include::modules/installation-creating-gcp-bootstrap.adoc[leveloffset=+1] + include::modules/installation-deployment-manager-bootstrap.adoc[leveloffset=+2] include::modules/installation-creating-gcp-control-plane.adoc[leveloffset=+1] + include::modules/installation-deployment-manager-control-plane.adoc[leveloffset=+2] // Removing bootstrap resources in GCP include::modules/installation-gcp-user-infra-wait-for-bootstrap.adoc[leveloffset=+1] include::modules/installation-creating-gcp-worker.adoc[leveloffset=+1] + include::modules/installation-deployment-manager-worker.adoc[leveloffset=+2] include::modules/cli-installing-cli.adoc[leveloffset=+1] diff --git a/installing/installing_gcp/installing-restricted-networks-gcp.adoc b/installing/installing_gcp/installing-restricted-networks-gcp.adoc index f88f4d2f46..619e83da20 100644 --- a/installing/installing_gcp/installing-restricted-networks-gcp.adoc +++ b/installing/installing_gcp/installing-restricted-networks-gcp.adoc @@ -44,11 +44,17 @@ include::modules/cluster-entitlements.adoc[leveloffset=+1] Before you can install {product-title}, you must configure a {gcp-first} project to host it. include::modules/installation-gcp-project.adoc[leveloffset=+2] + include::modules/installation-gcp-enabling-api-services.adoc[leveloffset=+2] + include::modules/installation-gcp-dns.adoc[leveloffset=+2] + include::modules/installation-gcp-limits.adoc[leveloffset=+2] + include::modules/installation-gcp-service-account.adoc[leveloffset=+2] + include::modules/installation-gcp-permissions.adoc[leveloffset=+2] + include::modules/minimum-required-permissions-upi-gcp.adoc[leveloffset=+2] [role="_additional-resources"] @@ -57,6 +63,7 @@ include::modules/minimum-required-permissions-upi-gcp.adoc[leveloffset=+2] * xref:../../scalability_and_performance/optimization/optimizing-storage.adoc#optimizing-storage[Optimizing storage] include::modules/installation-gcp-regions.adoc[leveloffset=+2] + include::modules/installation-gcp-install-cli.adoc[leveloffset=+2] [id="installation-requirements-user-infra_{context}"] @@ -68,12 +75,17 @@ of the required machines. This section describes the requirements for deploying {product-title} on user-provisioned infrastructure. include::modules/installation-machine-requirements.adoc[leveloffset=+2] + include::modules/installation-minimum-resource-requirements.adoc[leveloffset=+2] + include::modules/installation-gcp-tested-machine-types.adoc[leveloffset=+2] + include::modules/installation-using-gcp-custom-machine-types.adoc[leveloffset=+2] include::modules/installation-user-infra-generate.adoc[leveloffset=+1] + include::modules/installation-disk-partitioning-upi-templates.adoc[leveloffset=+2] + include::modules/installation-initializing.adoc[leveloffset=+2] [role="_additional-resources"] @@ -81,6 +93,7 @@ include::modules/installation-initializing.adoc[leveloffset=+2] * xref:../../installing/installing_gcp/installation-config-parameters-gcp.adoc#installation-config-parameters-gcp[Installation configuration parameters for {gcp-short}] include::modules/installation-gcp-enabling-shielded-vms.adoc[leveloffset=+2] + include::modules/installation-gcp-enabling-confidential-vms.adoc[leveloffset=+2] [role="_additional-resources"] @@ -88,6 +101,7 @@ include::modules/installation-gcp-enabling-confidential-vms.adoc[leveloffset=+2] * xref:../../installing/installing_gcp/installation-config-parameters-gcp.adoc#installation-configuration-parameters-additional-gcp_installation-config-parameters-gcp[Additional {gcp-first} configuration parameters] include::modules/installation-configure-proxy.adoc[leveloffset=+2] + include::modules/installation-user-infra-generate-k8s-manifest-ignition.adoc[leveloffset=+2] [role="_additional-resources"] @@ -99,37 +113,47 @@ include::modules/installation-user-infra-generate-k8s-manifest-ignition.adoc[lev == Exporting common variables include::modules/installation-extracting-infraid.adoc[leveloffset=+2] + include::modules/installation-user-infra-exporting-common-variables.adoc[leveloffset=+2] include::modules/installation-creating-gcp-vpc.adoc[leveloffset=+1] + include::modules/installation-deployment-manager-vpc.adoc[leveloffset=+2] include::modules/installation-network-user-infra.adoc[leveloffset=+1] include::modules/installation-creating-gcp-lb.adoc[leveloffset=+1] + include::modules/installation-deployment-manager-ext-lb.adoc[leveloffset=+2] + include::modules/installation-deployment-manager-int-lb.adoc[leveloffset=+2] include::modules/installation-creating-gcp-private-dns.adoc[leveloffset=+1] + include::modules/installation-deployment-manager-private-dns.adoc[leveloffset=+2] include::modules/installation-creating-gcp-firewall-rules-vpc.adoc[leveloffset=+1] + include::modules/installation-deployment-manager-firewall-rules.adoc[leveloffset=+2] include::modules/installation-creating-gcp-iam-shared-vpc.adoc[leveloffset=+1] + include::modules/installation-deployment-manager-iam-shared-vpc.adoc[leveloffset=+2] include::modules/installation-gcp-user-infra-rhcos.adoc[leveloffset=+1] include::modules/installation-creating-gcp-bootstrap.adoc[leveloffset=+1] + include::modules/installation-deployment-manager-bootstrap.adoc[leveloffset=+2] include::modules/installation-creating-gcp-control-plane.adoc[leveloffset=+1] + include::modules/installation-deployment-manager-control-plane.adoc[leveloffset=+2] include::modules/installation-gcp-user-infra-wait-for-bootstrap.adoc[leveloffset=+1] include::modules/installation-creating-gcp-worker.adoc[leveloffset=+1] + include::modules/installation-deployment-manager-worker.adoc[leveloffset=+2] //You install the CLI on the mirror host. diff --git a/installing/installing_ibm_cloud/installing-ibm-cloud-account.adoc b/installing/installing_ibm_cloud/installing-ibm-cloud-account.adoc index 4184dc80a2..fd3a6f3e53 100644 --- a/installing/installing_ibm_cloud/installing-ibm-cloud-account.adoc +++ b/installing/installing_ibm_cloud/installing-ibm-cloud-account.adoc @@ -24,9 +24,11 @@ How you configure DNS resolution depends on the type of {product-title} cluster * If you are installing a private cluster, you use {ibm-cloud-name} DNS Services (DNS Services) include::modules/installation-cis-ibm-cloud.adoc[leveloffset=+2] + include::modules/installation-dns-ibm-cloud.adoc[leveloffset=+2] include::modules/installation-ibm-cloud-iam-policies-api-key.adoc[leveloffset=+1] + include::modules/installation-ibm-cloud-creating-api-key.adoc[leveloffset=+2] include::modules/installation-ibm-cloud-regions.adoc[leveloffset=+1] diff --git a/installing/installing_ibm_cloud/installing-ibm-cloud-customizations.adoc b/installing/installing_ibm_cloud/installing-ibm-cloud-customizations.adoc index af41a02575..af9366f3cb 100644 --- a/installing/installing_ibm_cloud/installing-ibm-cloud-customizations.adoc +++ b/installing/installing_ibm_cloud/installing-ibm-cloud-customizations.adoc @@ -57,7 +57,9 @@ include::modules/manually-create-iam-ibm-cloud.adoc[leveloffset=+1] // Network Operator specific configuration include::modules/nw-network-config.adoc[leveloffset=+1] + include::modules/nw-modifying-operator-install-config.adoc[leveloffset=+1] + include::modules/nw-operator-cr.adoc[leveloffset=+1] include::modules/installation-launching-installer.adoc[leveloffset=+1] diff --git a/installing/installing_ibm_cloud/installing-ibm-cloud-network-customizations.adoc b/installing/installing_ibm_cloud/installing-ibm-cloud-network-customizations.adoc index 2aa9265ee9..6aed25bb9f 100644 --- a/installing/installing_ibm_cloud/installing-ibm-cloud-network-customizations.adoc +++ b/installing/installing_ibm_cloud/installing-ibm-cloud-network-customizations.adoc @@ -55,7 +55,9 @@ include::modules/manually-create-iam-ibm-cloud.adoc[leveloffset=+1] // Network Operator specific configuration include::modules/nw-network-config.adoc[leveloffset=+1] + include::modules/nw-modifying-operator-install-config.adoc[leveloffset=+1] + include::modules/nw-operator-cr.adoc[leveloffset=+1] include::modules/installation-launching-installer.adoc[leveloffset=+1] diff --git a/installing/installing_ibm_cloud/installing-ibm-cloud-restricted.adoc b/installing/installing_ibm_cloud/installing-ibm-cloud-restricted.adoc index 12dffb5c82..7190e29045 100644 --- a/installing/installing_ibm_cloud/installing-ibm-cloud-restricted.adoc +++ b/installing/installing_ibm_cloud/installing-ibm-cloud-restricted.adoc @@ -34,6 +34,7 @@ include::modules/installation-about-restricted-network.adoc[leveloffset=+1] * xref:../../installing/installing_ibm_cloud/installation-config-parameters-ibm-cloud-vpc.adoc#installation-configuration-parameters-additional-ibm-cloud_installation-config-parameters-ibm-cloud-vpc[Additional {ibm-cloud-title} configuration parameters] include::modules/installation-custom-ibm-cloud-vpc.adoc[leveloffset=+1] + include::modules/installation-ibm-cloud-configure-vpc-for-endpoint-gateways.adoc[leveloffset=+2] include::modules/ssh-agent-using.adoc[leveloffset=+1] @@ -73,6 +74,7 @@ include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1] Complete the following steps to complete the configuration of your cluster. include::modules/olm-restricted-networks-configuring-operatorhub.adoc[leveloffset=+2] + include::modules/oc-mirror-updating-restricted-cluster-manifests.adoc[leveloffset=+2] include::modules/cluster-telemetry.adoc[leveloffset=+1] diff --git a/installing/installing_ibm_power/installing-ibm-power.adoc b/installing/installing_ibm_power/installing-ibm-power.adoc index 83293d7e08..705758f258 100644 --- a/installing/installing_ibm_power/installing-ibm-power.adoc +++ b/installing/installing_ibm_power/installing-ibm-power.adoc @@ -39,6 +39,7 @@ of the required machines. This section describes the requirements for deploying {product-title} on user-provisioned infrastructure. include::modules/installation-machine-requirements.adoc[leveloffset=+2] + include::modules/installation-minimum-resource-requirements.adoc[leveloffset=+2] [role="_additional-resources"] @@ -47,7 +48,9 @@ include::modules/installation-minimum-resource-requirements.adoc[leveloffset=+2] * xref:../../scalability_and_performance/optimization/optimizing-storage.adoc#optimizing-storage[Optimizing storage] include::modules/minimum-ibm-power-system-requirements.adoc[leveloffset=+2] + include::modules/recommended-ibm-power-system-requirements.adoc[leveloffset=+2] + include::modules/csr-management.adoc[leveloffset=+2] include::modules/installation-network-user-infra.adoc[leveloffset=+2] diff --git a/installing/installing_ibm_power/installing-restricted-networks-ibm-power.adoc b/installing/installing_ibm_power/installing-restricted-networks-ibm-power.adoc index b5c0b89744..f57b765830 100644 --- a/installing/installing_ibm_power/installing-restricted-networks-ibm-power.adoc +++ b/installing/installing_ibm_power/installing-restricted-networks-ibm-power.adoc @@ -47,6 +47,7 @@ of the required machines. This section describes the requirements for deploying {product-title} on user-provisioned infrastructure. include::modules/installation-machine-requirements.adoc[leveloffset=+2] + include::modules/installation-minimum-resource-requirements.adoc[leveloffset=+2] [role="_additional-resources"] @@ -55,7 +56,9 @@ include::modules/installation-minimum-resource-requirements.adoc[leveloffset=+2] * xref:../../scalability_and_performance/optimization/optimizing-storage.adoc#optimizing-storage[Optimizing storage] include::modules/minimum-ibm-power-system-requirements.adoc[leveloffset=+2] + include::modules/recommended-ibm-power-system-requirements.adoc[leveloffset=+2] + include::modules/csr-management.adoc[leveloffset=+2] include::modules/installation-network-user-infra.adoc[leveloffset=+2] diff --git a/installing/installing_ibm_z/upi/installing-ibm-z-reqs.adoc b/installing/installing_ibm_z/upi/installing-ibm-z-reqs.adoc index 7d14c4dec4..55f925fa20 100644 --- a/installing/installing_ibm_z/upi/installing-ibm-z-reqs.adoc +++ b/installing/installing_ibm_z/upi/installing-ibm-z-reqs.adoc @@ -11,6 +11,7 @@ Before you begin an installation on {ibm-z-name} infrastructure, be sure that yo For a cluster that contains user-provisioned infrastructure, you must deploy all of the required machines. include::modules/installation-machine-requirements.adoc[leveloffset=+1] + include::modules/installation-minimum-resource-requirements.adoc[leveloffset=+2] [role="_additional-resources"] @@ -29,6 +30,7 @@ include::modules/installation-minimum-resource-requirements.adoc[leveloffset=+2] * xref:../../../scalability_and_performance/ibm-z-recommended-host-practices.adoc#ibm-z-recommended-host-practices[Recommended host practices for {ibm-z-name} & {ibm-linuxone-name} environments] include::modules/installation-requirements-ibm-z.adoc[leveloffset=+2] + include::modules/preferred-installation-requirements-ibm-z.adoc[leveloffset=+2] [role="_additional-resources"] @@ -46,4 +48,5 @@ include::modules/installation-network-user-infra.adoc[leveloffset=+2] * xref:../../../installing/install_config/installing-customizing.adoc#installation-special-config-chrony_installing-customizing[Configuring chrony time service] include::modules/installation-dns-user-infra.adoc[leveloffset=+2] + include::modules/installation-load-balancing-user-infra.adoc[leveloffset=+2] \ No newline at end of file diff --git a/installing/installing_nutanix/installing-nutanix-installer-provisioned.adoc b/installing/installing_nutanix/installing-nutanix-installer-provisioned.adoc index e8ca84557c..0097f838e0 100644 --- a/installing/installing_nutanix/installing-nutanix-installer-provisioned.adoc +++ b/installing/installing_nutanix/installing-nutanix-installer-provisioned.adoc @@ -47,7 +47,9 @@ include::modules/installation-initializing.adoc[leveloffset=+1] * xref:../../installing/installing_nutanix/installation-config-parameters-nutanix.adoc#installation-config-parameters-nutanix[Installation configuration parameters for Nutanix] include::modules/installation-nutanix-config-yaml.adoc[leveloffset=+2] + include::modules/installation-configuring-nutanix-failure-domains.adoc[leveloffset=+2] + include::modules/installation-configure-proxy.adoc[leveloffset=+2] include::modules/cli-installing-cli.adoc[leveloffset=+1] diff --git a/installing/installing_nutanix/installing-restricted-networks-nutanix-installer-provisioned.adoc b/installing/installing_nutanix/installing-restricted-networks-nutanix-installer-provisioned.adoc index c6bbb02af3..56e8814a60 100644 --- a/installing/installing_nutanix/installing-restricted-networks-nutanix-installer-provisioned.adoc +++ b/installing/installing_nutanix/installing-restricted-networks-nutanix-installer-provisioned.adoc @@ -46,7 +46,9 @@ include::modules/installation-initializing.adoc[leveloffset=+1] * xref:../../installing/installing_nutanix/installation-config-parameters-nutanix.adoc#installation-config-parameters-nutanix[Installation configuration parameters for Nutanix] include::modules/installation-nutanix-config-yaml.adoc[leveloffset=+2] + include::modules/installation-configuring-nutanix-failure-domains.adoc[leveloffset=+2] + include::modules/installation-configure-proxy.adoc[leveloffset=+2] include::modules/cli-installing-cli.adoc[leveloffset=+1] @@ -59,6 +61,7 @@ include::modules/installation-launching-installer.adoc[leveloffset=+1] Complete the following steps to complete the configuration of your cluster. include::modules/olm-restricted-networks-configuring-operatorhub.adoc[leveloffset=+2] + include::modules/oc-mirror-updating-restricted-cluster-manifests.adoc[leveloffset=+2] [role="_additional-resources"] diff --git a/installing/installing_nutanix/preparing-to-install-on-nutanix.adoc b/installing/installing_nutanix/preparing-to-install-on-nutanix.adoc index b87b8f3ab9..9d329c55ea 100644 --- a/installing/installing_nutanix/preparing-to-install-on-nutanix.adoc +++ b/installing/installing_nutanix/preparing-to-install-on-nutanix.adoc @@ -17,7 +17,9 @@ You can install an {product-title} cluster on Nutanix by using the Agent-based I For example, the Agent-based Installer can be used to install a three-node cluster, which is a smaller, more resource efficient cluster for testing, development, and production. See xref:../../installing/installing_with_agent_based_installer/preparing-to-install-with-agent-based-installer.adoc#preparing-to-install-with-agent-based-installer[Preparing to install with the Agent-based Installer] for additional details. include::modules/installation-nutanix-installer-infra-reqs.adoc[leveloffset=+1] + include::modules/cco-ccoctl-configuring.adoc[leveloffset=+1] + [role="_additional-resources"] .Additional resources * xref:../../updating/preparing_for_updates/preparing-manual-creds-update.adoc#preparing-manual-creds-update[Preparing to update a cluster with manually maintained credentials] \ No newline at end of file diff --git a/installing/installing_openstack/installing-openstack-cloud-config-reference.adoc b/installing/installing_openstack/installing-openstack-cloud-config-reference.adoc index cf3b448b96..85f81242fd 100644 --- a/installing/installing_openstack/installing-openstack-cloud-config-reference.adoc +++ b/installing/installing_openstack/installing-openstack-cloud-config-reference.adoc @@ -7,4 +7,5 @@ include::_attributes/common-attributes.adoc[] toc::[] include::modules/nw-openstack-external-ccm.adoc[leveloffset=+1] + include::modules/cluster-cloud-controller-config-osp.adoc[leveloffset=+1] diff --git a/installing/installing_openstack/installing-openstack-installer-custom.adoc b/installing/installing_openstack/installing-openstack-installer-custom.adoc index 6621b6f030..cb2ed87495 100644 --- a/installing/installing_openstack/installing-openstack-installer-custom.adoc +++ b/installing/installing_openstack/installing-openstack-installer-custom.adoc @@ -19,16 +19,27 @@ In {product-title} version {product-version}, you can install a customized clust * You have the metadata service enabled in {rh-openstack}. include::modules/installation-osp-default-deployment.adoc[leveloffset=+1] + include::modules/installation-osp-control-compute-machines.adoc[leveloffset=+2] + include::modules/installation-osp-bootstrap-machine.adoc[leveloffset=+2] + include::modules/installation-load-balancing-user-infra.adoc[leveloffset=+2] + include::modules/cluster-entitlements.adoc[leveloffset=+1] + include::modules/installation-osp-enabling-swift.adoc[leveloffset=+1] + include::modules/installation-registry-osp-creating-custom-pvc.adoc[leveloffset=+1] + include::modules/installation-osp-verifying-external-network.adoc[leveloffset=+1] + include::modules/installation-osp-describing-cloud-parameters.adoc[leveloffset=+1] + include::modules/installation-osp-setting-cloud-provider-options.adoc[leveloffset=+1] + include::modules/installation-obtaining-installer.adoc[leveloffset=+1] + include::modules/installation-initializing.adoc[leveloffset=+1] [role="_additional-resources"] @@ -36,10 +47,15 @@ include::modules/installation-initializing.adoc[leveloffset=+1] * xref:../../installing/installing_openstack/installation-config-parameters-openstack.adoc#installation-config-parameters-openstack[Installation configuration parameters for OpenStack] include::modules/installation-configure-proxy.adoc[leveloffset=+2] + include::modules/installation-osp-custom-subnet.adoc[leveloffset=+2] + include::modules/installation-osp-deploying-bare-metal-machines.adoc[leveloffset=+2] + include::modules/installation-osp-provider-networks.adoc[leveloffset=+2] + include::modules/installation-osp-provider-network-preparation.adoc[leveloffset=+3] + include::modules/installation-osp-deploying-provider-networks-installer.adoc[leveloffset=+3] [TIP] @@ -54,7 +70,9 @@ include::modules/installation-osp-config-yaml.adoc[leveloffset=+2] //Dual-stack networking include::modules/install-osp-dualstack.adoc[leveloffset=+2] + include::modules/install-osp-deploy-dualstack.adoc[leveloffset=+3] + include::modules/installation-configuring-shiftstack-single-ipv6.adoc[leveloffset=+2] [role="_additional-resources"] @@ -62,13 +80,20 @@ include::modules/installation-configuring-shiftstack-single-ipv6.adoc[leveloffse * See xref:../../disconnected/installing-mirroring-creating-registry.adoc#installing-mirroring-creating-registry[Creating a mirror registry with mirror registry for Red Hat OpenShift] include::modules/installation-osp-external-lb-config.adoc[leveloffset=+2] + // include::modules/installation-osp-setting-worker-affinity.adoc[leveloffset=+1] include::modules/ssh-agent-using.adoc[leveloffset=+1] + include::modules/installation-osp-accessing-api.adoc[leveloffset=+1] + include::modules/installation-osp-accessing-api-floating.adoc[leveloffset=+2] + include::modules/installation-osp-accessing-api-no-floating.adoc[leveloffset=+2] + include::modules/installation-launching-installer.adoc[leveloffset=+1] + include::modules/installation-osp-verifying-cluster-status.adoc[leveloffset=+1] + include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1] [role="_additional-resources"] diff --git a/installing/installing_openstack/installing-openstack-installer-restricted.adoc b/installing/installing_openstack/installing-openstack-installer-restricted.adoc index fe352e51bf..6db0dc3f97 100644 --- a/installing/installing_openstack/installing-openstack-installer-restricted.adoc +++ b/installing/installing_openstack/installing-openstack-installer-restricted.adoc @@ -24,14 +24,23 @@ Because the installation media is on the mirror host, you can use that computer * You have the metadata service enabled in {rh-openstack}. include::modules/installation-about-restricted-network.adoc[leveloffset=+1] + include::modules/installation-osp-default-deployment.adoc[leveloffset=+1] + include::modules/installation-osp-control-compute-machines.adoc[leveloffset=+2] + include::modules/installation-osp-bootstrap-machine.adoc[leveloffset=+2] + include::modules/cluster-entitlements.adoc[leveloffset=+1] + include::modules/installation-osp-enabling-swift.adoc[leveloffset=+1] + include::modules/installation-osp-describing-cloud-parameters.adoc[leveloffset=+1] + include::modules/installation-osp-setting-cloud-provider-options.adoc[leveloffset=+1] + include::modules/installation-creating-image-restricted.adoc[leveloffset=+1] + include::modules/installation-initializing.adoc[leveloffset=+1] [role="_additional-resources"] @@ -39,14 +48,22 @@ include::modules/installation-initializing.adoc[leveloffset=+1] * xref:../../installing/installing_openstack/installation-config-parameters-openstack.adoc#installation-config-parameters-openstack[Installation configuration parameters for OpenStack] include::modules/installation-configure-proxy.adoc[leveloffset=+2] + include::modules/installation-osp-restricted-config-yaml.adoc[leveloffset=+2] + // include::modules/installation-osp-setting-worker-affinity.adoc[leveloffset=+1] include::modules/ssh-agent-using.adoc[leveloffset=+1] + include::modules/installation-osp-accessing-api.adoc[leveloffset=+1] + include::modules/installation-osp-accessing-api-floating.adoc[leveloffset=+2] + include::modules/installation-osp-accessing-api-no-floating.adoc[leveloffset=+2] + include::modules/installation-launching-installer.adoc[leveloffset=+1] + include::modules/installation-osp-verifying-cluster-status.adoc[leveloffset=+1] + include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1] [role="_additional-resources"] diff --git a/installing/installing_openstack/installing-openstack-network-config.adoc b/installing/installing_openstack/installing-openstack-network-config.adoc index 5c93ec2cd5..3e8c19e14f 100644 --- a/installing/installing_openstack/installing-openstack-network-config.adoc +++ b/installing/installing_openstack/installing-openstack-network-config.adoc @@ -10,8 +10,13 @@ toc::[] You can configure network settings for an {product-title} on {rh-openstack-first} cluster after installation. include::modules/installation-osp-configuring-api-floating-ip.adoc[leveloffset=+1] + include::modules/nw-osp-enabling-ovs-offload.adoc[leveloffset=+1] + include::modules/nw-osp-hardware-offload-attaching-network.adoc[leveloffset=+1] + include::modules/nw-osp-pod-connections-ipv6.adoc[leveloffset=+1] + include::modules/nw-osp-pod-creating-ipv6.adoc[leveloffset=+1] + include::modules/nw-osp-pod-adding-connections-ipv6.adoc[leveloffset=+1] diff --git a/installing/installing_openstack/installing-openstack-nfv-preparing.adoc b/installing/installing_openstack/installing-openstack-nfv-preparing.adoc index 6cbd5fd44b..104c9a7f68 100644 --- a/installing/installing_openstack/installing-openstack-nfv-preparing.adoc +++ b/installing/installing_openstack/installing-openstack-nfv-preparing.adoc @@ -9,7 +9,9 @@ toc::[] Before you install a {product-title} cluster that uses single-root I/O virtualization (SR-IOV) or Open vSwitch with the Data Plane Development Kit (OVS-DPDK) on {rh-openstack-first}, you must understand the requirements for each technology and then perform preparatory tasks. include::modules/installation-openstack-nfv-requirements.adoc[leveloffset=+1] + include::modules/installation-openstack-sr-iov-requirements.adoc[leveloffset=+2] + include::modules/installation-openstack-ovs-dpdk-requirements.adoc[leveloffset=+2] [id="installing-openstack-nfv-preparing-tasks-sr-iov"] diff --git a/installing/installing_openstack/installing-openstack-user.adoc b/installing/installing_openstack/installing-openstack-user.adoc index 3ecda53afc..509f647715 100644 --- a/installing/installing_openstack/installing-openstack-user.adoc +++ b/installing/installing_openstack/installing-openstack-user.adoc @@ -23,21 +23,36 @@ Using your own infrastructure allows you to integrate your cluster with existing ** Python 3 include::modules/cluster-entitlements.adoc[leveloffset=+1] + include::modules/installation-osp-default-deployment.adoc[leveloffset=+1] + include::modules/installation-osp-control-compute-machines.adoc[leveloffset=+2] + include::modules/installation-osp-bootstrap-machine.adoc[leveloffset=+2] + include::modules/installation-osp-downloading-modules.adoc[leveloffset=+1] + include::modules/installation-osp-downloading-playbooks.adoc[leveloffset=+1] + include::modules/installation-obtaining-installer.adoc[leveloffset=+1] + include::modules/ssh-agent-using.adoc[leveloffset=+1] + // include::modules/installation-osp-enabling-swift.adoc[leveloffset=+1] include::modules/installation-osp-creating-image.adoc[leveloffset=+1] + include::modules/installation-osp-verifying-external-network.adoc[leveloffset=+1] + include::modules/installation-osp-accessing-api.adoc[leveloffset=+1] + include::modules/installation-osp-accessing-api-floating.adoc[leveloffset=+2] + include::modules/installation-osp-accessing-api-no-floating.adoc[leveloffset=+2] + include::modules/installation-osp-describing-cloud-parameters.adoc[leveloffset=+1] + include::modules/installation-osp-creating-network-resources.adoc[leveloffset=+1] + include::modules/installation-initializing.adoc[leveloffset=+1] [role="_additional-resources"] @@ -45,11 +60,17 @@ include::modules/installation-initializing.adoc[leveloffset=+1] * xref:../../installing/installing_openstack/installation-config-parameters-openstack.adoc#installation-config-parameters-openstack[Installation configuration parameters for OpenStack] include::modules/installation-osp-custom-subnet.adoc[leveloffset=+2] + include::modules/installation-osp-config-yaml.adoc[leveloffset=+2] + include::modules/installation-osp-fixing-subnet.adoc[leveloffset=+2] + include::modules/installation-osp-emptying-worker-pools.adoc[leveloffset=+2] + include::modules/installation-osp-provider-networks.adoc[leveloffset=+2] + include::modules/installation-osp-provider-network-preparation.adoc[leveloffset=+3] + include::modules/installation-osp-deploying-provider-networks-installer.adoc[leveloffset=+3] [TIP] @@ -60,18 +81,27 @@ After you deploy your cluster, you can attach pods to additional networks. For m ==== include::modules/installation-user-infra-generate-k8s-manifest-ignition.adoc[leveloffset=+1] + include::modules/installation-osp-converting-ignition-resources.adoc[leveloffset=+1] + include::modules/installation-osp-creating-control-plane-ignition.adoc[leveloffset=+1] + include::modules/installation-osp-updating-network-resources.adoc[leveloffset=+1] include::modules/installation-osp-deploying-bare-metal-machines.adoc[leveloffset=+2] include::modules/installation-osp-creating-bootstrap-machine.adoc[leveloffset=+1] + include::modules/installation-osp-creating-control-plane.adoc[leveloffset=+1] + include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1] + include::modules/installation-osp-deleting-bootstrap-resources.adoc[leveloffset=+1] + include::modules/installation-osp-creating-compute-machines.adoc[leveloffset=+1] + include::modules/installation-approve-csrs.adoc[leveloffset=+1] + include::modules/installation-osp-verifying-installation.adoc[leveloffset=+1] include::modules/cluster-telemetry.adoc[leveloffset=+1] diff --git a/installing/installing_openstack/uninstalling-openstack-user.adoc b/installing/installing_openstack/uninstalling-openstack-user.adoc index f5d3ed4dd3..9fa7ed71a8 100644 --- a/installing/installing_openstack/uninstalling-openstack-user.adoc +++ b/installing/installing_openstack/uninstalling-openstack-user.adoc @@ -10,4 +10,5 @@ You can remove a cluster that you deployed to {rh-openstack-first} on user-provi // include::modules/installation-uninstall-clouds.adoc[leveloffset=+1] include::modules/installation-osp-downloading-modules.adoc[leveloffset=+1] + include::modules/installation-uninstall-infra.adoc[leveloffset=+1] diff --git a/installing/installing_platform_agnostic/installing-platform-agnostic.adoc b/installing/installing_platform_agnostic/installing-platform-agnostic.adoc index 6dadf25f55..bfb5c2c606 100644 --- a/installing/installing_platform_agnostic/installing-platform-agnostic.adoc +++ b/installing/installing_platform_agnostic/installing-platform-agnostic.adoc @@ -36,7 +36,9 @@ of the required machines. This section describes the requirements for deploying {product-title} on user-provisioned infrastructure. include::modules/installation-machine-requirements.adoc[leveloffset=+2] + include::modules/installation-minimum-resource-requirements.adoc[leveloffset=+2] + include::modules/csr-management.adoc[leveloffset=+2] include::modules/installation-network-user-infra.adoc[leveloffset=+2] diff --git a/installing/installing_sno/install-sno-installing-sno.adoc b/installing/installing_sno/install-sno-installing-sno.adoc index f4441d9145..1f17665098 100644 --- a/installing/installing_sno/install-sno-installing-sno.adoc +++ b/installing/installing_sno/install-sno-installing-sno.adoc @@ -28,6 +28,7 @@ include::modules/install-sno-generating-the-discovery-iso-with-the-assisted-inst // Installing single-node OpenShift with the Assisted Installer include::modules/install-sno-installing-with-the-assisted-installer.adoc[leveloffset=+2] + endif::openshift-origin[] ifdef::openshift-origin[] @@ -200,4 +201,5 @@ You can use dedicated or shared IFLs to assign sufficient compute resources. Res include::modules/setting-up-bastion-for-sno.adoc[leveloffset=+2] include::modules/install-sno-ibm-power.adoc[leveloffset=+2] + endif::openshift-origin[] diff --git a/installing/installing_vsphere/ipi/ipi-vsphere-installation-reqs.adoc b/installing/installing_vsphere/ipi/ipi-vsphere-installation-reqs.adoc index 3b6a50b01d..c7116fffc6 100644 --- a/installing/installing_vsphere/ipi/ipi-vsphere-installation-reqs.adoc +++ b/installing/installing_vsphere/ipi/ipi-vsphere-installation-reqs.adoc @@ -9,7 +9,9 @@ toc::[] Before you begin an installation using installer-provisioned infrastructure, be sure that your vSphere environment meets the following installation requirements. include::modules/installation-vsphere-infrastructure.adoc[leveloffset=+1] + include::modules/installation-vsphere-installer-network-requirements.adoc[leveloffset=+1] + include::modules/vmware-csi-driver-reqs.adoc[leveloffset=+1] [role="_additional-resources"] @@ -20,6 +22,7 @@ include::modules/vmware-csi-driver-reqs.adoc[leveloffset=+1] * xref:../../../installing/installing_vsphere/ipi/ipi-vsphere-installation-reqs.adoc#installation-vsphere-minimum-permissions-storage_ipi-vsphere-installation-reqs[Minimum permissions for the storage components] include::modules/installation-vsphere-installer-infra-requirements.adoc[leveloffset=+1] + include::modules/installation-vsphere-installer-infra-static-ip-nodes.adoc[leveloffset=+2] [role="_additional-resources"] diff --git a/installing/installing_vsphere/upi/upi-vsphere-installation-reqs.adoc b/installing/installing_vsphere/upi/upi-vsphere-installation-reqs.adoc index 9405b0df73..88d46c330c 100644 --- a/installing/installing_vsphere/upi/upi-vsphere-installation-reqs.adoc +++ b/installing/installing_vsphere/upi/upi-vsphere-installation-reqs.adoc @@ -9,6 +9,7 @@ toc::[] Before you begin an installation on infrastructure that you provision, be sure that your vSphere environment meets the following installation requirements. include::modules/installation-vsphere-infrastructure.adoc[leveloffset=+1] + include::modules/vmware-csi-driver-reqs.adoc[leveloffset=+1] [role="_additional-resources"] @@ -33,6 +34,7 @@ include::modules/installation-vsphere-installer-infra-requirements.adoc[leveloff * xref:../../../machine_management/creating_machinesets/creating-machineset-vsphere.adoc#creating-machineset-vsphere_creating-machineset-vsphere[Creating a compute machine set on vSphere] include::modules/installation-machine-requirements.adoc[leveloffset=+2] + include::modules/installation-minimum-resource-requirements.adoc[leveloffset=+2] [role="_additional-resources"] @@ -41,11 +43,13 @@ include::modules/installation-minimum-resource-requirements.adoc[leveloffset=+2] * xref:../../../scalability_and_performance/optimization/optimizing-storage.adoc#optimizing-storage[Optimizing storage] include::modules/installation-vsphere-encrypted-vms.adoc[leveloffset=+2] + [role="_additional-resources"] .Additional resources * xref:../../../storage/container_storage_interface/persistent-storage-csi-vsphere.adoc#vsphere-pv-encryption[Creating an encrypted storage class] include::modules/csr-management.adoc[leveloffset=+2] + include::modules/installation-network-user-infra.adoc[leveloffset=+2] [role="_additional-resources"] @@ -54,4 +58,5 @@ include::modules/installation-network-user-infra.adoc[leveloffset=+2] * xref:../../../installing/install_config/installing-customizing.adoc#installation-special-config-chrony_installing-customizing[Configuring chrony time service] include::modules/installation-dns-user-infra.adoc[leveloffset=+2] + include::modules/installation-load-balancing-user-infra.adoc[leveloffset=+2] diff --git a/machine_configuration/index.adoc b/machine_configuration/index.adoc index f763b752d1..2aaf0c0596 100644 --- a/machine_configuration/index.adoc +++ b/machine_configuration/index.adoc @@ -29,6 +29,7 @@ include::modules/understanding-machine-config-operator.adoc[leveloffset=+1] * xref:../networking/ovn_kubernetes_network_provider/about-ovn-kubernetes.adoc#about-ovn-kubernetes[About the OVN-Kubernetes network plugin] include::modules/machine-config-overview.adoc[leveloffset=+1] + include::modules/architecture-machine-config-pools.adoc[leveloffset=+2] include::modules/machine-config-node-drain.adoc[leveloffset=+1] @@ -43,7 +44,9 @@ include::modules/machine-config-node-drain.adoc[leveloffset=+1] include::modules/machine-config-drift-detection.adoc[leveloffset=+1] include::modules/checking-mco-status.adoc[leveloffset=+1] + include::modules/checking-mco-node-status.adoc[leveloffset=+1] + include::modules/checking-mco-node-status-configuring.adoc[leveloffset=+2] [role="_additional-resources"] diff --git a/machine_configuration/machine-config-node-disruption.adoc b/machine_configuration/machine-config-node-disruption.adoc index 0d703461fe..721773fa2e 100644 --- a/machine_configuration/machine-config-node-disruption.adoc +++ b/machine_configuration/machine-config-node-disruption.adoc @@ -48,4 +48,5 @@ For example, if you have a policy for the `/etc/` directory and a policy for the include::snippets/machine-config-node-disruption-actions.adoc[] include::modules/machine-config-node-disruption-example.adoc[leveloffset=+1] + include::modules/machine-config-node-disruption-config.adoc[leveloffset=+1] diff --git a/machine_configuration/machine-configs-configure.adoc b/machine_configuration/machine-configs-configure.adoc index 07c0c3b7d8..a565ca2b29 100644 --- a/machine_configuration/machine-configs-configure.adoc +++ b/machine_configuration/machine-configs-configure.adoc @@ -25,7 +25,9 @@ include::modules/installation-special-config-chrony.adoc[leveloffset=+1] * xref:../installing/install_config/installing-customizing.adoc#installation-special-config-butane_installing-customizing[Creating machine configs with Butane] include::modules/cnf-disable-chronyd.adoc[leveloffset=+1] + include::modules/nodes-nodes-kernel-arguments.adoc[leveloffset=+1] + include::modules/rhcos-enabling-multipath-day-2.adoc[leveloffset=+1] [role="_additional-resources"] @@ -34,6 +36,7 @@ include::modules/rhcos-enabling-multipath-day-2.adoc[leveloffset=+1] * See xref:../installing/installing_bare_metal/upi/installing-bare-metal.adoc#rhcos-enabling-multipath_installing-bare-metal[Enabling multipathing with kernel arguments on RHCOS] for more information about enabling multipathing during installation time. include::modules/nodes-nodes-rtkernel-arguments.adoc[leveloffset=+1] + include::modules/machineconfig-modify-journald.adoc[leveloffset=+1] [role="_additional-resources"] @@ -42,6 +45,7 @@ include::modules/machineconfig-modify-journald.adoc[leveloffset=+1] * xref:../installing/install_config/installing-customizing.adoc#installation-special-config-butane_installing-customizing[Creating machine configs with Butane] include::modules/rhcos-add-extensions.adoc[leveloffset=+1] + include::modules/rhcos-load-firmware-blobs.adoc[leveloffset=+1] [role="_additional-resources"] diff --git a/machine_configuration/machine-configs-custom.adoc b/machine_configuration/machine-configs-custom.adoc index f8d7bfb3a4..9de02b1197 100644 --- a/machine_configuration/machine-configs-custom.adoc +++ b/machine_configuration/machine-configs-custom.adoc @@ -10,8 +10,11 @@ toc::[] Besides managing `MachineConfig` objects, the MCO manages two custom resources (CRs): `KubeletConfig` and `ContainerRuntimeConfig`. Those CRs let you change node-level settings impacting how the kubelet and CRI-O container runtime services behave. include::modules/create-a-kubeletconfig-crd-to-edit-kubelet-parameters.adoc[leveloffset=+1] + include::modules/create-a-containerruntimeconfig-crd.adoc[leveloffset=+1] + include::modules/set-the-default-max-container-root-partition-size-for-overlay-with-crio.adoc[leveloffset=+1] + include::modules/create-crio-default-capabilities.adoc[leveloffset=+1] diff --git a/machine_configuration/machine-configs-garbage-collection.adoc b/machine_configuration/machine-configs-garbage-collection.adoc index e0b166f79f..f9c6a25878 100644 --- a/machine_configuration/machine-configs-garbage-collection.adoc +++ b/machine_configuration/machine-configs-garbage-collection.adoc @@ -21,4 +21,5 @@ The `oc adm prune renderedmachineconfigs` command deletes only rendered machine ==== include::modules/machineconfig-garbage-collect-viewing.adoc[leveloffset=+1] + include::modules/machineconfig-garbage-collect-removing.adoc[leveloffset=+1] diff --git a/machine_configuration/mco-coreos-layering.adoc b/machine_configuration/mco-coreos-layering.adoc index 072708ff4a..d76560d48a 100644 --- a/machine_configuration/mco-coreos-layering.adoc +++ b/machine_configuration/mco-coreos-layering.adoc @@ -219,6 +219,7 @@ include::modules/coreos-layering-configuring.adoc[leveloffset=+1] xref:../machine_configuration/mco-coreos-layering.adoc#coreos-layering-updating_mco-coreos-layering[Updating with a {op-system} custom layered image] include::modules/coreos-layering-removing.adoc[leveloffset=+2] + include::modules/coreos-layering-updating.adoc[leveloffset=+1] //// diff --git a/machine_configuration/mco-update-boot-images.adoc b/machine_configuration/mco-update-boot-images.adoc index 0922b835e5..fb6bec136d 100644 --- a/machine_configuration/mco-update-boot-images.adoc +++ b/machine_configuration/mco-update-boot-images.adoc @@ -23,4 +23,5 @@ include::modules/mco-update-boot-images-about.adoc[leveloffset=+1] * xref:../machine_configuration/mco-update-boot-images.adoc#mco-update-boot-images-configuring_machine-configs-configure[Enabling boot image management] include::modules/mco-update-boot-images-disable.adoc[leveloffset=+1] + include::modules/mco-update-boot-images-configuring.adoc[leveloffset=+1] diff --git a/machine_management/applying-autoscaling.adoc b/machine_management/applying-autoscaling.adoc index 573e35f57d..c2570b5cd8 100644 --- a/machine_management/applying-autoscaling.adoc +++ b/machine_management/applying-autoscaling.adoc @@ -37,6 +37,7 @@ include::modules/machineset-label-gpu-autoscaler.adoc[leveloffset=+3] :FeatureName: cluster autoscaler :FeatureResourceName: ClusterAutoscaler include::modules/deploying-resource.adoc[leveloffset=+2] + .Next steps * After you configure the cluster autoscaler, you must xref:../machine_management/applying-autoscaling.adoc#configuring-machineautoscaler_applying-autoscaling[configure at least one machine autoscaler]. @@ -69,12 +70,14 @@ include::modules/deploying-resource.adoc[leveloffset=+2] You can disable an individual machine autoscaler in your cluster or disable autoscaling on the cluster entirely. include::modules/deleting-machine-autoscaler.adoc[leveloffset=+2] + [role="_additional-resources"] .Additional resources * xref:../machine_management/applying-autoscaling.adoc#deleting-cluster-autoscaler_applying-autoscaling[Disabling the cluster autoscaler] * xref:../machine_management/applying-autoscaling.adoc#MachineAutoscaler-deploying_applying-autoscaling[Deploying a machine autoscaler] include::modules/deleting-cluster-autoscaler.adoc[leveloffset=+2] + [role="_additional-resources"] .Additional resources * xref:../machine_management/applying-autoscaling.adoc#deleting-machine-autoscaler_applying-autoscaling[Disabling the machine autoscaler] diff --git a/machine_management/cluster_api_machine_management/cluster-api-getting-started.adoc b/machine_management/cluster_api_machine_management/cluster-api-getting-started.adoc index 2d44bd79ce..f629e4e17b 100644 --- a/machine_management/cluster_api_machine_management/cluster-api-getting-started.adoc +++ b/machine_management/cluster_api_machine_management/cluster-api-getting-started.adoc @@ -36,6 +36,7 @@ For clusters that do not support migrating Machine API resources to Cluster API //Creating a Cluster API machine template include::modules/capi-creating-machine-template.adoc[leveloffset=+2] + [role="_additional-resources"] .Additional resources * xref:../../machine_management/cluster_api_machine_management/cluster_api_provider_configurations/cluster-api-config-options-aws.adoc#capi-yaml-machine-template-aws_cluster-api-config-options-aws[Sample YAML for a Cluster API machine template resource on {aws-full}] @@ -47,6 +48,7 @@ include::modules/capi-creating-machine-template.adoc[leveloffset=+2] //Creating a Cluster API compute machine set include::modules/capi-creating-machine-set.adoc[leveloffset=+2] + [role="_additional-resources"] .Additional resources * xref:../../machine_management/cluster_api_machine_management/cluster_api_provider_configurations/cluster-api-config-options-aws.adoc#capi-yaml-machine-set-aws_cluster-api-config-options-aws[Sample YAML for a Cluster API compute machine set resource on {aws-full}] diff --git a/machine_management/cluster_api_machine_management/cluster-api-managing-machines.adoc b/machine_management/cluster_api_machine_management/cluster-api-managing-machines.adoc index d453454812..b3562cf780 100644 --- a/machine_management/cluster_api_machine_management/cluster-api-managing-machines.adoc +++ b/machine_management/cluster_api_machine_management/cluster-api-managing-machines.adoc @@ -11,6 +11,7 @@ include::snippets/technology-preview.adoc[] //Modifying a Cluster API machine template include::modules/capi-modifying-machine-template.adoc[leveloffset=+1] + [role="_additional-resources"] .Additional resources * xref:../../machine_management/cluster_api_machine_management/cluster_api_provider_configurations/cluster-api-config-options-aws.adoc#capi-yaml-machine-template-aws_cluster-api-config-options-aws[Sample YAML for a Cluster API machine template resource on {aws-full}] @@ -23,6 +24,7 @@ include::modules/capi-modifying-machine-template.adoc[leveloffset=+1] //Modifying a compute machine set by using the CLI //tags exclude MAPI, leaving untagged + CAPI include::modules/machineset-modifying.adoc[leveloffset=+1,tag=!MAPI] + [role="_additional-resources"] .Additional resources * xref:../../machine_management/cluster_api_machine_management/cluster_api_provider_configurations/cluster-api-config-options-aws.adoc#capi-yaml-machine-set-aws_cluster-api-config-options-aws[Sample YAML for a Cluster API compute machine set resource on {aws-full}] diff --git a/machine_management/cluster_api_machine_management/cluster_api_provider_configurations/cluster-api-config-options-vsphere.adoc b/machine_management/cluster_api_machine_management/cluster_api_provider_configurations/cluster-api-config-options-vsphere.adoc index 7f0fd83aac..3d609d3b06 100644 --- a/machine_management/cluster_api_machine_management/cluster_api_provider_configurations/cluster-api-config-options-vsphere.adoc +++ b/machine_management/cluster_api_machine_management/cluster_api_provider_configurations/cluster-api-config-options-vsphere.adoc @@ -21,6 +21,7 @@ include::modules/capi-yaml-machine-template-vsphere.adoc[leveloffset=+2] //Sample YAML for a CAPI vSphere compute machine set resource include::modules/capi-yaml-machine-set-vsphere.adoc[leveloffset=+2] + // This additional resources section can be added if this configuration is validated. (see also: callout in capi-yaml-machine-set-vsphere.adoc) // [role="_additional-resources"] // .Additional resources diff --git a/machine_management/control_plane_machine_management/cpmso-resiliency.adoc b/machine_management/control_plane_machine_management/cpmso-resiliency.adoc index 57a08b2b99..0eb8f8fcd4 100644 --- a/machine_management/control_plane_machine_management/cpmso-resiliency.adoc +++ b/machine_management/control_plane_machine_management/cpmso-resiliency.adoc @@ -15,6 +15,7 @@ When possible, the control plane machine set spreads the control plane machines //Failure domain platform support and configuration include::modules/cpmso-failure-domains-provider.adoc[leveloffset=+2] + [role="_additional-resources"] .Additional resources @@ -37,12 +38,14 @@ include::modules/cpmso-failure-domains-balancing.adoc[leveloffset=+2] //Recovery of the failed control plane machines include::modules/cpmso-control-plane-recovery.adoc[leveloffset=+1] + [role="_additional-resources"] .Additional resources * xref:../../machine_management/deploying-machine-health-checks.adoc#deploying-machine-health-checks[Deploying machine health checks] //Quorum protection with machine lifecycle hooks include::modules/machine-lifecycle-hook-deletion-etcd.adoc[leveloffset=+1] + [role="_additional-resources"] .Additional resources * xref:../../machine_management/deleting-machine.adoc#machine-lifecycle-hook-deletion_deleting-machine[Lifecycle hooks for the machine deletion phase] diff --git a/machine_management/control_plane_machine_management/cpmso_provider_configurations/cpmso-config-options-azure.adoc b/machine_management/control_plane_machine_management/cpmso_provider_configurations/cpmso-config-options-azure.adoc index 95111a4a12..fb007da8cb 100644 --- a/machine_management/control_plane_machine_management/cpmso_provider_configurations/cpmso-config-options-azure.adoc +++ b/machine_management/control_plane_machine_management/cpmso_provider_configurations/cpmso-config-options-azure.adoc @@ -26,6 +26,7 @@ include::modules/cpmso-yaml-failure-domain-azure.adoc[leveloffset=+2] You can enable features by updating values in the control plane machine set. include::modules/private-clusters-setting-api-private.adoc[leveloffset=+2] + [role="_additional-resources"] .Additional resources * xref:../../../networking/ingress_load_balancing/configuring_ingress_cluster_traffic/nw-configuring-ingress-controller-endpoint-publishing-strategy.adoc#nw-ingresscontroller-change-internal_nw-configuring-ingress-controller-endpoint-publishing-strategy[Configuring the Ingress Controller endpoint publishing scope to Internal] diff --git a/machine_management/control_plane_machine_management/cpmso_provider_configurations/cpmso-config-options-nutanix.adoc b/machine_management/control_plane_machine_management/cpmso_provider_configurations/cpmso-config-options-nutanix.adoc index 15ef9bbbfc..e35c3698f0 100644 --- a/machine_management/control_plane_machine_management/cpmso_provider_configurations/cpmso-config-options-nutanix.adoc +++ b/machine_management/control_plane_machine_management/cpmso_provider_configurations/cpmso-config-options-nutanix.adoc @@ -19,6 +19,7 @@ include::modules/cpmso-yaml-provider-spec-nutanix.adoc[leveloffset=+2] //Failure domains for Nutanix clusters include::modules/mapi-failure-domain-nutanix.adoc[leveloffset=+2] + [role="_additional-resources"] .Additional resources * xref:../../../installing/installing_nutanix/nutanix-failure-domains.adoc#nutanix-failure-domains-adding-to-existing-cluster_nutanix-failure-domains[Adding failure domains to an existing Nutanix cluster] diff --git a/machine_management/creating_machinesets/creating-machineset-gcp.adoc b/machine_management/creating_machinesets/creating-machineset-gcp.adoc index 0c20e023aa..818318888f 100644 --- a/machine_management/creating_machinesets/creating-machineset-gcp.adoc +++ b/machine_management/creating_machinesets/creating-machineset-gcp.adoc @@ -38,6 +38,7 @@ include::modules/machineset-creating-non-guaranteed-instances.adoc[leveloffset=+ //Configuring Shielded VM options by using machine sets include::modules/machineset-gcp-shielded-vms.adoc[leveloffset=+1] + [role="_additional-resources"] .Additional resources * link:https://cloud.google.com/compute/shielded-vm/docs/shielded-vm[What is Shielded VM?] diff --git a/machine_management/creating_machinesets/creating-machineset-nutanix.adoc b/machine_management/creating_machinesets/creating-machineset-nutanix.adoc index ebee464354..01f79b491b 100644 --- a/machine_management/creating_machinesets/creating-machineset-nutanix.adoc +++ b/machine_management/creating_machinesets/creating-machineset-nutanix.adoc @@ -26,6 +26,7 @@ include::modules/machineset-label-gpu-autoscaler.adoc[leveloffset=+1] //Failure domains for Nutanix clusters include::modules/mapi-failure-domain-nutanix.adoc[leveloffset=+1] + [role="_additional-resources"] .Additional resources * xref:../../installing/installing_nutanix/nutanix-failure-domains.adoc#nutanix-failure-domains-adding-to-existing-cluster_nutanix-failure-domains[Adding failure domains to an existing Nutanix cluster] diff --git a/machine_management/creating_machinesets/creating-machineset-vsphere.adoc b/machine_management/creating_machinesets/creating-machineset-vsphere.adoc index 18e0dc8bda..59e07d896b 100644 --- a/machine_management/creating_machinesets/creating-machineset-vsphere.adoc +++ b/machine_management/creating_machinesets/creating-machineset-vsphere.adoc @@ -30,6 +30,7 @@ include::modules/machineset-upi-reqs-vsphere-creds.adoc[leveloffset=+2] //Satisfying ignition configuration requirements include::modules/machineset-upi-reqs-ignition-config.adoc[leveloffset=+2] + [role="_additional-resources"] .Additional resources * xref:../../machine_configuration/index.adoc#machine-config-operator_machine-config-overview[Understanding the Machine Config Operator] diff --git a/machine_management/deploying-machine-health-checks.adoc b/machine_management/deploying-machine-health-checks.adoc index 6751fc6edd..90bfd098b3 100644 --- a/machine_management/deploying-machine-health-checks.adoc +++ b/machine_management/deploying-machine-health-checks.adoc @@ -11,6 +11,7 @@ You can configure and deploy a machine health check to automatically repair dama include::snippets/machine-user-provisioned-limitations.adoc[leveloffset=+1] include::modules/machine-health-checks-about.adoc[leveloffset=+1] + [role="_additional-resources"] .Additional resources * xref:../nodes/nodes/nodes-nodes-viewing.adoc#nodes-nodes-viewing-listing_nodes-nodes-viewing[About listing all the nodes in a cluster] diff --git a/networking/advanced_networking/bgp_routing/about-bgp-routing.adoc b/networking/advanced_networking/bgp_routing/about-bgp-routing.adoc index da77186461..d519616412 100644 --- a/networking/advanced_networking/bgp_routing/about-bgp-routing.adoc +++ b/networking/advanced_networking/bgp_routing/about-bgp-routing.adoc @@ -14,6 +14,7 @@ If you are using the MetalLB Operator and there are existing `FRRConfiguration` ==== include::modules/nw-bgp-about.adoc[leveloffset=+1] + include::modules/nw-metallb-frr-k8s-configuration-crd.adoc[leveloffset=+1] [role="_additional-resources"] diff --git a/networking/advanced_networking/changing-cluster-network-mtu.adoc b/networking/advanced_networking/changing-cluster-network-mtu.adoc index 3da6bbe05a..e6049d8c05 100644 --- a/networking/advanced_networking/changing-cluster-network-mtu.adoc +++ b/networking/advanced_networking/changing-cluster-network-mtu.adoc @@ -12,12 +12,19 @@ As a cluster administrator, you can change the maximum transmission unit (MTU) f include::modules/nw-cluster-mtu-change-about.adoc[leveloffset=+1] include::modules/nw-cluster-mtu-change.adoc[leveloffset=+1] + include::modules/nw-cluster-mtu-checking.adoc[leveloffset=+2] + include::modules/nw-cluster-mtu-preparing.adoc[leveloffset=+2] + include::modules/nw-cluster-mtu-creating-mc-objects.adoc[leveloffset=+2] + include::modules/nw-cluster-mtu-migration.adoc[leveloffset=+2] + include::modules/nw-cluster-mtu-verifying-configuration.adoc[leveloffset=+2] + include::modules/nw-cluster-mtu-applying-mtu-value.adoc[leveloffset=+2] + include::modules/nw-cluster-mtu-finalizing-migration.adoc[leveloffset=+2] [role="_additional-resources"] diff --git a/networking/advanced_networking/route_advertisements/about-route-advertisements.adoc b/networking/advanced_networking/route_advertisements/about-route-advertisements.adoc index af467e6129..1289014f30 100644 --- a/networking/advanced_networking/route_advertisements/about-route-advertisements.adoc +++ b/networking/advanced_networking/route_advertisements/about-route-advertisements.adoc @@ -9,7 +9,9 @@ toc::[] This feature provides route advertisement capabilities for the OVN-Kubernetes network plugin. A Border Gateway Router (BGP) provider is required. For more information, see xref:../../../networking/advanced_networking/bgp_routing/about-bgp-routing.adoc#about-bgp-routing[About BGP routing]. include::modules/nw-routeadvertisements-about.adoc[leveloffset=+1] + include::modules/nw-routeadvertisements-object.adoc[leveloffset=+1] + include::modules/nw-routeadvertisements-example.adoc[leveloffset=+1] [role="_additional-resources"] diff --git a/networking/configuring_network_settings/configuring-a-custom-pki.adoc b/networking/configuring_network_settings/configuring-a-custom-pki.adoc index 1c0296b22a..611fcea40d 100644 --- a/networking/configuring_network_settings/configuring-a-custom-pki.adoc +++ b/networking/configuring_network_settings/configuring-a-custom-pki.adoc @@ -20,6 +20,9 @@ The cluster Proxy object is the mechanism for managing the cluster-wide truststo ==== include::modules/adding-a-custom-CA-during-cluster-installation.adoc[leveloffset=+1] + include::modules/adding-a-custom-CA-to-a-running-cluster.adoc[leveloffset=+1] + include::modules/verifying-the-custom-ca-configuration.adoc[leveloffset=+1] + include::modules/certificate-injection-using-operators.adoc[leveloffset=+1] diff --git a/networking/ingress_load_balancing/routes/route-configuration.adoc b/networking/ingress_load_balancing/routes/route-configuration.adoc index 8f76947233..ddc1b79101 100644 --- a/networking/ingress_load_balancing/routes/route-configuration.adoc +++ b/networking/ingress_load_balancing/routes/route-configuration.adoc @@ -15,6 +15,7 @@ include::modules/nw-creating-a-route.adoc[leveloffset=+1] ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] // Creating a route for router sharding include::modules/nw-ingress-sharding-route-configuration.adoc[leveloffset=+1] + endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] //Creating route timeouts @@ -69,6 +70,7 @@ ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] include::modules/nw-route-admission-policy.adoc[leveloffset=+1] include::modules/nw-ingress-creating-a-route-via-an-ingress.adoc[leveloffset=+1] + endif::[] include::modules/nw-ingress-edge-route-default-certificate.adoc[leveloffset=+1] @@ -77,6 +79,7 @@ include::modules/nw-ingress-reencrypt-route-custom-cert.adoc[leveloffset=+1] ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] include::modules/nw-router-configuring-dual-stack.adoc[leveloffset=+1] + endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] ifdef::openshift-enterprise[] diff --git a/networking/k8s_nmstate/k8s-nmstate-updating-node-network-config.adoc b/networking/k8s_nmstate/k8s-nmstate-updating-node-network-config.adoc index ccf1fc4f30..ebca76783e 100644 --- a/networking/k8s_nmstate/k8s-nmstate-updating-node-network-config.adoc +++ b/networking/k8s_nmstate/k8s-nmstate-updating-node-network-config.adoc @@ -121,6 +121,7 @@ The following example configuration snippets show node network policies that use ifdef::openshift-enterprise[] :FeatureName: Applying node network configuration policies that use dynamic matching and templating include::snippets/technology-preview.adoc[leveloffset=+2] + endif::[] // Example: Linux bridge interface node network configuration policy to inherit static IP address from the NIC attached to the bridge diff --git a/networking/multiple_networks/secondary_networks/configuring-multi-network-policy.adoc b/networking/multiple_networks/secondary_networks/configuring-multi-network-policy.adoc index 648ecbc68b..61f663aaff 100644 --- a/networking/multiple_networks/secondary_networks/configuring-multi-network-policy.adoc +++ b/networking/multiple_networks/secondary_networks/configuring-multi-network-policy.adoc @@ -24,7 +24,9 @@ Support for configuring multi-network policies for SR-IOV secondary networks is ==== include::modules/nw-multi-network-policy-differences.adoc[leveloffset=+1] + include::modules/nw-multi-network-policy-enable.adoc[leveloffset=+1] + include::modules/nw-multi-network-policy-ipv6-suppport.adoc[leveloffset=+1] [id="{context}_working-with-multi-network-policy"] @@ -38,12 +40,19 @@ As a cluster administrator, you can create, edit, view, and delete multi-network * You have enabled multi-network policy support for your cluster. include::modules/nw-networkpolicy-create-cli.adoc[leveloffset=+2] + include::modules/nw-networkpolicy-edit.adoc[leveloffset=+2] + include::modules/nw-networkpolicy-view-cli.adoc[leveloffset=+2] + include::modules/nw-networkpolicy-delete-cli.adoc[leveloffset=+2] + include::modules/nw-networkpolicy-deny-all-allowed.adoc[leveloffset=+2] + include::modules/nw-networkpolicy-allow-external-clients.adoc[leveloffset=+2] + include::modules/nw-networkpolicy-allow-application-all-namespaces.adoc[leveloffset=+2] + include::modules/nw-networkpolicy-allow-application-particular-namespace.adoc[leveloffset=+2] diff --git a/networking/network_security/network-verification.adoc b/networking/network_security/network-verification.adoc index b16a56f21f..dc90e0be3c 100644 --- a/networking/network_security/network-verification.adoc +++ b/networking/network_security/network-verification.adoc @@ -41,13 +41,17 @@ endif::openshift-dedicated[] //endif::openshift-rosa,openshift-rosa-hcp[] include::modules/automatic-network-verification-bypassing.adoc[leveloffset=+1] + ifdef::openshift-rosa[] include::modules/running-network-verification-manually.adoc[leveloffset=+1] + endif::openshift-rosa[] ifdef::openshift-rosa,openshift-dedicated[] include::modules/running-network-verification-manually-ocm.adoc[leveloffset=+1] + endif::openshift-rosa,openshift-dedicated[] ifdef::openshift-rosa,openshift-rosa-hcp[] include::modules/running-network-verification-manually-cli.adoc[leveloffset=+2] + endif::openshift-rosa,openshift-rosa-hcp[] //OSDOCS-11830 Confirmed verifying via OCM not available for ROSA with HCP \ No newline at end of file diff --git a/networking/network_security/network_policy/creating-network-policy.adoc b/networking/network_security/network_policy/creating-network-policy.adoc index e4cd55d729..943912bd29 100644 --- a/networking/network_security/network_policy/creating-network-policy.adoc +++ b/networking/network_security/network_policy/creating-network-policy.adoc @@ -26,6 +26,7 @@ include::modules/nw-networkpolicy-allow-application-particular-namespace.adoc[le ifdef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] include::modules/nw-networkpolicy-create-ocm.adoc[leveloffset=+1] + endif::[] ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] diff --git a/networking/network_security/network_policy/deleting-network-policy.adoc b/networking/network_security/network_policy/deleting-network-policy.adoc index c92f63d381..341f1ea837 100644 --- a/networking/network_security/network_policy/deleting-network-policy.adoc +++ b/networking/network_security/network_policy/deleting-network-policy.adoc @@ -12,6 +12,8 @@ toc::[] As a cluster administrator, you can delete a network policy from a namespace. include::modules/nw-networkpolicy-delete-cli.adoc[leveloffset=+1] + ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] include::modules/nw-networkpolicy-delete-ocm.adoc[leveloffset=+1] + endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] \ No newline at end of file diff --git a/networking/network_security/network_policy/viewing-network-policy.adoc b/networking/network_security/network_policy/viewing-network-policy.adoc index 9cfe03a5f0..921ab47f76 100644 --- a/networking/network_security/network_policy/viewing-network-policy.adoc +++ b/networking/network_security/network_policy/viewing-network-policy.adoc @@ -17,4 +17,5 @@ include::modules/nw-networkpolicy-view-cli.adoc[leveloffset=+1] ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] include::modules/nw-networkpolicy-view-ocm.adoc[leveloffset=+1] + endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] \ No newline at end of file diff --git a/networking/networking_operators/dns-operator.adoc b/networking/networking_operators/dns-operator.adoc index fde50779ef..c1a23814e2 100644 --- a/networking/networking_operators/dns-operator.adoc +++ b/networking/networking_operators/dns-operator.adoc @@ -17,6 +17,7 @@ include::modules/nw-dns-operator.adoc[leveloffset=+1] // TODO OSDOCS-11830 This module seems fine to include in ROSA/HCP/OSD include::modules/nw-dns-view.adoc[leveloffset=+1] + endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] // Only this module is visible for ROSA Classic, ROSA with HCP, and OpenShift Dedicated @@ -43,4 +44,5 @@ include::modules/nw-dns-operator-managementState.adoc[leveloffset=+2] include::modules/nw-controlling-dns-pod-placement.adoc[leveloffset=+2] include::modules/configuring-dns-forwarding-with-tls.adoc[leveloffset=+2] + endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] diff --git a/networking/networking_operators/dpu-operator/dpu-operator.adoc b/networking/networking_operators/dpu-operator/dpu-operator.adoc index a75afd942e..a404f42ba0 100644 --- a/networking/networking_operators/dpu-operator/dpu-operator.adoc +++ b/networking/networking_operators/dpu-operator/dpu-operator.adoc @@ -11,6 +11,7 @@ As a cluster administrator, you can add the DPU Operator to your cluster to mana -- :FeatureName: The DPU Operator include::snippets/technology-preview.adoc[] + -- // About DPU and the DPU Operator diff --git a/networking/networking_operators/ebpf_manager/ebpf-manager-operator-install.adoc b/networking/networking_operators/ebpf_manager/ebpf-manager-operator-install.adoc index 956d2606ac..cf03e32be1 100644 --- a/networking/networking_operators/ebpf_manager/ebpf-manager-operator-install.adoc +++ b/networking/networking_operators/ebpf_manager/ebpf-manager-operator-install.adoc @@ -12,6 +12,7 @@ As a cluster administrator, you can install the eBPF Manager Operator by using t include::snippets/technology-preview.adoc[] include::modules/nw-bpfman-operator-installing-cli.adoc[leveloffset=+1] + include::modules/nw-bpfman-operator-installing-console.adoc[leveloffset=+1] [id="next-steps_{context}"] diff --git a/networking/networking_operators/ingress-node-firewall-operator.adoc b/networking/networking_operators/ingress-node-firewall-operator.adoc index 1f56e31166..4514a5c5c2 100644 --- a/networking/networking_operators/ingress-node-firewall-operator.adoc +++ b/networking/networking_operators/ingress-node-firewall-operator.adoc @@ -24,6 +24,7 @@ include::modules/nw-infw-operator-rules-object.adoc[leveloffset=+2] include::snippets/technology-preview.adoc[] include::modules/nw-bpfman-infw-about.adoc[leveloffset=+1] + include::modules/nw-bpfman-infw-configure.adoc[leveloffset=+1] include::modules/nw-infw-operator-viewing.adoc[leveloffset=+1] diff --git a/networking/networking_operators/ingress-operator.adoc b/networking/networking_operators/ingress-operator.adoc index 5673fbebdf..4758795a4c 100644 --- a/networking/networking_operators/ingress-operator.adoc +++ b/networking/networking_operators/ingress-operator.adoc @@ -128,13 +128,16 @@ include::modules/nw-configuring-router-compression.adoc[leveloffset=+2] include::modules/nw-exposing-router-metrics.adoc[leveloffset=+2] include::modules/nw-customize-ingress-error-pages.adoc[leveloffset=+2] + //include::modules/nw-ingress-select-route.adoc[leveloffset=+2] include::modules/nw-ingress-setting-max-connections.adoc[leveloffset=+2] + endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] ifdef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] include::modules/sd-ingress-responsibilities.adoc[leveloffset=+1] + endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] diff --git a/networking/ovn_kubernetes_network_provider/configuring-cluster-wide-proxy.adoc b/networking/ovn_kubernetes_network_provider/configuring-cluster-wide-proxy.adoc index 2d518e5d3f..f89642c5c5 100644 --- a/networking/ovn_kubernetes_network_provider/configuring-cluster-wide-proxy.adoc +++ b/networking/ovn_kubernetes_network_provider/configuring-cluster-wide-proxy.adoc @@ -60,9 +60,11 @@ endif::openshift-rosa,openshift-rosa-hcp[] ifdef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] include::modules/configuring-a-proxy-during-installation-ocm.adoc[leveloffset=+2] + endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] ifdef::openshift-rosa,openshift-rosa-hcp[] include::modules/configuring-a-proxy-during-installation-cli.adoc[leveloffset=+2] + endif::openshift-rosa,openshift-rosa-hcp[] ifdef::openshift-rosa,openshift-dedicated[] diff --git a/networking/ovn_kubernetes_network_provider/configuring-egress-ips-ovn.adoc b/networking/ovn_kubernetes_network_provider/configuring-egress-ips-ovn.adoc index 691b33089c..e478e73459 100644 --- a/networking/ovn_kubernetes_network_provider/configuring-egress-ips-ovn.adoc +++ b/networking/ovn_kubernetes_network_provider/configuring-egress-ips-ovn.adoc @@ -15,6 +15,7 @@ include::modules/nw-egress-ips-about.adoc[leveloffset=+1] ifndef::openshift-rosa[] // Considerations for using an egress IP address on additional network interfaces include::modules/nw-egress-ips-multi-nic-considerations.adoc[leveloffset=+2] + endif::openshift-rosa[] // EgressIP object @@ -36,6 +37,7 @@ include::modules/egressip_configure_failover_task.adoc[leveloffset=+2] // REFERENCE: Describes the parameters (The table of values) include::modules/egressip_failover_reference.adoc[leveloffset=+2] + endif::openshift-rosa,openshift-rosa-hcp[] // Labeling a node to host egress IP addresses @@ -44,6 +46,7 @@ include::modules/nw-egress-ips-node.adoc[leveloffset=+1] ifndef::openshift-rosa[] // Configuring dual-stack networking for an EgressIP object include::modules/nw-egress-ips-object-dual-stack.adoc[leveloffset=+1] + endif::openshift-rosa[] [role="_additional-resources"] diff --git a/networking/ovn_kubernetes_network_provider/enabling-multicast.adoc b/networking/ovn_kubernetes_network_provider/enabling-multicast.adoc index 1fe7df22d8..05ccdc90e9 100644 --- a/networking/ovn_kubernetes_network_provider/enabling-multicast.adoc +++ b/networking/ovn_kubernetes_network_provider/enabling-multicast.adoc @@ -24,6 +24,7 @@ In {product-title} {product-version}, a bug prevents pods in the same namespace, endif::bz[] include::modules/nw-about-multicast.adoc[leveloffset=+1] + include::modules/nw-enabling-multicast.adoc[leveloffset=+1] ifdef::bz[] diff --git a/networking/ovn_kubernetes_network_provider/ovn-kubernetes-troubleshooting-sources.adoc b/networking/ovn_kubernetes_network_provider/ovn-kubernetes-troubleshooting-sources.adoc index 7a85f74b53..6492b4545d 100644 --- a/networking/ovn_kubernetes_network_provider/ovn-kubernetes-troubleshooting-sources.adoc +++ b/networking/ovn_kubernetes_network_provider/ovn-kubernetes-troubleshooting-sources.adoc @@ -28,6 +28,7 @@ include::modules/nw-ovn-kubernetes-change-log-levels.adoc[leveloffset=+2] include::modules/nw-ovn-kubernetes-pod-connectivity-checks.adoc[leveloffset=+1] include::modules/nw-ovn-kubernetes-observability.adoc[leveloffset=+1] + include::modules/observability-ovs-sampling-flags.adoc[leveloffset=+2] [role="_additional-resources"] diff --git a/nodes/cma/nodes-cma-autoscaling-custom-adding.adoc b/nodes/cma/nodes-cma-autoscaling-custom-adding.adoc index cede8ee188..f5b4c5469d 100644 --- a/nodes/cma/nodes-cma-autoscaling-custom-adding.adoc +++ b/nodes/cma/nodes-cma-autoscaling-custom-adding.adoc @@ -18,6 +18,7 @@ include::modules/nodes-cma-autoscaling-custom-creating-workload.adoc[leveloffset //Scaling by using a scaled job is a Technology Preview feature. TP not supported in ROSA/OSD ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] include::modules/nodes-cma-autoscaling-custom-creating-job.adoc[leveloffset=+1] + endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] [role="_additional-resources"] diff --git a/nodes/cma/nodes-cma-autoscaling-custom-install.adoc b/nodes/cma/nodes-cma-autoscaling-custom-install.adoc index 837829fb0a..2bad32e090 100644 --- a/nodes/cma/nodes-cma-autoscaling-custom-install.adoc +++ b/nodes/cma/nodes-cma-autoscaling-custom-install.adoc @@ -26,10 +26,12 @@ If you are installing a Custom Metrics Autoscaler Operator version lower than 2. ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] include::modules/nodes-cma-autoscaling-custom-install.adoc[leveloffset=+1] + endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] ifdef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] include::modules/sd-nodes-cma-autoscaling-custom-install.adoc[leveloffset=+1] + endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] include::modules/nodes-cma-autoscaling-keda-controller-edit.adoc[leveloffset=+1] diff --git a/nodes/cma/nodes-cma-autoscaling-custom-metrics.adoc b/nodes/cma/nodes-cma-autoscaling-custom-metrics.adoc index 9ebe10e287..d28b6c5069 100644 --- a/nodes/cma/nodes-cma-autoscaling-custom-metrics.adoc +++ b/nodes/cma/nodes-cma-autoscaling-custom-metrics.adoc @@ -10,4 +10,5 @@ toc::[] The Custom Metrics Autoscaler Operator exposes ready-to-use metrics that it pulls from the on-cluster monitoring component. You can query the metrics by using the Prometheus Query Language (PromQL) to analyze and diagnose issues. All metrics are reset when the controller pod restarts. include::modules/nodes-cma-autoscaling-custom-metrics-access.adoc[leveloffset=+1] + include::modules/nodes-cma-autoscaling-custom-metrics-provided.adoc[leveloffset=+2] diff --git a/nodes/cma/nodes-cma-autoscaling-custom-pausing.adoc b/nodes/cma/nodes-cma-autoscaling-custom-pausing.adoc index aaab128ac0..ed44091ae0 100644 --- a/nodes/cma/nodes-cma-autoscaling-custom-pausing.adoc +++ b/nodes/cma/nodes-cma-autoscaling-custom-pausing.adoc @@ -12,4 +12,5 @@ You can pause and restart the autoscaling of a workload, as needed. For example, you might want to pause autoscaling before performing cluster maintenance or to avoid resource starvation by removing non-mission-critical workloads. include::modules/nodes-cma-autoscaling-custom-pausing-workload.adoc[leveloffset=+1] + include::modules/nodes-cma-autoscaling-custom-pausing-restart.adoc[leveloffset=+1] diff --git a/nodes/cma/nodes-cma-autoscaling-custom-trigger.adoc b/nodes/cma/nodes-cma-autoscaling-custom-trigger.adoc index 6d098239ca..eaa0c4f611 100644 --- a/nodes/cma/nodes-cma-autoscaling-custom-trigger.adoc +++ b/nodes/cma/nodes-cma-autoscaling-custom-trigger.adoc @@ -22,7 +22,9 @@ You can configure a certificate authority xref:../../nodes/cma/nodes-cma-autosca // assemblies. include::modules/nodes-cma-autoscaling-custom-trigger-prom.adoc[leveloffset=+1] + include::modules/nodes-cma-autoscaling-custom-trigger-prom-gpu.adoc[leveloffset=+2] + include::modules/nodes-cma-autoscaling-custom-prometheus-config.adoc[leveloffset=+2] [role="_additional-resources"] @@ -30,7 +32,11 @@ include::modules/nodes-cma-autoscaling-custom-prometheus-config.adoc[leveloffset * xref:../../nodes/cma/nodes-cma-autoscaling-custom-trigger-auth.adoc#nodes-cma-autoscaling-custom-trigger-auth[Understanding custom metrics autoscaler trigger authentications] include::modules/nodes-cma-autoscaling-custom-trigger-cpu.adoc[leveloffset=+1] + include::modules/nodes-cma-autoscaling-custom-trigger-memory.adoc[leveloffset=+1] + include::modules/nodes-cma-autoscaling-custom-trigger-kafka.adoc[leveloffset=+1] + include::modules/nodes-cma-autoscaling-custom-trigger-cron.adoc[leveloffset=+1] + include::modules/nodes-cma-autoscaling-custom-trigger-workload.adoc[leveloffset=+1] diff --git a/nodes/nodes-sigstore-using.adoc b/nodes/nodes-sigstore-using.adoc index 82213d204f..36b04a8bbf 100644 --- a/nodes/nodes-sigstore-using.adoc +++ b/nodes/nodes-sigstore-using.adoc @@ -15,7 +15,9 @@ You can use link:https://www.sigstore.dev/[sigstore] with {product-title} to imp // Manage secure signatures with SigStore include::modules/nodes-sigstore-using-about.adoc[leveloffset=+1] + include::modules/nodes-sigstore-configure.adoc[leveloffset=+1] + include::modules/nodes-sigstore-configure-cluster-policy.adoc[leveloffset=+1] [role="_additional-resources"] diff --git a/nodes/nodes/nodes-node-tuning-operator.adoc b/nodes/nodes/nodes-node-tuning-operator.adoc index 0d3940d320..6433d22445 100644 --- a/nodes/nodes/nodes-node-tuning-operator.adoc +++ b/nodes/nodes/nodes-node-tuning-operator.adoc @@ -19,6 +19,7 @@ include::modules/node-tuning-operator.adoc[leveloffset=+1] ifndef::openshift-rosa-hcp[] include::modules/accessing-an-example-cluster-node-tuning-operator-specification.adoc[leveloffset=+1] + endif::openshift-rosa-hcp[] include::modules/custom-tuning-specification.adoc[leveloffset=+1] @@ -27,6 +28,7 @@ ifndef::openshift-rosa-hcp[] include::modules/cluster-node-tuning-operator-default-profiles-set.adoc[leveloffset=+1] include::modules/node-tuning-operator-supported-tuned-daemon-plug-ins.adoc[leveloffset=+1] + endif::openshift-rosa-hcp[] ifdef::openshift-rosa-hcp[] @@ -35,4 +37,5 @@ include::modules/rosa-creating-node-tuning.adoc[leveloffset=+1] include::modules/rosa-modifying-node-tuning.adoc[leveloffset=+1] include::modules/rosa-deleting-node-tuning.adoc[leveloffset=+1] + endif::openshift-rosa-hcp[] diff --git a/nodes/nodes/nodes-nodes-managing.adoc b/nodes/nodes/nodes-nodes-managing.adoc index 70b52a9394..77259ee02f 100644 --- a/nodes/nodes/nodes-nodes-managing.adoc +++ b/nodes/nodes/nodes-nodes-managing.adoc @@ -31,6 +31,7 @@ include::modules/nodes-nodes-kernel-arguments.adoc[leveloffset=+1] ifdef::openshift-webscale[] include::modules/nodes-nodes-rtkernel-arguments.adoc[leveloffset=+1] + endif::openshift-webscale[] include::modules/nodes-nodes-swap-memory.adoc[leveloffset=+1] diff --git a/nodes/nodes/nodes-nodes-viewing.adoc b/nodes/nodes/nodes-nodes-viewing.adoc index 4cd731e050..8ee4b9eeb7 100644 --- a/nodes/nodes/nodes-nodes-viewing.adoc +++ b/nodes/nodes/nodes-nodes-viewing.adoc @@ -13,6 +13,7 @@ The master uses the information from node objects to validate nodes with health ifdef::openshift-rosa,openshift-rosa-hcp[] include::snippets/rosa-node-lifecycle.adoc[] + endif::openshift-rosa,openshift-rosa-hcp[] // The following include statements pull in the module files that comprise diff --git a/nodes/nodes/nodes-nodes-working.adoc b/nodes/nodes/nodes-nodes-working.adoc index 40ecc3edfb..0a4fd9311c 100644 --- a/nodes/nodes/nodes-nodes-working.adoc +++ b/nodes/nodes/nodes-nodes-working.adoc @@ -24,11 +24,14 @@ endif::openshift-rosa,openshift-rosa-hcp[] ifdef::openshift-enterprise,openshift-rosa,openshift-rosa-hcp[] include::modules/nodes-nodes-working-evacuating.adoc[leveloffset=+1] + endif::openshift-enterprise,openshift-rosa,openshift-rosa-hcp[] ifndef::openshift-rosa,openshift-rosa-hcp[] include::modules/nodes-nodes-working-updating.adoc[leveloffset=+1] + include::modules/nodes-nodes-working-marking.adoc[leveloffset=+1] + include::modules/sno-clusters-reboot-without-drain.adoc[leveloffset=+1] [role="_additional-resources"] @@ -46,4 +49,5 @@ include::modules/nodes-nodes-working-deleting.adoc[leveloffset=+2] * xref:../../machine_management/manually-scaling-machineset.adoc#machineset-manually-scaling-manually-scaling-machineset[Manually scaling a compute machine set] include::modules/nodes-nodes-working-deleting-bare-metal.adoc[leveloffset=+2] + endif::openshift-rosa,openshift-rosa-hcp[] diff --git a/nodes/nodes/nodes-update-boot-images.adoc b/nodes/nodes/nodes-update-boot-images.adoc index b862a52a7d..67801c6eaf 100644 --- a/nodes/nodes/nodes-update-boot-images.adoc +++ b/nodes/nodes/nodes-update-boot-images.adoc @@ -23,4 +23,5 @@ include::modules/mco-update-boot-images-about.adoc[leveloffset=+1] * xref:../../machine_configuration/mco-update-boot-images.adoc#mco-update-boot-images-configuring_machine-configs-configure[Enabling boot image management] include::modules/mco-update-boot-images-disable.adoc[leveloffset=+1] + include::modules/mco-update-boot-images-configuring.adoc[leveloffset=+1] diff --git a/nodes/pods/nodes-pods-configuring.adoc b/nodes/pods/nodes-pods-configuring.adoc index e94d481858..f93128adaf 100644 --- a/nodes/pods/nodes-pods-configuring.adoc +++ b/nodes/pods/nodes-pods-configuring.adoc @@ -28,6 +28,7 @@ include::modules/nodes-pods-pod-disruption-configuring.adoc[leveloffset=+2] ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] include::modules/pod-disruption-eviction-policy.adoc[leveloffset=+2] + endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] //Unsupported @@ -41,4 +42,5 @@ ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] include::modules/nodes-pods-configuring-pod-critical.adoc[leveloffset=+1] include::modules/nodes-pods-configuring-reducing.adoc[leveloffset=+1] + endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] diff --git a/nodes/pods/nodes-pods-secrets-store.adoc b/nodes/pods/nodes-pods-secrets-store.adoc index 78d793d6aa..5437c4f20a 100644 --- a/nodes/pods/nodes-pods-secrets-store.adoc +++ b/nodes/pods/nodes-pods-secrets-store.adoc @@ -36,6 +36,7 @@ After installing the {secrets-store-operator}, you can mount secrets from one of // Mounting secrets from AWS Secrets Manager :secrets-store-provider: AWS Secrets Manager include::modules/secrets-store-aws.adoc[leveloffset=+2] + :!secrets-store-provider: [role="_additional-resources"] @@ -49,6 +50,7 @@ include::modules/secrets-store-aws.adoc[leveloffset=+2] // Mounting secrets from AWS Systems Manager Parameter Store :secrets-store-provider: AWS Systems Manager Parameter Store include::modules/secrets-store-aws.adoc[leveloffset=+2] + :!secrets-store-provider: // Resetting the context back to original context diff --git a/nodes/pods/nodes-pods-viewing.adoc b/nodes/pods/nodes-pods-viewing.adoc index b8f0683c78..f3e21b5e45 100644 --- a/nodes/pods/nodes-pods-viewing.adoc +++ b/nodes/pods/nodes-pods-viewing.adoc @@ -13,5 +13,7 @@ include::modules/nodes-pods-viewing-project.adoc[leveloffset=+1] include::modules/nodes-pods-viewing-usage.adoc[leveloffset=+1] include::modules/viewing-resource-logs-cli-console.adoc[leveloffset=+1] + include::modules/viewing-resource-logs-console.adoc[leveloffset=+2] + include::modules/viewing-resource-logs-cli.adoc[leveloffset=+2] \ No newline at end of file diff --git a/nodes/scheduling/nodes-scheduler-node-affinity.adoc b/nodes/scheduling/nodes-scheduler-node-affinity.adoc index de0155c706..ceecdb3bfb 100644 --- a/nodes/scheduling/nodes-scheduler-node-affinity.adoc +++ b/nodes/scheduling/nodes-scheduler-node-affinity.adoc @@ -28,6 +28,7 @@ include::modules/nodes-scheduler-node-affinity-example.adoc[leveloffset=+1] ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] include::modules/olm-overriding-operator-pod-affinity.adoc[leveloffset=+1] + endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] diff --git a/nodes/scheduling/nodes-scheduler-node-selectors.adoc b/nodes/scheduling/nodes-scheduler-node-selectors.adoc index 7b4dc37dbc..40dc5ae222 100644 --- a/nodes/scheduling/nodes-scheduler-node-selectors.adoc +++ b/nodes/scheduling/nodes-scheduler-node-selectors.adoc @@ -16,6 +16,7 @@ ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] include::modules/nodes-scheduler-node-selectors-cluster.adoc[leveloffset=+1] include::modules/nodes-scheduler-node-selectors-project.adoc[leveloffset=+1] + endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] // The following xref points to a topic not included in the OSD and ROSA docs. diff --git a/nodes/scheduling/nodes-scheduler-pod-affinity.adoc b/nodes/scheduling/nodes-scheduler-pod-affinity.adoc index fef94caeca..ee8e06fd7a 100644 --- a/nodes/scheduling/nodes-scheduler-pod-affinity.adoc +++ b/nodes/scheduling/nodes-scheduler-pod-affinity.adoc @@ -18,4 +18,5 @@ include::modules/nodes-scheduler-pod-affinity-example.adoc[leveloffset=+1] ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] include::modules/olm-overriding-operator-pod-affinity.adoc[leveloffset=+1] + endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] diff --git a/openshift_images/create-images.adoc b/openshift_images/create-images.adoc index ea406c594d..dc76981c68 100644 --- a/openshift_images/create-images.adoc +++ b/openshift_images/create-images.adoc @@ -15,11 +15,17 @@ endif::[] // include::modules/builds-define-build-inputs.adoc[leveloffset=+1] include::modules/images-create-guidelines.adoc[leveloffset=+1] + include::modules/images-create-guide-general.adoc[leveloffset=+2] + include::modules/images-create-guide-openshift.adoc[leveloffset=+2] + include::modules/images-create-metadata.adoc[leveloffset=+1] + include::modules/images-create-s2i.adoc[leveloffset=+1] + include::modules/images-create-s2i-build.adoc[leveloffset=+2] + include::modules/images-create-s2i-scripts.adoc[leveloffset=+2] //Testing may have to move diff --git a/openshift_images/image-configuration.adoc b/openshift_images/image-configuration.adoc index 84862e32e7..264b1891ec 100644 --- a/openshift_images/image-configuration.adoc +++ b/openshift_images/image-configuration.adoc @@ -28,6 +28,7 @@ include::modules/images-configuration-blocked.adoc[leveloffset=+2] // Managed OpenShift customers may not create ImageContentSourcePolicy ifndef::openshift-rosa,openshift-dedicated[] include::modules/images-configuration-blocked-payload.adoc[leveloffset=+3] + endif::openshift-rosa,openshift-dedicated[] include::modules/images-configuration-insecure.adoc[leveloffset=+2] diff --git a/openshift_images/image-streams-manage.adoc b/openshift_images/image-streams-manage.adoc index a5e3af8052..af4e5493db 100644 --- a/openshift_images/image-streams-manage.adoc +++ b/openshift_images/image-streams-manage.adoc @@ -9,12 +9,18 @@ toc::[] Image streams provide a means of creating and updating container images in an on-going way. As improvements are made to an image, tags can be used to assign new version numbers and keep track of changes. This document describes how image streams are managed. include::modules/images-imagestream-use.adoc[leveloffset=+1] + include::modules/images-imagestream-configure.adoc[leveloffset=+1] + include::modules/images-using-imagestream-images.adoc[leveloffset=+1] + include::modules/images-using-imagestream-tags.adoc[leveloffset=+1] + include::modules/images-using-imagestream-change-triggers.adoc[leveloffset=+1] + ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] include::modules/images-imagestream-mapping.adoc[leveloffset=+1] + endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] == Working with image streams @@ -24,9 +30,13 @@ The following sections describe how to use image streams and image stream tags. include::snippets/default-projects.adoc[] include::modules/images-getting-info-about-imagestreams.adoc[leveloffset=+2] + include::modules/images-imagestream-adding-tags.adoc[leveloffset=+2] + include::modules/images-imagestream-external-image-tags.adoc[leveloffset=+2] + include::modules/images-imagestream-update-tag.adoc[leveloffset=+2] + include::modules/images-imagestream-remove-tag.adoc[leveloffset=+2] See xref:../openshift_images/configuring-samples-operator.adoc#images-samples-operator-deprecated-image-stream_configuring-samples-operator[Removing deprecated image stream tags from the Cluster Samples Operator] for more information on how the Cluster Samples Operator handles deprecated image stream tags. @@ -39,11 +49,16 @@ include::modules/images-imagestream-import.adoc[leveloffset=+2] The following sections describe how to import, and work with, image streams. include::modules/images-imagestream-import-images-private-registry.adoc[leveloffset=+2] + //include::modules/images-allow-pods-to-reference-images-from-secure-registries.adoc[leveloffset=+3] include::modules/images-imagestream-import-import-mode.adoc[leveloffset=+2] + include::modules/images-imagestream-periodic-import-list.adoc[leveloffset=+3] + include::modules/images-imagestream-ssl-import-list.adoc[leveloffset=+3] + include::modules/images-imagestream-specify-architecture.adoc[leveloffset=+2] + include::modules/importmode-configuration-fields.adoc[leveloffset=+2] diff --git a/openshift_images/images-understand.adoc b/openshift_images/images-understand.adoc index ae903dffdf..129928e033 100644 --- a/openshift_images/images-understand.adoc +++ b/openshift_images/images-understand.adoc @@ -9,14 +9,23 @@ toc::[] Containers, images, and image streams are important concepts to understand when you set out to create and manage containerized software. An image holds a set of software that is ready to run, while a container is a running instance of a container image. An image stream provides a way of storing different versions of the same basic image. Those different versions are represented by different tags on the same image name. include::modules/images-about.adoc[leveloffset=+1] + include::modules/containers-about.adoc[leveloffset=+1] + include::modules/images-image-registry-about.adoc[leveloffset=+1] + include::modules/images-container-repository-about.adoc[leveloffset=+1] + include::modules/images-tag.adoc[leveloffset=+1] + include::modules/images-id.adoc[leveloffset=+1] + include::modules/images-imagestream-use.adoc[leveloffset=+1] + include::modules/images-imagestream-tag.adoc[leveloffset=+1] + include::modules/images-imagestream-image.adoc[leveloffset=+1] + include::modules/images-imagestream-trigger.adoc[leveloffset=+1] ifdef::openshift-enterprise,openshift-webscale,openshift-origin[] diff --git a/openshift_images/index.adoc b/openshift_images/index.adoc index a9c52a9376..90a8c2d042 100644 --- a/openshift_images/index.adoc +++ b/openshift_images/index.adoc @@ -14,6 +14,7 @@ An image stream provides a way of storing different versions of the same basic i Those different versions are represented by different tags on the same image name. include::modules/images-about.adoc[leveloffset=+1] + ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] You can xref:../openshift_images/create-images.adoc#creating-images[create], xref:../openshift_images/managing_images/managing-images-overview.adoc#managing-images-overview[manage], and xref:../openshift_images/using_images/using-images-overview.adoc#using-images-overview[use] container images. endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] diff --git a/openshift_images/managing_images/using-image-pull-secrets.adoc b/openshift_images/managing_images/using-image-pull-secrets.adoc index 1303c86082..399aefb063 100644 --- a/openshift_images/managing_images/using-image-pull-secrets.adoc +++ b/openshift_images/managing_images/using-image-pull-secrets.adoc @@ -17,7 +17,9 @@ You use this pull secret to authenticate with the services that are provided by include::modules/images-allow-pods-to-reference-images-across-projects.adoc[leveloffset=+1] include::modules/images-allow-pods-to-reference-images-from-secure-registries.adoc[leveloffset=+1] + include::modules/creating-pull-secrets.adoc[leveloffset=+2] + include::modules/using-pull-secret.adoc[leveloffset=+2] include::modules/images-pulling-from-private-registries.adoc[leveloffset=+2] @@ -25,4 +27,5 @@ include::modules/images-pulling-from-private-registries.adoc[leveloffset=+2] // cannot get resource "secrets" in API group "" in the namespace "openshift-config" ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] include::modules/images-update-global-pull-secret.adoc[leveloffset=+1] + endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] diff --git a/operators/admin/olm-adding-operators-to-cluster.adoc b/operators/admin/olm-adding-operators-to-cluster.adoc index 16d11da4c1..38974bf038 100644 --- a/operators/admin/olm-adding-operators-to-cluster.adoc +++ b/operators/admin/olm-adding-operators-to-cluster.adoc @@ -32,6 +32,7 @@ If you have the pull secret, add the `redhat-operators` catalog to the `Operator endif::[] include::modules/olm-installing-operators-from-software-catalog.adoc[leveloffset=+1] + [role="_additional-resources"] .Additional resources @@ -58,6 +59,7 @@ include::modules/olm-installing-from-software-catalog-using-cli.adoc[leveloffset * xref:../../operators/admin/olm-upgrading-operators.adoc#olm-approving-pending-upgrade_olm-upgrading-operators[Manually approving a pending Operator update] include::modules/olm-preparing-multitenant-operators.adoc[leveloffset=+1] + .Next steps * Install the Operator in the tenant Operator namespace. This task is more easily performed by using the software catalog in the web console instead of the CLI; for a detailed procedure, "Installing from software catalog using the web console". diff --git a/operators/admin/olm-configuring-proxy-support.adoc b/operators/admin/olm-configuring-proxy-support.adoc index ee21faf153..96625c22de 100644 --- a/operators/admin/olm-configuring-proxy-support.adoc +++ b/operators/admin/olm-configuring-proxy-support.adoc @@ -25,6 +25,7 @@ ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] include::modules/olm-overriding-proxy-settings.adoc[leveloffset=+1] + include::modules/olm-injecting-custom-ca.adoc[leveloffset=+1] ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] diff --git a/operators/admin/olm-creating-policy.adoc b/operators/admin/olm-creating-policy.adoc index 2fdf5b2b1d..f82875cd44 100644 --- a/operators/admin/olm-creating-policy.adoc +++ b/operators/admin/olm-creating-policy.adoc @@ -14,13 +14,17 @@ Cluster administrators can use _Operator groups_ to allow regular users to insta * xref:../../operators/understanding/olm/olm-understanding-operatorgroups.adoc#olm-understanding-operatorgroups[Operator groups] include::modules/olm-policy-understanding.adoc[leveloffset=+1] + include::modules/olm-policy-scenarios.adoc[leveloffset=+2] + include::modules/olm-policy-workflow.adoc[leveloffset=+2] include::modules/olm-policy-scoping-operator-install.adoc[leveloffset=+1] + include::modules/olm-policy-fine-grained-permissions.adoc[leveloffset=+2] include::modules/olm-policy-catalog-access.adoc[leveloffset=+1] + [role="_additional-resources"] .Additional resources diff --git a/operators/admin/olm-deleting-operators-from-cluster.adoc b/operators/admin/olm-deleting-operators-from-cluster.adoc index 18b72926ee..8cb8291f9f 100644 --- a/operators/admin/olm-deleting-operators-from-cluster.adoc +++ b/operators/admin/olm-deleting-operators-from-cluster.adoc @@ -18,5 +18,7 @@ endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] ==== include::modules/olm-deleting-operators-from-a-cluster-using-web-console.adoc[leveloffset=+1] + include::modules/olm-deleting-operators-from-a-cluster-using-cli.adoc[leveloffset=+1] + include::modules/olm-refresh-subs.adoc[leveloffset=+1] diff --git a/operators/admin/olm-managing-custom-catalogs.adoc b/operators/admin/olm-managing-custom-catalogs.adoc index 6a30119aa0..ca054c492e 100644 --- a/operators/admin/olm-managing-custom-catalogs.adoc +++ b/operators/admin/olm-managing-custom-catalogs.adoc @@ -53,6 +53,7 @@ endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] ==== include::modules/olm-creating-fb-catalog-image.adoc[leveloffset=+2] + [role="_additional-resources"] .Additional resources @@ -62,6 +63,7 @@ ifndef::openshift-rosa-hcp[] endif::openshift-rosa-hcp[] include::modules/olm-filtering-fbc.adoc[leveloffset=+2] + ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] [role="_additional-resources"] .Additional resources @@ -78,7 +80,9 @@ endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] include::modules/deprecated-feature.adoc[leveloffset=+1] include::modules/olm-creating-index-image.adoc[leveloffset=+2] + include::modules/olm-updating-index-image.adoc[leveloffset=+2] + include::modules/olm-pruning-index-image.adoc[leveloffset=+2] include::modules/olm-catalog-source-and-psa.adoc[leveloffset=+1] @@ -96,6 +100,7 @@ include::modules/olm-migrating-sqlite-catalog-to-fbc.adoc[leveloffset=+2] * xref:../../operators/admin/olm-managing-custom-catalogs.adoc#olm-creating-catalog-from-index_olm-managing-custom-catalogs[Adding a catalog source to a cluster] include::modules/olm-updating-sqlite-catalog-to-a-new-opm-version.adoc[leveloffset=+2] + include::modules/olm-sqlite-catalog-configuring-elevated-permissions.adoc[leveloffset=+2] include::modules/olm-creating-catalog-from-index.adoc[leveloffset=+1] @@ -125,12 +130,15 @@ endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] // Exclude from OSD/ROSA - dedicated-admins can't do this procedure. ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] include::modules/olm-restricted-networks-configuring-operatorhub.adoc[leveloffset=+1] + endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] // Removing custom catalogs can be done as a dedicated-admin, but the steps are different. ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] include::modules/olm-removing-catalogs.adoc[leveloffset=+1] + endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] include::modules/sd-olm-removing-catalogs.adoc[leveloffset=+1] + endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] diff --git a/operators/admin/olm-managing-operatorconditions.adoc b/operators/admin/olm-managing-operatorconditions.adoc index b7052be0a8..4e54548b9a 100644 --- a/operators/admin/olm-managing-operatorconditions.adoc +++ b/operators/admin/olm-managing-operatorconditions.adoc @@ -14,6 +14,7 @@ As an administrator with the `dedicated-admin` role, you can manage Operator con endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] include::modules/olm-overriding-operatorconditions.adoc[leveloffset=+1] + include::modules/olm-updating-use-operatorconditions.adoc[leveloffset=+1] [role="_additional-resources"] diff --git a/operators/admin/olm-status.adoc b/operators/admin/olm-status.adoc index 4849030b05..5f3d355a28 100644 --- a/operators/admin/olm-status.adoc +++ b/operators/admin/olm-status.adoc @@ -16,6 +16,7 @@ include::modules/olm-status-conditions.adoc[leveloffset=+1] * xref:../../operators/admin/olm-deleting-operators-from-cluster.adoc#olm-refresh-subs_olm-deleting-operators-from-a-cluster[Refreshing failing subscriptions] include::modules/olm-status-viewing-cli.adoc[leveloffset=+1] + include::modules/olm-cs-status-cli.adoc[leveloffset=+1] [role="_additional-resources"] diff --git a/operators/admin/olm-troubleshooting-operator-issues.adoc b/operators/admin/olm-troubleshooting-operator-issues.adoc index e46c13c53e..c8cff9684c 100644 --- a/operators/admin/olm-troubleshooting-operator-issues.adoc +++ b/operators/admin/olm-troubleshooting-operator-issues.adoc @@ -12,6 +12,7 @@ If you experience Operator issues, verify Operator subscription status. Check Op // Operator subscription condition types include::modules/olm-status-conditions.adoc[leveloffset=+1] + [role="_additional-resources"] .Additional resources @@ -44,20 +45,25 @@ include::modules/gathering-operator-logs.adoc[leveloffset=+1] ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] // Disabling Machine Config Operator from autorebooting include::modules/troubleshooting-disabling-autoreboot-mco.adoc[leveloffset=+1] + include::modules/troubleshooting-disabling-autoreboot-mco-console.adoc[leveloffset=+2] + include::modules/troubleshooting-disabling-autoreboot-mco-cli.adoc[leveloffset=+2] + endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] // Refreshing failing subscriptions // OSD/ROSA cannot delete resource "clusterserviceversions", "jobs" in API group "operators.coreos.com" in the namespace "openshift-apiserver" ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] include::modules/olm-refresh-subs.adoc[leveloffset=+1] + endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] // Reinstalling Operators after failed uninstallation // OSD/ROSA gitcannot delete resource "customresourcedefinitions" ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] include::modules/olm-reinstall.adoc[leveloffset=+1] + endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] diff --git a/operators/admin/olm-upgrading-operators.adoc b/operators/admin/olm-upgrading-operators.adoc index 7110e45fb7..277ac5588e 100644 --- a/operators/admin/olm-upgrading-operators.adoc +++ b/operators/admin/olm-upgrading-operators.adoc @@ -21,7 +21,9 @@ For information on how OLM handles updates for installed Operators colocated in ==== include::modules/olm-preparing-upgrade.adoc[leveloffset=+1] + include::modules/olm-changing-update-channel.adoc[leveloffset=+1] + include::modules/olm-approving-pending-upgrade.adoc[leveloffset=+1] ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] diff --git a/operators/operator_sdk/token_auth/osdk-cco-aws-sts.adoc b/operators/operator_sdk/token_auth/osdk-cco-aws-sts.adoc index 1e08c96526..31d452c97d 100644 --- a/operators/operator_sdk/token_auth/osdk-cco-aws-sts.adoc +++ b/operators/operator_sdk/token_auth/osdk-cco-aws-sts.adoc @@ -41,6 +41,9 @@ Your code should check for secrets that never appear and warn users to follow th * xref:../../../operators/admin/olm-adding-operators-to-cluster.adoc#olm-installing-operator-from-software-catalog-using-cli_olm-adding-operators-to-a-cluster[Installing from OperatorHub using the CLI] include::modules/osdk-cco-aws-sts-enabling.adoc[leveloffset=+1] + include::modules/osdk-cco-aws-sts-role.adoc[leveloffset=+1] + include::modules/osdk-cco-aws-sts-tshooting.adoc[leveloffset=+1] + include::modules/osdk-cco-aws-sts-alt.adoc[leveloffset=+1] diff --git a/operators/understanding/crds/crd-extending-api-with-crds.adoc b/operators/understanding/crds/crd-extending-api-with-crds.adoc index 94fc1498ec..7ed28b23b7 100644 --- a/operators/understanding/crds/crd-extending-api-with-crds.adoc +++ b/operators/understanding/crds/crd-extending-api-with-crds.adoc @@ -10,7 +10,11 @@ toc::[] Operators use the Kubernetes extension mechanism, custom resource definitions (CRDs), so that custom objects managed by the Operator look and act just like the built-in, native Kubernetes objects. This guide describes how cluster administrators can extend their {product-title} cluster by creating and managing CRDs. include::modules/crd-custom-resource-definitions.adoc[leveloffset=+1] + include::modules/crd-creating-crds.adoc[leveloffset=+1] + include::modules/crd-creating-aggregated-cluster-roles.adoc[leveloffset=+1] + include::modules/crd-creating-custom-resources-from-file.adoc[leveloffset=+1] + include::modules/crd-inspecting-custom-resources.adoc[leveloffset=+1] diff --git a/operators/understanding/crds/crd-managing-resources-from-crds.adoc b/operators/understanding/crds/crd-managing-resources-from-crds.adoc index c26eb7d220..70598b0e46 100644 --- a/operators/understanding/crds/crd-managing-resources-from-crds.adoc +++ b/operators/understanding/crds/crd-managing-resources-from-crds.adoc @@ -10,5 +10,7 @@ toc::[] This guide describes how developers can manage custom resources (CRs) that come from custom resource definitions (CRDs). include::modules/crd-custom-resource-definitions.adoc[leveloffset=+1] + include::modules/crd-creating-custom-resources-from-file.adoc[leveloffset=+1] + include::modules/crd-inspecting-custom-resources.adoc[leveloffset=+1] diff --git a/operators/understanding/olm-multitenancy.adoc b/operators/understanding/olm-multitenancy.adoc index 588a839fec..d6dbf0fc24 100644 --- a/operators/understanding/olm-multitenancy.adoc +++ b/operators/understanding/olm-multitenancy.adoc @@ -23,12 +23,14 @@ Consider the following scenarios to determine which Operator installation workfl * xref:../../operators/understanding/olm/olm-understanding-operatorgroups.adoc#olm-operatorgroups-limitations[Limitations for multitenant Operator management] include::modules/olm-default-install-behavior.adoc[leveloffset=+1] + [role="_additional-resources"] .Additional resources * xref:../../operators/admin/olm-adding-operators-to-cluster.adoc#olm-adding-operators-to-a-cluster[Adding Operators to a cluster] * xref:../../operators/understanding/olm/olm-understanding-operatorgroups.adoc#olm-operatorgroups-membership_olm-understanding-operatorgroups[Install modes types] include::modules/olm-multitenancy-solution.adoc[leveloffset=+1] + [role="_additional-resources"] .Additional resources * xref:../../operators/admin/olm-adding-operators-to-cluster.adoc#olm-preparing-operators-multitenant_olm-adding-operators-to-a-cluster[Preparing for multiple instances of an Operator for multitenant clusters] diff --git a/operators/understanding/olm-packaging-format.adoc b/operators/understanding/olm-packaging-format.adoc index fd47e8eabf..b7bc57d0fa 100644 --- a/operators/understanding/olm-packaging-format.adoc +++ b/operators/understanding/olm-packaging-format.adoc @@ -9,6 +9,7 @@ toc::[] This guide outlines the packaging format for Operators supported by Operator Lifecycle Manager (OLM) in {product-title}. include::modules/olm-bundle-format.adoc[leveloffset=+1] + include::modules/olm-dependencies.adoc[leveloffset=+2] [role="_additional-resources"] @@ -33,6 +34,7 @@ ifdef::openshift-origin[] endif::[] include::modules/olm-fb-catalogs.adoc[leveloffset=+1] + [IMPORTANT] ==== As of {product-title} 4.11, the default Red Hat-provided Operator catalog releases in the file-based catalog format. The default Red Hat-provided Operator catalogs for {product-title} 4.6 through 4.10 released in the deprecated SQLite database format. @@ -51,17 +53,24 @@ endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] include::modules/olm-fb-catalogs-structure.adoc[leveloffset=+2] include::modules/olm-fb-catalogs-schemas.adoc[leveloffset=+2] + include::modules/olm-package-schema.adoc[leveloffset=+3] + include::modules/olm-channel-schema.adoc[leveloffset=+3] + include::modules/olm-bundle-schema.adoc[leveloffset=+3] + include::modules/olm-deprecations-schema.adoc[leveloffset=+3] + [role="_additional-resources"] .Additional resources * xref:../../operators/admin/olm-managing-custom-catalogs.adoc#olm-filtering-fbc_olm-managing-custom-catalogs[Updating or filtering a file-based catalog image] include::modules/olm-fb-catalogs-prop.adoc[leveloffset=+2] + include::modules/olm-fb-catalogs-example.adoc[leveloffset=+2] + include::modules/olm-fb-catalogs-guidelines.adoc[leveloffset=+2] [id="olm-fb-catalogs-cli"] diff --git a/operators/understanding/olm-understanding-software-catalog.adoc b/operators/understanding/olm-understanding-software-catalog.adoc index 2b96b7106a..c4633c53ed 100644 --- a/operators/understanding/olm-understanding-software-catalog.adoc +++ b/operators/understanding/olm-understanding-software-catalog.adoc @@ -7,6 +7,7 @@ include::_attributes/common-attributes.adoc[] toc::[] include::modules/olm-software-catalog-overview.adoc[leveloffset=+1] + include::modules/olm-software-catalog-architecture.adoc[leveloffset=+1] [id="olm-understanding-software-catalog-resources"] diff --git a/operators/understanding/olm-what-operators-are.adoc b/operators/understanding/olm-what-operators-are.adoc index e695ceaf54..1508faa310 100644 --- a/operators/understanding/olm-what-operators-are.adoc +++ b/operators/understanding/olm-what-operators-are.adoc @@ -15,5 +15,7 @@ More technically, Operators are a method of packaging, deploying, and managing a A Kubernetes application is an app that is both deployed on Kubernetes and managed using the Kubernetes APIs and `kubectl` or `oc` tooling. To be able to make the most of Kubernetes, you require a set of cohesive APIs to extend in order to service and manage your apps that run on Kubernetes. Think of Operators as the runtime that manages this type of app on Kubernetes. include::modules/olm-why-use-operators.adoc[leveloffset=+1] + include::modules/olm-operator-framework.adoc[leveloffset=+1] + include::modules/olm-operator-maturity-model.adoc[leveloffset=+1] diff --git a/operators/understanding/olm/olm-arch.adoc b/operators/understanding/olm/olm-arch.adoc index d2adea59fb..3aa1603695 100644 --- a/operators/understanding/olm/olm-arch.adoc +++ b/operators/understanding/olm/olm-arch.adoc @@ -9,6 +9,9 @@ toc::[] This guide outlines the component architecture of Operator Lifecycle Manager (OLM) in {product-title}. include::modules/olm-architecture.adoc[leveloffset=+1] + include::modules/olm-arch-olm-operator.adoc[leveloffset=+1] + include::modules/olm-arch-catalog-operator.adoc[leveloffset=+1] + include::modules/olm-arch-catalog-registry.adoc[leveloffset=+1] diff --git a/operators/understanding/olm/olm-colocation.adoc b/operators/understanding/olm/olm-colocation.adoc index 7ce9226f29..11ec6a6605 100644 --- a/operators/understanding/olm/olm-colocation.adoc +++ b/operators/understanding/olm/olm-colocation.adoc @@ -9,6 +9,7 @@ toc::[] This guide outlines multitenancy and Operator colocation in Operator Lifecycle Manager (OLM). include::modules/olm-colocation-namespaces.adoc[leveloffset=+1] + [role="_additional-resources"] .Additional resources diff --git a/operators/understanding/olm/olm-operatorconditions.adoc b/operators/understanding/olm/olm-operatorconditions.adoc index 975dc4ccf9..9252c20359 100644 --- a/operators/understanding/olm/olm-operatorconditions.adoc +++ b/operators/understanding/olm/olm-operatorconditions.adoc @@ -9,6 +9,7 @@ toc::[] This guide outlines how Operator Lifecycle Manager (OLM) uses Operator conditions. include::modules/olm-operatorconditions-about.adoc[leveloffset=+1] + include::modules/olm-supported-operatorconditions.adoc[leveloffset=+1] [id="olm-operatorconditions-addtl-resources"] diff --git a/operators/understanding/olm/olm-understanding-dependency-resolution.adoc b/operators/understanding/olm/olm-understanding-dependency-resolution.adoc index fb7c368cbe..cee06d9a33 100644 --- a/operators/understanding/olm/olm-understanding-dependency-resolution.adoc +++ b/operators/understanding/olm/olm-understanding-dependency-resolution.adoc @@ -9,12 +9,16 @@ toc::[] This guide outlines dependency resolution and custom resource definition (CRD) upgrade lifecycles with Operator Lifecycle Manager (OLM) in {product-title}. include::modules/olm-dependency-resolution-about.adoc[leveloffset=+1] + include::modules/olm-properties.adoc[leveloffset=+1] + .Additional resources * xref:../../../operators/understanding/olm/olm-understanding-dependency-resolution.adoc#olm-cel_olm-understanding-dependency-resolution[Common Expression Language (CEL) constraints] include::modules/olm-dependencies.adoc[leveloffset=+1] + include::modules/olm-generic-constraints.adoc[leveloffset=+1] + include::modules/olm-dependency-resolution-preferences.adoc[leveloffset=+1] [role="_additional-resources"] @@ -33,4 +37,5 @@ include::modules/olm-dependencies-best-practices.adoc[leveloffset=+1] * Kubernetes documentation: link:https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api_changes.md#readme[Changing the API] include::modules/olm-dependencies-caveats.adoc[leveloffset=+1] + include::modules/olm-dependency-resolution-examples.adoc[leveloffset=+1] diff --git a/operators/understanding/olm/olm-understanding-olm.adoc b/operators/understanding/olm/olm-understanding-olm.adoc index 8f0098ad8e..ab9ce4bdb5 100644 --- a/operators/understanding/olm/olm-understanding-olm.adoc +++ b/operators/understanding/olm/olm-understanding-olm.adoc @@ -9,9 +9,13 @@ toc::[] This guide provides an overview of the concepts that drive Operator Lifecycle Manager (OLM) in {product-title}. include::modules/olm-overview.adoc[leveloffset=+1] + include::modules/olm-crds.adoc[leveloffset=+1] + include::modules/olm-csv.adoc[leveloffset=+2] + include::modules/olm-catalogsource.adoc[leveloffset=+2] + [role="_additional-resources"] .Additional resources @@ -27,7 +31,9 @@ endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * xref:../../../operators/admin/olm-cs-podsched.adoc#olm-cs-podsched[Catalog source pod scheduling] include::modules/olm-catalogsource-image-template.adoc[leveloffset=+3] + include::modules/olm-cs-health.adoc[leveloffset=+3] + ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] [role="_additional-resources"] .Additional resources @@ -57,6 +63,7 @@ ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] include::modules/olm-operatorgroups-about.adoc[leveloffset=+2] + .Additional resources * xref:../../../operators/understanding/olm/olm-understanding-operatorgroups.adoc#olm-understanding-operatorgroups[Operator groups] diff --git a/operators/understanding/olm/olm-understanding-operatorgroups.adoc b/operators/understanding/olm/olm-understanding-operatorgroups.adoc index e7fdc406ee..d417aca615 100644 --- a/operators/understanding/olm/olm-understanding-operatorgroups.adoc +++ b/operators/understanding/olm/olm-understanding-operatorgroups.adoc @@ -9,15 +9,25 @@ toc::[] This guide outlines the use of Operator groups with Operator Lifecycle Manager (OLM) in {product-title}. include::modules/olm-operatorgroups-about.adoc[leveloffset=+1] + include::modules/olm-operatorgroups-membership.adoc[leveloffset=+1] + include::modules/olm-operatorgroups-target-namespace.adoc[leveloffset=+1] + include::modules/olm-operatorgroups-csv-annotations.adoc[leveloffset=+1] + include::modules/olm-operatorgroups-provided-apis-annotations.adoc[leveloffset=+1] + include::modules/olm-operatorgroups-rbac.adoc[leveloffset=+1] + include::modules/olm-operatorgroups-copied-csvs.adoc[leveloffset=+1] + include::modules/olm-operatorgroups-static.adoc[leveloffset=+1] + include::modules/olm-operatorgroups-intersections.adoc[leveloffset=+1] + include::modules/olm-operatorgroups-limitations.adoc[leveloffset=+1] + [role="_additional-resources"] .Additional resources ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] diff --git a/operators/user/olm-installing-operators-in-namespace.adoc b/operators/user/olm-installing-operators-in-namespace.adoc index cc983105a9..1021b972da 100644 --- a/operators/user/olm-installing-operators-in-namespace.adoc +++ b/operators/user/olm-installing-operators-in-namespace.adoc @@ -21,9 +21,11 @@ endif::[] include::modules/olm-installing-operators-from-software-catalog.adoc[leveloffset=+1] + * xref:../../operators/understanding/olm-understanding-software-catalog.adoc#olm-understanding-software-catalog[Understanding the software catalog] include::modules/olm-installing-from-software-catalog-using-web-console.adoc[leveloffset=+1] + ifdef::openshift-enterprise,openshift-webscale,openshift-origin[] include::modules/olm-installing-from-software-catalog-using-cli.adoc[leveloffset=+1] diff --git a/post_installation_configuration/changing-cloud-credentials-configuration.adoc b/post_installation_configuration/changing-cloud-credentials-configuration.adoc index 4c14db8e90..5834d4076d 100644 --- a/post_installation_configuration/changing-cloud-credentials-configuration.adoc +++ b/post_installation_configuration/changing-cloud-credentials-configuration.adoc @@ -24,16 +24,19 @@ You can use the Cloud Credential Operator (CCO) utility (`ccoctl`) to update key :context: key-rotation-aws //Rotating OIDC bound service account signer keys include::modules/rotating-bound-service-keys.adoc[leveloffset=+2] + :!context: key-rotation-aws :context: key-rotation-gcp //Rotating OIDC bound service account signer keys include::modules/rotating-bound-service-keys.adoc[leveloffset=+2] + :!context: key-rotation-gcp :context: key-rotation-azure //Rotating OIDC bound service account signer keys include::modules/rotating-bound-service-keys.adoc[leveloffset=+2] + :!context: key-rotation-azure :context: changing-cloud-credentials-configuration diff --git a/post_installation_configuration/cluster-tasks.adoc b/post_installation_configuration/cluster-tasks.adoc index a3873d5c69..95e21a6687 100644 --- a/post_installation_configuration/cluster-tasks.adoc +++ b/post_installation_configuration/cluster-tasks.adoc @@ -293,7 +293,9 @@ include::modules/infrastructure-moving-registry.adoc[leveloffset=+2] include::modules/infrastructure-moving-monitoring.adoc[leveloffset=+2] include::modules/cluster-autoscaler-about.adoc[leveloffset=+1] + include::modules/cluster-autoscaler-cr.adoc[leveloffset=+2] + :FeatureName: cluster autoscaler :FeatureResourceName: ClusterAutoscaler include::modules/deploying-resource.adoc[leveloffset=+2] @@ -311,7 +313,9 @@ For more information, see xref:../machine_management/applying-autoscaling.adoc#a You can turn on a subset of the current Technology Preview features on for all nodes in the cluster by editing the `FeatureGate` custom resource (CR). include::modules/nodes-cluster-enabling-features-about.adoc[leveloffset=+2] + include::modules/nodes-cluster-enabling-features-console.adoc[leveloffset=+2] + include::modules/nodes-cluster-enabling-features-cli.adoc[leveloffset=+2] [id="post-install-etcd-tasks"] @@ -324,11 +328,17 @@ If you deployed a bare-metal cluster, you can scale the cluster up to 5 nodes as ==== include::modules/about-etcd-encryption.adoc[leveloffset=+2] + include::modules/etcd-encryption-types.adoc[leveloffset=+2] + include::modules/enabling-etcd-encryption.adoc[leveloffset=+2] + include::modules/disabling-etcd-encryption.adoc[leveloffset=+2] + include::modules/backup-etcd.adoc[leveloffset=+2] + include::modules/etcd-defrag.adoc[leveloffset=+2] + include::modules/dr-restoring-cluster-state.adoc[leveloffset=+2] [role="_additional-resources"] @@ -345,7 +355,9 @@ include::modules/dr-scenario-cluster-state-issues.adoc[leveloffset=+2] Understand and configure pod disruption budgets. include::modules/nodes-pods-pod-disruption-about.adoc[leveloffset=+2] + include::modules/nodes-pods-pod-disruption-configuring.adoc[leveloffset=+2] + include::modules/pod-disruption-eviction-policy.adoc[leveloffset=+2] [role="_additional-resources"] diff --git a/post_installation_configuration/node-tasks.adoc b/post_installation_configuration/node-tasks.adoc index 2698843a8c..f6a3b87d46 100644 --- a/post_installation_configuration/node-tasks.adoc +++ b/post_installation_configuration/node-tasks.adoc @@ -41,20 +41,29 @@ include::modules/machine-node-custom-partition.adoc[leveloffset=+2] Understand and deploy machine health checks. include::snippets/machine-user-provisioned-limitations.adoc[leveloffset=+2] + include::modules/machine-health-checks-about.adoc[leveloffset=+2] + [role="_additional-resources"] .Additional resources * xref:../machine_management/control_plane_machine_management/cpmso-about.adoc#cpmso-about[About control plane machine sets] include::modules/machine-health-checks-resource.adoc[leveloffset=+2] + include::modules/machine-health-checks-creating.adoc[leveloffset=+2] + include::modules/machineset-manually-scaling.adoc[leveloffset=+2] + include::modules/differences-between-machinesets-and-machineconfigpool.adoc[leveloffset=+2] include::modules/recommended-node-host-practices.adoc[leveloffset=+1] + include::modules/create-a-kubeletconfig-crd-to-edit-kubelet-parameters.adoc[leveloffset=+2] + include::modules/modify-unavailable-workers.adoc[leveloffset=+2] + include::modules/master-node-sizing.adoc[leveloffset=+2] + include::modules/setting-up-cpu-manager.adoc[leveloffset=+2] [id="post-install-huge-pages"] @@ -62,11 +71,15 @@ include::modules/setting-up-cpu-manager.adoc[leveloffset=+2] Understand and configure huge pages. include::modules/what-huge-pages-do.adoc[leveloffset=+2] + include::modules/how-huge-pages-are-consumed-by-apps.adoc[leveloffset=+2] + include::modules/configuring-huge-pages.adoc[leveloffset=+2] include::modules/nodes-pods-plugins-about.adoc[leveloffset=+1] + include::modules/nodes-pods-plugins-device-mgr.adoc[leveloffset=+2] + include::modules/nodes-pods-plugins-install.adoc[leveloffset=+2] [id="post-install-taints-tolerations"] @@ -74,10 +87,15 @@ include::modules/nodes-pods-plugins-install.adoc[leveloffset=+2] Understand and work with taints and tolerations. include::modules/nodes-scheduler-taints-tolerations-about.adoc[leveloffset=+2] + include::modules/nodes-scheduler-taints-tolerations-adding.adoc[leveloffset=+2] + include::modules/nodes-scheduler-taints-tolerations-adding-machineset.adoc[leveloffset=+2] + include::modules/nodes-scheduler-taints-tolerations-binding.adoc[leveloffset=+2] + include::modules/nodes-scheduler-taints-tolerations-special.adoc[leveloffset=+2] + include::modules/nodes-scheduler-taints-tolerations-removing.adoc[leveloffset=+2] [id="post-install-topology-manager"] @@ -85,7 +103,9 @@ include::modules/nodes-scheduler-taints-tolerations-removing.adoc[leveloffset=+2 Understand and work with Topology Manager. include::modules/topology-manager-policies.adoc[leveloffset=+2] + include::modules/setting-up-topology-manager.adoc[leveloffset=+2] + include::modules/pod-interactions-with-topology-manager.adoc[leveloffset=+2] include::modules/nodes-cluster-overcommit-resource-requests.adoc[leveloffset=+1] @@ -135,7 +155,9 @@ include::modules/nodes-cluster-overcommit-project-disable.adoc[leveloffset=+2] Understand and use garbage collection. include::modules/nodes-nodes-garbage-collection-containers.adoc[leveloffset=+2] + include::modules/nodes-nodes-garbage-collection-images.adoc[leveloffset=+2] + include::modules/nodes-nodes-garbage-collection-configuring.adoc[leveloffset=+2] [id="post-using-node-tuning-operator"] @@ -143,9 +165,13 @@ include::modules/nodes-nodes-garbage-collection-configuring.adoc[leveloffset=+2] Understand and use the Node Tuning Operator. include::modules/node-tuning-operator.adoc[leveloffset=+2] + include::modules/accessing-an-example-cluster-node-tuning-operator-specification.adoc[leveloffset=+2] + include::modules/custom-tuning-specification.adoc[leveloffset=+2] + include::modules/cluster-node-tuning-operator-default-profiles-set.adoc[leveloffset=+2] + include::modules/node-tuning-operator-supported-tuned-daemon-plug-ins.adoc[leveloffset=+2] include::modules/nodes-nodes-managing-max-pods-proc.adoc[leveloffset=+1] diff --git a/post_installation_configuration/post-install-image-config.adoc b/post_installation_configuration/post-install-image-config.adoc index 6f8eef2506..a9a0706d69 100644 --- a/post_installation_configuration/post-install-image-config.adoc +++ b/post_installation_configuration/post-install-image-config.adoc @@ -21,6 +21,9 @@ For information about images and configuring image streams or image registries, After installing {product-title} in a disconnected environment, configure the image streams for the Cluster Samples Operator and the `must-gather` image stream. include::modules/installation-images-samples-disconnected-mirroring-assist.adoc[leveloffset=+2] + include::modules/installation-restricted-network-samples.adoc[leveloffset=+2] + include::modules/installation-preparing-restricted-cluster-to-gather-support-data.adoc[leveloffset=+2] + include::modules/images-cluster-sample-imagestream-import.adoc[leveloffset=+1] diff --git a/post_installation_configuration/post-install-network-configuration.adoc b/post_installation_configuration/post-install-network-configuration.adoc index 0898b5af5d..ad25f2dc10 100644 --- a/post_installation_configuration/post-install-network-configuration.adoc +++ b/post_installation_configuration/post-install-network-configuration.adoc @@ -12,6 +12,7 @@ After installing {product-title}, you can further expand and customize your netw == Using the Cluster Network Operator include::snippets/cluster-network-operator-abstract.adoc[] + For more information, see xref:../networking/networking_operators/cluster-network-operator.adoc#nw-cluster-network-operator_cluster-network-operator[Cluster Network Operator in {product-title}]. [id="post-install-network-configuration-tasks"] @@ -33,5 +34,7 @@ ifdef::openshift-enterprise,openshift-webscale,openshift-origin[] As a cluster administrator, you can modify the new project template to automatically include `NetworkPolicy` objects when you create a new project. include::modules/modifying-template-for-new-projects.adoc[leveloffset=+3] + include::modules/nw-networkpolicy-project-defaults.adoc[leveloffset=+3] + endif::[] diff --git a/post_installation_configuration/preparing-for-users.adoc b/post_installation_configuration/preparing-for-users.adoc index abd19fceec..0462e70adf 100644 --- a/post_installation_configuration/preparing-for-users.adoc +++ b/post_installation_configuration/preparing-for-users.adoc @@ -104,6 +104,7 @@ include::modules/rbac-creating-local-role.adoc[leveloffset=+2] ifdef::openshift-enterprise,openshift-webscale,openshift-origin[] include::modules/rbac-creating-cluster-role.adoc[leveloffset=+2] + endif::[] include::modules/rbac-local-role-binding-commands.adoc[leveloffset=+2] @@ -112,6 +113,7 @@ ifdef::openshift-enterprise,openshift-webscale,openshift-origin[] include::modules/rbac-cluster-role-binding-commands.adoc[leveloffset=+2] include::modules/rbac-creating-cluster-admin.adoc[leveloffset=+2] + endif::[] include::modules/unauthenticated-users-cluster-role-binding-con.adoc[leveloffset=+2] @@ -133,6 +135,7 @@ If you mirrored Operator catalogs for use with disconnected clusters, you can po * xref:../disconnected/installing-mirroring-installation-images.adoc#olm-mirror-catalog_installing-mirroring-installation-images[Mirroring Operator catalogs for use with disconnected clusters] include::modules/olm-mirroring-catalog-icsp.adoc[leveloffset=+3] + include::modules/olm-creating-catalog-from-index.adoc[leveloffset=+3] [role="_additional-resources"] @@ -142,10 +145,13 @@ include::modules/olm-creating-catalog-from-index.adoc[leveloffset=+3] * xref:../openshift_images/managing_images/image-pull-policy.adoc#image-pull-policy[Image pull policy] include::modules/olm-installing-operators-from-software-catalog.adoc[leveloffset=+1] + ifdef::openshift-origin[] include::modules/olm-installing-operators-from-software-catalog-configure.adoc[leveloffset=+2] + endif::[] include::modules/olm-installing-from-software-catalog-using-web-console.adoc[leveloffset=+2] + ifdef::openshift-enterprise,openshift-webscale,openshift-origin[] include::modules/olm-installing-from-software-catalog-using-cli.adoc[leveloffset=+2] diff --git a/registry/accessing-the-registry.adoc b/registry/accessing-the-registry.adoc index daa7dc8ad3..958e0c6f46 100644 --- a/registry/accessing-the-registry.adoc +++ b/registry/accessing-the-registry.adoc @@ -42,6 +42,7 @@ endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] include::modules/registry-accessing-directly.adoc[leveloffset=+1] + endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] include::modules/registry-checking-the-status-of-registry-pods.adoc[leveloffset=+1] diff --git a/scalability_and_performance/enabling-workload-partitioning.adoc b/scalability_and_performance/enabling-workload-partitioning.adoc index fd0302823b..af114fe0fb 100644 --- a/scalability_and_performance/enabling-workload-partitioning.adoc +++ b/scalability_and_performance/enabling-workload-partitioning.adoc @@ -37,6 +37,7 @@ include::modules/create-perf-profile-workload-partitioning.adoc[leveloffset=+1] [source,yaml] ---- include::snippets/ztp_PerformanceProfile.yaml[] + ---- include::snippets/performance-profile-workload-partitioning.adoc[] diff --git a/scalability_and_performance/managing-bare-metal-hosts.adoc b/scalability_and_performance/managing-bare-metal-hosts.adoc index a7d007e6c5..af2cfeb76b 100644 --- a/scalability_and_performance/managing-bare-metal-hosts.adoc +++ b/scalability_and_performance/managing-bare-metal-hosts.adoc @@ -9,6 +9,7 @@ toc::[] When you install {product-title} on a bare-metal cluster, you can provision and manage bare-metal nodes by using `machine` and `machineset` custom resources (CRs) for bare-metal hosts that exist in the cluster. include::modules/about-bare-metal-hosts-and-nodes.adoc[leveloffset=+1] + include::modules/maintaining-bare-metal-hosts.adoc[leveloffset=+1] [role="_additional-resources"] @@ -17,8 +18,11 @@ include::modules/maintaining-bare-metal-hosts.adoc[leveloffset=+1] * xref:../machine_management/user_infra/adding-bare-metal-compute-user-infra.adoc#adding-bare-metal-compute-user-infra[Adding compute machines to bare metal] include::modules/adding-bare-metal-host-to-cluster-using-web-console.adoc[leveloffset=+2] + include::modules/adding-bare-metal-host-to-cluster-using-yaml.adoc[leveloffset=+2] + include::modules/automatically-scaling-machines-to-available-bare-metal-hosts.adoc[leveloffset=+2] + include::modules/removing-bare-metal-hosts-from-provisioner.adoc[leveloffset=+2] [role="_additional-resources"] diff --git a/scalability_and_performance/optimization/routing-optimization.adoc b/scalability_and_performance/optimization/routing-optimization.adoc index d460bca19e..312eff7f9f 100644 --- a/scalability_and_performance/optimization/routing-optimization.adoc +++ b/scalability_and_performance/optimization/routing-optimization.adoc @@ -15,4 +15,5 @@ For more information on Ingress sharding, see xref:../../networking/ingress_load You can modify the Ingress Controller deployment by using the information provided in xref:../../networking/networking_operators/ingress-operator.adoc#nw-ingress-setting-thread-count_configuring-ingress[Setting Ingress Controller thread count] for threads and xref:../../networking/networking_operators/ingress-operator.adoc#nw-ingress-controller-configuration-parameters_configuring-ingress[Ingress Controller configuration parameters] for timeouts, and other tuning configurations in the Ingress Controller specification. include::modules/ingress-liveness-readiness-startup-probes.adoc[leveloffset=+1] + include::modules/configuring-haproxy-interval.adoc[leveloffset=+1] diff --git a/security/audit-log-view.adoc b/security/audit-log-view.adoc index 5d79176fe7..2ed29f5096 100644 --- a/security/audit-log-view.adoc +++ b/security/audit-log-view.adoc @@ -22,6 +22,7 @@ include::modules/security-audit-log-filtering.adoc[leveloffset=+1] // Gathering audit logs include::modules/gathering-data-audit-logs.adoc[leveloffset=+1] + //removed xrefs for hcp migration local test builds. Will update conditionals once hcp docs can be tested with live builds. ifndef::openshift-rosa-hcp[] [id="viewing-audit-logs-additional-resources"] diff --git a/security/certificate_types_descriptions/etcd-certificates.adoc b/security/certificate_types_descriptions/etcd-certificates.adoc index c82e6df76e..0a3e3dd457 100644 --- a/security/certificate_types_descriptions/etcd-certificates.adoc +++ b/security/certificate_types_descriptions/etcd-certificates.adoc @@ -15,7 +15,9 @@ etcd certificates are signed by the etcd-signer; they come from a certificate au The CA certificates are valid for 10 years. The peer, client, and server certificates are valid for three years. include::modules/rotating-certificate-authority.adoc[leveloffset=+1] + include::modules/removing-unused-ca-bundle.adoc[leveloffset=+1] + include::modules/etcd-cert-alerts-metrics-signer.adoc[leveloffset=+1] == Management diff --git a/security/compliance_operator/co-management/compliance-operator-updating.adoc b/security/compliance_operator/co-management/compliance-operator-updating.adoc index dffae4859a..768f71daa9 100644 --- a/security/compliance_operator/co-management/compliance-operator-updating.adoc +++ b/security/compliance_operator/co-management/compliance-operator-updating.adoc @@ -28,7 +28,9 @@ Updating your {product-title} cluster to version 4.14 might cause the Compliance // ==== include::modules/olm-preparing-upgrade.adoc[leveloffset=+1] + include::modules/olm-changing-update-channel.adoc[leveloffset=+1] + include::modules/olm-approving-pending-upgrade.adoc[leveloffset=+1] // [id="additional-resources-updating-the-compliance-operator"] diff --git a/security/compliance_operator/compliance-operator-release-notes.adoc b/security/compliance_operator/compliance-operator-release-notes.adoc index eedd3ad4c7..1e0db7c338 100644 --- a/security/compliance_operator/compliance-operator-release-notes.adoc +++ b/security/compliance_operator/compliance-operator-release-notes.adoc @@ -262,6 +262,7 @@ This update addresses a CVE in an underlying dependency. + -- include::snippets/fips-snippet.adoc[] + -- [id="compliance-operator-1-3-1-known-issue"] diff --git a/security/container_security/security-compliance.adoc b/security/container_security/security-compliance.adoc index 1459d22d90..c2361024b2 100644 --- a/security/container_security/security-compliance.adoc +++ b/security/container_security/security-compliance.adoc @@ -13,6 +13,7 @@ standards or the organization's corporate governance framework. // Compliance and the NIST risk management model include::modules/security-compliance-nist.adoc[leveloffset=+1] + ifndef::openshift-origin[] [role="_additional-resources"] diff --git a/security/file_integrity_operator/file-integrity-operator-release-notes.adoc b/security/file_integrity_operator/file-integrity-operator-release-notes.adoc index 5aa5f531a8..f75e9ed821 100644 --- a/security/file_integrity_operator/file-integrity-operator-release-notes.adoc +++ b/security/file_integrity_operator/file-integrity-operator-release-notes.adoc @@ -72,6 +72,7 @@ This update addresses a CVE in an underlying dependency. + -- include::snippets/fips-snippet.adoc[] + -- [id="file-integrity-operator-1-3-3-bug-fixes"] diff --git a/security/file_integrity_operator/file-integrity-operator-understanding.adoc b/security/file_integrity_operator/file-integrity-operator-understanding.adoc index 67ff62c3e2..44ca020484 100644 --- a/security/file_integrity_operator/file-integrity-operator-understanding.adoc +++ b/security/file_integrity_operator/file-integrity-operator-understanding.adoc @@ -14,10 +14,17 @@ Currently, only {op-system-first} nodes are supported. ==== include::modules/file-integrity-understanding-file-integrity-cr.adoc[leveloffset=+1] + include::modules/checking-file-intergrity-cr-status.adoc[leveloffset=+1] + include::modules/file-integrity-CR-phases.adoc[leveloffset=+1] + include::modules/file-integrity-understanding-file-integrity-node-statuses-object.adoc[leveloffset=+1] + include::modules/file-integrity-node-status.adoc[leveloffset=+1] + include::modules/file-integrity-node-status-success.adoc[leveloffset=+2] + include::modules/file-integrity-node-status-failure.adoc[leveloffset=+2] + include::modules/file-integrity-events.adoc[leveloffset=+1] diff --git a/security/file_integrity_operator/file-integrity-operator-updating.adoc b/security/file_integrity_operator/file-integrity-operator-updating.adoc index 0dc52b8db8..980488fd81 100644 --- a/security/file_integrity_operator/file-integrity-operator-updating.adoc +++ b/security/file_integrity_operator/file-integrity-operator-updating.adoc @@ -9,7 +9,9 @@ toc::[] As a cluster administrator, you can update the File Integrity Operator on your {product-title} cluster. include::modules/olm-preparing-upgrade.adoc[leveloffset=+1] + include::modules/olm-changing-update-channel.adoc[leveloffset=+1] + include::modules/olm-approving-pending-upgrade.adoc[leveloffset=+1] // [id="additional-resources-updating-the-compliance-operator"] diff --git a/security/pod-vulnerability-scan.adoc b/security/pod-vulnerability-scan.adoc index c9a7d124f6..e016f70ffc 100644 --- a/security/pod-vulnerability-scan.adoc +++ b/security/pod-vulnerability-scan.adoc @@ -28,8 +28,10 @@ namespace, so it is available to all namespaces on your {product-title} cluster. // include::modules/security-pod-scan-cso.adoc[leveloffset=+1] + include::modules/security-pod-scan-cso-using.adoc[leveloffset=+1] // include::modules/security-pod-scan-query-cli.adoc[leveloffset=+1] + include::modules/removing-cso-operator.adoc[leveloffset=+1] diff --git a/security/seccomp-profiles.adoc b/security/seccomp-profiles.adoc index 1eca1b46bd..2e140478b4 100644 --- a/security/seccomp-profiles.adoc +++ b/security/seccomp-profiles.adoc @@ -27,7 +27,9 @@ You can configure a custom seccomp profile, which allows you to update the filte Seccomp security profiles list the system calls (syscalls) a process can make. Permissions are broader than SELinux, which restrict operations, such as `write`, system-wide. include::modules/creating-custom-seccomp-profile.adoc[leveloffset=+2] + include::modules/setting-custom-seccomp-profile.adoc[leveloffset=+2] + include::modules/applying-custom-seccomp-profile.adoc[leveloffset=+2] During deployment, the admission controller validates the following: diff --git a/storage/container_storage_interface/persistent-storage-csi-aws-efs.adoc b/storage/container_storage_interface/persistent-storage-csi-aws-efs.adoc index 6f75895645..2bf44c22ab 100644 --- a/storage/container_storage_interface/persistent-storage-csi-aws-efs.adoc +++ b/storage/container_storage_interface/persistent-storage-csi-aws-efs.adoc @@ -35,11 +35,13 @@ include::modules/persistent-storage-efs-csi-driver-operator-setup.adoc[leveloffs // Obtaining a role ARN (OCP) ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] include::modules/persistent-storage-csi-efs-sts.adoc[leveloffset=+2] + endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] // Obtaining a role ARN (OSD and ROSA) ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] include::modules/sd-persistent-storage-csi-efs-sts.adoc[leveloffset=+2] + endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] .Next steps @@ -63,7 +65,9 @@ include::modules/persistent-storage-csi-efs-driver-install.adoc[leveloffset=+2] :StorageClass: AWS EFS :Provisioner: efs.csi.aws.com include::modules/storage-create-storage-class.adoc[leveloffset=+1] + include::modules/storage-create-storage-class-console.adoc[leveloffset=+2] + include::modules/storage-create-storage-class-cli.adoc[leveloffset=+2] include::modules/persistent-storage-csi-efs-cross-account.adoc[leveloffset=+1] @@ -79,6 +83,7 @@ include::modules/persistent-storage-csi-efs-one-zone-overview.adoc[leveloffset=+ include::modules/persistent-storage-csi-efs-one-zone-procedure.adoc[leveloffset=+2] include::modules/persistent-storage-csi-dynamic-provisioning-aws-efs.adoc[leveloffset=+1] + If you have problems setting up dynamic provisioning, see xref:../../storage/container_storage_interface/persistent-storage-csi-aws-efs.adoc#efs-troubleshooting_persistent-storage-csi-aws-efs[AWS EFS troubleshooting]. [role="_additional-resources"] .Additional resources @@ -89,6 +94,7 @@ If you have problems setting up dynamic provisioning, see xref:../../storage/con :!StorageClass: include::modules/persistent-storage-csi-efs-static-pv.adoc[leveloffset=+1] + If you have problems setting up static PVs, see xref:../../storage/container_storage_interface/persistent-storage-csi-aws-efs.adoc#efs-troubleshooting_persistent-storage-csi-aws-efs[AWS EFS troubleshooting]. include::modules/persistent-storage-csi-efs-security.adoc[leveloffset=+1] diff --git a/storage/container_storage_interface/persistent-storage-csi-migration.adoc b/storage/container_storage_interface/persistent-storage-csi-migration.adoc index f9526e87be..d8ba3edaac 100644 --- a/storage/container_storage_interface/persistent-storage-csi-migration.adoc +++ b/storage/container_storage_interface/persistent-storage-csi-migration.adoc @@ -9,6 +9,7 @@ toc::[] In-tree storage drivers that are traditionally shipped with {product-title} are being deprecated and replaced by their equivalent Container Storage Interface (CSI) drivers. {product-title} provides automatic migration for in-tree volume plugins to their equivalent CSI drivers. include::modules/persistent-storage-csi-migration-overview.adoc[leveloffset=+1] + include::modules/persistent-storage-csi-migration-sc.adoc[leveloffset=+1] To change the default storage class, see xref:../../storage/container_storage_interface/persistent-storage-csi-sc-manage.adoc#change-default-storage-class_persistent-storage-csi-sc-manage[Changing the default storage class]. diff --git a/storage/container_storage_interface/persistent-storage-csi-sc-manage.adoc b/storage/container_storage_interface/persistent-storage-csi-sc-manage.adoc index 5f2b9cb358..6569e49e3b 100644 --- a/storage/container_storage_interface/persistent-storage-csi-sc-manage.adoc +++ b/storage/container_storage_interface/persistent-storage-csi-sc-manage.adoc @@ -43,6 +43,9 @@ Managing the default storage classes is supported by the following Container Sto endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] include::modules/persistent-storage-csi-sc-managing.adoc[leveloffset=+1] + include::modules/persistent-storage-csi-sc-managing-cli.adoc[leveloffset=+1] + include::modules/persistent-storage-csi-sc-multiple-none.adoc[leveloffset=+1] + include::modules/dynamic-provisioning-change-default-class.adoc[leveloffset=+1] diff --git a/storage/container_storage_interface/persistent-storage-csi-vsphere.adoc b/storage/container_storage_interface/persistent-storage-csi-vsphere.adoc index a6382dcaa9..091a50abce 100644 --- a/storage/container_storage_interface/persistent-storage-csi-vsphere.adoc +++ b/storage/container_storage_interface/persistent-storage-csi-vsphere.adoc @@ -76,6 +76,7 @@ include::modules/persistent-storage-csi-vsphere-encryption-tag-based.adoc[levelo include::modules/persistent-storage-csi-vsphere-multi-vcenter-support-overview.adoc[leveloffset=+1] include::modules/persistent-storage-csi-vsphere-multi-vcenter-support-procedure-install.adoc[leveloffset=+2] + [role="_additional-resources"] .Additional resources [id="link_installation_config_parameters_vsphere"] @@ -84,17 +85,20 @@ include::modules/persistent-storage-csi-vsphere-multi-vcenter-support-procedure- include::modules/persistent-storage-csi-vsphere-top-aware-overview.adoc[leveloffset=+1] include::modules/persistent-storage-csi-vsphere-top-aware-during-install.adoc[leveloffset=+2] + [role="_additional-resources"] .Additional resources * xref:../../installing/installing_vsphere/ipi/installing-vsphere-installer-provisioned-customizations.adoc#configuring-vsphere-regions-zones_installing-vsphere-installer-provisioned-customizations[Configuring regions and zones for a VMware vCenter] include::modules/persistent-storage-csi-vsphere-top-aware-post-install.adoc[leveloffset=+2] + [role="_additional-resources"] .Additional resources * xref:../../installing/installing_vsphere/post-install-vsphere-zones-regions-configuration.adoc#specifying-regions-zones-infrastructure-vsphere_post-install-vsphere-zones-regions-configuration[Specifying multiple regions and zones for your cluster on vSphere] * https://docs.vmware.com/en/VMware-vSphere/8.0/vsphere-vcenter-esxi-management/GUID-16422FF7-235B-4A44-92E2-532F6AED0923.html?hWord=N4IghgNiBcIC5gOYgL5A[VMware vSphere tag documentation] include::modules/persistent-storage-csi-vsphere-top-aware-infra-top.adoc[leveloffset=+2] + [role="_additional-resources"] .Additional resources * https://docs.vmware.com/en/VMware-vSphere/8.0/vsphere-vcenter-esxi-management/GUID-16422FF7-235B-4A44-92E2-532F6AED0923.html?hWord=N4IghgNiBcIC5gOYgL5A[VMware vSphere tag documentation] diff --git a/storage/container_storage_interface/persistent-storage-csi.adoc b/storage/container_storage_interface/persistent-storage-csi.adoc index 21962195f6..00fc0ac6c3 100644 --- a/storage/container_storage_interface/persistent-storage-csi.adoc +++ b/storage/container_storage_interface/persistent-storage-csi.adoc @@ -23,6 +23,7 @@ include::modules/persistent-storage-csi-external-controllers.adoc[leveloffset=+2 include::modules/persistent-storage-csi-driver-daemonset.adoc[leveloffset=+2] include::modules/persistent-storage-csi-drivers-supported.adoc[leveloffset=+1] + [role="_additional-resources"] .Additional resources * link:https://catalog.redhat.com/[Red Hat ecosystem portal] diff --git a/storage/dynamic-provisioning.adoc b/storage/dynamic-provisioning.adoc index 6d5e353756..7a68d49fb8 100644 --- a/storage/dynamic-provisioning.adoc +++ b/storage/dynamic-provisioning.adoc @@ -20,6 +20,7 @@ ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] include::modules/dynamic-provisioning-cinder-definition.adoc[leveloffset=+2] include::modules/dynamic-provisioning-manila-csi-definition.adoc[leveloffset=+2] + endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] include::modules/dynamic-provisioning-aws-definition.adoc[leveloffset=+2] @@ -30,10 +31,12 @@ include::modules/dynamic-provisioning-azure-disk-definition.adoc[leveloffset=+2] include::modules/dynamic-provisioning-azure-file-definition.adoc[leveloffset=+2] include::modules/dynamic-provisioning-azure-file-considerations.adoc[leveloffset=+3] + endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] ifndef::openshift-rosa,openshift-rosa-hcp[] include::modules/dynamic-provisioning-gce-definition.adoc[leveloffset=+2] + endif::openshift-rosa,openshift-rosa-hcp[] // include::modules/dynamic-provisioning-gluster-definition.adoc[leveloffset=+2] @@ -41,6 +44,7 @@ endif::openshift-rosa,openshift-rosa-hcp[] ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] include::modules/dynamic-provisioning-vsphere-definition.adoc[leveloffset=+2] + endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] include::modules/dynamic-provisioning-change-default-class.adoc[leveloffset=+1] diff --git a/storage/expanding-persistent-volumes.adoc b/storage/expanding-persistent-volumes.adoc index f8e13cfd00..78570452dc 100644 --- a/storage/expanding-persistent-volumes.adoc +++ b/storage/expanding-persistent-volumes.adoc @@ -15,6 +15,7 @@ include::modules/storage-expanding-csi-volumes.adoc[leveloffset=+1] ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] include::modules/storage-expanding-flexvolume.adoc[leveloffset=+1] + endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] include::modules/storage-expanding-local-volumes.adoc[leveloffset=+1] @@ -22,6 +23,7 @@ include::modules/storage-expanding-local-volumes.adoc[leveloffset=+1] include::modules/storage-expanding-filesystem-pvc.adoc[leveloffset=+1] include::modules/storage-expanding-recovering-failure.adoc[leveloffset=+1] + endif::openshift-enterprise,openshift-webscale,openshift-origin,openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] [role="_additional-resources"] diff --git a/storage/persistent_storage_local/persistent-storage-hostpath.adoc b/storage/persistent_storage_local/persistent-storage-hostpath.adoc index 250fa448c6..3b7f2c28d0 100644 --- a/storage/persistent_storage_local/persistent-storage-hostpath.adoc +++ b/storage/persistent_storage_local/persistent-storage-hostpath.adoc @@ -14,5 +14,7 @@ The cluster administrator must configure pods to run as privileged. This grants ==== include::modules/persistent-storage-hostpath-about.adoc[leveloffset=+1] + include::modules/persistent-storage-hostpath-static-provisioning.adoc[leveloffset=+1] + include::modules/persistent-storage-hostpath-pod.adoc[leveloffset=+1] diff --git a/storage/persistent_storage_local/persistent-storage-using-lvms.adoc b/storage/persistent_storage_local/persistent-storage-using-lvms.adoc index 79c6ccbdc2..bbdbc65a5e 100644 --- a/storage/persistent_storage_local/persistent-storage-using-lvms.adoc +++ b/storage/persistent_storage_local/persistent-storage-using-lvms.adoc @@ -126,7 +126,9 @@ include::modules/lvms-creating-lvmcluster-using-rhacm.adoc[leveloffset=+2] include::modules/lvms-about-deleting-lvmcluster-cr.adoc[leveloffset=+1] include::modules/lvms-deleting-lvmcluster-using-cli.adoc[leveloffset=+2] + include::modules/lvms-deleting-lvmcluster-using-web-console.adoc[leveloffset=+2] + include::modules/lvms-deleting-lvmcluster-using-rhacm.adoc[leveloffset=+2] //Provisioning @@ -205,13 +207,16 @@ include::modules/lvms-about-volume-snapshots.adoc[leveloffset=+1] * xref:../../backup_and_restore/application_backup_and_restore/oadp-features-plugins.adoc#oadp-features_oadp-features-plugins[OADP features] include::modules/lvms-creating-volume-snapshots.adoc[leveloffset=+2] + include::modules/lvms-restoring-volume-snapshots.adoc[leveloffset=+2] + include::modules/lvms-deleting-volume-snapshots.adoc[leveloffset=+2] //Volume cloning include::modules/lvms-about-volume-clones.adoc[leveloffset=+1] include::modules/lvms-creating-volume-clones.adoc[leveloffset=+2] + include::modules/lvms-deleting-volume-clones.adoc[leveloffset=+2] //Updating @@ -223,7 +228,9 @@ include::modules/lvms-monitoring-logical-volume-manager-operator.adoc[leveloffse // Uninstalling LVM Storage include::modules/lvms-uninstalling-logical-volume-manager-operator-using-openshift-cli.adoc[leveloffset=+1] + include::modules/lvms-uninstalling-logical-volume-manager-operator-using-openshift-web-console.adoc[leveloffset=+1] + include::modules/lvms-uninstalling-logical-volume-manager-operator-using-rhacm.adoc[leveloffset=+1] //Must-gather diff --git a/storage/understanding-persistent-storage.adoc b/storage/understanding-persistent-storage.adoc index d95ebf0aff..5a2d33ecaa 100644 --- a/storage/understanding-persistent-storage.adoc +++ b/storage/understanding-persistent-storage.adoc @@ -31,6 +31,7 @@ include::modules/storage-persistent-storage-pvc.adoc[leveloffset=+1] ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] include::modules/storage-persistent-storage-pvc-volumeattributesclass.adoc[leveloffset=+2] + endif::[] ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] diff --git a/support/approved-access.adoc b/support/approved-access.adoc index 8bccac4352..1e90cd2eeb 100644 --- a/support/approved-access.adoc +++ b/support/approved-access.adoc @@ -26,5 +26,7 @@ Denying an access request requires you to complete the *Justification* field. In ==== include::modules/support-submitting-a-case-enable-approved-access.adoc[leveloffset=+1] + include::modules/support-reviewing-an-access-request-from-an-email-notification.adoc[leveloffset=+1] + include::modules/support-reviewing-an-access-request-from-the-hybrid-console.adoc[leveloffset=+1] diff --git a/support/gathering-cluster-data.adoc b/support/gathering-cluster-data.adoc index 989a67b50c..71603aedf6 100644 --- a/support/gathering-cluster-data.adoc +++ b/support/gathering-cluster-data.adoc @@ -29,16 +29,19 @@ include::modules/about-must-gather.adoc[leveloffset=+1] ifndef::openshift-origin[] // Gathering data about your cluster for Red Hat Support include::modules/support-gather-data.adoc[leveloffset=+2] + endif::openshift-origin[] ifndef::openshift-origin[] // Reducing the size of must-gather output include::modules/support-must-gather-targeted-collection.adoc[leveloffset=+1] + endif::openshift-origin[] ifndef::openshift-origin[] // Gathering data for specific resources include::modules/support-must-gather-targeted-collection-gathering-data.adoc[leveloffset=+2] + endif::openshift-origin[] ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] @@ -50,6 +53,7 @@ endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] ifndef::openshift-origin[] // Table of must-gather flags include::modules/must-gather-flags.adoc[leveloffset=+2] + endif::openshift-origin[] // Gathering data about specific features @@ -86,6 +90,7 @@ include::modules/support-log-gather-overview.adoc[leveloffset=+1] // Support log gather installation include::modules/support-log-gather-install-console.adoc[leveloffset=+2] + include::modules/support-log-gather-install-cli.adoc[leveloffset=+2] //Support log gather configuration @@ -101,11 +106,13 @@ include::modules/support-log-gather-config-params.adoc[leveloffset=+2] //Support log gather uninstallation include::modules/support-log-gather-uninstall-console.adoc[leveloffset=+2] + include::modules/support-log-gather-remove-resources-console.adoc[leveloffset=+2] ifndef::openshift-origin[] // Obtain your cluster identifier include::modules/support-get-cluster-id.adoc[leveloffset=+1] + endif::openshift-origin[] ifndef::openshift-origin,openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] @@ -114,11 +121,13 @@ include::modules/about-sosreport.adoc[leveloffset=+1] // Generating a `sosreport` archive for an {product-title} cluster node include::modules/support-generating-a-sosreport-archive.adoc[leveloffset=+1] + endif::openshift-origin,openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] // Querying bootstrap node journal logs include::modules/querying-bootstrap-node-journal-logs.adoc[leveloffset=+1] + endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] // Querying cluster node journal logs @@ -133,16 +142,19 @@ include::modules/support-collecting-host-network-trace.adoc[leveloffset=+1] // Collecting a network trace from an {product-title} node or container include::modules/support-collecting-network-trace.adoc[leveloffset=+1] + endif::openshift-origin[] ifdef::openshift-origin[] // Collecting a host network trace include::modules/support-collecting-host-network-trace.adoc[leveloffset=+1] + endif::openshift-origin[] ifndef::openshift-origin[] // Providing diagnostic data to Red Hat Support include::modules/support-providing-diagnostic-data-to-red-hat.adoc[leveloffset=+1] + endif::openshift-origin[] // About `toolbox` diff --git a/support/getting-support.adoc b/support/getting-support.adoc index b8618d5edc..0154ee5937 100644 --- a/support/getting-support.adoc +++ b/support/getting-support.adoc @@ -12,8 +12,11 @@ toc::[] // Getting support include::modules/support.adoc[leveloffset=+1] + include::modules/support-knowledgebase-about.adoc[leveloffset=+1] + include::modules/support-knowledgebase-search.adoc[leveloffset=+1] + include::modules/support-submitting-a-case.adoc[leveloffset=+1] [id="getting-support-additional-resources"] diff --git a/support/remote_health_monitoring/about-remote-health-monitoring.adoc b/support/remote_health_monitoring/about-remote-health-monitoring.adoc index 0e96ecb28d..d41e6c8e72 100644 --- a/support/remote_health_monitoring/about-remote-health-monitoring.adoc +++ b/support/remote_health_monitoring/about-remote-health-monitoring.adoc @@ -64,6 +64,7 @@ include::modules/telemetry-what-information-is-collected.adoc[leveloffset=+2] // Module is not in OCP ifdef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] include::modules/telemetry-user-telemetry.adoc[leveloffset=+2] + endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] [role="_additional-resources"] diff --git a/support/remote_health_monitoring/showing-data-collected-by-remote-health-monitoring.adoc b/support/remote_health_monitoring/showing-data-collected-by-remote-health-monitoring.adoc index 235daa008e..fe59cb3f0c 100644 --- a/support/remote_health_monitoring/showing-data-collected-by-remote-health-monitoring.adoc +++ b/support/remote_health_monitoring/showing-data-collected-by-remote-health-monitoring.adoc @@ -16,4 +16,5 @@ include::modules/telemetry-showing-data-collected-from-the-cluster.adoc[leveloff // cannot create resource "pods/exec" in API group "" in the namespace "openshift-insights" ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] include::modules/insights-operator-showing-data-collected-from-the-cluster.adoc[leveloffset=+1] + endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] diff --git a/support/remote_health_monitoring/using-insights-operator.adoc b/support/remote_health_monitoring/using-insights-operator.adoc index 6d1566e45b..4eef09dea8 100644 --- a/support/remote_health_monitoring/using-insights-operator.adoc +++ b/support/remote_health_monitoring/using-insights-operator.adoc @@ -22,17 +22,22 @@ endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] include::modules/insights-operator-configuring.adoc[leveloffset=+1] + endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] include::modules/understanding-insights-operator-alerts.adoc[leveloffset=+1] + ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] include::modules/disabling-insights-operator-alerts.adoc[leveloffset=+2] + include::modules/enabling-insights-operator-alerts.adoc[leveloffset=+2] + endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] // cannot create resource "pods/exec" in API group "" in the namespace "openshift-insights" ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] include::modules/insights-operator-downloading-archive.adoc[leveloffset=+1] + // cannot download archive using previous module endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] @@ -81,7 +86,9 @@ include::snippets/technology-preview.adoc[] If you enable Technology Preview in your cluster, the {insights-operator} runs gather operations in individual pods. This is part of the Technology Preview feature set for the {insights-operator} and supports the new data gathering features. ==== include::modules/insights-operator-gather-duration.adoc[leveloffset=+2] + include::modules/running-insights-operator-gather-web-console.adoc[leveloffset=+2] + include::modules/running-insights-operator-gather-cli.adoc[leveloffset=+2] [role="_additional-resources"] @@ -93,7 +100,9 @@ endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] // cannot list resource "secrets" in API group "" in the namespace "openshift-config" ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] include::modules/disabling-insights-operator-gather.adoc[leveloffset=+2] + include::modules/enabling-insights-operator-gather.adoc[leveloffset=+2] + endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] include::modules/obfuscating-dvo-data.adoc[leveloffset=+1] diff --git a/support/remote_health_monitoring/using-insights-to-identify-issues-with-your-cluster.adoc b/support/remote_health_monitoring/using-insights-to-identify-issues-with-your-cluster.adoc index 5a3536c32c..a3db2b1214 100644 --- a/support/remote_health_monitoring/using-insights-to-identify-issues-with-your-cluster.adoc +++ b/support/remote_health_monitoring/using-insights-to-identify-issues-with-your-cluster.adoc @@ -12,13 +12,23 @@ toc::[] {red-hat-lightspeed} repeatedly analyzes the data {insights-operator} sends, which includes workload recommendations from Deployment Validation Operator (DVO). Users of {product-title} can display the results in the {insights-advisor-url} service on {hybrid-console}. include::modules/insights-operator-advisor-overview.adoc[leveloffset=+1] + include::modules/insights-operator-advisor-recommendations.adoc[leveloffset=+1] + include::modules/displaying-potential-issues-with-your-cluster.adoc[leveloffset=+1] + include::modules/displaying-all-insights-advisor-recommendations.adoc[leveloffset=+1] + include::modules/insights-advisor-recommendations-filters.adoc[leveloffset=+1] + include::modules/filtering-insights-advisor-recommendations.adoc[leveloffset=+2] + include::modules/removing-filters-from-insights-advisor-recommendations.adoc[leveloffset=+2] + include::modules/disabling-insights-advisor-recommendations.adoc[leveloffset=+1] + include::modules/enabling-insights-advisor-recommendations.adoc[leveloffset=+1] + include::modules/about-insights-advisor-workload-recommendations.adoc[leveloffset=+1] + include::modules/displaying-the-insights-status-in-the-web-console.adoc[leveloffset=+1] diff --git a/support/troubleshooting/investigating-monitoring-issues.adoc b/support/troubleshooting/investigating-monitoring-issues.adoc index 3e0325f44f..e0d70eadb7 100644 --- a/support/troubleshooting/investigating-monitoring-issues.adoc +++ b/support/troubleshooting/investigating-monitoring-issues.adoc @@ -42,4 +42,5 @@ endif::openshift-rosa-hcp[] // Resolving the KubePersistentVolumeFillingUp alert firing for Prometheus ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] include::modules/monitoring-resolving-the-kubepersistentvolumefillingup-alert-firing-for-prometheus.adoc[leveloffset=+1] + endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] diff --git a/support/troubleshooting/troubleshooting-crio-issues.adoc b/support/troubleshooting/troubleshooting-crio-issues.adoc index 6dba73c4b0..13cd9a2852 100644 --- a/support/troubleshooting/troubleshooting-crio-issues.adoc +++ b/support/troubleshooting/troubleshooting-crio-issues.adoc @@ -16,6 +16,7 @@ include::modules/verifying-crio-status.adoc[leveloffset=+1] ifndef::openshift-rosa,openshift-dedicated[] // Gathering CRI-O journald unit logs include::modules/gathering-crio-logs.adoc[leveloffset=+1] + endif::openshift-rosa,openshift-dedicated[] // Cleaning CRI-O storage diff --git a/support/troubleshooting/troubleshooting-operator-issues.adoc b/support/troubleshooting/troubleshooting-operator-issues.adoc index f96b67da38..3cea905795 100644 --- a/support/troubleshooting/troubleshooting-operator-issues.adoc +++ b/support/troubleshooting/troubleshooting-operator-issues.adoc @@ -51,20 +51,25 @@ include::modules/querying-operator-pod-status.adoc[leveloffset=+1] // Gathering Operator logs ifndef::openshift-rosa-hcp[] include::modules/gathering-operator-logs.adoc[leveloffset=+1] + endif::openshift-rosa-hcp[] // cannot patch resource "machineconfigpools" ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] // Disabling Machine Config Operator from autorebooting include::modules/troubleshooting-disabling-autoreboot-mco.adoc[leveloffset=+1] + include::modules/troubleshooting-disabling-autoreboot-mco-console.adoc[leveloffset=+2] + include::modules/troubleshooting-disabling-autoreboot-mco-cli.adoc[leveloffset=+2] + endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] // Refreshing failing subscriptions // cannot delete resource "clusterserviceversions", "jobs" in API group "operators.coreos.com" in the namespace "openshift-apiserver" ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] include::modules/olm-refresh-subs.adoc[leveloffset=+1] + endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] // Reinstalling Operators after failed uninstallation diff --git a/support/troubleshooting/troubleshooting-windows-container-workload-issues.adoc b/support/troubleshooting/troubleshooting-windows-container-workload-issues.adoc index 5f0731ae78..1d65d8d796 100644 --- a/support/troubleshooting/troubleshooting-windows-container-workload-issues.adoc +++ b/support/troubleshooting/troubleshooting-windows-container-workload-issues.adoc @@ -18,10 +18,13 @@ include::modules/investigating-why-windows-machine-compute-node.adoc[leveloffset Windows nodes cannot be accessed using the `oc debug node` command; the command requires running a privileged pod on the node, which is not yet supported for Windows. Instead, a Windows node can be accessed using a secure shell (SSH) or Remote Desktop Protocol (RDP). An SSH bastion is required for both methods. include::modules/accessing-windows-node-using-ssh.adoc[leveloffset=+2] + include::modules/accessing-windows-node-using-rdp.adoc[leveloffset=+2] include::modules/collecting-kube-node-logs-windows.adoc[leveloffset=+1] + include::modules/collecting-windows-application-event-logs.adoc[leveloffset=+1] + include::modules/collecting-containerd-logs-windows.adoc[leveloffset=+1] [role="_additional-resources"] diff --git a/support/troubleshooting/verifying-node-health.adoc b/support/troubleshooting/verifying-node-health.adoc index 83b1b81840..5f458c8184 100644 --- a/support/troubleshooting/verifying-node-health.adoc +++ b/support/troubleshooting/verifying-node-health.adoc @@ -17,5 +17,6 @@ include::modules/querying-kubelet-status-on-a-node.adoc[leveloffset=+1] // cannot get resource "nodes/proxy" // Querying node journal logs include::modules/querying-cluster-node-journal-logs.adoc[leveloffset=+1] + endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] diff --git a/updating/preparing_for_updates/kmm-preflight-validation.adoc b/updating/preparing_for_updates/kmm-preflight-validation.adoc index 235a71598e..6b0ea1762b 100644 --- a/updating/preparing_for_updates/kmm-preflight-validation.adoc +++ b/updating/preparing_for_updates/kmm-preflight-validation.adoc @@ -18,7 +18,11 @@ Before performing an upgrade on the cluster with applied KMM modules, you must v :FeatureName: Kernel Module Management Operator Preflight validation include::modules/kmm-validation-kickoff.adoc[leveloffset=+1] + include::modules/kmm-validation-lifecycle.adoc[leveloffset=+1] + include::modules/kmm-validation-status.adoc[leveloffset=+1] + include::modules/kmm-image-validation-stage.adoc[leveloffset=+1] + include::modules/kmm-example-cr.adoc[leveloffset=+1] diff --git a/updating/preparing_for_updates/preparing-manual-creds-update.adoc b/updating/preparing_for_updates/preparing-manual-creds-update.adoc index 075c465960..d7ac30ee92 100644 --- a/updating/preparing_for_updates/preparing-manual-creds-update.adoc +++ b/updating/preparing_for_updates/preparing-manual-creds-update.adoc @@ -22,6 +22,7 @@ Before updating a cluster with manually maintained credentials, you must accommo //Upgrading clusters with manually maintained credentials include::modules/about-manually-maintained-credentials-upgrade.adoc[leveloffset=+1] + [role="_additional-resources"] .Additional resources * xref:../../updating/preparing_for_updates/preparing-manual-creds-update.adoc#cco-determine-mode-gui_preparing-manual-creds-update[Determining the Cloud Credential Operator mode by using the web console] @@ -31,18 +32,21 @@ include::modules/about-manually-maintained-credentials-upgrade.adoc[leveloffset= //Determining the Cloud Credential Operator mode by using the web console include::modules/cco-determine-mode-gui.adoc[leveloffset=+2] + [role="_additional-resources"] .Additional resources * xref:../../updating/preparing_for_updates/preparing-manual-creds-update.adoc#cco-ccoctl-upgrading-extracting_preparing-manual-creds-update[Extracting and preparing credentials request resources] //Determining the Cloud Credential Operator mode by using the CLI include::modules/cco-determine-mode-cli.adoc[leveloffset=+2] + [role="_additional-resources"] .Additional resources * xref:../../updating/preparing_for_updates/preparing-manual-creds-update.adoc#cco-ccoctl-upgrading-extracting_preparing-manual-creds-update[Extracting and preparing credentials request resources] //Extracting and preparing credentials request resources include::modules/manually-maintained-credentials-upgrade-extract.adoc[leveloffset=+1] + [role="_additional-resources"] .Additional resources * xref:../../updating/preparing_for_updates/preparing-manual-creds-update.adoc#cco-ccoctl-configuring_preparing-manual-creds-update[Configuring the Cloud Credential Operator utility for a cluster update] @@ -53,12 +57,14 @@ include::modules/cco-ccoctl-configuring.adoc[leveloffset=+1] //Updating cloud provider resources with the Cloud Credential Operator utility include::modules/cco-ccoctl-upgrading.adoc[leveloffset=+1] + [role="_additional-resources"] .Additional resources * xref:../../updating/preparing_for_updates/preparing-manual-creds-update.adoc#cco-manual-upgrade-annotation_preparing-manual-creds-update[Indicating that the cluster is ready to upgrade] //Manually updating cloud provider resources include::modules/manually-maintained-credentials-upgrade.adoc[leveloffset=+1] + [role="_additional-resources"] .Additional resources * xref:../../installing/installing_aws/ipi/installing-aws-customizations.adoc#manually-create-iam_installing-aws-customizations[Manually creating long-term credentials for AWS] diff --git a/updating/updating_a_cluster/updating-bootloader-rhcos.adoc b/updating/updating_a_cluster/updating-bootloader-rhcos.adoc index f8ee75580e..7af1b9e34d 100644 --- a/updating/updating_a_cluster/updating-bootloader-rhcos.adoc +++ b/updating/updating_a_cluster/updating-bootloader-rhcos.adoc @@ -91,6 +91,7 @@ The boot loader update operation generally completes quickly thus the risk is lo [NOTE] ==== include::snippets/butane-version.adoc[] + ==== + .Example output diff --git a/web_console/capabilities_products-web-console.adoc b/web_console/capabilities_products-web-console.adoc index 4ffb22bce9..14dbf8d496 100644 --- a/web_console/capabilities_products-web-console.adoc +++ b/web_console/capabilities_products-web-console.adoc @@ -43,6 +43,7 @@ include::modules/serverless-web-console.adoc[leveloffset=+1] //RHDH include::modules/rhdh-web-console.adoc[leveloffset=+1] + include::modules/rhdh-install-web-console.adoc[leveloffset=+2] [role="_additional-resources"] diff --git a/web_console/configuring-web-console.adoc b/web_console/configuring-web-console.adoc index e1b442ed94..80d99da4dc 100644 --- a/web_console/configuring-web-console.adoc +++ b/web_console/configuring-web-console.adoc @@ -17,6 +17,8 @@ or disable the quick start tutorials. // Hiding in ROSA/OSD, as dedicated-admins cannot create "consoles" resource ifndef::openshift-rosa,openshift-dedicated[] include::modules/web-console-configuration.adoc[leveloffset=+1] + // Hiding in ROSA/OSD, as dedicated-admins do not have sufficient permissions to read any cluster configuration include::modules/disable-quickstarts-admin-console.adoc[leveloffset=+1] + endif::openshift-rosa,openshift-dedicated[] diff --git a/web_console/customizing-the-web-console.adoc b/web_console/customizing-the-web-console.adoc index d842b8e300..8c0642c797 100644 --- a/web_console/customizing-the-web-console.adoc +++ b/web_console/customizing-the-web-console.adoc @@ -15,6 +15,7 @@ corporate or government requirements. // Hiding in ROSA/OSD, as Hive overwrites changes to console config ifndef::openshift-rosa,openshift-dedicated[] include::modules/adding-a-custom-logo.adoc[leveloffset=+1] + endif::openshift-rosa,openshift-dedicated[] // Hiding in ROSA/OSD, as dedicated-admins cannot create resource "consolelinks" @@ -23,6 +24,7 @@ include::modules/creating-custom-links.adoc[leveloffset=+1] // Hiding in ROSA/OSD, as dedicated-admins cannot patch resource "ingresses" include::modules/customizing-the-web-console-URL.adoc[leveloffset=+1] + endif::openshift-rosa,openshift-dedicated[] // moved _Recognizing resource and project limits and quotas_ to modules/recognize-resource-limits-quotas.adoc in web-console.adoc @@ -51,16 +53,19 @@ include::modules/odc-customizing-a-perspective-using-YAML-view.adoc[leveloffset= // Hiding in ROSA/OSD, as dedicated-admins do not have sufficient permissions to read any cluster configuration include::modules/odc-customizing-a-perspective-using-form-view.adoc[leveloffset=+2] + endif::openshift-rosa,openshift-dedicated[] // Hiding in ROSA/OSD, as Hive overwrites changes to console config ifndef::openshift-rosa,openshift-dedicated[] include::modules/odc_con_customizing-a-developer-catalog-or-its-sub-catalogs.adoc[leveloffset=+1] + endif::openshift-rosa,openshift-dedicated[] // Hiding in ROSA/OSD, as Hive overwrites changes to console config ifndef::openshift-rosa,openshift-dedicated[] include::modules/odc_customizing-a-developer-catalog-or-its-sub-catalogs-using-the-yaml-view.adoc[leveloffset=+2] + endif::openshift-rosa,openshift-dedicated[] // Hiding in ROSA/OSD, as dedicated-admins do not have sufficient permissions to read any cluster configuration @@ -69,4 +74,5 @@ include::modules/odc_customizing-a-developer-catalog-or-its-sub-catalogs-using-t // Hiding in ROSA/OSD, as dedicated-admins cannot patch resource "consoles" include::modules/odc_con_example-yaml-file-changes.adoc[leveloffset=+3] + endif::openshift-rosa,openshift-dedicated[] diff --git a/web_console/using-dashboard-to-get-cluster-information.adoc b/web_console/using-dashboard-to-get-cluster-information.adoc index 4127515727..b3bc0c6092 100644 --- a/web_console/using-dashboard-to-get-cluster-information.adoc +++ b/web_console/using-dashboard-to-get-cluster-information.adoc @@ -10,4 +10,5 @@ toc::[] The {product-title} web console captures high-level information about the cluster. include::modules/virt-about-the-overview-dashboard.adoc[leveloffset=+1] + include::modules/recognize-resource-limits-quotas.adoc[leveloffset=+1] diff --git a/web_console/web-console-overview.adoc b/web_console/web-console-overview.adoc index 2584154dd2..20eb250494 100644 --- a/web_console/web-console-overview.adoc +++ b/web_console/web-console-overview.adoc @@ -11,12 +11,15 @@ The {product-title} web console provides a graphical user interface to visualize ifndef::openshift-rosa-hcp[] include::snippets/unified-perspective-web-console.adoc[] + endif::openshift-rosa-hcp[] You can create quick start tutorials for {product-title} that provide guided steps within the web console with user tasks. They are helpful for getting oriented with an application, Operator, or other product offering. include::modules/about-administrator_web-console.adoc[leveloffset=+1] + include::modules/about-developer_web-console.adoc[leveloffset=+1] + include::modules/enabling-developer-perspective_web-console.adoc[leveloffset=+1] [role="_additional-resources"] diff --git a/web_console/web_terminal/configuring-web-terminal.adoc b/web_console/web_terminal/configuring-web-terminal.adoc index 73022c4569..27859f4b5d 100644 --- a/web_console/web_terminal/configuring-web-terminal.adoc +++ b/web_console/web_terminal/configuring-web-terminal.adoc @@ -10,7 +10,10 @@ toc::[] You can configure timeout and image settings for the web terminal, either for your current session or for all user sessions if you are a cluster administrator. include::modules/odc-configure-web-terminal-timeout-session.adoc[leveloffset=+1] + include::modules/configure-web-terminal-timeout-admin.adoc[leveloffset=+1] + include::modules/odc-configure-web-terminal-image-session.adoc[leveloffset=+1] + include::modules/configure-web-terminal-image-admin.adoc[leveloffset=+1] diff --git a/web_console/web_terminal/uninstalling-web-terminal.adoc b/web_console/web_terminal/uninstalling-web-terminal.adoc index 2b6ffa5bbd..9a3f2fea8c 100644 --- a/web_console/web_terminal/uninstalling-web-terminal.adoc +++ b/web_console/web_terminal/uninstalling-web-terminal.adoc @@ -15,4 +15,5 @@ Uninstalling the web terminal is a two-step process: . Uninstall the DevWorkspace Operator and its related custom resources that were added as a dependency of the {web-terminal-op}. include::modules/removing-web-terminal-operator.adoc[leveloffset=+1] + include::modules/removing-devworkspace-operator.adoc[leveloffset=+1] \ No newline at end of file diff --git a/windows_containers/byoh-windows-instance.adoc b/windows_containers/byoh-windows-instance.adoc index 893bef92a8..e44df6aeac 100644 --- a/windows_containers/byoh-windows-instance.adoc +++ b/windows_containers/byoh-windows-instance.adoc @@ -9,4 +9,5 @@ toc::[] Bring-Your-Own-Host (BYOH) allows for users to repurpose Windows Server VMs and bring them to {product-title}. BYOH Windows instances benefit users looking to mitigate major disruptions in the event that a Windows server goes offline. include::modules/byoh-configuring.adoc[leveloffset=+1] + include::modules/byoh-removal.adoc[leveloffset=+1] diff --git a/windows_containers/creating_windows_machinesets/creating-windows-machineset-aws.adoc b/windows_containers/creating_windows_machinesets/creating-windows-machineset-aws.adoc index eca03485a7..daa0ecdb0a 100644 --- a/windows_containers/creating_windows_machinesets/creating-windows-machineset-aws.adoc +++ b/windows_containers/creating_windows_machinesets/creating-windows-machineset-aws.adoc @@ -39,7 +39,9 @@ where: * For disconnected clusters, the Windows AMI must have the EC2LaunchV2 agent version 2.0.2107 or later installed. For more information, see the link:https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2launch-v2-install.html[Install the latest version of EC2Launch v2] in the AWS documentation. include::modules/machine-api-overview.adoc[leveloffset=+1] + include::modules/windows-machineset-aws.adoc[leveloffset=+1] + include::modules/machineset-creating.adoc[leveloffset=+1] [role="_additional-resources"] diff --git a/windows_containers/creating_windows_machinesets/creating-windows-machineset-azure.adoc b/windows_containers/creating_windows_machinesets/creating-windows-machineset-azure.adoc index fd7c890cbd..bfe96e2bf0 100644 --- a/windows_containers/creating_windows_machinesets/creating-windows-machineset-azure.adoc +++ b/windows_containers/creating_windows_machinesets/creating-windows-machineset-azure.adoc @@ -15,7 +15,9 @@ You can create a Windows `MachineSet` object to serve a specific purpose in your * You are using a supported Windows Server as the operating system image. include::modules/machine-api-overview.adoc[leveloffset=+1] + include::modules/windows-machineset-azure.adoc[leveloffset=+1] + include::modules/machineset-creating.adoc[leveloffset=+1] [role="_additional-resources"] diff --git a/windows_containers/creating_windows_machinesets/creating-windows-machineset-gcp.adoc b/windows_containers/creating_windows_machinesets/creating-windows-machineset-gcp.adoc index b78911aaad..d521df2917 100644 --- a/windows_containers/creating_windows_machinesets/creating-windows-machineset-gcp.adoc +++ b/windows_containers/creating_windows_machinesets/creating-windows-machineset-gcp.adoc @@ -15,7 +15,9 @@ You can create a Windows `MachineSet` object to serve a specific purpose in your * You are using a supported Windows Server as the operating system image. include::modules/machine-api-overview.adoc[leveloffset=+1] + include::modules/windows-machineset-gcp.adoc[leveloffset=+1] + include::modules/machineset-creating.adoc[leveloffset=+1] [role="_additional-resources"] diff --git a/windows_containers/creating_windows_machinesets/creating-windows-machineset-nutanix.adoc b/windows_containers/creating_windows_machinesets/creating-windows-machineset-nutanix.adoc index 56fe72a30b..977d12d416 100644 --- a/windows_containers/creating_windows_machinesets/creating-windows-machineset-nutanix.adoc +++ b/windows_containers/creating_windows_machinesets/creating-windows-machineset-nutanix.adoc @@ -16,7 +16,9 @@ You can create a Windows `MachineSet` object to serve a specific purpose in your * You added a new DNS entry for the internal API server URL, `api-int..`, that points to the external API server URL, `api..`. This can be a CNAME or an additional A record. include::modules/machine-api-overview.adoc[leveloffset=+1] + include::modules/windows-machineset-nutanix.adoc[leveloffset=+1] + include::modules/machineset-creating.adoc[leveloffset=+1] [role="_additional-resources"] diff --git a/windows_containers/creating_windows_machinesets/creating-windows-machineset-vsphere.adoc b/windows_containers/creating_windows_machinesets/creating-windows-machineset-vsphere.adoc index add8ffb814..4019769c22 100644 --- a/windows_containers/creating_windows_machinesets/creating-windows-machineset-vsphere.adoc +++ b/windows_containers/creating_windows_machinesets/creating-windows-machineset-vsphere.adoc @@ -33,6 +33,7 @@ include::modules/creating-the-vsphere-windows-vm-golden-image.adoc[leveloffset=+ include::modules/enabling-internal-api-server-vsphere.adoc[leveloffset=+2] include::modules/windows-machineset-vsphere.adoc[leveloffset=+1] + include::modules/machineset-creating.adoc[leveloffset=+1] [role="_additional-resources"] diff --git a/windows_containers/windows-node-upgrades.adoc b/windows_containers/windows-node-upgrades.adoc index d8b4b5d746..5cb2426376 100644 --- a/windows_containers/windows-node-upgrades.adoc +++ b/windows_containers/windows-node-upgrades.adoc @@ -21,6 +21,7 @@ include::modules/wmco-upgrades.adoc[leveloffset=+1] * xref:../operators/admin/olm-upgrading-operators.adoc#olm-upgrading-operators[Updating installed Operators]. include::modules/windows-upgrades-eus.adoc[leveloffset=+1] + include::modules/wmco-upgrades-eus-using-web-console.adoc[leveloffset=+2] [role="_additional-resources"]