_topic_map.yml

# trunk-ignore-all(prettier)
# This configuration file dictates the organization of the topic groups and
# topics on the main page of the doc site for this branch. Each record
# consists of the following:
#
# ---                                  <= Record delimiter
# Name: Origin of the Species          <= Display name of topic group
# Dir:  origin_of_the_species          <= Directory name of topic group
# Topics:
#   - Name: The Majestic Marmoset      <= Topic name
#     File: the_majestic_marmoset      <= Topic file under group dir +/-
#   - Name: The Curious Crocodile      <= Topic 2 name
#     File: the_curious_crocodile      <= Topic 2 file
#   - Name: The Numerous Nematodes     <= Sub-topic group name
#     Dir: the_numerous_nematodes      <= Sub-topic group dir
#     Topics:
#       - Name: The Wily Worm          <= Sub-topic name
#         File: the_wily_worm          <= Sub-topic file under <group dir>/<subtopic dir>
#       - Name: The Acrobatic Ascarid  <= Sub-topic 2 name
#         File: the_acrobatic_ascarid  <= Sub-topic 2 file under <group dir>/<subtopic dir>
#
# The ordering of the records in this document determines the ordering of the
# topic groups and topics on the main page.

---
Name: Overview
Dir: welcome
Distros: openshift-enterprise,openshift-webscale,openshift-origin,openshift-online,openshift-dpu,openshift-telco
Topics:
- Name: Welcome
  File: index
- Name: Introduction to OpenShift Container Platform
  File: ocp-overview
- Name: Learn more about OpenShift Container Platform
  File: learn_more_about_openshift
- Name: Kubernetes overview
  File: kubernetes-overview
- Name: OpenShift editions
  File: openshift-editions
- Name: Glossary
  File: glossary
  Distros: openshift-enterprise
- Name: OpenShift Kubernetes Engine overview
  File: oke_about
  Distros: openshift-enterprise
- Name: Providing documentation feedback
  File: providing-feedback-on-red-hat-documentation
- Name: Legal notice
  File: legal-notice
  Distros: openshift-enterprise,openshift-online
---
Name: What's new?
Dir: whats_new
Distros: openshift-origin
Topics:
- Name: New features and enhancements
  File: new-features
- Name: Deprecated features
  File: deprecated-features
---
Name: Release notes
Dir: release_notes
Distros: openshift-enterprise
Topics:
- Name: OpenShift Container Platform release notes
  File: ocp-release-notes
- Name: Additional release notes
  File: addtl-release-notes
---
Name: Tutorials
Dir: tutorials
Distros: openshift-enterprise
Topics:
- Name: Tutorials overview
  File: index
- Name: Deploying an application by using the web console
  File: dev-app-web-console
- Name: Deploying an application by using the CLI
  File: dev-app-cli
- Name: Additional hands-on learning
  File: additional-tutorials
---
Name: Architecture
Dir: architecture
Distros: openshift-enterprise,openshift-origin,openshift-online
Topics:
- Name: Architecture overview
  File: index
- Name: Product architecture
  File: architecture
- Name: Installation and update
  Distros: openshift-enterprise,openshift-origin
  File: architecture-installation
- Name: Red Hat OpenShift Cluster Manager
  Distros: openshift-enterprise
  File: ocm-overview-ocp
- Name: About the multicluster engine for Kubernetes Operator
  Distros: openshift-enterprise
  File: mce-overview-ocp
- Name: Control plane architecture
  File: control-plane
  Distros: openshift-enterprise,openshift-origin,openshift-online
- Name: Understanding OpenShift development
  File: understanding-development
  Distros: openshift-enterprise
- Name: Understanding OKD development
  File: understanding-development
  Distros: openshift-origin
- Name: Fedora CoreOS
  File: architecture-rhcos
  Distros: openshift-origin
- Name: Red Hat Enterprise Linux CoreOS
  File: architecture-rhcos
  Distros: openshift-enterprise
- Name: Admission plugins
  File: admission-plug-ins
  Distros: openshift-enterprise,openshift-aro,openshift-origin
---
Name: Disconnected environments
Dir: disconnected
Distros: openshift-enterprise,openshift-origin
Topics:
- Name: About disconnected environments
  File: about
- Name: Converting a connected cluster to a disconnected cluster
  File: connected-to-disconnected
- Name: About disconnected installation mirroring
  File: index
- Name: Creating a mirror registry with mirror registry for Red Hat OpenShift
  File: installing-mirroring-creating-registry
- Name: Mirroring images for a disconnected installation using oc-mirror plugin v2
  File: about-installing-oc-mirror-v2
- Name: Migrating from oc-mirror plugin v1 to v2
  File: oc-mirror-migration-v1-to-v2
- Name: Mirroring images for a disconnected installation using the oc-mirror plugin v1
  File: installing-mirroring-disconnected
- Name: Mirroring images for a disconnected installation by using the oc adm command
  File: installing-mirroring-installation-images
- Name: Installing a cluster in a disconnected environment
  File: installing
- Name: Using OLM in disconnected environments
  File: using-olm
  Distros: openshift-origin,openshift-enterprise
- Name: Updating a cluster in a disconnected environment
  Dir: updating
  Topics:
  - Name: About cluster updates in a disconnected environment
    File: index
  - Name: Mirroring OpenShift Container Platform images
    File: mirroring-image-repository
  - Name: Updating a cluster in a disconnected environment using OSUS
    File: disconnected-update-osus
    Distros: openshift-enterprise
  - Name: Updating a cluster in a disconnected environment without OSUS
    File: disconnected-update
    Distros: openshift-enterprise
  - Name: Updating a cluster in a disconnected environment by using the CLI
    File: disconnected-update
    Distros: openshift-origin
  - Name: Uninstalling OSUS from a cluster
    File: uninstalling-osus
    Distros: openshift-enterprise
---
Name: Installing
Dir: installing
Distros: openshift-origin,openshift-enterprise,openshift-webscale
Topics:
- Name: Installation overview
  Dir: overview
  Topics:
  - Name: Installation overview
    File: index
    Distros: openshift-origin,openshift-enterprise
  - Name: Selecting an installation method and preparing a cluster
    File: installing-preparing
    Distros: openshift-origin,openshift-enterprise
  - Name: Cluster capabilities
    File: cluster-capabilities
    Distros: openshift-origin,openshift-enterprise
  - Name: Support for FIPS cryptography
    File: installing-fips
    Distros: openshift-enterprise,openshift-online
- Name: Installing on Alibaba Cloud
  Distros: openshift-origin,openshift-enterprise
  Dir: installing_alibaba
  Topics:
  - Name: Installing a cluster on Alibaba Cloud using the Assisted Installer
    File: installing-alibaba-assisted-installer
- Name: Installing on AWS
  Dir: installing_aws
  Distros: openshift-origin,openshift-enterprise
  Topics:
  - Name: Installation methods
    File: preparing-to-install-on-aws
  - Name: Configuring an AWS account
    File: installing-aws-account
  - Name: Installer-provisioned infrastructure
    Dir: ipi
    Distros: openshift-origin,openshift-enterprise
    Topics:
    - Name: Preparing to install a cluster
      File: ipi-aws-preparing-to-install
    - Name: Installing a cluster
      File: installing-aws-default
    - Name: Installing a cluster with customizations
      File: installing-aws-customizations
    - Name: Installing a cluster in a disconnected environment
      File: installing-restricted-networks-aws-installer-provisioned
    - Name: Installing a cluster into an existing VPC
      File: installing-aws-vpc
    - Name: Installing a private cluster
      File: installing-aws-private
    - Name: Installing a cluster in a specialized region
      File: installing-aws-specialized-region
    - Name: Installing a cluster with compute nodes on Local Zones
      File: installing-aws-localzone
    - Name: Installing a cluster with compute nodes on Wavelength Zones
      File: installing-aws-wavelength-zone
    - Name: Extending an AWS VPC cluster into an AWS Outpost
      File: installing-aws-outposts
    - Name: Installing an AWS cluster with the support for configuring multi-architecture compute machines
      File: installing-aws-multiarch-support
  - Name: User-provisioned infrastructure
    Dir: upi
    Distros: openshift-origin,openshift-enterprise
    Topics:
    - Name: Preparing to install a cluster
      File: upi-aws-preparing-to-install
    - Name: Installation requirements
      File: upi-aws-installation-reqs
    - Name: Installing a cluster using CloudFormation templates
      File: installing-aws-user-infra
    - Name: Installing a cluster in a disconnected environment with user-provisioned infrastructure
      File: installing-restricted-networks-aws
    - Name: Installing an AWS cluster with the support for configuring multi-architecture compute machines
      File: installing-aws-multiarch-support-upi
  - Name: Installing a three-node cluster
    File: installing-aws-three-node
  - Name: Uninstalling a cluster
    File: uninstalling-cluster-aws
  - Name: Installation configuration parameters
    File: installation-config-parameters-aws
  - Name: AWS Local Zone or Wavelength Zone tasks
    File: aws-compute-edge-zone-tasks
    Distros: openshift-enterprise
- Name: Installing on Azure
  Dir: installing_azure
  Distros: openshift-origin,openshift-enterprise
  Topics:
  - Name: Installation methods
    File: preparing-to-install-on-azure
  - Name: Configuring an Azure account
    File: installing-azure-account
  - Name: Installer-provisioned infrastructure
    Dir: ipi
    Distros: openshift-origin,openshift-enterprise
    Topics:
    - Name: Preparing to install a cluster
      File: installing-azure-preparing-ipi
    - Name: Installing a cluster
      File: installing-azure-default
    - Name: Installing a cluster with customizations
      File: installing-azure-customizations
    - Name: Installing a cluster in a disconnected environment
      File: installing-restricted-networks-azure-installer-provisioned
    - Name: Installing a cluster into an existing VNet
      File: installing-azure-vnet
    - Name: Installing a private cluster
      File: installing-azure-private
    - Name: Installing a cluster into a government region
      File: installing-azure-government-region
  - Name: User-provisioned infrastructure
    Dir: upi
    Distros: openshift-origin,openshift-enterprise
    Topics:
    - Name: Preparing to install a cluster
      File: installing-azure-preparing-upi
    - Name: Installing a cluster in a disconnected environment with user-provisioned infrastructure
      File: installing-restricted-networks-azure-user-provisioned
    - Name: Installing a cluster using ARM templates
      File: installing-azure-user-infra
  - Name: Installing a three-node cluster
    File: installing-azure-three-node
  - Name: Uninstalling a cluster
    File: uninstalling-cluster-azure
  - Name: Installation configuration parameters for Azure
    File: installation-config-parameters-azure
- Name: Installing on Azure Stack Hub
  Dir: installing_azure_stack_hub
  Distros: openshift-origin,openshift-enterprise
  Topics:
  - Name: Installation methods
    File: preparing-to-install-on-azure-stack-hub
  - Name: Configuring an Azure Stack Hub account
    File: installing-azure-stack-hub-account
  - Name: Installer-provisioned infrastructure
    Dir: ipi
    Distros: openshift-origin,openshift-enterprise
    Topics:
    - Name: Preparing to install a cluster
      File: ipi-ash-preparing-to-install
    - Name: Installing a cluster
      File: installing-azure-stack-hub-default
    - Name: Installing a cluster with network customizations
      File: installing-azure-stack-hub-network-customizations
  - Name: User-provisioned infrastructure
    Dir: upi
    Distros: openshift-origin,openshift-enterprise
    Topics:
    - Name: Preparing to install a cluster
      File: upi-ash-preparing-to-install
    - Name: Installing a cluster using ARM templates
      File: installing-azure-stack-hub-user-infra
  - Name: Installation configuration parameters
    File: installation-config-parameters-ash
  - Name: Uninstalling a cluster
    File: uninstalling-cluster-azure-stack-hub
- Name: Installing on Google Cloud
  Dir: installing_gcp
  Distros: openshift-origin,openshift-enterprise
  Topics:
  - Name: Preparing to install on Google Cloud
    File: preparing-to-install-on-gcp
  - Name: Configuring a Google Cloud project
    File: installing-gcp-account
  - Name: Installing a cluster quickly on Google Cloud
    File: installing-gcp-default
  - Name: Installing a cluster on Google Cloud with customizations
    File: installing-gcp-customizations
  - Name: Installing a cluster on Google Cloud in a disconnected environment
    File: installing-restricted-networks-gcp-installer-provisioned
  - Name: Installing a cluster on Google Cloud into an existing VPC
    File: installing-gcp-vpc
  - Name: Installing a cluster on Google Cloud into a shared VPC
    File: installing-gcp-shared-vpc
  - Name: Installing a private cluster on Google Cloud
    File: installing-gcp-private
  - Name: Installing a cluster on Google Cloud using Deployment Manager templates
    File: installing-gcp-user-infra
  - Name: Installing a cluster into a shared VPC on Google Cloud using Deployment Manager templates
    File: installing-gcp-user-infra-vpc
  - Name: Installing a cluster on Google Cloud in a disconnected environment with user-provisioned infrastructure
    File: installing-restricted-networks-gcp
  - Name: Installing a three-node cluster on Google Cloud
    File: installing-gcp-three-node
  - Name: Installation configuration parameters for Google Cloud
    File: installation-config-parameters-gcp
  - Name: Uninstalling a cluster on Google Cloud
    File: uninstalling-cluster-gcp
  - Name: Installing a Google Cloud cluster with the support for configuring multi-architecture compute machines
    File: installing-gcp-multiarch-support
- Name: Installing on IBM Cloud
  Dir: installing_ibm_cloud
  Distros: openshift-origin,openshift-enterprise
  Topics:
  - Name: Preparing to install on IBM Cloud
    File: preparing-to-install-on-ibm-cloud
  - Name: Configuring an IBM Cloud account
    File: installing-ibm-cloud-account
  - Name: Configuring IAM for IBM Cloud
    File: configuring-iam-ibm-cloud
  - Name: User-managed encryption
    File: user-managed-encryption-ibm-cloud
  - Name: Installing a cluster on IBM Cloud with customizations
    File: installing-ibm-cloud-customizations
  - Name: Installing a cluster on IBM Cloud into an existing VPC
    File: installing-ibm-cloud-vpc
  - Name: Installing a private cluster on IBM Cloud
    File: installing-ibm-cloud-private
  - Name: Installing a cluster on IBM Cloud in a disconnected environment
    File: installing-ibm-cloud-restricted
  - Name: Installation configuration parameters for IBM Cloud
    File: installation-config-parameters-ibm-cloud-vpc
  - Name: Uninstalling a cluster on IBM Cloud
    File: uninstalling-cluster-ibm-cloud
- Name: Installing on Nutanix
  Dir: installing_nutanix
  Distros: openshift-origin,openshift-enterprise
  Topics:
  - Name: Preparing to install on Nutanix
    File: preparing-to-install-on-nutanix
  - Name: Fault tolerant deployments
    File: nutanix-failure-domains
  - Name: Installing a cluster on Nutanix
    File: installing-nutanix-installer-provisioned
  - Name: Installing a cluster on Nutanix in a disconnected environment
    File: installing-restricted-networks-nutanix-installer-provisioned
  - Name: Installing a three-node cluster on Nutanix
    File: installing-nutanix-three-node
  - Name: Uninstalling a cluster on Nutanix
    File: uninstalling-cluster-nutanix
  - Name: Installation configuration parameters for Nutanix
    File: installation-config-parameters-nutanix
- Name: Installing on-premise with Assisted Installer
  Dir: installing_on_prem_assisted
  Distros: openshift-enterprise
  Topics:
  - Name: Installing an on-premise cluster using the Assisted Installer
    File: installing-on-prem-assisted
- Name: Installing an on-premise cluster with the Agent-based Installer
  Dir: installing_with_agent_based_installer
  Distros: openshift-enterprise
  Topics:
  - Name: Preparing to install with Agent-based Installer
    File: preparing-to-install-with-agent-based-installer
  - Name: Understanding disconnected installation mirroring
    File: understanding-disconnected-installation-mirroring
  - Name: Installing a cluster
    File: installing-with-agent-basic
  - Name: Installing a cluster with customizations
    File: installing-with-agent-based-installer
  - Name: Installing a cluster without an external registry
    File: installing-ove
  - Name: Preparing PXE assets for OCP
    File: prepare-pxe-assets-agent
  - Name: Preparing installation assets for iSCSI booting
    File: installing-using-iscsi
  - Name: Preparing an Agent-based installed cluster for the multicluster engine for Kubernetes
    File: preparing-an-agent-based-installed-cluster-for-mce
  - Name: Installation configuration parameters for the Agent-based Installer
    File: installation-config-parameters-agent
- Name: Installing on a single node
  Dir: installing_sno
  Distros: openshift-enterprise,openshift-origin
  Topics:
  - Name: Preparing to install OpenShift on a single node
    File: install-sno-preparing-to-install-sno
  - Name: Installing OpenShift on a single node
    File: install-sno-installing-sno
- Name: Installing a Two Node OpenShift Cluster
  Dir: installing_two_node_cluster
  Distros: openshift-origin,openshift-enterprise
  Topics:
  - Name: Two-Node with Arbiter
    File: about-two-node-arbiter-installation
  - Name: Two-node with Fencing
    Dir: installing_tnf
    Distros: openshift-enterprise,openshift-origin
    Topics:
    - Name: Preparing to install a two-node OpenShift cluster with fencing
      File: installing-two-node-fencing
    - Name: Installing a two-node OpenShift cluster with fencing
      File: install-tnf
    - Name: Post-installation troubleshooting and recovery
      File: install-post-tnf

- Name: Installing on bare metal
  Dir: installing_bare_metal
  Distros: openshift-origin,openshift-enterprise
  Topics:
  - Name: Preparing to install on bare metal
    File: preparing-to-install-on-bare-metal
  - Name: User-provisioned infrastructure
    Dir: upi
    Distros: openshift-origin,openshift-enterprise
    Topics:
    - Name: Installing a user-provisioned cluster on bare metal
      File: installing-bare-metal
    - Name: Installing a user-provisioned bare metal cluster with network customizations
      File: installing-bare-metal-network-customizations
    - Name: Installing a user-provisioned bare metal cluster on a disconnected environment
      File: installing-restricted-networks-bare-metal
    - Name: Scaling a user-provisioned installation with the bare metal operator
      File: scaling-a-user-provisioned-cluster-with-the-bare-metal-operator
    - Name: Installation configuration parameters for bare metal
      File: installation-config-parameters-bare-metal
  - Name: Installer-provisioned infrastructure
    Dir: ipi
    Distros: openshift-origin,openshift-enterprise
    Topics:
    - Name: Overview
      File: ipi-install-overview
    - Name: Prerequisites
      File: ipi-install-prerequisites
    - Name: Setting up the environment for an OpenShift installation
      File: ipi-install-installation-workflow
    - Name: Installing a cluster
      File: ipi-install-installing-a-cluster
    - Name: Troubleshooting the installation
      File: ipi-install-troubleshooting
  - Name: Postinstallation configuration
    File: bare-metal-postinstallation-configuration
  - Name: Expanding the cluster
    File: bare-metal-expanding-the-cluster
  - Name: Using bare metal as a service
    File: bare-metal-using-bare-metal-as-a-service
- Name: Installing IBM Cloud Bare Metal (Classic)
  Dir: installing_ibm_cloud_classic
  Distros: openshift-origin,openshift-enterprise
  Topics:
  - Name: Prerequisites for IBM Cloud (Classic)
    File: install-ibm-cloud-prerequisites
  - Name: Installation workflow for IBM Cloud Bare Metal (Classic)
    File: install-ibm-cloud-installation-workflow
- Name: Installing on IBM Z and IBM LinuxONE
  Dir: installing_ibm_z
  Distros: openshift-enterprise
  Topics:
  - Name: Installation methods
    File: preparing-to-install-on-ibm-z
  - Name: User-provisioned infrastructure
    Dir: upi
    Distros: openshift-enterprise
    Topics:
    - Name: Installation requirements
      File: installing-ibm-z-reqs
    - Name: Preparing to install a cluster
      File: upi-ibm-z-preparing-to-install
    - Name: Installing a cluster with z/VM
      File: installing-ibm-z
    - Name: Installing a cluster with z/VM in a disconnected environment
      File: installing-restricted-networks-ibm-z
    - Name: Installing a cluster with RHEL KVM
      File: installing-ibm-z-kvm
    - Name: Installing a cluster with RHEL KVM in a disconnected environment
      File: installing-restricted-networks-ibm-z-kvm
    - Name: Installing a cluster in an LPAR
      File: installing-ibm-z-lpar
    - Name: Installing a cluster in an LPAR in a disconnected environment
      File: installing-restricted-networks-ibm-z-lpar
  - Name: Installation configuration parameters
    File: installation-config-parameters-ibm-z
  - Name: Configuring additional devices
    File: ibmz-post-install
- Name: Installing on IBM Power
  Dir: installing_ibm_power
  Distros: openshift-enterprise
  Topics:
  - Name: Preparing to install on IBM Power
    File: preparing-to-install-on-ibm-power
  - Name: Installing a cluster on IBM Power
    File: installing-ibm-power
  - Name: Installing a cluster on IBM Power in a disconnected environment
    File: installing-restricted-networks-ibm-power
  - Name: Installation configuration parameters for IBM Power
    File: installation-config-parameters-ibm-power
- Name: Installing on IBM PowerVC
  Dir: installing_ibm_powervc
  Distros: openshift-enterprise
  Topics:
  - Name: Installation methods
    File: installation-methods-ibm-powervc
  - Name: Installing a cluster on IBM PowerVC with customizations
    File: installing-ibm-powervc-installer-custom
  - Name: Installation configuration parameters for IBM PowerVC
    File: installation-config-parameters-ibm-powervc
  - Name: Uninstalling a cluster on IBM PowerVC
    File: uninstalling-cluster-powervc
- Name: Installing on IBM Power Virtual Server
  Dir: installing_ibm_powervs
  Distros: openshift-enterprise
  Topics:
  - Name: Preparing to install on IBM Power Virtual Server
    File: preparing-to-install-on-ibm-power-vs
  - Name: Configuring an IBM Cloud account
    File: installing-ibm-cloud-account-power-vs
  - Name: Creating an IBM Power Virtual Server workspace
    File: creating-ibm-power-vs-workspace
  - Name: Installing a cluster on IBM Power Virtual Server with customizations
    File: installing-ibm-power-vs-customizations
  - Name: Installing a cluster on IBM Power Virtual Server into an existing VPC
    File: installing-ibm-powervs-vpc
  - Name: Installing a private cluster on IBM Power Virtual Server
    File: installing-ibm-power-vs-private-cluster
  - Name: Installing a cluster on IBM Power Virtual Server in a disconnected environment
    File: installing-restricted-networks-ibm-power-vs
  - Name: Uninstalling a cluster on IBM Power Virtual Server
    File: uninstalling-cluster-ibm-power-vs
  - Name: Installation configuration parameters for IBM Power Virtual Server
    File: installation-config-parameters-ibm-power-vs
- Name: Installing on OpenStack
  Dir: installing_openstack
  Distros: openshift-origin,openshift-enterprise
  Topics:
  - Name: Preparing to install on OpenStack
    File: preparing-to-install-on-openstack
  - Name: Preparing to install a cluster that uses SR-IOV or OVS-DPDK on OpenStack
    File: installing-openstack-nfv-preparing
#  - Name: Installing a cluster on OpenStack
#    File: installing-openstack-installer
  - Name: Installing a cluster on OpenStack with customizations
    File: installing-openstack-installer-custom
  - Name: Installing a cluster on OpenStack on your own infrastructure
    File: installing-openstack-user
  - Name: Installing a cluster on OpenStack in a disconnected environment
    File: installing-openstack-installer-restricted
  - Name: Installing a three-node cluster on OpenStack
    File: installing-openstack-three-node
  - Name: Configuring network settings after installing OpenStack
    File: installing-openstack-network-config
  - Name: OpenStack Cloud Controller Manager reference guide
    File: installing-openstack-cloud-config-reference
  - Name: Deploying on OpenStack with rootVolume and etcd on local disk
    File: deploying-openstack-with-rootVolume-etcd-on-local-disk
  # - Name: Load balancing deployments on OpenStack
  #   File: installing-openstack-load-balancing
  - Name: Uninstalling a cluster on OpenStack
    File: uninstalling-cluster-openstack
  - Name: Uninstalling a cluster on OpenStack from your own infrastructure
    File: uninstalling-openstack-user
  - Name: Installation configuration parameters for OpenStack
    File: installation-config-parameters-openstack
- Name: Installing on Oracle Distributed Cloud
  Dir: installing_oci
  Distros: openshift-origin,openshift-enterprise
  Topics:
  - Name: Installing a cluster on Oracle Distributed Cloud by using the Assisted Installer
    File: installing-oci-assisted-installer
  - Name: Installing a cluster on Oracle Distributed Cloud by using the Agent-based Installer
    File: installing-oci-agent-based-installer
- Name: Installing on Oracle Edge Cloud
  Dir: installing_oci_edge
  Distros: openshift-enterprise
  Topics:
  - Name: Installing a cluster on Oracle Edge Cloud by using the Assisted Installer
    File: installing-c3-assisted-installer
  - Name: Installing a cluster on Oracle Edge Cloud by using the Agent-based Installer
    File: installing-c3-agent-based-installer
- Name: Installing on Oracle Database Appliance
  Dir: installing_oda
  Distros: openshift-enterprise
  Topics:
  - Name: Installing a cluster on Oracle Database Appliance by using the Assisted Installer
    File: installing-oda-assisted
- Name: Installing on VMware vSphere
  Dir: installing_vsphere
  Distros: openshift-origin,openshift-enterprise
  Topics:
  - Name: Installation methods
    File: preparing-to-install-on-vsphere
  - Name: Installer-provisioned infrastructure
    Dir: ipi
    Distros: openshift-origin,openshift-enterprise
    Topics:
    - Name: vSphere installation requirements
      File: ipi-vsphere-installation-reqs
    - Name: Preparing to install a cluster
      File: ipi-vsphere-preparing-to-install
    - Name: Installing a cluster
      File: installing-vsphere-installer-provisioned
    - Name: Installing a cluster with customizations
      File: installing-vsphere-installer-provisioned-customizations
    - Name: Installing a cluster in a disconnected environment
      File: installing-restricted-networks-installer-provisioned-vsphere
  - Name: User-provisioned infrastructure
    Dir: upi
    Distros: openshift-origin,openshift-enterprise
    Topics:
    - Name: vSphere installation requirements
      File: upi-vsphere-installation-reqs
    - Name: Preparing to install a cluster
      File: upi-vsphere-preparing-to-install
    - Name: Installing a cluster
      File: installing-vsphere
    - Name: Installing a cluster with network customizations
      File: installing-vsphere-network-customizations
    - Name: Installing a cluster in a disconnected environment
      File: installing-restricted-networks-vsphere
  - Name: Assisted Installer
    Distros: openshift-enterprise
    File: installing-vsphere-assisted-installer
  - Name: Agent-based Installer
    Distros: openshift-enterprise
    File: installing-vsphere-agent-based-installer
  - Name: Installing a three-node cluster
    File: installing-vsphere-three-node
  - Name: Uninstalling a cluster
    File: uninstalling-cluster-vsphere-installer-provisioned
  - Name: Using the vSphere Problem Detector Operator
    File: using-vsphere-problem-detector-operator
  - Name: Installation configuration parameters
    File: installation-config-parameters-vsphere
  - Name: Regions and zones for a VMware vCenter
    File: post-install-vsphere-zones-regions-configuration
  - Name: Enabling encryption on a vSphere cluster
    File: vsphere-post-installation-encryption
  - Name: Configuring the vSphere connection settings after an installation
    File: installing-vsphere-post-installation-configuration
- Name: Installing on any platform
  Dir: installing_platform_agnostic
  Distros: openshift-origin,openshift-enterprise
  Topics:
  - Name: Installing a cluster on any platform
    File: installing-platform-agnostic
- Name: Installation configuration
  Dir: install_config
  Distros: openshift-origin,openshift-enterprise
  Topics:
  - Name: Customizing nodes
    File: installing-customizing
  - Name: Configuring your firewall
    File: configuring-firewall
    Distros: openshift-enterprise
- Name: Validation and troubleshooting
  Dir: validation_and_troubleshooting
  Topics:
  - Name: Validating an installation
    File: validating-an-installation
    Distros: openshift-origin,openshift-enterprise
  - Name: Troubleshooting installation issues
    File: installing-troubleshooting
    Distros: openshift-origin,openshift-enterprise
---
Name: Postinstallation configuration
Dir: post_installation_configuration
Distros: openshift-origin,openshift-enterprise
Topics:
- Name: Postinstallation configuration overview
  Distros: openshift-enterprise
  File: index
- Name: Configuring a private cluster
  Distros: openshift-enterprise,openshift-origin
  File: configuring-private-cluster
- Name: Configuring multi-architecture compute machines on an OpenShift cluster
  Dir: configuring-multi-arch-compute-machines
  Distros: openshift-enterprise
  Topics:
  - Name: About clusters with multi-architecture compute machines
    File: multi-architecture-configuration
  - Name: Creating a cluster with multi-architecture compute machines on AWS
    File: creating-multi-arch-compute-nodes-aws
  - Name: Creating a cluster with multi-architecture compute machines on Azure
    File: creating-multi-arch-compute-nodes-azure
  - Name: Creating a cluster with multi-architecture compute machines on Google Cloud
    File: creating-multi-arch-compute-nodes-google-cloud
  - Name: Creating a cluster with multi-architecture compute machines on bare metal, IBM Power, or IBM Z
    File: creating-multi-arch-compute-nodes-bare-metal
  - Name: Creating a cluster with multi-architecture compute machines on IBM Z and IBM LinuxONE with z/VM
    File: creating-multi-arch-compute-nodes-ibm-z
  - Name: Creating a cluster with multi-architecture compute machines on IBM Z and IBM LinuxONE in an LPAR
    File: creating-multi-arch-compute-nodes-ibm-z-lpar
  - Name: Creating a cluster with multi-architecture compute machines on IBM Z and IBM LinuxONE with RHEL KVM
    File: creating-multi-arch-compute-nodes-ibm-z-kvm
  - Name: Creating a cluster with multi-architecture compute machines on IBM Power
    File: creating-multi-arch-compute-nodes-ibm-power
  - Name: Managing your cluster with multi-architecture compute machines
    File: multi-architecture-compute-managing
  - Name: Managing workloads on multi-architecture clusters by using the Multiarch Tuning Operator
    File: multiarch-tuning-operator
  - Name: Multiarch Tuning Operator release notes
    File: multi-arch-tuning-operator-release-notes
- Name: Cluster tasks
  File: cluster-tasks
- Name: Node tasks
  File: node-tasks
- Name: Postinstallation network configuration
  File: post-install-network-configuration
- Name: Configuring image streams and image registries
  File: post-install-image-config
- Name: Storage configuration
  File: post-install-storage-configuration
- Name: Preparing for users
  File: preparing-for-users
- Name: Changing the cloud provider credentials configuration
  File: changing-cloud-credentials-configuration
- Name: Configuring alert notifications
  File: configuring-alert-notifications
- Name: Converting a connected cluster to a disconnected cluster
  File: converting-to-disconnected
- Name: Day 2 operations for OpenShift Container Platform clusters
  Dir: day_2_core_cnf_clusters
  Distros: openshift-origin,openshift-enterprise
  Topics:
  - Name: Day 2 operations for OpenShift Container Platform clusters
    File: telco-day-2-welcome
  - Name: Upgrading OpenShift Container Platform clusters
    Dir: updating
    Topics:
    - Name: Upgrading OpenShift Container Platform clusters
      File: update-welcome
    - Name: OpenShift Container Platform API compatibility
      File: update-api
    - Name: Preparing for the cluster update
      File: update-ocp-update-prep
    - Name: Managing application pods during the cluster update
      File: update-cnf-update-prep
    - Name: Before you update the cluster
      File: update-before-the-update
    - Name: Completing the Control Plane Only update
      File: update-completing-the-control-plane-only-update
    - Name: Completing the y-stream update
      File: update-completing-the-y-stream-update
    - Name: Completing the z-stream update
      File: update-completing-the-z-stream-update
  - Name: Troubleshooting and maintaining OpenShift Container Platform clusters
    Dir: troubleshooting
    Topics:
    - Name: Troubleshooting and maintaining OpenShift Container Platform clusters
      File: troubleshooting-intro
    - Name: General troubleshooting
      File: troubleshooting-general-troubleshooting
    - Name: Cluster maintenance
      File: troubleshooting-cluster-maintenance
    - Name: Security
      File: troubleshooting-security
    - Name: Certificate maintenance
      File: troubleshooting-cert-maintenance
    - Name: Machine Config Operator
      File: troubleshooting-mco
    - Name: Bare-metal node maintenance
      File: troubleshooting-bmn-maintenance
  - Name: Observability
    Dir: observability
    Topics:
    - Name: Observability in OpenShift Container Platform
      File: observability
  - Name: Security
    Dir: security
    Topics:
    - Name: Security basics
      File: security-basics
    - Name: Host security
      File: security-host-sec
    - Name: Security context constraints
      File: security-sec-context-constraints
---
Name: Updating clusters
Dir: updating
Distros: openshift-origin,openshift-enterprise
Topics:
- Name: Updating clusters overview
  File: index
  Distros: openshift-origin
- Name: Understanding OpenShift updates
  Dir: understanding_updates
  Topics:
  - Name: Introduction to OpenShift updates
    File: intro-to-updates
  - Name: How cluster updates work
    File: how-updates-work
    Distros: openshift-enterprise
  - Name: Understanding update channels and releases
    File: understanding-update-channels-release
    Distros: openshift-enterprise
  - Name: Understanding OpenShift update duration
    File: understanding-openshift-update-duration
- Name: Preparing to update a cluster
  Dir: preparing_for_updates
  Topics:
  - Name: Preparing to update to OpenShift Container Platform 4.21
    File: updating-cluster-prepare
    Distros: openshift-enterprise
  - Name: Preparing to update to OKD 4.21
    File: updating-cluster-prepare
    Distros: openshift-origin
  - Name: Preparing to update a cluster with manually maintained credentials
    File: preparing-manual-creds-update
  - Name: Preflight validation for Kernel Module Management (KMM) Modules
    File: kmm-preflight-validation
  - Name: Preparing to update from OpenShift Container Platform 4.18 to a newer version
    File: updating-cluster-prepare-past-4-18
    Distros: openshift-enterprise
- Name: Performing a cluster update
  Dir: updating_a_cluster
  Topics:
  - Name: Updating a cluster using the CLI
    File: updating-cluster-cli
  - Name: Updating a cluster using the web console
    File: updating-cluster-web-console
  - Name: Performing a Control Plane Only update
    File: control-plane-only-update
    Distros: openshift-enterprise
  - Name: Performing a canary rollout update
    File: update-using-custom-machine-config-pools
  - Name: Updating a cluster in a disconnected environment
    File: disconnected-update
  - Name: Updating hardware on nodes running on vSphere
    File: updating-hardware-on-nodes-running-on-vsphere
  - Name: Migrating to a cluster with multi-architecture compute machines
    File: migrating-to-multi-payload
  - Name: Updating the boot loader on Red Hat Enterprise Linux CoreOS nodes using bootupd
    File: updating-bootloader-rhcos
    Distros: openshift-enterprise
  - Name: Updating the boot loader on Fedora CoreOS nodes using bootupd
    File: updating-bootloader-rhcos
    Distros: openshift-origin
- Name: Troubleshooting a cluster update
  Dir: troubleshooting_updates
  Distros: openshift-enterprise,openshift-origin
  Topics:
  - Name: Gathering data about your cluster update
    File: gathering-data-cluster-update
---
Name: Support
Dir: support
Distros: openshift-enterprise,openshift-online,openshift-origin
Topics:
- Name: Support overview
  File: index
- Name: Managing your cluster resources
  File: managing-cluster-resources
- Name: Getting support
  File: getting-support
  Distros: openshift-enterprise
- Name: Remote health monitoring with connected clusters
  Dir: remote_health_monitoring
  Distros: openshift-enterprise,openshift-origin
  Topics:
  - Name: About remote health monitoring
    File: about-remote-health-monitoring
  - Name: Showing data collected by remote health monitoring
    File: showing-data-collected-by-remote-health-monitoring
  - Name: Remote health reporting
    File: remote-health-reporting
  - Name: Using Insights to identify issues with your cluster
    File: using-insights-to-identify-issues-with-your-cluster
  - Name: Using the Insights Operator
    File: using-insights-operator
  - Name: Using remote health reporting in a disconnected environment
    File: remote-health-reporting-from-restricted-network
  - Name: Importing simple content access entitlements with Insights Operator
    File: insights-operator-simple-access
- Name: Gathering data about your cluster
  File: gathering-cluster-data
  Distros: openshift-enterprise,openshift-origin
- Name: Summarizing cluster specifications
  File: summarizing-cluster-specifications
  Distros: openshift-enterprise,openshift-origin
- Name: Troubleshooting
  Dir: troubleshooting
  Distros: openshift-enterprise,openshift-origin
  Topics:
  - Name: Troubleshooting installations
    File: troubleshooting-installations
  - Name: Verifying node health
    File: verifying-node-health
  - Name: Troubleshooting CRI-O container runtime issues
    File: troubleshooting-crio-issues
  - Name: Troubleshooting operating system issues
    File: troubleshooting-operating-system-issues
    Distros: openshift-enterprise,openshift-origin
  - Name: Troubleshooting network issues
    File: troubleshooting-network-issues
    Distros: openshift-enterprise,openshift-origin
  - Name: Troubleshooting Operator issues
    File: troubleshooting-operator-issues
  - Name: Investigating pod issues
    File: investigating-pod-issues
  - Name: Troubleshooting the Source-to-Image process
    File: troubleshooting-s2i
  - Name: Troubleshooting storage issues
    File: troubleshooting-storage-issues
  - Name: Troubleshooting Windows container workload issues
    File: troubleshooting-windows-container-workload-issues
  - Name: Investigating monitoring issues
    File: investigating-monitoring-issues
  - Name: Diagnosing OpenShift CLI (oc) issues
    File: diagnosing-oc-issues
---
Name: Web console
Dir: web_console
Distros: openshift-enterprise,openshift-origin,openshift-online
Topics:
- Name: Web console overview
  File: web-console-overview
- Name: Accessing the web console
  File: web-console
- Name: Using the OpenShift Container Platform dashboard to get cluster information
  File: using-dashboard-to-get-cluster-information
- Name: Adding user preferences
  File: adding-user-preferences
  Distros: openshift-enterprise,openshift-origin
- Name: Configuring the web console
  File: configuring-web-console
  Distros: openshift-enterprise,openshift-origin
- Name: Customizing the web console
  File: customizing-the-web-console
  Distros: openshift-enterprise,openshift-origin
- Name: Dynamic plugins
  Dir: dynamic-plugin
  Distros: openshift-enterprise,openshift-origin
  Topics:
  - Name: Overview of dynamic plugins
    File: overview-dynamic-plugin
  - Name: Getting started with dynamic plugins
    File: dynamic-plugins-get-started
  - Name: Deploy your plugin on a cluster
    File: deploy-plugin-cluster
  - Name: Content Security Policy
    File: content-security-policy
  - Name: Dynamic plugin example
    File: dynamic-plugin-example
  - Name: Dynamic plugin reference
    File: dynamic-plugins-reference
- Name: Web terminal
  Dir: web_terminal
  Distros: openshift-enterprise,openshift-online
  Topics:
  - Name: Installing the web terminal
    File: installing-web-terminal
  - Name: Configuring the web terminal
    File: configuring-web-terminal
  - Name: Using the web terminal
    File: odc-using-web-terminal
  - Name: Troubleshooting the web terminal
    File: troubleshooting-web-terminal
  - Name: Uninstalling the web terminal
    File: uninstalling-web-terminal
- Name: Disabling the web console
  File: disabling-web-console
  Distros: openshift-enterprise,openshift-origin
- Name: Creating quick start tutorials
  File: creating-quick-start-tutorials
  Distros: openshift-enterprise,openshift-origin
- Name: Optional capabilities and products
  File: capabilities_products-web-console
  Distros: openshift-enterprise,openshift-origin
---
Name: CLI tools
Dir: cli_reference
Distros: openshift-enterprise,openshift-origin,openshift-online
Topics:
- Name: CLI tools overview
  File: index
- Name: OpenShift CLI (oc)
  Dir: openshift_cli
  Topics:
  - Name: Getting started with the OpenShift CLI
    File: getting-started-cli
  - Name: Configuring the OpenShift CLI
    File: configuring-cli
  - Name: Usage of oc and kubectl commands
    File: usage-oc-kubectl
  - Name: Managing CLI profiles
    File: managing-cli-profiles
  - Name: Extending the OpenShift CLI with plugins
    File: extending-cli-plugins
  - Name: OpenShift CLI developer command reference
    File: developer-cli-commands
  - Name: OpenShift CLI administrator command reference
    File: administrator-cli-commands
    Distros: openshift-enterprise,openshift-origin
- Name: OpenShift CLI Manager
  Dir: cli_manager
  Topics:
  - Name: OpenShift CLI Manager overview
    File: index
  - Name: OpenShift CLI Manager release notes
    File: cli-manager-release-notes
  - Name: Installing the Openshift CLI Manager
    File: cli-manager-install
  - Name: Using the OpenShift CLI Manager
    File: cli-manager-using
  - Name: Uninstalling the OpenShift CLI Manager
    File: cli-manager-uninstall
- Name: Developer CLI (odo)
  File: odo-important-update
  # Dir: developer_cli_odo
  Distros: openshift-enterprise,openshift-origin,openshift-online
  # Topics:
  # - Name: odo release notes
  #  File: odo-release-notes
  # - Name: Understanding odo
  #  File: understanding-odo
  # - Name: Installing odo
  #  File: installing-odo
  # - Name: Configuring the odo CLI
  #  File: configuring-the-odo-cli
  # - Name: odo CLI reference
  #  File: odo-cli-reference
- Name: Knative CLI (kn) for use with OpenShift Serverless
  File: kn-cli-tools
  Distros: openshift-enterprise,openshift-origin
- Name: Pipelines CLI (tkn)
  Dir: tkn_cli
  Distros: openshift-enterprise
  Topics:
  - Name: Installing tkn
    File: installing-tkn
  - Name: Configuring tkn
    File: op-configuring-tkn
  - Name: Basic tkn commands
    File: op-tkn-reference
- Name: GitOps CLI (argocd) for use with OpenShift GitOps
  File: gitops-argocd-cli-tools
  Distros: openshift-enterprise
- Name: opm CLI
  Dir: opm
  Distros: openshift-enterprise,openshift-origin
  Topics:
  - Name: Installing the opm CLI
    File: cli-opm-install
  - Name: opm CLI reference
    File: cli-opm-ref
---
Name: Security and compliance
Dir: security
Distros: openshift-enterprise,openshift-origin,openshift-aro
Topics:
- Name: Security and compliance overview
  File: index
- Name: Container security
  Dir: container_security
  Topics:
  - Name: Understanding container security
    File: security-understanding
  - Name: Understanding host and VM security
    File: security-hosts-vms
  - Name: Hardening Red Hat Enterprise Linux CoreOS
    File: security-hardening
    Distros: openshift-enterprise,openshift-aro
  - Name: Container image signatures
    File: security-container-signature
  - Name: Hardening Fedora CoreOS
    File: security-hardening
    Distros: openshift-origin
  - Name: Understanding compliance
    File: security-compliance
  - Name: Securing container content
    File: security-container-content
  - Name: Using container registries securely
    File: security-registries
  - Name: Securing the build process
    File: security-build
  - Name: Deploying containers
    File: security-deploy
  - Name: Securing the container platform
    File: security-platform
  - Name: Securing networks
    File: security-network
  - Name: Securing attached storage
    File: security-storage
  - Name: Monitoring cluster events and logs
    File: security-monitoring
- Name: Configuring certificates
  Dir: certificates
  Distros: openshift-enterprise,openshift-origin
  Topics:
  - Name: Replacing the default ingress certificate
    File: replacing-default-ingress-certificate
  - Name: Adding API server certificates
    File: api-server
  - Name: Securing service traffic using service serving certificates
    File: service-serving-certificate
  - Name: Updating the CA bundle
    File: updating-ca-bundle
- Name: Certificate types and descriptions
  Dir: certificate_types_descriptions
  Distros: openshift-enterprise,openshift-origin
  Topics:
  - Name: User-provided certificates for the API server
    File: user-provided-certificates-for-api-server
  - Name: Proxy certificates
    File: proxy-certificates
  - Name: Service CA certificates
    File: service-ca-certificates
  - Name: Node certificates
    File: node-certificates
  - Name: Bootstrap certificates
    File: bootstrap-certificates
  - Name: etcd certificates
    File: etcd-certificates
  - Name: OLM certificates
    File: olm-certificates
  - Name: Aggregated API client certificates
    File: aggregated-api-client-certificates
  - Name: Machine Config Operator certificates
    File: machine-config-operator-certificates
  - Name: User-provided certificates for default ingress
    File: user-provided-certificates-for-default-ingress
  - Name: Ingress certificates
    File: ingress-certificates
  - Name: Monitoring and cluster logging Operator component certificates
    File: monitoring-and-cluster-logging-operator-component-certificates
  - Name: Control plane certificates
    File: control-plane-certificates
- Name: Compliance Operator
  Dir: compliance_operator
  Topics:
  - Name: Compliance Operator overview
    File: co-overview
  - Name: Compliance Operator release notes
    File: compliance-operator-release-notes
  - Name: Compliance Operator support
    File: co-support
  - Name: Compliance Operator concepts
    Dir: co-concepts
    Topics:
    - Name: Understanding the Compliance Operator
      File: compliance-operator-understanding
    - Name: Understanding the Custom Resource Definitions
      File: compliance-operator-crd
  - Name: Compliance Operator management
    Dir: co-management
    Topics:
    - Name: Installing the Compliance Operator
      File: compliance-operator-installation
    - Name: Updating the Compliance Operator
      File: compliance-operator-updating
    - Name: Managing the Compliance Operator
      File: compliance-operator-manage
    - Name: Uninstalling the Compliance Operator
      File: compliance-operator-uninstallation
  - Name: Compliance Operator scan management
    Dir: co-scans
    Topics:
    - Name: Supported compliance profiles
      File: compliance-operator-supported-profiles
    - Name: Compliance Operator scans
      File: compliance-scans
    - Name: Tailoring the Compliance Operator
      File: compliance-operator-tailor
    - Name: Retrieving Compliance Operator raw results
      File: compliance-operator-raw-results
    - Name: Managing Compliance Operator remediation
      File: compliance-operator-remediation
    - Name: Performing advanced Compliance Operator tasks
      File: compliance-operator-advanced
    - Name: Troubleshooting Compliance Operator scans
      File: compliance-operator-troubleshooting
    - Name: Using the oc-compliance plugin
      File: oc-compliance-plug-in-using
- Name: File Integrity Operator
  Dir: file_integrity_operator
  Topics:
  - Name: File Integrity Operator Overview
    File: fio-overview
  - Name: File Integrity Operator release notes
    File: file-integrity-operator-release-notes
  - Name: File Integrity Operator support
    File: fio-support
  - Name: Installing the File Integrity Operator
    File: file-integrity-operator-installation
  - Name: Updating the File Integrity Operator
    File: file-integrity-operator-updating
  - Name: Understanding the File Integrity Operator
    File: file-integrity-operator-understanding
  - Name: Configuring the File Integrity Operator
    File: file-integrity-operator-configuring
  - Name: Performing advanced File Integrity Operator tasks
    File: file-integrity-operator-advanced-usage
  - Name: Troubleshooting the File Integrity Operator
    File: file-integrity-operator-troubleshooting
  - Name: Uninstalling the File Integrity Operator
    File: fio-uninstalling
- Name: Security Profiles Operator
  Dir: security_profiles_operator
  Topics:
  - Name: Security Profiles Operator overview
    File: spo-overview
  - Name: Security Profiles Operator release notes
    File: spo-release-notes
  - Name: Security Profiles Operator support
    File: spo-support
  - Name: Understanding the Security Profiles Operator
    File: spo-understanding
  - Name: Enabling the Security Profiles Operator
    File: spo-enabling
  - Name: Managing seccomp profiles
    File: spo-seccomp
  - Name: Managing SELinux profiles
    File: spo-selinux
  - Name: Advanced Security Profiles Operator tasks
    File: spo-advanced
  - Name: Advanced Audit Logging Framework
    File: spo-logging
  - Name: Troubleshooting the Security Profiles Operator
    File: spo-troubleshooting
  - Name: Uninstalling the Security Profiles Operator
    File: spo-uninstalling
- Name: NBDE Tang Server Operator
  Dir: nbde_tang_server_operator
  Distros: openshift-enterprise
  Topics:
  - Name: NBDE Tang Server Operator overview
    File: nbde-tang-server-operator-overview
  - Name: NBDE Tang Server Operator release notes
    File: nbde-tang-server-operator-release-notes
  - Name: Understanding the NBDE Tang Server Operator
    File: nbde-tang-server-operator-understanding
  - Name: Installing the NBDE Tang Server Operator
    File: nbde-tang-server-operator-installing
  - Name: Configuring and managing Tang servers using the NBDE Tang Server Operator
    File: nbde-tang-server-operator-configuring-managing
  - Name: Identifying URL of a Tang server deployed with the NBDE Tang Server Operator
    File: nbde-tang-server-operator-identifying-url
- Name: Understanding secrets management
  File: understanding-secrets-management
- Name: cert-manager Operator for Red Hat OpenShift
  Dir: cert_manager_operator
  Distros: openshift-enterprise
  Topics:
  - Name: cert-manager Operator for Red Hat OpenShift overview
    File: index
  - Name: cert-manager Operator for Red Hat OpenShift release notes
    File: cert-manager-operator-release-notes
  - Name: Installing the cert-manager Operator for Red Hat OpenShift
    File: cert-manager-operator-install
  - Name: Configuring the egress proxy
    File: cert-manager-operator-proxy
  - Name: Customizing cert-manager by using the cert-manager Operator API fields
    File: cert-manager-customizing-api-fields
  - Name: Authenticating the cert-manager Operator for Red Hat OpenShift
    File: cert-manager-authenticate
  - Name: Configuring an ACME issuer
    File: cert-manager-operator-issuer-acme
  - Name: Configuring certificates with an issuer
    File: cert-manager-creating-certificate
  - Name: Securing routes with the cert-manager Operator for Red Hat OpenShift
    File: cert-manager-securing-routes
  - Name: Integrating the cert-manager Operator with Istio-CSR
    File: cert-manager-operator-integrating-istio
  - Name: Network policy configuration for cert-manager Operator
    File: cert-manager-nw-policy
  - Name: Distributing certificates by using trust-manager operand
    File: cert-manager-trust-manager
  - Name: Monitoring the cert-manager Operator for Red Hat OpenShift
    File: cert-manager-monitoring
  - Name: Configuring log levels for cert-manager and the cert-manager Operator for Red Hat OpenShift
    File: cert-manager-log-levels
  - Name: Uninstalling the cert-manager Operator for Red Hat OpenShift
    File: cert-manager-operator-uninstall
- Name: Zero Trust Workload Identity Manager
  Dir: zero_trust_workload_identity_manager
  Distros: openshift-enterprise
  Topics:
  - Name: Zero Trust Workload Identity Manager overview
    File: zero-trust-manager-overview
  - Name: Zero Trust Workload Identity Manager components
    File: zero-trust-manager-components
  - Name: Zero Trust Workload Identity Manager release notes
    File: zero-trust-manager-release-notes
  - Name: Installing Zero Trust Workload Identity Manager
    File: zero-trust-manager-install
  - Name: Deploying Zero Trust Workload Identity Manager operands
    File: zero-trust-manager-configuration
  - Name: Configuring the egress proxy
    File: zero-trust-manager-proxy
  - Name: Configuring Zero Trust Workload Identity Manager OIDC Federation
    File: zero-trust-manager-oidc-federation
  - Name: Configuring Zero Trust Workload Identity Manager SPIRE Federation
    File: zero-trust-manager-spire-federation
  - Name: Enabling create-only mode for the Zero Trust Workload Identity Manager
    File: zero-trust-manager-reconciliation
  - Name: Monitoring Zero Trust Workload Identity Manager
    File: zero-trust-manager-monitoring
  - Name: Uninstalling the Zero Trust Workload Identity Manager
    File: zero-trust-manager-uninstall
- Name: External Secrets Operator for Red Hat OpenShift
  Dir: external_secrets_operator
  Distros: openshift-enterprise
  Topics:
  - Name: External Secrets Operator overview
    File: index
  - Name: External Secrets Operator release notes
    File: external-secrets-operator-release-notes
  - Name: Installing the External Secrets Operator
    File: external-secrets-operator-install
  - Name: Configuring Network Policy for the Operand
    File: external-secrets-operator-config-net-policy
  - Name: Configuring the egress proxy
    File: external-secrets-operator-proxy
  - Name: Monitoring the External Secrets Operator for Red Hat OpenShift
    File: external-secrets-monitoring
  - Name: Customizing the External Secrets Operator for Red Hat OpenShift
    File: external-secrets-log-levels
  - Name: Uninstalling the External Secrets Operator
    File: external-secrets-operator-uninstall
  - Name: External Secrets Operator APIs
    File: external-secrets-operator-api
  - Name: Migrating from the community External Secret Operator to the External Secret Operator For Red Hat OpenShift
    File: external-secrets-operator-migrate-downstream-upstream
- Name: Viewing audit logs
  File: audit-log-view
- Name: Configuring the audit log policy
  File: audit-log-policy-config
- Name: Configuring TLS security profiles
  File: tls-security-profiles
- Name: Configuring seccomp profiles
  File: seccomp-profiles
- Name: Allowing JavaScript-based access to the API server from additional hosts
  File: allowing-javascript-access-api-server
  Distros: openshift-enterprise,openshift-origin
- Name: Scanning pods for vulnerabilities
  File: pod-vulnerability-scan
  Distros: openshift-enterprise,openshift-origin
- Name: Network-Bound Disk Encryption (NBDE)
  Dir: network_bound_disk_encryption
  Topics:
  - Name: About disk encryption technology
    File: nbde-about-disk-encryption-technology
  - Name: Tang server installation considerations
    File: nbde-tang-server-installation-considerations
  - Name: Tang server encryption key management
    File: nbde-managing-encryption-keys
  - Name: Disaster recovery considerations
    File: nbde-disaster-recovery-considerations
    Distros: openshift-enterprise,openshift-origin
---
Name: Authentication and authorization
Dir: authentication
Distros: openshift-enterprise,openshift-origin
Topics:
- Name: Authentication and authorization overview
  File: index
- Name: Understanding authentication
  File: understanding-authentication
  Distros: openshift-enterprise,openshift-origin,openshift-online
- Name: Configuring the internal OAuth server
  File: configuring-internal-oauth
- Name: Configuring OAuth clients
  File: configuring-oauth-clients
- Name: Managing user-owned OAuth access tokens
  File: managing-oauth-access-tokens
  Distros: openshift-enterprise,openshift-origin
- Name: Understanding identity provider configuration
  File: understanding-identity-provider
  Distros: openshift-enterprise,openshift-origin
- Name: Configuring identity providers
  Dir: identity_providers
  Topics:
  - Name: Configuring an htpasswd identity provider
    File: configuring-htpasswd-identity-provider
    Distros: openshift-enterprise,openshift-origin
  - Name: Configuring a Keystone identity provider
    File: configuring-keystone-identity-provider
    Distros: openshift-enterprise,openshift-origin
  - Name: Configuring an LDAP identity provider
    File: configuring-ldap-identity-provider
  - Name: Configuring a basic authentication identity provider
    File: configuring-basic-authentication-identity-provider
    Distros: openshift-enterprise,openshift-origin
  - Name: Configuring a request header identity provider
    File: configuring-request-header-identity-provider
    Distros: openshift-enterprise,openshift-origin
  - Name: Configuring a GitHub or GitHub Enterprise identity provider
    File: configuring-github-identity-provider
  - Name: Configuring a GitLab identity provider
    File: configuring-gitlab-identity-provider
    Distros: openshift-enterprise,openshift-origin
  - Name: Configuring a Google identity provider
    File: configuring-google-identity-provider
  - Name: Configuring an OpenID Connect identity provider
    File: configuring-oidc-identity-provider
- Name: Enabling direct authentication with an OIDC identity provider
  File: external-auth
- Name: Using RBAC to define and apply permissions
  File: using-rbac
- Name: Removing the kubeadmin user
  File: remove-kubeadmin
  Distros: openshift-enterprise,openshift-origin
#- Name: Configuring LDAP failover
#  File: configuring-ldap-failover
- Name: Understanding and creating service accounts
  File: understanding-and-creating-service-accounts
- Name: Using service accounts in applications
  File: using-service-accounts-in-applications
- Name: Using a service account as an OAuth client
  File: using-service-accounts-as-oauth-client
- Name: Scoping tokens
  File: tokens-scoping
- Name: Using bound service account tokens
  File: bound-service-account-tokens
- Name: Managing security context constraints
  File: managing-security-context-constraints
  Distros: openshift-enterprise,openshift-origin
- Name: Understanding and managing pod security admission
  File: understanding-and-managing-pod-security-admission
  Distros: openshift-enterprise,openshift-origin
- Name: Impersonating the system:admin user
  File: impersonating-system-admin
  Distros: openshift-enterprise,openshift-origin
- Name: Syncing LDAP groups
  File: ldap-syncing
  Distros: openshift-enterprise,openshift-origin
- Name: Managing cloud provider credentials
  Dir: managing_cloud_provider_credentials
  Topics:
  - Name: About the Cloud Credential Operator
    File: about-cloud-credential-operator
  - Name: Mint mode
    File: cco-mode-mint
  - Name: Passthrough mode
    File: cco-mode-passthrough
  - Name: Manual mode with long-term credentials for components
    File: cco-mode-manual
  - Name: Manual mode with short-term credentials for components
    File: cco-short-term-creds
---
Name: Networking
Dir: networking
Distros: openshift-enterprise,openshift-origin
Topics:
- Name: Networking overview
  Dir: networking_overview
  Distros: openshift-enterprise,openshift-origin
  Topics:
  - Name: Understanding networking
    File: understanding-networking
  - Name: Accessing hosts
    File: accessing-hosts
  - Name: Networking dashboards
    File: networking-dashboards
  - Name: CIDR range definitions
    File: cidr-range-definitions
- Name: Networking Operators
  Dir: networking_operators
  Distros: openshift-enterprise,openshift-origin
  Topics:
  - Name: Kubernetes NMState Operator
    File: k8s-nmstate-about-the-k8s-nmstate-operator
  - Name: AWS Load Balancer Operator
    Dir: aws_load_balancer_operator
    Distros: openshift-enterprise,openshift-origin
    Topics:
    - Name: AWS Load Balancer Operator release notes
      File: aws-load-balancer-operator-release-notes
    - Name: AWS Load Balancer Operator in OpenShift Container Platform
      File: understanding-aws-load-balancer-operator
    - Name: Preparing an AWS STS cluster for the AWS Load Balancer Operator
      File: preparing-sts-cluster-for-albo
    - Name: Installing the AWS Load Balancer Operator
      File: install-aws-load-balancer-operator
    - Name: Configuring the AWS Load Balancer Operator
      File: configuring-aws-load-balancer-operator
  - Name: eBPF manager Operator
    Dir: ebpf_manager
    Topics:
    - Name: About the eBPF Manager Operator
      File: ebpf-manager-operator-about
    - Name: Installing the eBPF Manager Operator
      File: ebpf-manager-operator-install
    - Name: Deploying an eBPF program
      File: ebpf-manager-operator-deploy
  - Name: External DNS Operator
    Dir: external_dns_operator
    Topics:
    - Name: External DNS Operator release notes
      File: external-dns-operator-release-notes
    - Name: Understanding the External DNS Operator
      File: understanding-external-dns-operator
    - Name: Installing the External DNS Operator
      File: nw-installing-external-dns-operator-on-cloud-providers
    - Name: External DNS Operator configuration parameters
      File: nw-configuration-parameters
    - Name: Creating DNS records on AWS
      File: nw-creating-dns-records-on-aws
    - Name: Creating DNS records on Azure
      File: nw-creating-dns-records-on-azure
    - Name: Creating DNS records on Google Cloud
      File: nw-creating-dns-records-on-gcp
    - Name: Creating DNS records on Infoblox
      File: nw-creating-dns-records-on-infoblox
    - Name: Configuring the cluster-wide proxy on the External DNS Operator
      File: nw-configuring-cluster-wide-egress-proxy
  - Name: MetalLB Operator
    Dir: metallb-operator
    Distros: openshift-enterprise,openshift-origin
    Topics:
    - Name: About MetalLB and the MetalLB Operator
      File: about-metallb
    - Name: Installing the MetalLB Operator
      File: metallb-operator-install
    - Name: Upgrading the MetalLB Operator
      File: metallb-upgrading-operator
  - Name: Cluster Network Operator in OpenShift Container Platform
    File: cluster-network-operator
    Distros: openshift-enterprise,openshift-origin
  - Name: DNS Operator in OpenShift Container Platform
    File: dns-operator
    Distros: openshift-enterprise,openshift-origin
  - Name: Ingress Operator in OpenShift Container Platform
    File: ingress-operator
    Distros: openshift-enterprise,openshift-origin
  - Name: Ingress Node Firewall Operator in OpenShift Container Platform
    File: ingress-node-firewall-operator
    Distros: openshift-enterprise,openshift-origin
  - Name: SR-IOV Operator
    Dir: sr-iov-operator
    Distros: openshift-enterprise,openshift-origin
    Topics:
    - Name: Installing the SR-IOV Operator
      File: installing-sriov-operator
    - Name: Configuring the SR-IOV Operator
      File: configuring-sriov-operator
    - Name: Uninstalling the SR-IOV Operator
      File: uninstalling-sriov-operator
  - Name: DPU Operator
    Dir: dpu-operator
    Distros: openshift-enterprise,openshift-origin
    Topics:
    - Name: DPU Operator
      File: dpu-operator
- Name: Network security
  Dir: network_security
  Distros: openshift-enterprise,openshift-origin
  Topics:
  - Name: Understanding network policy APIs
    File: network-policy-apis
  - Name: Admin network policy
    Dir: AdminNetworkPolicy
    Distros: openshift-enterprise, openshift-origin
    Topics:
    - Name: About AdminNetworkPolicy
      File: ovn-k-anp
    - Name: About BaselineAdminNetworkPolicy
      File: ovn-k-banp
    - Name: Metrics for AdminNetworkPolicy
      File: ovn-k-anp-banp-metrics
    - Name: Northbound Traffic Controls for AdminNetworkPolicy
      File: ovn-k-egress-nodes-networks-peer
    - Name: Troubleshooting
      File: ovn-k-anp-troubleshooting
    - Name: Best practices
      File: ovn-k-anp-recommended-practices
  - Name: Network policy
    Dir: network_policy
    Distros: openshift-enterprise, openshift-origin
    Topics:
    - Name: About network policy
      File: about-network-policy
    - Name: Creating a network policy
      File: creating-network-policy
    - Name: Viewing a network policy
      File: viewing-network-policy
    - Name: Editing a network policy
      File: editing-network-policy
    - Name: Deleting a network policy
      File: deleting-network-policy
    - Name: Defining a default network policy for projects
      File: default-network-policy
    - Name: Configuring multitenant isolation with network policy
      File: multitenant-network-policy
  - Name: Audit logging for network security
    File: logging-network-security
  - Name: Egress Firewall
    Dir: egress_firewall
    Distros: openshift-enterprise,openshift-origin
    Topics:
    - Name: Viewing an egress firewall for a project
      File: viewing-egress-firewall-ovn
    - Name: Editing an egress firewall for a project
      File: editing-egress-firewall-ovn
    - Name: Removing an egress firewall from a project
      File: removing-egress-firewall-ovn
    - Name: Configuring an egress firewall for a project
      File: configuring-egress-firewall-ovn
  - Name: Configuring IPsec encryption
    File: configuring-ipsec-ovn
  - Name: Zero trust networking
    File: zero-trust-networking
- Name: Multiple networks
  Dir: multiple_networks
  Distros: openshift-enterprise,openshift-origin
  Topics:
  - Name: Understanding multiple networks
    File: understanding-multiple-networks
  - Name: Use cases for a secondary network
    File: use-cases-secondary-network
  - Name: Primary networks
    Dir: primary_networks
    Distros: openshift-enterprise, openshift-origin
    Topics:
    - Name: UserDefinedNetwork CR
      File: about-user-defined-networks
    - Name: NetworkAttachmentDefinition CR
      File: about-primary-nwt-nad
  - Name: Secondary networks
    Dir: secondary_networks
    Distros: openshift-enterprise, openshift-origin
    Topics:
    - Name: Creating secondary networks on OVN-Kubernetes
      File: creating-secondary-nwt-ovnk
    - Name: Creating secondary networks with other CNI plugins
      File: creating-secondary-nwt-other-cni
    - Name: Attaching a pod to an additional network
      File: attaching-pod
    - Name: Configuring multi-network policies
      File: configuring-multi-network-policy
    - Name: Removing a pod from an additional network
      File: removing-pod
    - Name: Editing an additional network
      File: editing-additional-network
    - Name: Configuring IP address assignment for secondary networks
      File: configuring-ip-secondary-nwt
    - Name: Configuring the master interface in the container network namespace
      File: configuring-master-interface
    - Name: Removing an additional network
      File: removing-additional-network
    - Name: Enabling multi-networking for advanced use cases with CNI Plugin chaining
      File: about-chaining
  - Name: About virtual routing and forwarding
    File: about-virtual-routing-and-forwarding
  - Name: Assigning a secondary network to a VRF
    File: assigning-a-secondary-network-to-a-vrf
- Name: Hardware networks
  Dir: hardware_networks
  Distros: openshift-enterprise,openshift-origin
  Topics:
  - Name: About Single Root I/O Virtualization (SR-IOV) hardware networks
    File: about-sriov
  - Name: Configuring an SR-IOV network device
    File: configuring-sriov-device
  - Name: Configuring an SR-IOV Ethernet network attachment
    File: configuring-sriov-net-attach
  - Name: Configuring an SR-IOV InfiniBand network attachment
    File: configuring-sriov-ib-attach
  - Name: Configuring SriovNetwork in application namespaces
    File: configuring-namespaced-sriov-resources
  - Name: Configuring an RDMA subsystem for SR-IOV
    File: configuring-sriov-rdma-cni
  - Name: Configuring interface-level network sysctl settings and all-multicast mode for SR-IOV networks
    File: configuring-interface-sysctl-sriov-device
  - Name: Configuring QinQ support for SR-IOV networks
    File: configuring-sriov-qinq-support
  - Name: Using high performance multicast
    File: using-sriov-multicast
  - Name: Using DPDK and RDMA
    File: using-dpdk-and-rdma
  - Name: High availability for pod-level bonds on SR-IOV networks
    File: configure-lacp-for-sriov
  - Name: Using pod-level bonding for secondary networks
    File: using-pod-level-bonding
  - Name: Configuring hardware offloading
    File: configuring-hardware-offloading
  - Name: Switching Bluefield-2 from NIC to DPU mode
    File: switching-bf2-nic-dpu
- Name: OVN-Kubernetes network plugin
  Dir: ovn_kubernetes_network_provider
  Topics:
  - Name: About the OVN-Kubernetes network plugin
    File: about-ovn-kubernetes
  - Name: OVN-Kubernetes architecture
    File: ovn-kubernetes-architecture-assembly
  - Name: OVN-Kubernetes troubleshooting
    File: ovn-kubernetes-troubleshooting-sources
  - Name: OVN-Kubernetes traffic tracing
    File: ovn-kubernetes-tracing-using-ovntrace
  - Name: Converting to IPv4/IPv6 dual stack networking
    File: converting-to-dual-stack
  - Name: Configuring internal subnets
    File: configure-ovn-kubernetes-subnets
  - Name: Configuring a gateway
    File: configuring-gateway
  - Name: Configure an external gateway on the default network
    File: configuring-secondary-external-gateway
  - Name: Configuring an egress IP address
    File: configuring-egress-ips-ovn
  - Name: Configuring an egress service
    File: configuring-egress-traffic-for-vrf-loadbalancer-services
  - Name: Considerations for the use of an egress router pod
    File: using-an-egress-router-ovn
  - Name: Deploying an egress router pod in redirect mode
    File: deploying-egress-router-ovn-redirection
  - Name: Enabling multicast for a project
    File: enabling-multicast
  - Name: Disabling multicast for a project
    File: disabling-multicast
  - Name: Tracking network flows
    File: tracking-network-flows
  - Name: Configuring hybrid networking
    File: configuring-hybrid-networking
- Name: Ingress and load balancing
  Dir: ingress_load_balancing
  Distros: openshift-enterprise,openshift-origin
  Topics:
  - Name: Routes
    Dir: routes
    Distros: openshift-enterprise,openshift-origin
    Topics:
    - Name: Creating basic routes
      File: creating-basic-routes
    - Name: Securing routes
      File: securing-routes
    - Name: Configuring routes
      File: nw-configuring-routes
    - Name: Creating advanced routes
      File: creating-advanced-routes
  - Name: Configuring ingress cluster traffic
    Dir: configuring_ingress_cluster_traffic
    Distros: openshift-enterprise,openshift-origin
    Topics:
    - Name: Overview
      File: overview-traffic
    - Name: Configuring ExternalIPs for services
      File: configuring-externalip
    - Name: Configuring ingress cluster traffic by using an Ingress Controller
      File: configuring-ingress-cluster-traffic-ingress-controller
    - Name: Configuring the Ingress Controller endpoint publishing strategy
      File: nw-configuring-ingress-controller-endpoint-publishing-strategy
    - Name: Configuring ingress cluster traffic using a load balancer
      File: configuring-ingress-cluster-traffic-load-balancer
    - Name: Configuring ingress cluster traffic on AWS
      File: configuring-ingress-cluster-traffic-aws
    - Name: Configuring ingress cluster traffic using a service external IP
      File: configuring-ingress-cluster-traffic-service-external-ip
    - Name: Configuring ingress cluster traffic using a NodePort
      File: configuring-ingress-cluster-traffic-nodeport
    - Name: Configuring ingress cluster traffic using load balancer allowed source ranges
      File: configuring-ingress-cluster-traffic-load-balancer-allowed-source-ranges
    - Name: Patching existing ingress objects
      File: configuring-ingress-cluster-patch-fields
    - Name: Configuring the Ingress Controller for manual DNS management
      File: ingress-controller-dnsmgt
    - Name: Gateway API with OpenShift Container Platform networking
      File: ingress-gateway-api
  - Name: Configuring Gateway API
    Dir: configuring_gateway_api
    Distros: openshift-enterprise,openshift-origin
    Topics:
    - Name: Controlling incoming traffic with Gateway listeners
      File: controlling-incoming-traffic-gateway-listeners
    - Name: Assigning network addresses to gateways
      File: assigning-network-addresses-gateways
    - Name: Routing HTTP requests to services
      File: routing-http-requests-to-services
    - Name: Routing gRPC requests to services
      File: routing-grpc-requests-to-services
    - Name: Verifying Gateway infrastructure status
      File: verifying-gateway-infrastructure-status
  - Name: Load balancing on OpenStack
    File: load-balancing-openstack
  - Name: Load balancing with MetalLB
    Dir: metallb
    Distros: openshift-enterprise,openshift-origin
    Topics:
    - Name: Configuring MetalLB address pools
      File: metallb-configure-address-pools
    - Name: Advertising the IP address pools
      File: about-advertising-ipaddresspool
    - Name: Configuring MetalLB BGP peers
      File: metallb-configure-bgp-peers
    - Name: Advertising an IP address pool using the community alias
      File: metallb-configure-community-alias
    - Name: Configuring MetalLB BFD profiles
      File: metallb-configure-bfd-profiles
    - Name: Configuring services to use MetalLB
      File: metallb-configure-services
    - Name: Managing symmetric routing with MetalLB
      File: metallb-configure-return-traffic
    - Name: Configuring the integration of MetalLB and FRR-K8s
      File: metallb-frr-k8s
    - Name: MetalLB status reporting
      File: monitoring-metallb-status
    - Name: MetalLB logging, troubleshooting, and support
      File: metallb-troubleshoot-support
- Name: Configuring network settings
  Dir: configuring_network_settings
  Distros: openshift-enterprise,openshift-origin
  Topics:
  - Name: Configuring system controls and interface attributes using the tuning plugin
    File: configure-syscontrols-interface-tuning-cni
  - Name: Configuring the node port service range
    File: configuring-node-port-service-range
  - Name: Configuring the cluster network IP address range
    File: configuring-cluster-network-range
  - Name: Configuring IP failover
    File: configuring-ipfailover
  - Name: Configuring the cluster-wide proxy
    File: enable-cluster-wide-proxy
  - Name: Configuring a custom PKI
    File: configuring-a-custom-pki
- Name: Advanced networking
  Dir: advanced_networking
  Distros: openshift-enterprise, openshift-origin
  Topics:
  - Name: Verifying connectivity to an endpoint
    File: verifying-connectivity-endpoint
  - Name: Changing the cluster network MTU
    File: changing-cluster-network-mtu
  - Name: Network bonding considerations
    File: network-bonding-considerations
  - Name: Using Stream Control Transmission Protocol
    File: using-sctp
  - Name: Associating secondary interfaces metrics to network attachments
    File: associating-secondary-interfaces-metrics-to-network-attachments
  - Name: BGP routing
    Dir: bgp_routing
    Topics:
    - Name: About BGP routing
      File: about-bgp-routing
    - Name: Enabling BGP routing
      File: enabling-bgp-routing
    - Name: Disabling BGP routing
      File: disabling-bgp-routing
    - Name: Migrating FRR-K8s custom resources
      File: migrating-frr-k8s-resources
  - Name: Route advertisements
    Dir: route_advertisements
    Topics:
    - Name: About route advertisements
      File: about-route-advertisements
    - Name: Enabling route advertisements
      File: enabling-route-advertisements
    - Name: Disabling route advertisements
      File: disabling-route-advertisements
    - Name: Example route advertisements setup
      File: example-route-advertisement-setup
  - Name: Using PTP hardware
    Dir: ptp
    Distros: openshift-enterprise,openshift-origin
    Topics:
    - Name: About PTP in OpenShift cluster nodes
      File: about-ptp
    - Name: Configuring PTP devices
      File: configuring-ptp
    - Name: Developing PTP events consumer applications with the REST API v2
      File: ptp-cloud-events-consumer-dev-reference-v2
    - Name: PTP events REST API v2 reference
      File: ptp-events-rest-api-reference-v2
- Name: Kubernetes NMState
  Dir: k8s_nmstate
  Topics:
  - Name: Observing and updating node network state and configuration
    File: k8s-nmstate-updating-node-network-config
  - Name: Troubleshooting node network configuration
    File: k8s-nmstate-troubleshooting-node-network
---
Name: Storage
Dir: storage
Distros: openshift-enterprise,openshift-origin,openshift-online
Topics:
- Name: Storage overview
  File: index
  Distros: openshift-enterprise,openshift-origin,openshift-online
- Name: Understanding ephemeral storage
  File: understanding-ephemeral-storage
  Distros: openshift-enterprise,openshift-origin,openshift-online
- Name: Understanding persistent storage
  File: understanding-persistent-storage
  Distros: openshift-enterprise,openshift-origin,openshift-online
- Name: Configuring persistent storage
  Dir: persistent_storage
  Distros: openshift-enterprise,openshift-origin
  Topics:
  - Name: Persistent storage using AWS Elastic Block Store
    File: persistent-storage-aws
  - Name: Persistent storage using Azure Disk
    File: persistent-storage-azure
  - Name: Persistent storage using Azure File
    File: persistent-storage-azure-file
  - Name: Persistent storage using Cinder
    File: persistent-storage-cinder
  - Name: Persistent storage using Fibre Channel
    File: persistent-storage-fibre
  - Name: Persistent storage using FlexVolume
    File: persistent-storage-flexvolume
  - Name: Persistent storage using GCE Persistent Disk
    File: persistent-storage-gce
  - Name: Persistent Storage using iSCSI
    File: persistent-storage-iscsi
  - Name: Persistent storage using NFS
    File: persistent-storage-nfs
  - Name: Persistent storage using Red Hat OpenShift Data Foundation
    File: persistent-storage-ocs
  - Name: Persistent storage using VMware vSphere
    File: persistent-storage-vsphere
- Name: Persistent storage using local storage
  Dir: persistent_storage_local
  Distros: openshift-enterprise,openshift-origin
  Topics:
  - Name: Local storage overview
    File: ways-to-provision-local-storage
  - Name: Persistent storage using local volumes
    File: persistent-storage-local
  - Name: Persistent storage using hostPath
    File: persistent-storage-hostpath
  - Name: Persistent storage using LVM Storage
    File: persistent-storage-using-lvms
- Name: Using Container Storage Interface (CSI)
  Dir: container_storage_interface
  Distros: openshift-enterprise,openshift-origin
  Topics:
  - Name: Configuring CSI volumes
    File: persistent-storage-csi
  - Name: CSI inline ephemeral volumes
    File: ephemeral-storage-csi-inline
  - Name: CSI volume snapshots
    File: persistent-storage-csi-snapshots
  - Name: CSI volume group snapshots
    File: persistent-storage-csi-group-snapshots
  - Name: CSI volume cloning
    File: persistent-storage-csi-cloning
  - Name: Volume populators
    File: persistent-storage-csi-vol-populators
  - Name: Managing the default storage class
    File: persistent-storage-csi-sc-manage
  - Name: CSI automatic migration
    File: persistent-storage-csi-migration
  - Name: AWS Elastic Block Store CSI Driver Operator
    File: persistent-storage-csi-ebs
  - Name: AWS Elastic File Service CSI Driver Operator
    File: persistent-storage-csi-aws-efs
  - Name: Azure Disk CSI Driver Operator
    File: persistent-storage-csi-azure
  - Name: Azure File CSI Driver Operator
    File: persistent-storage-csi-azure-file
  - Name: Azure Stack Hub CSI Driver Operator
    File: persistent-storage-csi-azure-stack-hub
  - Name: GCP PD CSI Driver Operator
    File: persistent-storage-csi-gcp-pd
  - Name: GCP Filestore CSI Driver Operator
    File: persistent-storage-csi-google-cloud-file
  - Name: IBM Cloud Block Storage (VPC) CSI Driver Operator
    File: persistent-storage-csi-ibm-cloud-vpc-block
  - Name: IBM Power Virtual Server Block Storage CSI Driver Operator
    File: persistent-storage-csi-ibm-powervs-block
  - Name: OpenStack Cinder CSI Driver Operator
    File: persistent-storage-csi-cinder
  - Name: OpenStack Manila CSI Driver Operator
    File: persistent-storage-csi-manila
  - Name: Secrets Store CSI Driver Operator
    File: persistent-storage-csi-secrets-store
  - Name: CIFS/SMB CSI Driver Operator
    File: persistent-storage-csi-smb-cifs
  - Name: VMware vSphere CSI Driver Operator
    File: persistent-storage-csi-vsphere
- Name: Generic ephemeral volumes
  File: generic-ephemeral-vols
  Distros: openshift-enterprise,openshift-origin,openshift-online
- Name: Expanding persistent volumes
  File: expanding-persistent-volumes
  Distros: openshift-enterprise,openshift-origin
- Name: Dynamic provisioning
  File: dynamic-provisioning
  Distros: openshift-enterprise,openshift-origin
- Name: Detach volumes after non-graceful node shutdown
  File: persistent-storage-csi-vol-detach-non-graceful-shutdown
  Distros: openshift-enterprise,openshift-origin,openshift-online
---
Name: Registry
Dir: registry
Distros: openshift-enterprise,openshift-origin
Topics:
- Name: Registry overview
  File: index
- Name: Image Registry Operator in OpenShift Container Platform
  File: configuring-registry-operator
  Distros: openshift-enterprise
- Name: Image Registry Operator in OKD
  File: configuring-registry-operator
  Distros: openshift-origin
- Name: Setting up and configuring the registry
  Dir: configuring_registry_storage
  Distros: openshift-enterprise,openshift-origin
  Topics:
  - Name: Configuring the registry for AWS user-provisioned infrastructure
    File: configuring-registry-storage-aws-user-infrastructure
  - Name: Configuring the registry for Google Cloud user-provisioned infrastructure
    File: configuring-registry-storage-gcp-user-infrastructure
  - Name: Configuring the registry for OpenStack user-provisioned infrastructure
    File: configuring-registry-storage-openstack-user-infrastructure
  - Name: Configuring the registry for Azure user-provisioned infrastructure
    File: configuring-registry-storage-azure-user-infrastructure
  - Name: Configuring the registry for OpenStack
    File: configuring-registry-storage-osp
  - Name: Configuring the registry for bare metal
    File: configuring-registry-storage-baremetal
  - Name: Configuring the registry for vSphere
    File: configuring-registry-storage-vsphere
  - Name: Configuring the registry for OpenShift Data Foundation
    File: configuring-registry-storage-rhodf
    Distros: openshift-enterprise,openshift-origin
  - Name: Configuring the registry for Nutanix
    File: configuring-registry-storage-nutanix
    Distros: openshift-enterprise,openshift-origin
- Name: Accessing the registry
  File: accessing-the-registry
- Name: Exposing the registry
  File: securing-exposing-registry
  Distros: openshift-enterprise,openshift-origin
---
Name: Operators
Dir: operators
Distros: openshift-enterprise,openshift-origin
Topics:
- Name: Operators overview
  File: index
- Name: Understanding Operators
  Dir: understanding
  Topics:
  - Name: What are Operators?
    File: olm-what-operators-are
  - Name: Packaging format
    File: olm-packaging-format
  - Name: Common terms
    File: olm-common-terms
  - Name: Operator Lifecycle Manager (OLM)
    Dir: olm
    Distros: openshift-enterprise,openshift-origin
    Topics:
    - Name: Concepts and resources
      File: olm-understanding-olm
    - Name: Architecture
      File: olm-arch
    - Name: Workflow
      File: olm-workflow
    - Name: Dependency resolution
      File: olm-understanding-dependency-resolution
    - Name: Operator groups
      File: olm-understanding-operatorgroups
    - Name: Multitenancy and Operator colocation
      File: olm-colocation
    - Name: Operator conditions
      File: olm-operatorconditions
    - Name: Metrics
      File: olm-understanding-metrics
    - Name: Webhooks
      File: olm-webhooks
  - Name: Software catalog
    Distros: openshift-enterprise,openshift-origin
    File: olm-understanding-software-catalog
  - Name: Red Hat-provided Operator catalogs
    Distros: openshift-enterprise
    File: olm-rh-catalogs
  - Name: Operators in multitenant clusters
    Distros: openshift-enterprise,openshift-origin
    File: olm-multitenancy
  - Name: CRDs
    Dir: crds
    Topics:
    - Name: Extending the Kubernetes API with CRDs
      File: crd-extending-api-with-crds
      Distros: openshift-origin,openshift-enterprise
    - Name: Managing resources from CRDs
      File: crd-managing-resources-from-crds
      Distros: openshift-origin,openshift-enterprise
- Name: User tasks
  Dir: user
  Topics:
  - Name: Creating applications from installed Operators
    File: olm-creating-apps-from-installed-operators
    Distros: openshift-enterprise,openshift-origin
  - Name: Installing Operators in your namespace
    File: olm-installing-operators-in-namespace
    Distros: openshift-enterprise,openshift-origin
- Name: Administrator tasks
  Dir: admin
  Topics:
  - Name: Adding Operators to a cluster
    File: olm-adding-operators-to-cluster
    Distros: openshift-enterprise,openshift-origin
  - Name: Updating installed Operators
    File: olm-upgrading-operators
    Distros: openshift-enterprise,openshift-origin
  - Name: Deleting Operators from a cluster
    File: olm-deleting-operators-from-cluster
    Distros: openshift-enterprise,openshift-origin
  - Name: Configuring OLM features
    File: olm-config
    Distros: openshift-enterprise,openshift-origin
  - Name: Configuring proxy support
    File: olm-configuring-proxy-support
    Distros: openshift-enterprise,openshift-origin
  - Name: Viewing Operator status
    File: olm-status
    Distros: openshift-enterprise,openshift-origin
  - Name: Managing Operator conditions
    File: olm-managing-operatorconditions
    Distros: openshift-origin,openshift-enterprise
  - Name: Allowing non-cluster administrators to install Operators
    File: olm-creating-policy
    Distros: openshift-origin,openshift-enterprise
  - Name: Managing custom catalogs
    File: olm-managing-custom-catalogs
    Distros: openshift-origin,openshift-enterprise
  - Name: Using OLM in disconnected environments
    File: olm-restricted-networks
    Distros: openshift-origin,openshift-enterprise
  - Name: Catalog source pod scheduling
    File: olm-cs-podsched
    Distros: openshift-origin,openshift-enterprise
  - Name: Troubleshooting Operator issues
    File: olm-troubleshooting-operator-issues
    Distros: openshift-enterprise,openshift-origin
- Name: Developing Operators
  Dir: operator_sdk
  Distros: openshift-origin,openshift-enterprise
  Topics:
  - Name: Token authentication
    Dir: token_auth
    Topics:
    - Name: Token authentication for Operators on cloud providers
      File: osdk-token-auth
    - Name: CCO-based workflow for OLM-managed Operators with AWS STS
      File: osdk-cco-aws-sts
    - Name: CCO-based workflow for OLM-managed Operators with Microsoft Entra Workload ID
      File: osdk-cco-azure
    - Name: CCO-based workflow for OLM-managed Operators with Google Cloud Workload Identity
      File: osdk-cco-gcp
- Name: Cluster Operators reference
  File: operator-reference
- Name: OLM v1
  Dir: olm_v1
  Distros: openshift-origin,openshift-enterprise
  Topics:
  - Name: About OLM v1
    File: index
---
Name: Extensions
Dir: extensions
Distros: openshift-enterprise,openshift-origin
Topics:
- Name: Extensions overview
  File: index
- Name: Architecture
  Dir: arch
  Topics:
  - Name: Components overview
    File: components
  - Name: Operator Controller
    File: operator-controller
  - Name: Catalogd
    File: catalogd
- Name: Common terms
  File: of-terms
- Name: Catalogs
  Dir: catalogs
  Topics:
  - Name: File-based catalogs
    File: fbc
  - Name: Red Hat-provided catalogs
    File: rh-catalogs
  - Name: Managing catalogs
    File: managing-catalogs
  - Name: Catalog content resolution
    File: catalog-content-resolution
  - Name: Creating catalogs
    File: creating-catalogs
  - Name: Disconnected environment support in OLM v1
    File: disconnected-catalogs
- Name: Cluster extensions
  Dir: ce
  Topics:
  - Name: Supported extensions
    File: olmv1-supported-extensions
  - Name: Managing extensions
    File: managing-ce
  - Name: Extension configuration
    File: olmv1-configuring-extensions
  - Name: User access to extension resources
    File: user-access-resources
  - Name: Update paths
    File: update-paths
  - Name: CRD upgrade safety
    File: crd-upgrade-safety
---
Name: CI/CD
Dir: cicd
Distros: openshift-enterprise,openshift-origin,openshift-online
Topics:
- Name: CI/CD overview
  Dir: overview
  Distros: openshift-enterprise,openshift-origin,openshift-online
  Topics:
  - Name: About CI/CD
    File: index
- Name: Builds using Shipwright
  Dir: builds_using_shipwright
  Distros: openshift-enterprise
  Topics:
  - Name: Overview of Builds
    File: overview-openshift-builds
- Name: Builds using BuildConfig
  Dir: builds
  Distros: openshift-enterprise,openshift-origin,openshift-online
  Topics:
  - Name: Understanding image builds
    File: understanding-image-builds
  - Name: Understanding build configurations
    File: understanding-buildconfigs
  - Name: Creating build inputs
    File: creating-build-inputs
  - Name: Managing build output
    File: managing-build-output
  - Name: Using build strategies
    File: build-strategies
  - Name: Custom image builds with Buildah
    File: custom-builds-buildah
    Distros: openshift-enterprise,openshift-origin
  - Name: Performing and configuring basic builds
    File: basic-build-operations
    Distros: openshift-enterprise,openshift-origin,openshift-online
  - Name: Triggering and modifying builds
    File: triggering-builds-build-hooks
    Distros: openshift-enterprise,openshift-origin,openshift-online
  - Name: Performing advanced builds
    File: advanced-build-operations
    Distros: openshift-enterprise,openshift-origin
  - Name: Using Red Hat subscriptions in builds
    File: running-entitled-builds
    Distros: openshift-enterprise,openshift-origin
  - Name: Securing builds by strategy
    File: securing-builds-by-strategy
    Distros: openshift-enterprise,openshift-origin
  - Name: Build configuration resources
    File: build-configuration
    Distros: openshift-enterprise,openshift-origin
  - Name: Troubleshooting builds
    File: troubleshooting-builds
    Distros: openshift-enterprise,openshift-origin
  - Name: Setting up additional trusted certificate authorities for builds
    File: setting-up-trusted-ca
    Distros: openshift-enterprise,openshift-origin
- Name: Pipelines
  Dir: pipelines
  Distros: openshift-enterprise
  Topics:
  - Name: About OpenShift Pipelines
    File: about-pipelines
- Name: GitOps
  Dir: gitops
  Distros: openshift-enterprise
  Topics:
  - Name: About OpenShift GitOps
    File: about-redhat-openshift-gitops
- Name: Jenkins
  Dir: jenkins
  Distros: openshift-enterprise
  Topics:
  - Name: Configuring Jenkins images
    File: images-other-jenkins
  - Name: Jenkins agent
    File: images-other-jenkins-agent
  - Name: Migrating from Jenkins to OpenShift Pipelines
    File: migrating-from-jenkins-to-openshift-pipelines
  - Name: Important changes to OpenShift Jenkins images
    File: important-changes-to-openshift-jenkins-images
---
Name: Images
Dir: openshift_images
Distros: openshift-enterprise,openshift-origin,openshift-online
Topics:
- Name: Overview of images
  File: index
- Name: Configuring the Cluster Samples Operator
  File: configuring-samples-operator
  Distros: openshift-enterprise,openshift-origin
- Name: Using the Cluster Samples Operator with an alternate registry
  File: samples-operator-alt-registry
  Distros: openshift-enterprise,openshift-origin
- Name: Creating images
  File: create-images
- Name: Managing images
  Dir: managing_images
  Topics:
  - Name: Managing images overview
    File: managing-images-overview
  - Name: Tagging images
    File: tagging-images
  - Name: Image pull policy
    File: image-pull-policy
  - Name: Using image pull secrets
    File: using-image-pull-secrets
- Name: Managing image streams
  File: image-streams-manage
  Distros: openshift-enterprise,openshift-origin
- Name: Using image streams with Kubernetes resources
  File: using-imagestreams-with-kube-resources
  Distros: openshift-enterprise,openshift-origin
- Name: Triggering updates on image stream changes
  File: triggering-updates-on-imagestream-changes
  Distros: openshift-enterprise,openshift-origin
- Name: Image configuration resources
  File: image-configuration
  Distros: openshift-enterprise,openshift-origin
- Name: Using images
  Dir: using_images
  Distros: openshift-enterprise,openshift-origin
  Topics:
  - Name: Using images overview
    File: using-images-overview
  - Name: Source-to-image
    File: using-s21-images
  - Name: Customizing source-to-image images
    File: customizing-s2i-images
---
Name: Building applications
Dir: applications
Distros: openshift-enterprise,openshift-origin
Topics:
- Name: Building applications overview
  File: index
- Name: Projects
  Dir: projects
  Topics:
  - Name: Working with projects
    File: working-with-projects
  - Name: Creating a project as another user
    File: creating-project-other-user
    Distros: openshift-enterprise,openshift-origin
  - Name: Configuring project creation
    File: configuring-project-creation
    Distros: openshift-enterprise,openshift-origin
- Name: Creating applications
  Dir: creating_applications
  Topics:
  - Name: Using templates
    File: using-templates
  - Name: Creating applications using the Developer perspective
    File: odc-creating-applications-using-developer-perspective
  - Name: Creating applications from installed Operators
    File: creating-apps-from-installed-operators
  - Name: Creating applications by using the CLI
    File: creating-applications-using-cli
  - Name: Creating applications using Ruby on Rails
    File: templates-using-ruby-on-rails
- Name: Viewing application composition by using the Topology view
  File: odc-viewing-application-composition-using-topology-view
- Name: Exporting applications
  File: odc-exporting-applications
- Name: Working with Helm charts
  Dir: working_with_helm_charts
  Topics:
  - Name: Understanding Helm
    File: understanding-helm
  - Name: Installing Helm
    File: installing-helm
  - Name: Configuring custom Helm chart repositories
    File: configuring-custom-helm-chart-repositories
  - Name: Working with Helm releases
    File: odc-working-with-helm-releases
- Name: Deployments
  Dir: deployments
  Topics:
  - Name: Understanding deployments
    File: what-deployments-are
  - Name: Managing deployment processes
    File: managing-deployment-processes
  - Name: Using deployment strategies
    File: deployment-strategies
  - Name: Using route-based deployment strategies
    File: route-based-deployment-strategies
- Name: Quotas
  Dir: quotas
  Distros: openshift-origin,openshift-enterprise
  Topics:
  - Name: Resource quotas per project
    File: quotas-setting-per-project
  - Name: Resource quotas across multiple projects
    File: quotas-setting-across-multiple-projects
    Distros: openshift-enterprise,openshift-origin
- Name: Using config maps with applications
  File: config-maps
- Name: Monitoring project and application metrics using the Developer perspective
  File: odc-monitoring-project-and-application-metrics-using-developer-perspective
- Name: Monitoring application health
  File: application-health
- Name: Editing applications
  File: odc-editing-applications
- Name: Working with quotas
  File: working-with-quotas
  Distros: openshift-online
- Name: Pruning objects to reclaim resources
  File: pruning-objects
  Distros: openshift-origin,openshift-enterprise
- Name: Idling applications
  File: idling-applications
  Distros: openshift-origin,openshift-enterprise
- Name: Deleting applications
  File: odc-deleting-applications
- Name: Using the Red Hat Marketplace
  File: red-hat-marketplace
  Distros: openshift-origin,openshift-enterprise
---
Name: Serverless
Dir: serverless
Distros: openshift-enterprise
Topics:
- Name: About Serverless
  Dir: about
  Topics:
  - Name: Serverless overview
    File: about-serverless
---
Name: Machine configuration
Dir: machine_configuration
Distros: openshift-enterprise, openshift-origin
Topics:
- Name: Machine configuration overview
  File: index
- Name: Using machine config objects to configure nodes
  File: machine-configs-configure
- Name: Using node disruption policies to minimize disruption from machine config changes
  File: machine-config-node-disruption
- Name: Configuring MCO-related custom resources
  File: machine-configs-custom
- Name: Pinning images to nodes
  File: machine-config-pin-preload-images-about
- Name: Boot image management
  File: mco-update-boot-images
- Name: Manually updating the boot image
  File: mco-update-boot-images-manual
- Name: Managing unused rendered machine configs
  File: machine-configs-garbage-collection
- Name: Image mode for OpenShift
  File: mco-coreos-layering
  Distros: openshift-enterprise,openshift-origin
- Name: Machine Config Daemon metrics
  File: machine-config-daemon-metrics
---
Name: Machine management
Dir: machine_management
Distros: openshift-origin,openshift-enterprise
Topics:
- Name: Overview of machine management
  File: index
- Name: Managing compute machines with the Machine API
  Dir: creating_machinesets
  Distros: openshift-origin,openshift-enterprise
  Topics:
  - Name: Creating a compute machine set on AWS
    File: creating-machineset-aws
  - Name: Creating a compute machine set on Azure
    File: creating-machineset-azure
  - Name: Creating a compute machine set on Azure Stack Hub
    File: creating-machineset-azure-stack-hub
  - Name: Creating a compute machine set on Google Cloud
    File: creating-machineset-gcp
  - Name: Creating a compute machine set on IBM Cloud
    File: creating-machineset-ibm-cloud
  - Name: Creating a compute machine set on IBM Power Virtual Server
    File: creating-machineset-ibm-power-vs
  - Name: Creating a compute machine set on Nutanix
    File: creating-machineset-nutanix
  - Name: Creating a compute machine set on OpenStack
    File: creating-machineset-osp
  - Name: Creating a compute machine set on vSphere
    File: creating-machineset-vsphere
  - Name: Creating a compute machine set on bare metal
    File: creating-machineset-bare-metal
- Name: Manually scaling a compute machine set
  File: manually-scaling-machineset
- Name: Modifying a compute machine set
  File: modifying-machineset
- Name: Machine phases and lifecycle
  File: machine-phases-lifecycle
- Name: Deleting a machine
  File: deleting-machine
- Name: Applying autoscaling to a cluster
  File: applying-autoscaling
- Name: Creating infrastructure machine sets
  File: creating-infrastructure-machinesets
- Name: Managing user-provisioned infrastructure manually
  Dir: user_infra
  Topics:
  - Name: Adding compute machines to clusters with user-provisioned infrastructure manually
    File: adding-compute-user-infra-general
  - Name: Adding compute machines to AWS using CloudFormation templates
    File: adding-aws-compute-user-infra
  - Name: Adding compute machines to vSphere manually
    File: adding-vsphere-compute-user-infra
  - Name: Adding bare-metal compute machines to a vSphere cluster
    File: adding-bare-metal-compute-vsphere-user-infra
  - Name: Adding compute machines to bare metal
    File: adding-bare-metal-compute-user-infra
- Name: Managing control plane machines
  Dir: control_plane_machine_management
  Topics:
  - Name: About control plane machine sets
    File: cpmso-about
  - Name: Getting started with control plane machine sets
    File: cpmso-getting-started
  - Name: Managing control plane machines with control plane machine sets
    File: cpmso-managing-machines
  - Name: Control plane machine set configuration
    File: cpmso-configuration
  - Name: Configuration options for control plane machines
    Dir: cpmso_provider_configurations
    Topics:
    - Name: Control plane configuration options for Amazon Web Services
      File: cpmso-config-options-aws
    - Name: Configuring Amazon Web Services features for control plane machines
      File: cpmso-supported-features-aws
    - Name: Control plane configuration options for Microsoft Azure
      File: cpmso-config-options-azure
    - Name: Configuring Microsoft Azure features for control plane machines
      File: cpmso-supported-features-azure
    - Name: Control plane configuration options for Google Cloud
      File: cpmso-config-options-gcp
    - Name: Configuring Google Cloud features for control plane machines
      File: cpmso-supported-features-gcp
    - Name: Control plane configuration options for Nutanix
      File: cpmso-config-options-nutanix
    - Name: Control plane configuration options for Red Hat OpenStack Platform
      File: cpmso-config-options-openstack
    - Name: Configuring Red Hat OpenStack Platform features for control plane machines
      File: cpmso-supported-features-openstack
    - Name: Control plane configuration options for VMware vSphere
      File: cpmso-config-options-vsphere
    - Name: Configuring VMware vSphere features for control plane machines
      File: cpmso-supported-features-vsphere
  - Name: Control plane resiliency and recovery
    File: cpmso-resiliency
  - Name: Troubleshooting the control plane machine set
    File: cpmso-troubleshooting
  - Name: Disabling the control plane machine set
    File: cpmso-disabling
  - Name: Manually scaling control plane machines
    File: cpmso-manually-scaling-control-planes
- Name: Managing machines with the Cluster API
  Dir: cluster_api_machine_management
  Topics:
  - Name: About the Cluster API
    File: cluster-api-about
  - Name: Getting started with the Cluster API
    File: cluster-api-getting-started
  - Name: Managing machines with the Cluster API
    File: cluster-api-managing-machines
  - Name: Configuration options for Cluster API machines
    Dir: cluster_api_provider_configurations
    Topics:
    - Name: Cluster API configuration options for Amazon Web Services
      File: cluster-api-config-options-aws
    - Name: Cluster API configuration options for Google Cloud
      File: cluster-api-config-options-gcp
    - Name: Cluster API configuration options for Microsoft Azure
      File: cluster-api-config-options-azure
    - Name: Cluster API configuration options for Red Hat OpenStack Platform
      File: cluster-api-config-options-rhosp
    - Name: Cluster API configuration options for VMware vSphere
      File: cluster-api-config-options-vsphere
    - Name: Cluster API configuration options for bare metal
      File: cluster-api-config-options-bare-metal
#  - Name: Cluster API resiliency and recovery
#    File: cluster-api-resiliency
  - Name: Troubleshooting Cluster API clusters
    File: cluster-api-troubleshooting
  - Name: Disabling the Cluster API
    File: cluster-api-disabling
- Name: Deploying machine health checks
  File: deploying-machine-health-checks
---
Name: etcd
Dir: etcd
Distros: openshift-enterprise, openshift-origin
Topics:
- Name: Overview of etcd
  File: etcd-overview
- Name: Recommended etcd practices
  File: etcd-practices
- Name: Ensuring reliable etcd performance and scalability
  File: etcd-performance
- Name: Backing up and restoring etcd data
  Dir: etcd-backup-restore
  Topics:
  - Name: Backing up etcd
    File: etcd-backup
  - Name: Replacing an unhealthy etcd member
    File: replace-unhealthy-etcd-member
  - Name: Disaster recovery
    File: etcd-disaster-recovery
- Name: Enabling etcd encryption
  File: etcd-encrypt
- Name: Guidance for clusters that span data centers
  File: etcd-guidance-span
# - Name: Setting up fault-tolerant control planes that span data centers
#  File: etcd-fault-tolerant
# - Name: Scaling a cluster to 4 or 5 control-plane nodes
#  File: etcd-4-5-node
---
Name: Hosted control planes
Dir: hosted_control_planes
Distros: openshift-enterprise, openshift-origin
Topics:
- Name: Hosted control planes release notes
  File: hcp-release-notes
- Name: Hosted control planes overview
  File: index
- Name: Preparing to deploy hosted control planes
  Dir: hcp-prepare
  Topics:
  - Name: Requirements for hosted control planes
    File: hcp-requirements
  - Name: Sizing guidance for hosted control planes
    File: hcp-sizing-guidance
  - Name: Overriding resouce utilization measurements
    File: hcp-override-resource-util
  - Name: Installing the hosted control plane command-line interface
    File: hcp-cli
  - Name: Distributing hosted cluster workloads
    File: hcp-distribute-workloads
  - Name: Enabling or disabling the hosted control planes feature
    File: hcp-enable-disable
- Name: Deploying hosted control planes
  Dir: hcp-deploy
  Topics:
  - Name: Deploying hosted control planes on AWS
    File: hcp-deploy-aws
  - Name: Deploying hosted control planes on bare metal
    File: hcp-deploy-bm
  - Name: Deploying hosted control planes on OpenShift Virtualization
    File: hcp-deploy-virt
  - Name: Deploying hosted control planes on non-bare-metal agent machines
    File: hcp-deploy-non-bm
  - Name: Deploying hosted control planes on IBM Z
    File: hcp-deploy-ibmz
  - Name: Deploying hosted control planes on IBM Power
    File: hcp-deploy-ibm-power
  - Name: Deploying hosted control planes on OpenStack
    File: hcp-deploy-openstack
- Name: Managing hosted control planes
  Dir: hcp-manage
  Topics:
  - Name: Managing hosted control planes on AWS
    File: hcp-manage-aws
  - Name: Managing hosted control planes on bare metal
    File: hcp-manage-bm
  - Name: Managing hosted control planes on OpenShift Virtualization
    File: hcp-manage-virt
  - Name: Managing hosted control planes on non-bare-metal agent machines
    File: hcp-manage-non-bm
  - Name: Managing hosted control planes on IBM Power
    File: hcp-manage-ibm-power
  - Name: Managing hosted control planes on OpenStack
    File: hcp-manage-openstack
- Name: Deploying hosted control planes in a disconnected environment
  Dir: hcp-disconnected
  Topics:
  - Name: Introduction to hosted control planes in a disconnected environment
    File: hcp-deploy-dc
  - Name: Deploying hosted control planes on OpenShift Virtualization in a disconnected environment
    File: hcp-deploy-dc-virt
  - Name: Deploying hosted control planes on bare metal in a disconnected environment
    File: hcp-deploy-dc-bm
  - Name: Deploying hosted control planes on IBM Z in a disconnected environment
    File: disconnected-install-ibmz-hcp
  - Name: Monitoring user workload in a disconnected environment
    File: hcp-dc-monitor
- Name: Configuring certificates for hosted control planes
  File: hcp-certificates
- Name: Updating hosted control planes
  File: hcp-updating
- Name: High availability for hosted control planes
  Dir: hcp_high_availability
  Topics:
  - Name: About high availability for hosted control planes
    File: about-hcp-ha
  - Name: Recovering a failing etcd cluster
    File: hcp-recovering-etcd-cluster
  - Name: Backing up and restoring etcd in an on-premise environment
    File: hcp-backup-restore-on-premise
  - Name: Backing up and restoring etcd on the management cluster
    File: hcp-backup-restore-aws
  - Name: Backing up and restoring a hosted cluster on OpenShift Virtualization
    File: hcp-backup-restore-virt
  - Name: Disaster recovery for a hosted cluster in AWS
    File: hcp-disaster-recovery-aws
  - Name: Disaster recovery for a hosted cluster by using OADP
    File: hcp-disaster-recovery-oadp
  - Name: Automated disaster recovery for a hosted cluster by using OADP
    File: hcp-disaster-recovery-oadp-auto
- Name: Authentication and authorization for hosted control planes
  File: hcp-authentication-authorization
- Name: Handling machine configuration for hosted control planes
  File: hcp-machine-config
- Name: Using feature gates in a hosted cluster
  File: hcp-using-feature-gates
- Name: Observability for hosted control planes
  File: hcp-observability
- Name: Networking for hosted control planes
  File: hcp-networking
- Name: Troubleshooting hosted control planes
  File: hcp-troubleshooting
- Name: Destroying a hosted cluster
  Dir: hcp-destroy
  Topics:
  - Name: Destroying a hosted cluster on AWS
    File: hcp-destroy-aws
  - Name: Destroying a hosted cluster on bare metal
    File: hcp-destroy-bm
  - Name: Destroying a hosted cluster on OpenShift Virtualization
    File: hcp-destroy-virt
  - Name: Destroying a hosted cluster on IBM Z
    File: hcp-destroy-ibmz
  - Name: Destroying a hosted cluster on IBM Power
    File: hcp-destroy-ibm-power
  - Name: Destroying a hosted cluster on OpenStack
    File: hcp-destroy-openstack
  - Name: Destroying a hosted cluster on non-bare-metal agent machines
    File: hcp-destroy-non-bm
- Name: Manually importing a hosted cluster
  File: hcp-import
---
Name: Nodes
Dir: nodes
Distros: openshift-enterprise,openshift-origin
Topics:
- Name: Overview of nodes
  File: index
- Name: Working with pods
  Dir: pods
  Topics:
  - Name: About pods
    File: nodes-pods-using
  - Name: Viewing pods
    File: nodes-pods-viewing
  - Name: Configuring a cluster for pods
    File: nodes-pods-configuring
    Distros: openshift-enterprise,openshift-origin
  - Name: Automatically scaling pods with the horizontal pod autoscaler
    File: nodes-pods-autoscaling
  - Name: Automatically adjust pod resource levels with the vertical pod autoscaler
    File: nodes-pods-vertical-autoscaler
  - Name: Adjust pod resource levels without pod disruption
    File: nodes-pods-adjust-resources-in-place
  - Name: Providing sensitive data to pods by using secrets
    File: nodes-pods-secrets
  - Name: Providing sensitive data to pods by using an external secrets store
    File: nodes-pods-secrets-store
  - Name: Authenticating pods with short-term credentials
    File: nodes-pods-short-term-auth
  - Name: Creating and using config maps
    File: nodes-pods-configmaps
  - Name: Mounting an OCI image into a pod
    File: nodes-pods-image-volume
  - Name: Using Device Manager to make devices available to nodes
    File: nodes-pods-plugins
    Distros: openshift-enterprise,openshift-origin
  - Name: Including pod priority in pod scheduling decisions
    File: nodes-pods-priority
    Distros: openshift-enterprise,openshift-origin
  - Name: Placing pods on specific nodes using node selectors
    File: nodes-pods-node-selectors
  - Name: Allocating GPUs to pods by using DRA
    File: nodes-pods-allocate-dra
    Distros: openshift-enterprise,openshift-origin
  - Name: Run Once Duration Override Operator
    Dir: run_once_duration_override
    Distros: openshift-enterprise
    Topics:
    - Name: Run Once Duration Override Operator overview
      File: index
    - Name: Run Once Duration Override Operator release notes
      File: run-once-duration-override-release-notes
    - Name: Overriding the active deadline for run-once pods
      File: run-once-duration-override-install
    - Name: Uninstalling the Run Once Duration Override Operator
      File: run-once-duration-override-uninstall
  - Name: Running pods in Linux user namespaces
    File: nodes-pods-user-namespaces
- Name: Automatically scaling pods with the Custom Metrics Autoscaler Operator
  Dir: cma
  Distros: openshift-enterprise,openshift-origin
  Topics:
  - Name: Release notes
    Dir: nodes-cma-rn
    Topics:
    - Name: Custom Metrics Autoscaler Operator release notes
      File: nodes-cma-autoscaling-custom-rn
    - Name: Past releases
      File: nodes-cma-autoscaling-custom-rn-past
  - Name: Custom Metrics Autoscaler Operator overview
    File: nodes-cma-autoscaling-custom
  - Name: Installing the custom metrics autoscaler
    File: nodes-cma-autoscaling-custom-install
  - Name: Understanding the custom metrics autoscaler triggers
    File: nodes-cma-autoscaling-custom-trigger
  - Name: Understanding custom metrics autoscaler trigger authentications
    File: nodes-cma-autoscaling-custom-trigger-auth
  - Name: Understanding how to add custom metrics autoscalers
    File: nodes-cma-autoscaling-custom-adding
  - Name: Pausing the custom metrics autoscaler
    File: nodes-cma-autoscaling-custom-pausing
  - Name: Gathering audit logs
    File: nodes-cma-autoscaling-custom-audit-log
  - Name: Gathering debugging data
    File: nodes-cma-autoscaling-custom-debugging
  - Name: Viewing Operator metrics
    File: nodes-cma-autoscaling-custom-metrics
  - Name: Removing the Custom Metrics Autoscaler Operator
    File: nodes-cma-autoscaling-custom-removing
- Name: Controlling pod placement onto nodes (scheduling)
  Dir: scheduling
  Distros: openshift-enterprise,openshift-origin
  Topics:
  - Name: About pod placement using the scheduler
    File: nodes-scheduler-about
  - Name: Scheduling pods using a scheduler profile
    File: nodes-scheduler-profiles
  - Name: Placing pods relative to other pods using pod affinity and anti-affinity rules
    File: nodes-scheduler-pod-affinity
  - Name: Controlling pod placement on nodes using node affinity rules
    File: nodes-scheduler-node-affinity
  - Name: Placing pods onto overcommited nodes
    File: nodes-scheduler-overcommit
  - Name: Controlling pod placement using node taints
    File: nodes-scheduler-taints-tolerations
  - Name: Placing pods on specific nodes using node selectors
    File: nodes-scheduler-node-selectors
  - Name: Controlling pod placement using pod topology spread constraints
    File: nodes-scheduler-pod-topology-spread-constraints
# - Name: Placing a pod on a specific node by name
#   File: nodes-scheduler-node-names
# - Name: Placing a pod in a specific project
#   File: nodes-scheduler-node-projects
# - Name: Keeping your cluster balanced using the descheduler
#   File: nodes-scheduler-descheduler
  - Name: Descheduler
    Dir: descheduler
    Distros: openshift-enterprise
    Topics:
    - Name: Descheduler overview
      File: index
    - Name: Descheduler release notes
      File: nodes-descheduler-release-notes
    - Name: Evicting pods using the descheduler
      File: nodes-descheduler-configuring
    - Name: Uninstalling the descheduler
      File: nodes-descheduler-uninstalling
  - Name: Secondary scheduler
    Dir: secondary_scheduler
    Distros: openshift-enterprise
    Topics:
    - Name: Secondary scheduler overview
      File: index
    - Name: Secondary Scheduler Operator release notes
      File: nodes-secondary-scheduler-release-notes
    - Name: Scheduling pods using a secondary scheduler
      File: nodes-secondary-scheduler-configuring
    - Name: Uninstalling the Secondary Scheduler Operator
      File: nodes-secondary-scheduler-uninstalling
- Name: Using jobs and daemon sets
  Dir: jobs
  Topics:
  - Name: Running background tasks on nodes automatically with daemon sets
    File: nodes-pods-daemonsets
    Distros: openshift-enterprise,openshift-origin
  - Name: Running tasks in pods using jobs
    File: nodes-nodes-jobs
- Name: Working with nodes
  Dir: nodes
  Distros: openshift-enterprise,openshift-origin
  Topics:
  - Name: Viewing and listing the nodes in your cluster
    File: nodes-nodes-viewing
  - Name: Working with nodes
    File: nodes-nodes-working
  - Name: Managing nodes
    File: nodes-nodes-managing
  - Name: Adding worker nodes to an on-premise cluster
    File: nodes-nodes-adding-node-iso
# Hiding this assembly per @rphillips: "We are trying to enable the feature, but there are cases we are running into where networking does not get enabled at boot."
#  - Name: Managing graceful node shutdown
#    File: nodes-nodes-graceful-shutdown
  - Name: Managing the maximum number of pods per node
    File: nodes-nodes-managing-max-pods
  - Name: Replacing a failed bare-metal control plane node without BMC credentials
    File: nodes-nodes-replace-control-plane
  - Name: Using the Node Tuning Operator
    File: nodes-node-tuning-operator
  - Name: Remediating, fencing, and maintaining nodes
    File: nodes-remediating-fencing-maintaining-rhwa
  - Name: Understanding node rebooting
    File: nodes-nodes-rebooting
  - Name: Boot image management
    File: nodes-update-boot-images
  - Name: Freeing node resources using garbage collection
    File: nodes-nodes-garbage-collection
  - Name: Allocating resources for nodes
    File: nodes-nodes-resources-configuring
  - Name: Allocating specific CPUs for nodes in a cluster
    File: nodes-nodes-resources-cpus
  - Name: Additional CRI-O storage locations for faster container startup
    File: nodes-nodes-additional-crio-storage
  - Name: Enabling TLS security profiles for the kubelet
    File: nodes-nodes-tls
    Distros: openshift-enterprise,openshift-origin
#  - Name: Monitoring for problems in your nodes
#    File: nodes-nodes-problem-detector
  - Name: Creating infrastructure nodes
    File: nodes-nodes-creating-infrastructure-nodes
- Name: Working with containers
  Dir: containers
  Topics:
  - Name: Understanding containers
    File: nodes-containers-using
  - Name: Using Init Containers to perform tasks before a pod is deployed
    File: nodes-containers-init
    Distros: openshift-enterprise,openshift-origin
  - Name: Using volumes to persist container data
    File: nodes-containers-volumes
  - Name: Mapping volumes using projected volumes
    File: nodes-containers-projected-volumes
  - Name: Allowing containers to consume API objects
    File: nodes-containers-downward-api
  - Name: Copying files to or from a container
    File: nodes-containers-copying-files
  - Name: Executing remote commands in a container
    File: nodes-containers-remote-commands
  - Name: Using port forwarding to access applications in a container
    File: nodes-containers-port-forwarding
  - Name: Using sysctls in containers
    File: nodes-containers-sysctls
  - Name: Accessing faster builds with /dev/fuse
    File: nodes-containers-dev-fuse
- Name: Working with clusters
  Dir: clusters
  Topics:
  - Name: Viewing system event information in a cluster
    File: nodes-containers-events
  - Name: Estimating the number of pods your OpenShift Container Platform nodes can hold
    File: nodes-cluster-resource-levels
    Distros: openshift-enterprise,openshift-origin
  - Name: Restrict resource consumption with limit ranges
    File: nodes-cluster-limit-ranges
  - Name: Configuring cluster memory to meet container memory and risk requirements
    File: nodes-cluster-resource-configure
    Distros: openshift-enterprise,openshift-origin
  - Name: Configuring your cluster to place pods on overcommited nodes
    File: nodes-cluster-overcommit
    Distros: openshift-enterprise
  - Name: Enabling features using FeatureGates
    File: nodes-cluster-enabling-features
    Distros: openshift-enterprise,openshift-origin
  - Name: Improving cluster stability in high latency environments using worker latency profiles
    File: nodes-cluster-worker-latency-profiles
    Distros: openshift-enterprise,openshift-origin
- Name: Remote worker nodes on the network edge
  Dir: edge
  Distros: openshift-enterprise
  Topics:
  - Name: Using remote worker node at the network edge
    File: nodes-edge-remote-workers
- Name: Worker nodes for single-node OpenShift clusters
  Dir: nodes
  Distros: openshift-enterprise
  Topics:
  - Name: Adding worker nodes to single-node OpenShift clusters
    File: nodes-sno-worker-nodes
- Name: Node metrics dashboard
  File: nodes-dashboard-using
- Name: Manage secure signatures with sigstore
  File: nodes-sigstore-using
---
Name: Windows Container Support for OpenShift
Dir: windows_containers
Distros: openshift-origin,openshift-enterprise
Topics:
- Name: Red Hat OpenShift support for Windows Containers overview
  File: index
- Name: Release notes
  Dir: wmco_rn
  Topics:
  - Name: Red Hat OpenShift support for Windows Containers release notes
    File: windows-containers-release-notes
  - Name: Past releases
    File: windows-containers-release-notes-past
  - Name: Windows Machine Config Operator prerequisites
    File: windows-containers-release-notes-prereqs
  - Name: Windows Machine Config Operator known limitations
    File: windows-containers-release-notes-limitations
- Name: Getting support
  File: windows-containers-support
  Distros: openshift-enterprise
- Name: Understanding Windows container workloads
  File: understanding-windows-container-workloads
- Name: Enabling Windows container workloads
  File: enabling-windows-container-workloads
- Name: Creating Windows machine sets
  Dir: creating_windows_machinesets
  Topics:
  - Name: Creating a Windows machine set on AWS
    File: creating-windows-machineset-aws
  - Name: Creating a Windows machine set on Azure
    File: creating-windows-machineset-azure
  - Name: Creating a Windows machine set on Google Cloud
    File: creating-windows-machineset-gcp
  - Name: Creating a Windows machine set on Nutanix
    File: creating-windows-machineset-nutanix
  - Name: Creating a Windows machine set on vSphere
    File: creating-windows-machineset-vsphere
- Name: Scheduling Windows container workloads
  File: scheduling-windows-workloads
- Name: Windows node updates
  File: windows-node-upgrades
- Name: Using Bring-Your-Own-Host Windows instances as nodes
  File: byoh-windows-instance
- Name: Removing Windows nodes
  File: removing-windows-nodes
- Name: Disabling Windows container workloads
  File: disabling-windows-container-workloads
---
Name: OpenShift sandboxed containers
Dir: sandboxed_containers
Distros: openshift-enterprise
Topics:
- Name: About OpenShift sandboxed containers
  File: about-openshift-sandboxed-containers
---
Name: Observability
Dir: observability
Distros: openshift-enterprise,openshift-origin
Topics:
- Name: Observability overview
  Dir: overview
  Distros: openshift-enterprise,openshift-origin
  Topics:
  - Name: About Observability
    File: index
- Name: Cluster Observability Operator
  Dir: cluster_observability_operator
  Distros: openshift-enterprise,openshift-origin
  Topics:
  - Name: Cluster Observability Operator overview
    File: cluster-observability-operator-overview
- Name: Monitoring
  Dir: monitoring
  Distros: openshift-enterprise,openshift-origin
  Topics:
  - Name: About OpenShift Container Platform monitoring
    File: about-ocp-monitoring
- Name: Logging
  Dir: logging
  Distros: openshift-enterprise,openshift-origin
  Topics:
#  - Name: Release notes
#    Dir: logging_release_notes
#    Topics:
#    - Name: Logging 5.9
#      File: logging-5-9-release-notes
#    - Name: Logging 5.8
#      File: logging-5-8-release-notes
#    - Name: Logging 5.7
#      File: logging-5-7-release-notes
#  - Name: Logging 6.2
#    Dir: logging-6.2
#    Topics:
#    - Name: Support
#      File: log62-cluster-logging-support
#    - Name: Release notes
#      File: log6x-release-notes-6.2
#    - Name: About logging 6.2
#      File: log6x-about-6.2
#    - Name: Configuring log forwarding
#      File: log6x-clf-6.2
#    - Name: Configuring the logging collector
#      File: 6x-cluster-logging-collector-6.2
#    - Name: Configuring LokiStack storage
#      File: log6x-loki-6.2
#    - Name: Configuring LokiStack for OTLP
#      File: log6x-configuring-lokistack-otlp-6.2
#    - Name: Visualization for logging
#      File: log6x-visual-6.2
#  - Name: Logging 6.1
#    Dir: logging-6.1
#    Topics:
#    - Name: Support
#      File: log61-cluster-logging-support
#    - Name: Release notes
#      File: log6x-release-notes-6.1
#    - Name: About logging 6.1
#      File: log6x-about-6.1
#    - Name: Configuring log forwarding
#      File: log6x-clf-6.1
#    - Name: Configuring the logging collector
#      File: 6x-cluster-logging-collector-6.1
#    - Name: Configuring LokiStack storage
#      File: log6x-loki-6.1
#    - Name: Configuring LokiStack for OTLP
#      File: log6x-configuring-lokistack-otlp-6.1
#    - Name: OpenTelemetry data model
#      File: log6x-opentelemetry-data-model-6.1
#    - Name: Visualization for logging
#      File: log6x-visual-6.1
#  - Name: Support
#    File: cluster-logging-support
#  - Name: Troubleshooting logging
#    Dir: troubleshooting
#    Topics:
#    - Name: Viewing Logging status
#      File: cluster-logging-cluster-status
#    - Name: Troubleshooting log forwarding
#      File: log-forwarding-troubleshooting
#    - Name: Troubleshooting logging alerts
#      File: troubleshooting-logging-alerts
#      File: cluster-logging-log-store-status
     - Name: About Logging
       File: about-logging
#  - Name: Installing Logging
#    File: cluster-logging-deploying
#  - Name: Updating Logging
#    File: cluster-logging-upgrading
#    Distros: openshift-enterprise,openshift-origin
#  - Name: Visualizing logs
#    Topics:
#    - Name: About log visualization
#      File: log-visualization
#    - Name: Log visualization with the web console
#      File: log-visualization-ocp-console
#    - Name: Viewing cluster dashboards
#      File: cluster-logging-dashboards
#    - Name: Log visualization with Kibana
#      File: logging-kibana
#  - Name: Configuring your Logging deployment
#    Dir: config
#    Distros: openshift-enterprise,openshift-origin
#    Topics:
#    - Name: Configuring CPU and memory limits for Logging components
#      File: cluster-logging-memory
#    - Name: Configuring systemd-journald for Logging
#      File: cluster-logging-systemd
#  - Name: Log collection and forwarding
#    Dir: log_collection_forwarding
#    Topics:
#    - Name: About log collection and forwarding
#      File: log-forwarding
#    - Name: Log output types
#      File: logging-output-types
#    - Name: Enabling JSON log forwarding
#      File: cluster-logging-enabling-json-logging
#    - Name: Configuring log forwarding
#      File: configuring-log-forwarding
#    - Name: Configuring the logging collector
#      File: cluster-logging-collector
#    - Name: Collecting and storing Kubernetes events
#      File: cluster-logging-eventrouter
#  - Name: Log storage
#    Dir: log_storage
#    Topics:
#    - Name: About log storage
#      File: about-log-storage
#      File: installing-log-storage
#  - Name: Configuring the LokiStack log store
#      File: cluster-logging-loki
#    - Name: Configuring the Elasticsearch log store
#      File: logging-config-es-store
#  - Name: Logging alerts
#    Dir: logging_alerts
#    Topics:
#    - Name: Default logging alerts
#      File: default-logging-alerts
#    - Name: Custom logging alerts
#      File: custom-logging-alerts
#  - Name: Performance and reliability tuning
#    Dir: performance_reliability
#    Topics:
#    - Name: Flow control mechanisms
#      File: logging-flow-control-mechanisms
#    - Name: Filtering logs by content
#      File: logging-content-filtering
#    - Name: Filtering logs by metadata
#      File: logging-input-spec-filtering
#  - Name: Scheduling resources
#    Dir: scheduling_resources
#    Topics:
#    - Name: Using node selectors to move logging resources
#      File: logging-node-selectors
#    - Name: Using tolerations to control logging pod placement
#      File: logging-taints-tolerations
#  - Name: Uninstalling Logging
#    File: cluster-logging-uninstall
#  - Name: Exported fields
#    File: cluster-logging-exported-fields
#    Distros: openshift-enterprise,openshift-origin
#  - Name: API reference
#    Dir: api_reference
#    Topics:
  #  - Name: 5.8 Logging API reference
  #    File: logging-5-8-reference
  #  - Name: 5.7 Logging API reference
  #    File: logging-5-7-reference
#    - Name: 5.6 Logging API reference
#      File: logging-5-6-reference
#  - Name: Glossary
#    File: logging-common-terms
- Name: Distributed Tracing
  Dir: distr_tracing
  Distros: openshift-enterprise
  Topics:
  - Name: About the Distributed Tracing Platform
    File: distr-tracing-tempo-architecture
- Name: Red Hat build of OpenTelemetry
  Dir: otel
  Distros: openshift-enterprise
  Topics:
  - Name: About the Red Hat build of OpenTelemetry
    File: otel-architecture
- Name: Network Observability
  Dir: network_observability
  Distros: openshift-enterprise,openshift-origin
  Topics:
  - Name: Network Observability Operator release notes
    File: network-observability-operator-release-notes
  - Name: Network Observability Operator release notes archive
    Dir: release_notes_archive
    Distros: openshift-enterprise
    Topics:
    - Name: Network Observability Operator release notes archive
      File: network-observability-operator-release-notes-archive
  - Name: Network observability overview
    File: network-observability-overview
  - Name: Installing the Network Observability Operator
    File: installing-operators
  - Name: Understanding Network Observability Operator
    File: understanding-network-observability-operator
  - Name: Configuring the Network Observability Operator
    File: configuring-operator
  - Name: Network observability per-tenant model
    File: network-observability-per-tenant-model
  - Name: Network Policy
    File: network-observability-network-policy
  - Name: Network observability DNS resolution analysis
    File: network-observability-dns-resolution-analysis
  - Name: Observing the network traffic
    File: observing-network-traffic
  - Name: Network observability health rules
    File: network-observability-health-rules
  - Name: Using metrics with dashboards and alerts
    File: metrics-alerts-dashboards
  - Name: Monitoring the Network Observability Operator
    File: network-observability-operator-monitoring
  - Name: Scheduling resources
    File: network-observability-scheduling-resources
  - Name: Secondary networks
    File: network-observability-secondary-networks
  - Name: Network Observability CLI
    Dir: netobserv_cli
    Distros: openshift-enterprise
    Topics:
    - Name: Installing the Network Observability CLI
      File: netobserv-cli-install
    - Name: Using the Network Observability CLI
      File: netobserv-cli-using
    - Name: Network Observability CLI reference
      File: netobserv-cli-reference
  - Name: FlowCollector API reference
    File: flowcollector-api
  - Name: FlowMetric API reference
    File: flowmetric-api
  - Name: Flows format reference
    File: json-flows-format-reference
  - Name: Troubleshooting network observability
    File: troubleshooting-network-observability
- Name: Power Monitoring
  Dir: power_monitoring
  Distros: openshift-enterprise,openshift-origin
  Topics:
  - Name: About power monitoring
    File: about-power-monitoring
---
Name: Scalability and performance
Dir: scalability_and_performance
Distros: openshift-origin,openshift-enterprise,openshift-webscale,openshift-dpu
Topics:
- Name: Scalability and performance overview
  File: index
- Name: Recommended performance and scalability practices
  Dir: recommended-performance-scale-practices
  Distros: openshift-origin,openshift-enterprise
  Topics:
  - Name: Recommended control plane practices
    File: recommended-control-plane-practices
  - Name: Selecting a larger AWS instance type for control plane machines
    File: increasing-aws-flavor-size
  - Name: Recommended infrastructure practices
    File: recommended-infrastructure-practices
- Name: Telco core reference design specifications
  File: telco-core-rds
- Name: Telco RAN DU reference design specifications
  File: telco-ran-du-rds
- Name: Telco hub reference design specifications
  File: telco-hub-rds
- Name: Comparing cluster configurations
  Dir: cluster-compare
  Distros: openshift-origin,openshift-enterprise
  Topics:
  - Name: Understanding the cluster-compare plugin
    File: understanding-the-cluster-compare-plugin
  - Name: Installing the cluster-compare plugin
    File: installing-cluster-compare-plugin
  - Name: Using the cluster-compare plugin
    File: using-the-cluster-compare-plugin
  - Name: Creating a reference configuration
    File: creating-a-reference-configuration
  - Name: Performing advanced reference configuration customization
    File: advanced-ref-config-customization
  - Name: Troubleshooting cluster comparisons
    File: troubleshooting-cluster-comparisons
- Name: Planning your environment according to object maximums
  File: planning-your-environment-according-to-object-maximums
  Distros: openshift-origin,openshift-enterprise
- Name: Compute Resource Quotas
  File: compute-resource-quotas
- Name: Recommended host practices for IBM Z & IBM LinuxONE environments
  File: ibm-z-recommended-host-practices
  Distros: openshift-enterprise
- Name: Using the Node Tuning Operator
  File: using-node-tuning-operator
  Distros: openshift-origin,openshift-enterprise
- Name: Using CPU Manager and Topology Manager
  File: using-cpu-manager
  Distros: openshift-origin,openshift-enterprise
- Name: Scheduling NUMA-aware workloads
  File: cnf-numa-aware-scheduling
  Distros: openshift-origin,openshift-enterprise
- Name: Scalability and performance optimization
  Dir: optimization
  Distros: openshift-origin,openshift-enterprise
  Topics:
  - Name: Optimizing storage
    File: optimizing-storage
  - Name: Optimizing routing
    File: routing-optimization
  - Name: Optimizing networking
    File: optimizing-networking
  - Name: Optimizing CPU usage
    File: optimizing-cpu-usage
- Name: Managing bare metal hosts
  File: managing-bare-metal-hosts
  Distros: openshift-origin,openshift-enterprise
- Name: Optimizing memory management for workloads by using huge pages
  File: what-huge-pages-do-and-how-they-are-consumed-by-apps
  Distros: openshift-origin,openshift-enterprise
- Name: Understanding low latency
  File: cnf-understanding-low-latency
- Name: Tuning nodes for low latency with the performance profile
  File: cnf-tuning-low-latency-nodes-with-perf-profile
- Name: Tuning hosted control planes for low latency with the performance profile
  File: cnf-tuning-low-latency-hosted-cp-nodes-with-perf-profile
- Name: Provisioning real-time and low latency workloads
  File: cnf-provisioning-low-latency-workloads
- Name: Debugging low latency tuning
  File: cnf-debugging-low-latency-tuning-status
- Name: Performing latency tests for platform verification
  File: cnf-performing-platform-verification-latency-tests
- Name: Improving cluster stability in high latency environments using worker latency profiles
  File: scaling-worker-latency-profiles
  Distros: openshift-origin,openshift-enterprise
- Name: Workload partitioning
  File: enabling-workload-partitioning
  Distros: openshift-origin,openshift-enterprise
- Name: Using the Node Observability Operator
  File: node-observability-operator
  Distros: openshift-origin,openshift-enterprise
---
Name: AI workloads
Dir: ai_workloads
Distros: openshift-enterprise
Topics:
- Name: Overview of AI workloads on OpenShift Container Platform
  File: index
- Name: Red Hat build of Kueue
  Dir: kueue
  Distros: openshift-enterprise
  Topics:
  - Name: Introduction to Red Hat build of Kueue
    File: about-kueue
  - Name: Release notes
    File: release-notes
  - Name: Installing Red Hat build of Kueue
    File: install-kueue
  - Name: Installing Red Hat build of Kueue in a disconnected environment
    File: install-disconnected
  - Name: Integrating the Leader Worker Set Operator
    File: integrating-lws
  - Name: Integrating the JobSet Operator
    File: integrating-jobset
  - Name: Configuring role-based permissions
    File: rbac-permissions
  - Name: Configuring quotas
    File: configuring-quotas
  - Name: Managing jobs and workloads
    File: managing-workloads
  - Name: Monitoring pending workloads
    File: monitoring-pending-workloads
  - Name: Using cohorts
    File: using-cohorts
  - Name: Configuring fair sharing
    File: configuring-fairsharing
  - Name: Gang scheduling
    File: gangscheduling
  - Name: Running jobs with quota limits
    File: running-kueue-jobs
  - Name: Getting support
    File: getting-support
- Name: Leader Worker Set Operator
  Dir: leader_worker_set
  Distros: openshift-enterprise
  Topics:
  - Name: Leader Worker Set Operator overview
    File: index
  - Name: Leader Worker Set Operator release notes
    File: lws-release-notes
  - Name: Managing distributed workloads with the Leader Worker Set Operator
    File: lws-managing
  - Name: Uninstalling the Leader Worker Set Operator
    File: lws-uninstalling
- Name: JobSet Operator
  Dir: jobset_operator
  Distros: openshift-enterprise
  Topics:
  - Name: Jobset Operator overview
    File: index
  - Name: JobSet Operator release notes
    File: jobset-release-notes
  - Name: Installing the JobSet Operator
    File: jobset-install
  - Name: Managing workloads with the JobSet Operator
    File: managing-jobset
  - Name: Uninstalling the JobSet Operator
    File: jobset-uninstall
---
Name: Edge computing
Dir: edge_computing
Distros: openshift-origin,openshift-enterprise
Topics:
- Name: Challenges of the network far edge
  File: ztp-deploying-far-edge-clusters-at-scale
- Name: Preparing the hub cluster for ZTP
  File: ztp-preparing-the-hub-cluster
- Name: Updating GitOps ZTP
  File: ztp-updating-gitops
- Name: Installing managed clusters with RHACM and ClusterInstance resources
  File: ztp-deploying-far-edge-sites
- Name: Manually installing a single-node OpenShift cluster with GitOps ZTP
  File: ztp-manual-install
- Name: Migrating from SiteConfig CRs to ClusterInstance CRs
  File: ztp-migrate-clusterinstance
- Name: Recommended single-node OpenShift cluster configuration for vDU application workloads
  File: ztp-reference-cluster-configuration-for-vdu
- Name: Validating cluster tuning for vDU application workloads
  File: ztp-vdu-validating-cluster-tuning
- Name: Advanced managed cluster configuration with ClusterInstance resources
  File: ztp-advanced-install-ztp
- Name: Managing cluster policies with PolicyGenerator resources
  Dir: policygenerator_for_ztp
  Distros: openshift-origin,openshift-enterprise
  Topics:
  - Name: Configuring managed cluster policies by using PolicyGenerator resources
    File: ztp-configuring-managed-clusters-policygenerator
  - Name: Advanced managed cluster configuration with PolicyGenerator resources
    File: ztp-advanced-policygenerator-config
  - Name: Updating managed clusters in a disconnected environment with PolicyGenerator resources and TALM
    File: ztp-talm-updating-managed-policies-pg
- Name: Managing cluster policies with PolicyGenTemplate resources
  Dir: policygentemplate_for_ztp
  Distros: openshift-origin,openshift-enterprise
  Topics:
  - Name: Configuring managed cluster policies by using PolicyGenTemplate resources
    File: ztp-configuring-managed-clusters-policies
  - Name: Advanced managed cluster configuration with PolicyGenTemplate resources
    File: ztp-advanced-policy-config
  - Name: Updating managed clusters in a disconnected environment with PolicyGenTemplate resources and TALM
    File: ztp-talm-updating-managed-policies
- Name: Using hub templates in PolicyGenerator or PolicyGenTemplate CRs
  File: ztp-using-hub-cluster-templates
- Name: Updating managed clusters with the Topology Aware Lifecycle Manager
  File: cnf-talm-for-cluster-upgrades
- Name: Expanding single-node OpenShift clusters with GitOps ZTP
  File: ztp-sno-additional-worker-node
- Name: Pre-caching images for single-node OpenShift deployments
  File: ztp-precaching-tool
- Name: Image-based upgrade for single-node OpenShift clusters
  Dir: image_based_upgrade
  Distros: openshift-origin,openshift-enterprise
  Topics:
  - Name: Understanding the image-based upgrade for single-node OpenShift clusters
    File: cnf-understanding-image-based-upgrade
  - Name: Preparing for an image-based upgrade for single-node OpenShift clusters
    Dir: preparing_for_image_based_upgrade
    Distros: openshift-origin,openshift-enterprise
    Topics:
    - Name: Configuring a shared container partition for the image-based upgrade
      File: cnf-image-based-upgrade-shared-container-partition
    - Name: Installing Operators for the image-based upgrade
      File: cnf-image-based-upgrade-install-operators
    - Name: Generating a seed image for the image-based upgrade with the Lifecycle Agent
      File: cnf-image-based-upgrade-generate-seed
    - Name: Creating ConfigMap objects for the image-based upgrade with the Lifecycle Agent
      File: cnf-image-based-upgrade-prep-resources
    - Name: Creating ConfigMap objects for the image-based upgrade with Lifecycle Agent using GitOps ZTP
      File: ztp-image-based-upgrade-prep-resources
    - Name: Configuring the automatic image cleanup of the container storage disk
      File: cnf-image-based-upgrade-auto-image-cleanup
  - Name: Performing an image-based upgrade for single-node OpenShift clusters with the Lifecycle Agent
    File: cnf-image-based-upgrade-base
  - Name: Performing an image-based upgrade for single-node OpenShift clusters using GitOps ZTP
    File: ztp-image-based-upgrade
- Name: Image-based installation for single-node OpenShift
  Dir: image_base_install
  Distros: openshift-origin,openshift-enterprise
  Topics:
  - Name: Understanding image-based installation and deployment for single-node OpenShift
    File: ibi-understanding-image-based-install
  - Name: Preparing for a single-node OpenShift image-based installation
    File: ibi-preparing-for-image-based-install
  - Name: Preinstalling single-node OpenShift using an image-based installation
    File: ibi-factory-image-based-install
  - Name: Deploying single-node OpenShift clusters
    Dir: ibi_deploying_sno_clusters
    Distros: openshift-origin,openshift-enterprise
    Topics:
    - Name: Deploying managed single-node OpenShift using the IBI Operator
      File: ibi-edge-image-based-install
    - Name: Deploying single-node OpenShift using the installation program
      File: ibi-edge-image-based-install-standalone
---
Name: Specialized hardware and driver enablement
Dir: hardware_enablement
Distros: openshift-origin,openshift-enterprise
Topics:
- Name: About specialized hardware and driver enablement
  File: about-hardware-enablement
- Name: Driver Toolkit
  File: psap-driver-toolkit
- Name: Node Feature Discovery Operator
  File: psap-node-feature-discovery-operator
- Name: Kernel Module Management Operator
  File: kmm-kernel-module-management
- Name: Kernel Module Management Operator release notes
  File: kmm-release-notes
---
Name: Hardware accelerators
Dir: hardware_accelerators
Distros: openshift-origin,openshift-enterprise
Topics:
- Name: About hardware accelerators
  File: about-hardware-accelerators
- Name: NVIDIA GPU architecture
  File: nvidia-gpu-architecture
- Name: AMD GPU Operator
  File: amd-gpu-operator
- Name: Intel Gaudi AI accelerators
  File: gaudi-ai-accelerator
- Name: Remote Direct Memory Access (RDMA)
  File: rdma-remote-direct-memory-access
- Name: Dynamic Accelerator Slicer (DAS) Operator
  File: das-about-dynamic-accelerator-slicer-operator
---
Name: Backup and restore
Dir: backup_and_restore
Distros: openshift-origin,openshift-enterprise
Topics:
- Name: Overview of backup and restore operations
  File: index
- Name: Shutting down a cluster gracefully
  File: graceful-cluster-shutdown
- Name: Restarting a cluster gracefully
  File: graceful-cluster-restart
- Name: Hibernating a cluster
  File: hibernating-cluster
- Name: OADP Application backup and restore
  Dir: application_backup_and_restore
  Topics:
  - Name: Introduction to OpenShift API for Data Protection
    File: oadp-intro
  - Name: OADP release notes
    Dir: release-notes
    Topics:
    - Name: OADP 1.5 release notes
      File: oadp-1-5-release-notes
    - Name: Upgrading OADP 1.4 to 1.5
      File: oadp-upgrade-notes-1-5
  - Name: OADP performance
    Dir: oadp-performance
    Topics:
    - Name: OADP recommended network settings
      File: oadp-recommended-network-settings
  - Name: OADP features and plugins
    File: oadp-features-plugins
  - Name: OADP use cases
    Dir: oadp-use-cases
    Topics:
    - Name: Backing up an application using OADP and ODF
      File: oadp-usecase-backup-using-odf
    - Name: Restoring a backup to a different namespace
      File: oadp-usecase-restore-different-namespace
    - Name: Including a self-signed CA certificate during backup
      File: oadp-usecase-enable-ca-cert
    - Name: Using the legacy-aws Velero plugin
      File: oadp-usecase-legacy-aws-plugin
    - Name: Backing up workloads on OADP with ROSA STS
      File: oadp-rosa-backup-restore
  - Name: Installing OADP
    Dir: installing
    Topics:
    - Name: About installing OADP
      File: about-installing-oadp
    - Name: Installing the OADP Operator
      File: oadp-installing-operator
  - Name: Configuring OADP with AWS S3 compatible storage
    Dir: installing
    Topics:
    - Name: Configuring OADP with AWS S3 compatible storage
      File: installing-oadp-aws
  - Name: Configuring OADP with IBM Cloud
    Dir: installing
    Topics:
    - Name: Configuring OADP with IBM Cloud
      File: installing-oadp-ibm-cloud
  - Name: Configuring OADP with Azure
    Dir: installing
    Topics:
    - Name: Configuring OADP with Azure
      File: installing-oadp-azure
  - Name: Configuring OADP with Google Cloud
    Dir: installing
    Topics:
    - Name: Configuring OADP with Google Cloud
      File: installing-oadp-gcp
  - Name: Configuring OADP with MCG
    Dir: installing
    Topics:
    - Name: Configuring OADP with MCG
      File: installing-oadp-mcg
  - Name: Configuring OADP with ODF
    Dir: installing
    Topics:
    - Name: Configuring OADP with ODF
      File: installing-oadp-ocs
  - Name: Configuring OADP with OpenShift Virtualization
    Dir: installing
    Topics:
    - Name: Configuring OADP with OpenShift Virtualization
      File: installing-oadp-kubevirt
  - Name: Configuring OADP with multiple backup storage locations
    Dir: installing
    Topics:
    - Name: Configuring OADP with multiple backup storage locations
      File: configuring-oadp-multiple-bsl
  - Name: Configuring OADP with multiple Volume Snapshot Locations
    Dir: installing
    Topics:
    - Name: Configuring OADP with multiple Volume Snapshot Locations
      File: configuring-oadp-multiple-vsl
  - Name: Uninstalling OADP
    Dir: installing
    Topics:
    - Name: Uninstalling OADP
      File: uninstalling-oadp
  - Name: OADP backing up
    Dir: backing_up_and_restoring
    Topics:
    - Name: Backing up applications
      File: backing-up-applications
    - Name: Creating a Backup CR
      File: oadp-creating-backup-cr
    - Name: Backing up persistent volumes with CSI snapshots
      File: oadp-backing-up-pvs-csi-doc
    - Name: Backing up applications with File System Backup
      File: oadp-backing-up-applications-restic-doc
    - Name: Creating backup hooks
      File: oadp-creating-backup-hooks-doc
    - Name: Scheduling backups using Schedule CR
      File: oadp-scheduling-backups-doc
    - Name: Deleting backups
      File: oadp-deleting-backups
    - Name: About Kopia
      File: oadp-about-kopia
  - Name: OADP restoring
    Dir: backing_up_and_restoring
    Topics:
    - Name: Restoring applications
      File: restoring-applications
  - Name: OADP Self-Service
    Dir: oadp-self-service
    Topics:
    - Name: OADP Self-Service
      File: oadp-self-service
    - Name: OADP Self-Service cluster admin use cases
      File: oadp-self-service-cluster-admin-use-cases
    - Name: OADP Self-Service namespace admin use cases
      File: oadp-self-service-namespace-admin-use-cases
    - Name: OADP Self-Service troubleshooting
      File: oadp-self-service-troubleshooting
  - Name: OADP and ROSA
    Dir: oadp-rosa
    Topics:
    - Name: Backing up applications on ROSA STS using OADP
      File: oadp-rosa-backing-up-applications
  - Name: OADP and AWS STS
    Dir: aws-sts
    Topics:
    - Name: Backing up applications on AWS STS using OADP
      File: oadp-aws-sts
  - Name: OADP and 3scale
    Dir: oadp-3scale
    Topics:
    - Name: Backing up and restoring 3scale API Management by using OADP
      File: backing-up-and-restoring-3scale-api-management-by-using-oadp
    - Name: Backing up 3scale API Management by using OADP
      File: backing-up-3scale-api-management-by-using-oadp
    - Name: Restoring 3scale API Management by using OADP
      File: restoring-3scale-api-management-by-using-oadp
  - Name: OADP Data Mover
    Dir: installing
    Topics:
    - Name: About the OADP Data Mover
      File: about-oadp-data-mover
    - Name: Backing up and restoring volumes by using CSI snapshots data movement
      File: oadp-backup-restore-csi-snapshots
    - Name: Configuring backupPVC and restorePVC for Data Mover
      File: configuring-backup-restore-pvc-datamover
    - Name: Overriding Kopia algorithms
      File: overriding-kopia-algorithms
  - Name: OADP API
    File: oadp-api
  - Name: Advanced OADP features and functionalities
    Dir: oadp-advanced-topics
    Topics:
#   - Name: Advanced OADP features and functionalities - review this after the migration
#     File: oadp-advanced-topics
    - Name: Working with different Kubernetes API versions on the same cluster
      File: oadp-different-kubernetes-api-versions
    - Name: Backing up data from one cluster and restoring it to another cluster
      File: oadp-backing-up-data-one-cluster-restoring-another-cluster
    - Name: OADP storage class mapping
      File: oadp-storage-class-mapping-main
  - Name: OADP troubleshooting
    Dir: troubleshooting
    Topics:
    - Name: Troubleshooting OADP
      File: troubleshooting
    - Name: Velero CLI tool
      File: velero-cli-tool
    - Name: Pods crash or restart due to lack of memory or CPU
      File: pods-crash-or-restart-due-to-lack-of-memory-or-cpu
    - Name: Restoring workarounds for Velero backups that use admission webhooks
      File: restoring-workarounds-for-velero-backups-that-use-admission-webhooks
    - Name: OADP installation issues
      File: oadp-installation-issues
    - Name: OADP Operator issues
      File: oadp-operator-issues
    - Name: OADP timeouts
      File: oadp-timeouts
    - Name: Backup and Restore CR issues
      File: backup-and-restore-cr-issues
    - Name: Restic issues
      File: restic-issues
    - Name: OADP Data protection test
      File: oadp-data-protection-test
    - Name: Using the must-gather tool
      File: using-the-must-gather-tool
    - Name: OADP monitoring
      File: oadp-monitoring
- Name: Control plane backup and restore
  Dir: control_plane_backup_and_restore
  Topics:
  - Name: Backing up etcd data
    File: backing-up-etcd
  - Name: Replacing an unhealthy etcd member
    File: replacing-unhealthy-etcd-member
  - Name: Disaster recovery
    Dir: disaster_recovery
    Topics:
    - Name: About disaster recovery
      File: about-disaster-recovery
    - Name: Quorum restoration
      File: quorum-restoration
    - Name: Restoring to a previous cluster state
      File: scenario-2-restoring-cluster-state
    - Name: Recovering from expired control plane certificates
      File: scenario-3-expired-certs
---
Name: Migrating from version 3 to 4
Dir: migrating_from_ocp_3_to_4
Distros: openshift-enterprise,openshift-origin
Topics:
- Name: Migrating from version 3 to 4 overview
  File: index
- Name: About migrating from OpenShift Container Platform 3 to 4
  File: about-migrating-from-3-to-4
  Distros: openshift-enterprise
- Name: About migrating from OKD 3 to 4
  File: about-migrating-from-3-to-4
  Distros: openshift-origin
- Name: Differences between OpenShift Container Platform 3 and 4
  File: planning-migration-3-4
  Distros: openshift-enterprise
- Name: Differences between OKD 3 and 4
  File: planning-migration-3-4
  Distros: openshift-origin
- Name: Network considerations
  File: planning-considerations-3-4
---
Name: API reference
Dir: rest_api
Distros: openshift-enterprise,openshift-origin
Topics:
- Name: API overview
  Dir: overview
  Topics:
  - Name: Understanding API tiers
    File: understanding-api-support-tiers
  - Name: API compatibility guidelines
    File: understanding-compatibility-guidelines
  - Name: Editing kubelet log level verbosity and gathering logs
    File: editing-kubelet-log-level-verbosity
  - Name: API list
    File: index
- Name: Common object reference
  Dir: objects
  Topics:
  - Name: Index
    File: index
- Name: Authorization APIs
  Dir: authorization_apis
  Topics:
  - Name: About Authorization APIs
    File: authorization-apis-index
  - Name: 'LocalResourceAccessReview [authorization.openshift.io/v1]'
    File: localresourceaccessreview-authorization-openshift-io-v1
  - Name: 'LocalSubjectAccessReview [authorization.openshift.io/v1]'
    File: localsubjectaccessreview-authorization-openshift-io-v1
  - Name: 'ResourceAccessReview [authorization.openshift.io/v1]'
    File: resourceaccessreview-authorization-openshift-io-v1
  - Name: 'SelfSubjectRulesReview [authorization.openshift.io/v1]'
    File: selfsubjectrulesreview-authorization-openshift-io-v1
  - Name: 'SubjectAccessReview [authorization.openshift.io/v1]'
    File: subjectaccessreview-authorization-openshift-io-v1
  - Name: 'SubjectRulesReview [authorization.openshift.io/v1]'
    File: subjectrulesreview-authorization-openshift-io-v1
  - Name: 'SelfSubjectReview [authentication.k8s.io/v1]'
    File: selfsubjectreview-authentication-k8s-io-v1
  - Name: 'TokenRequest [authentication.k8s.io/v1]'
    File: tokenrequest-authentication-k8s-io-v1
  - Name: 'TokenReview [authentication.k8s.io/v1]'
    File: tokenreview-authentication-k8s-io-v1
  - Name: 'LocalSubjectAccessReview [authorization.k8s.io/v1]'
    File: localsubjectaccessreview-authorization-k8s-io-v1
  - Name: 'SelfSubjectAccessReview [authorization.k8s.io/v1]'
    File: selfsubjectaccessreview-authorization-k8s-io-v1
  - Name: 'SelfSubjectRulesReview [authorization.k8s.io/v1]'
    File: selfsubjectrulesreview-authorization-k8s-io-v1
  - Name: 'SubjectAccessReview [authorization.k8s.io/v1]'
    File: subjectaccessreview-authorization-k8s-io-v1
- Name: Autoscale APIs
  Dir: autoscale_apis
  Topics:
  - Name: About Autoscale APIs
    File: autoscale-apis-index
  - Name: 'ClusterAutoscaler [autoscaling.openshift.io/v1]'
    File: clusterautoscaler-autoscaling-openshift-io-v1
  - Name: 'MachineAutoscaler [autoscaling.openshift.io/v1beta1]'
    File: machineautoscaler-autoscaling-openshift-io-v1beta1
  - Name: 'HorizontalPodAutoscaler [autoscaling/v2]'
    File: horizontalpodautoscaler-autoscaling-v2
  - Name: 'Scale [autoscaling/v1]'
    File: scale-autoscaling-v1
- Name: Cluster APIs
  Dir: cluster_apis
  Topics:
  - Name: About Cluster APIs
    File: cluster-apis-index
  - Name: 'IPAddress [ipam.cluster.x-k8s.io/v1beta1]'
    File: ipaddress-ipam-cluster-x-k8s-io-v1beta1
  - Name: 'IPAddressClaim [ipam.cluster.x-k8s.io/v1beta1]'
    File: ipaddressclaim-ipam-cluster-x-k8s-io-v1beta1
- Name: Config APIs
  Dir: config_apis
  Topics:
  - Name: About Config APIs
    File: config-apis-index
  - Name: 'APIServer [config.openshift.io/v1]'
    File: apiserver-config-openshift-io-v1
  - Name: 'Authentication [config.openshift.io/v1]'
    File: authentication-config-openshift-io-v1
  - Name: 'Backup [config.openshift.io/v1alpha1]'
    File: backup-config-openshift-io-v1alpha1
  - Name: 'Build [config.openshift.io/v1]'
    File: build-config-openshift-io-v1
  - Name: 'ClusterImagePolicy [config.openshift.io/v1]'
    File: clusterimagepolicy-config-openshift-io-v1
  - Name: 'ClusterOperator [config.openshift.io/v1]'
    File: clusteroperator-config-openshift-io-v1
  - Name: 'ClusterMonitoring [config.openshift.io/v1alpha1]'
    File: clustermonitoring-config-openshift-io-v1alpha1
  - Name: 'ClusterVersion [config.openshift.io/v1]'
    File: clusterversion-config-openshift-io-v1
  - Name: 'Console [config.openshift.io/v1]'
    File: console-config-openshift-io-v1
  - Name: 'DNS [config.openshift.io/v1]'
    File: dns-config-openshift-io-v1
  - Name: 'FeatureGate [config.openshift.io/v1]'
    File: featuregate-config-openshift-io-v1
  - Name: 'HelmChartRepository [helm.openshift.io/v1beta1]'
    File: helmchartrepository-helm-openshift-io-v1beta1
  - Name: 'Image [config.openshift.io/v1]'
    File: image-config-openshift-io-v1
  - Name: 'ImageDigestMirrorSet [config.openshift.io/v1]'
    File: imagedigestmirrorset-config-openshift-io-v1
  - Name: 'ImageContentPolicy [config.openshift.io/v1]'
    File: imagecontentpolicy-config-openshift-io-v1
  - Name: 'ImagePolicy [config.openshift.io/v1]'
    File: imagepolicy-config-openshift-io-v1
  - Name: 'ImageTagMirrorSet [config.openshift.io/v1]'
    File: imagetagmirrorset-config-openshift-io-v1
  - Name: 'InsightsDataGather [config.openshift.io/v1alpha2]'
    File: insightsdatagather-config-openshift-io-v1alpha2
  - Name: 'Infrastructure [config.openshift.io/v1]'
    File: infrastructure-config-openshift-io-v1
  - Name: 'Ingress [config.openshift.io/v1]'
    File: ingress-config-openshift-io-v1
  - Name: 'Network [config.openshift.io/v1]'
    File: network-config-openshift-io-v1
  - Name: 'Node [config.openshift.io/v1]'
    File: node-config-openshift-io-v1
  - Name: 'OAuth [config.openshift.io/v1]'
    File: oauth-config-openshift-io-v1
  - Name: 'OperatorHub [config.openshift.io/v1]'
    File: operatorhub-config-openshift-io-v1
  - Name: 'Project [config.openshift.io/v1]'
    File: project-config-openshift-io-v1
  - Name: 'ProjectHelmChartRepository [helm.openshift.io/v1beta1]'
    File: projecthelmchartrepository-helm-openshift-io-v1beta1
  - Name: 'Proxy [config.openshift.io/v1]'
    File: proxy-config-openshift-io-v1
  - Name: 'Scheduler [config.openshift.io/v1]'
    File: scheduler-config-openshift-io-v1
- Name: Console APIs
  Dir: console_apis
  Topics:
  - Name: About Console APIs
    File: console-apis-index
  - Name: 'ConsoleCLIDownload [console.openshift.io/v1]'
    File: consoleclidownload-console-openshift-io-v1
  - Name: 'ConsoleExternalLogLink [console.openshift.io/v1]'
    File: consoleexternalloglink-console-openshift-io-v1
  - Name: 'ConsoleLink [console.openshift.io/v1]'
    File: consolelink-console-openshift-io-v1
  - Name: 'ConsoleNotification [console.openshift.io/v1]'
    File: consolenotification-console-openshift-io-v1
  - Name: 'ConsolePlugin [console.openshift.io/v1]'
    File: consoleplugin-console-openshift-io-v1
  - Name: 'ConsoleQuickStart [console.openshift.io/v1]'
    File: consolequickstart-console-openshift-io-v1
  - Name: 'ConsoleSample [console.openshift.io/v1]'
    File: consolesample-console-openshift-io-v1
  - Name: 'ConsoleYAMLSample [console.openshift.io/v1]'
    File: consoleyamlsample-console-openshift-io-v1
- Name: Extension APIs
  Dir: extension_apis
  Topics:
  - Name: About Extension APIs
    File: extension-apis-index
  - Name: 'APIService [apiregistration.k8s.io/v1]'
    File: apiservice-apiregistration-k8s-io-v1
  - Name: 'CustomResourceDefinition [apiextensions.k8s.io/v1]'
    File: customresourcedefinition-apiextensions-k8s-io-v1
  - Name: 'MutatingWebhookConfiguration [admissionregistration.k8s.io/v1]'
    File: mutatingwebhookconfiguration-admissionregistration-k8s-io-v1
  - Name: 'ValidatingAdmissionPolicy [admissionregistration.k8s.io/v1]'
    File: validatingadmissionpolicy-admissionregistration-k8s-io-v1
  - Name: 'ValidatingAdmissionPolicyBinding [admissionregistration.k8s.io/v1]'
    File: validatingadmissionpolicybinding-admissionregistration-k8s-io-v1
  - Name: 'ValidatingWebhookConfiguration [admissionregistration.k8s.io/v1]'
    File: validatingwebhookconfiguration-admissionregistration-k8s-io-v1
- Name: Image APIs
  Dir: image_apis
  Topics:
  - Name: About Image APIs
    File: image-apis-index
  - Name: 'Image [image.openshift.io/v1]'
    File: image-image-openshift-io-v1
  - Name: 'ImageSignature [image.openshift.io/v1]'
    File: imagesignature-image-openshift-io-v1
  - Name: 'ImageStreamImage [image.openshift.io/v1]'
    File: imagestreamimage-image-openshift-io-v1
  - Name: 'ImageStreamImport [image.openshift.io/v1]'
    File: imagestreamimport-image-openshift-io-v1
  - Name: 'ImageStreamLayers [image.openshift.io/v1]'
    File: imagestreamlayers-image-openshift-io-v1
  - Name: 'ImageStreamMapping [image.openshift.io/v1]'
    File: imagestreammapping-image-openshift-io-v1
  - Name: 'ImageStream [image.openshift.io/v1]'
    File: imagestream-image-openshift-io-v1
  - Name: 'ImageStreamTag [image.openshift.io/v1]'
    File: imagestreamtag-image-openshift-io-v1
  - Name: 'ImageTag [image.openshift.io/v1]'
    File: imagetag-image-openshift-io-v1
  - Name: 'SecretList [image.openshift.io/v1]'
    File: secretlist-image-openshift-io-v1
- Name: Machine APIs
  Dir: machine_apis
  Topics:
  - Name: About Machine APIs
    File: machine-apis-index
  - Name: 'ContainerRuntimeConfig [machineconfiguration.openshift.io/v1]'
    File: containerruntimeconfig-machineconfiguration-openshift-io-v1
  - Name: 'ControllerConfig [machineconfiguration.openshift.io/v1]'
    File: controllerconfig-machineconfiguration-openshift-io-v1
  - Name: 'ControlPlaneMachineSet [machine.openshift.io/v1]'
    File: controlplanemachineset-machine-openshift-io-v1
  - Name: 'KubeletConfig [machineconfiguration.openshift.io/v1]'
    File: kubeletconfig-machineconfiguration-openshift-io-v1
  - Name: 'MachineConfig [machineconfiguration.openshift.io/v1]'
    File: machineconfig-machineconfiguration-openshift-io-v1
  - Name: 'MachineConfigPool [machineconfiguration.openshift.io/v1]'
    File: machineconfigpool-machineconfiguration-openshift-io-v1
  - Name: 'MachineHealthCheck [machine.openshift.io/v1beta1]'
    File: machinehealthcheck-machine-openshift-io-v1beta1
  - Name: 'Machine [machine.openshift.io/v1beta1]'
    File: machine-machine-openshift-io-v1beta1
  - Name: 'MachineSet [machine.openshift.io/v1beta1]'
    File: machineset-machine-openshift-io-v1beta1
  - Name: 'MachineConfigNode [machineconfiguration.openshift.io/v1]'
    File: machineconfignode-machineconfiguration-openshift-io-v1
  - Name: 'MachineOSBuild [machineconfiguration.openshift.io/v1]'
    File: machineosbuild-machineconfiguration-openshift-io-v1
  - Name: 'MachineOSConfig [machineconfiguration.openshift.io/v1]'
    File: machineosconfig-machineconfiguration-openshift-io-v1
  - Name: 'InternalReleaseImage [machineconfiguration.openshift.io/v1alpha1]'
    File: internalreleaseimage-machineconfiguration-openshift-io-v1alpha1
  - Name: 'OSImageStream [machineconfiguration.openshift.io/v1alpha1]'
    File: osimagestream-machineconfiguration-openshift-io-v1alpha1
  - Name: 'PinnedImageSet [machineconfiguration.openshift.io/v1]'
    File: pinnedimageset-machineconfiguration-openshift-io-v1
- Name: Metadata APIs
  Dir: metadata_apis
  Topics:
  - Name: About Metadata APIs
    File: metadata-apis-index
  - Name: 'APIRequestCount [apiserver.openshift.io/v1]'
    File: apirequestcount-apiserver-openshift-io-v1
  - Name: 'Binding [undefined/v1]'
    File: binding-v1
  - Name: 'ComponentStatus [undefined/v1]'
    File: componentstatus-v1
  - Name: 'ConfigMap [undefined/v1]'
    File: configmap-v1
  - Name: 'ControllerRevision [apps/v1]'
    File: controllerrevision-apps-v1
  - Name: 'Event [events.k8s.io/v1]'
    File: event-events-k8s-io-v1
  - Name: 'Event [undefined/v1]'
    File: event-v1
  - Name: 'Lease [coordination.k8s.io/v1]'
    File: lease-coordination-k8s-io-v1
  - Name: 'Namespace [undefined/v1]'
    File: namespace-v1
- Name: Monitoring APIs
  Dir: monitoring_apis
  Topics:
  - Name: About Monitoring APIs
    File: monitoring-apis-index
  - Name: 'Alertmanager [monitoring.coreos.com/v1]'
    File: alertmanager-monitoring-coreos-com-v1
  - Name: 'AlertmanagerConfig [monitoring.coreos.com/v1beta1]'
    File: alertmanagerconfig-monitoring-coreos-com-v1beta1
  - Name: 'AlertRelabelConfig [monitoring.openshift.io/v1]'
    File: alertrelabelconfig-monitoring-openshift-io-v1
  - Name: 'AlertingRule [monitoring.openshift.io/v1]'
    File: alertingrule-monitoring-openshift-io-v1
  - Name: 'DataGather [insights.openshift.io/v1alpha2]'
    File: datagather-insights-openshift-io-v1alpha2
  - Name: 'PodMonitor [monitoring.coreos.com/v1]'
    File: podmonitor-monitoring-coreos-com-v1
  - Name: 'Probe [monitoring.coreos.com/v1]'
    File: probe-monitoring-coreos-com-v1
  - Name: 'Prometheus [monitoring.coreos.com/v1]'
    File: prometheus-monitoring-coreos-com-v1
  - Name: 'PrometheusRule [monitoring.coreos.com/v1]'
    File: prometheusrule-monitoring-coreos-com-v1
  - Name: 'ServiceMonitor [monitoring.coreos.com/v1]'
    File: servicemonitor-monitoring-coreos-com-v1
  - Name: 'ThanosRuler [monitoring.coreos.com/v1]'
    File: thanosruler-monitoring-coreos-com-v1
  - Name: 'NodeMetrics [metrics.k8s.io/v1beta1]'
    File: nodemetrics-metrics-k8s-io-v1beta1
  - Name: 'PodMetrics [metrics.k8s.io/v1beta1]'
    File: podmetrics-metrics-k8s-io-v1beta1
- Name: Network APIs
  Dir: network_apis
  Topics:
  - Name: About Network APIs
    File: network-apis-index
  - Name: 'ClusterUserDefinedNetwork [k8s.ovn.org/v1]'
    File: clusteruserdefinednetwork-k8s-ovn-org-v1
  - Name: 'AdminNetworkPolicy [policy.networking.k8s.io/v1alpha1]'
    File: adminnetworkpolicy-policy-networking-k8s-io-v1alpha1
  - Name: 'AdminPolicyBasedExternalRoute [k8s.ovn.org/v1]'
    File: adminpolicybasedexternalroute-k8s-ovn-org-v1
  - Name: 'BaselineAdminNetworkPolicy [policy.networking.k8s.io/v1alpha1]'
    File: baselineadminnetworkpolicy-policy-networking-k8s-io-v1alpha1
  - Name: 'CloudPrivateIPConfig [cloud.network.openshift.io/v1]'
    File: cloudprivateipconfig-cloud-network-openshift-io-v1
  - Name: 'DNSNameResolver [network.openshift.io/v1alpha1]'
    File: dnsnameresolver-network-openshift-io-v1alpha1
  - Name: 'EgressFirewall [k8s.ovn.org/v1]'
    File: egressfirewall-k8s-ovn-org-v1
  - Name: 'EgressIP [k8s.ovn.org/v1]'
    File: egressip-k8s-ovn-org-v1
  - Name: 'EgressQoS [k8s.ovn.org/v1]'
    File: egressqos-k8s-ovn-org-v1
  - Name: 'EgressService [k8s.ovn.org/v1]'
    File: egressservice-k8s-ovn-org-v1
  - Name: 'Endpoints [undefined/v1]'
    File: endpoints-v1
  - Name: 'EndpointSlice [discovery.k8s.io/v1]'
    File: endpointslice-discovery-k8s-io-v1
  - Name: 'EgressRouter [network.operator.openshift.io/v1]'
    File: egressrouter-network-operator-openshift-io-v1
  - Name: 'GRPCRoute [gateway.networking.k8s.io/v1]'
    File: grpcroute-gateway-networking-k8s-io-v1
  - Name: 'Gateway [gateway.networking.k8s.io/v1]'
    File: gateway-gateway-networking-k8s-io-v1
  - Name: 'GatewayClass [gateway.networking.k8s.io/v1]'
    File: gatewayclass-gateway-networking-k8s-io-v1
  - Name: 'HTTPRoute [gateway.networking.k8s.io/v1]'
    File: httproute-gateway-networking-k8s-io-v1
  - Name: 'Ingress [networking.k8s.io/v1]'
    File: ingress-networking-k8s-io-v1
  - Name: 'IngressClass [networking.k8s.io/v1]'
    File: ingressclass-networking-k8s-io-v1
  - Name: 'IPAddress [networking.k8s.io/v1]'
    File: ipaddress-networking-k8s-io-v1
  - Name: 'IPAMClaim [k8s.cni.cncf.io/v1alpha1]'
    File: ipamclaim-k8s-cni-cncf-io-v1alpha1
  - Name: 'IPPool [whereabouts.cni.cncf.io/v1alpha1]'
    File: ippool-whereabouts-cni-cncf-io-v1alpha1
  - Name: 'MultiNetworkPolicy [k8s.cni.cncf.io/v1beta1]'
    File: multinetworkpolicy-k8s-cni-cncf-io-v1beta1
  - Name: 'NetworkAttachmentDefinition [k8s.cni.cncf.io/v1]'
    File: networkattachmentdefinition-k8s-cni-cncf-io-v1
  - Name: 'NetworkPolicy [networking.k8s.io/v1]'
    File: networkpolicy-networking-k8s-io-v1
  - Name: 'NodeSlicePool [whereabouts.cni.cncf.io/v1alpha1]'
    File: nodeslicepool-whereabouts-cni-cncf-io-v1alpha1
  - Name: 'OverlappingRangeIPReservation [whereabouts.cni.cncf.io/v1alpha1]'
    File: overlappingrangeipreservation-whereabouts-cni-cncf-io-v1alpha1
  - Name: 'PodNetworkConnectivityCheck [controlplane.operator.openshift.io/v1alpha1]'
    File: podnetworkconnectivitycheck-controlplane-operator-openshift-io-v1alpha1
  - Name: 'ReferenceGrant [gateway.networking.k8s.io/v1beta1]'
    File: referencegrant-gateway-networking-k8s-io-v1beta1
  - Name: 'Route [route.openshift.io/v1]'
    File: route-route-openshift-io-v1
  - Name: 'Service [undefined/v1]'
    File: service-v1
  - Name: 'ServiceCIDR [networking.k8s.io/v1]'
    File: servicecidr-networking-k8s-io-v1
  - Name: 'IPAddressClaim [ipam.cluster.x-k8s.io/v1beta1]'
    File: ipaddressclaim-ipam-cluster-x-k8s-io-v1beta1
  - Name: 'UserDefinedNetwork [k8s.ovn.org/v1]'
    File: userdefinednetwork-k8s-ovn-org-v1
- Name: Node APIs
  Dir: node_apis
  Topics:
  - Name: About Node APIs
    File: node-apis-index
  - Name: 'Node [undefined/v1]'
    File: node-v1
  - Name: 'PerformanceProfile [performance.openshift.io/v2]'
    File: performanceprofile-performance-openshift-io-v2
  - Name: 'Profile [tuned.openshift.io/v1]'
    File: profile-tuned-openshift-io-v1
  - Name: 'RuntimeClass [node.k8s.io/v1]'
    File: runtimeclass-node-k8s-io-v1
  - Name: 'Tuned [tuned.openshift.io/v1]'
    File: tuned-tuned-openshift-io-v1
- Name: OAuth APIs
  Dir: oauth_apis
  Topics:
  - Name: About OAuth APIs
    File: oauth-apis-index
  - Name: 'OAuthAccessToken [oauth.openshift.io/v1]'
    File: oauthaccesstoken-oauth-openshift-io-v1
  - Name: 'OAuthAuthorizeToken [oauth.openshift.io/v1]'
    File: oauthauthorizetoken-oauth-openshift-io-v1
  - Name: 'OAuthClientAuthorization [oauth.openshift.io/v1]'
    File: oauthclientauthorization-oauth-openshift-io-v1
  - Name: 'OAuthClient [oauth.openshift.io/v1]'
    File: oauthclient-oauth-openshift-io-v1
  - Name: 'UserOAuthAccessToken [oauth.openshift.io/v1]'
    File: useroauthaccesstoken-oauth-openshift-io-v1
- Name: Operator APIs
  Dir: operator_apis
  Topics:
  - Name: About Operator APIs
    File: operator-apis-index
  - Name: 'Authentication [operator.openshift.io/v1]'
    File: authentication-operator-openshift-io-v1
  - Name: 'CloudCredential [operator.openshift.io/v1]'
    File: cloudcredential-operator-openshift-io-v1
  - Name: 'ClusterVersionOperator [operator.openshift.io/v1alpha1]'
    File: clusterversionoperator-operator-openshift-io-v1alpha1
  - Name: 'ClusterCSIDriver [operator.openshift.io/v1]'
    File: clustercsidriver-operator-openshift-io-v1
  - Name: 'Console [operator.openshift.io/v1]'
    File: console-operator-openshift-io-v1
  - Name: 'Config [operator.openshift.io/v1]'
    File: config-operator-openshift-io-v1
  - Name: 'Config [imageregistry.operator.openshift.io/v1]'
    File: config-imageregistry-operator-openshift-io-v1
  - Name: 'Config [samples.operator.openshift.io/v1]'
    File: config-samples-operator-openshift-io-v1
  - Name: 'CSISnapshotController [operator.openshift.io/v1]'
    File: csisnapshotcontroller-operator-openshift-io-v1
  - Name: 'DNS [operator.openshift.io/v1]'
    File: dns-operator-openshift-io-v1
  - Name: 'DNSRecord [ingress.operator.openshift.io/v1]'
    File: dnsrecord-ingress-operator-openshift-io-v1
  - Name: 'Etcd [operator.openshift.io/v1]'
    File: etcd-operator-openshift-io-v1
  - Name: 'EtcdBackup [operator.openshift.io/v1alpha1]'
    File: etcdbackup-operator-openshift-io-v1alpha1
  - Name: 'ImageContentSourcePolicy [operator.openshift.io/v1alpha1]'
    File: imagecontentsourcepolicy-operator-openshift-io-v1alpha1
  - Name: 'ImagePruner [imageregistry.operator.openshift.io/v1]'
    File: imagepruner-imageregistry-operator-openshift-io-v1
  - Name: 'IngressController [operator.openshift.io/v1]'
    File: ingresscontroller-operator-openshift-io-v1
  - Name: 'InsightsOperator [operator.openshift.io/v1]'
    File: insightsoperator-operator-openshift-io-v1
  - Name: 'KubeAPIServer [operator.openshift.io/v1]'
    File: kubeapiserver-operator-openshift-io-v1
  - Name: 'KubeControllerManager [operator.openshift.io/v1]'
    File: kubecontrollermanager-operator-openshift-io-v1
  - Name: 'KubeScheduler [operator.openshift.io/v1]'
    File: kubescheduler-operator-openshift-io-v1
  - Name: 'KubeStorageVersionMigrator [operator.openshift.io/v1]'
    File: kubestorageversionmigrator-operator-openshift-io-v1
  - Name: 'MachineConfiguration [operator.openshift.io/v1]'
    File: machineconfiguration-operator-openshift-io-v1
  - Name: 'Network [operator.openshift.io/v1]'
    File: network-operator-openshift-io-v1
  - Name: 'OpenShiftAPIServer [operator.openshift.io/v1]'
    File: openshiftapiserver-operator-openshift-io-v1
  - Name: 'OpenShiftControllerManager [operator.openshift.io/v1]'
    File: openshiftcontrollermanager-operator-openshift-io-v1
  - Name: 'OperatorPKI [network.operator.openshift.io/v1]'
    File: operatorpki-network-operator-openshift-io-v1
  - Name: 'ServiceCA [operator.openshift.io/v1]'
    File: serviceca-operator-openshift-io-v1
  - Name: 'Storage [operator.openshift.io/v1]'
    File: storage-operator-openshift-io-v1
- Name: OperatorHub APIs
  Dir: operatorhub_apis
  Topics:
  - Name: About OperatorHub APIs
    File: operatorhub-apis-index
  - Name: 'CatalogSource [operators.coreos.com/v1alpha1]'
    File: catalogsource-operators-coreos-com-v1alpha1
  - Name: 'ClusterCatalog [olm.operatorframework.io/v1]'
    File: clustercatalog-olm-operatorframework-io-v1
  - Name: 'ClusterExtension [olm.operatorframework.io/v1]'
    File: clusterextension-olm-operatorframework-io-v1
  - Name: 'ClusterExtensionRevision [olm.operatorframework.io/v1]'
    File: clusterextensionrevision-olm-operatorframework-io-v1
  - Name: 'ClusterServiceVersion [operators.coreos.com/v1alpha1]'
    File: clusterserviceversion-operators-coreos-com-v1alpha1
  - Name: 'InstallPlan [operators.coreos.com/v1alpha1]'
    File: installplan-operators-coreos-com-v1alpha1
  - Name: 'OLM [operator.openshift.io/v1]'
    File: olm-operator-openshift-io-v1
  - Name: 'OLMConfig [operators.coreos.com/v1]'
    File: olmconfig-operators-coreos-com-v1
  - Name: 'Operator [operators.coreos.com/v1]'
    File: operator-operators-coreos-com-v1
  - Name: 'OperatorCondition [operators.coreos.com/v2]'
    File: operatorcondition-operators-coreos-com-v2
  - Name: 'OperatorGroup [operators.coreos.com/v1]'
    File: operatorgroup-operators-coreos-com-v1
  - Name: 'PackageManifest [packages.operators.coreos.com/v1]'
    File: packagemanifest-packages-operators-coreos-com-v1
  - Name: 'Subscription [operators.coreos.com/v1alpha1]'
    File: subscription-operators-coreos-com-v1alpha1
- Name: Policy APIs
  Dir: policy_apis
  Topics:
  - Name: About Policy APIs
    File: policy-apis-index
  - Name: 'Eviction [policy/v1]'
    File: eviction-policy-v1
  - Name: 'PodDisruptionBudget [policy/v1]'
    File: poddisruptionbudget-policy-v1
- Name: Project APIs
  Dir: project_apis
  Topics:
  - Name: About Project APIs
    File: project-apis-index
  - Name: 'Project [project.openshift.io/v1]'
    File: project-project-openshift-io-v1
  - Name: 'ProjectRequest [project.openshift.io/v1]'
    File: projectrequest-project-openshift-io-v1
- Name: Provisioning APIs
  Dir: provisioning_apis
  Topics:
  - Name: About Provisioning APIs
    File: provisioning-apis-index
  - Name: 'BMCEventSubscription [metal3.io/v1alpha1]'
    File: bmceventsubscription-metal3-io-v1alpha1
  - Name: 'BareMetalHost [metal3.io/v1alpha1]'
    File: baremetalhost-metal3-io-v1alpha1
  - Name: 'DataImage [metal3.io/v1alpha1]'
    File: dataimage-metal3-io-v1alpha1
  - Name: 'FirmwareSchema [metal3.io/v1alpha1]'
    File: firmwareschema-metal3-io-v1alpha1
  - Name: 'HardwareData [metal3.io/v1alpha1]'
    File: hardwaredata-metal3-io-v1alpha1
  - Name: 'HostFirmwareComponents [metal3.io/v1alpha1]'
    File: hostfirmwarecomponents-metal3-io-v1alpha1
  - Name: 'HostFirmwareSettings [metal3.io/v1alpha1]'
    File: hostfirmwaresettings-metal3-io-v1alpha1
  - Name: 'HostUpdatePolicy [metal3.io/v1alpha1]'
    File: hostupdatepolicy-metal3-io-v1alpha1
  - Name: 'Metal3Remediation [infrastructure.cluster.x-k8s.io/v1beta1]'
    File: metal3remediation-infrastructure-cluster-x-k8s-io-v1beta1
  - Name: 'Metal3RemediationTemplate [infrastructure.cluster.x-k8s.io/v1beta1]'
    File: metal3remediationtemplate-infrastructure-cluster-x-k8s-io-v1beta1
  - Name: 'PreprovisioningImage [metal3.io/v1alpha1]'
    File: preprovisioningimage-metal3-io-v1alpha1
  - Name: 'Provisioning [metal3.io/v1alpha1]'
    File: provisioning-metal3-io-v1alpha1
- Name: RBAC APIs
  Dir: rbac_apis
  Topics:
  - Name: About RBAC APIs
    File: rbac-apis-index
  - Name: 'ClusterRoleBinding [rbac.authorization.k8s.io/v1]'
    File: clusterrolebinding-rbac-authorization-k8s-io-v1
  - Name: 'ClusterRole [rbac.authorization.k8s.io/v1]'
    File: clusterrole-rbac-authorization-k8s-io-v1
  - Name: 'RoleBinding [rbac.authorization.k8s.io/v1]'
    File: rolebinding-rbac-authorization-k8s-io-v1
  - Name: 'Role [rbac.authorization.k8s.io/v1]'
    File: role-rbac-authorization-k8s-io-v1
- Name: Role APIs
  Dir: role_apis
  Topics:
  - Name: About Role APIs
    File: role-apis-index
  - Name: 'ClusterRoleBinding [authorization.openshift.io/v1]'
    File: clusterrolebinding-authorization-openshift-io-v1
  - Name: 'ClusterRole [authorization.openshift.io/v1]'
    File: clusterrole-authorization-openshift-io-v1
  - Name: 'RoleBindingRestriction [authorization.openshift.io/v1]'
    File: rolebindingrestriction-authorization-openshift-io-v1
  - Name: 'RoleBinding [authorization.openshift.io/v1]'
    File: rolebinding-authorization-openshift-io-v1
  - Name: 'Role [authorization.openshift.io/v1]'
    File: role-authorization-openshift-io-v1
- Name: Schedule and quota APIs
  Dir: schedule_and_quota_apis
  Topics:
  - Name: About Schedule and quota APIs
    File: schedule-and-quota-apis-index
  - Name: 'AppliedClusterResourceQuota [quota.openshift.io/v1]'
    File: appliedclusterresourcequota-quota-openshift-io-v1
  - Name: 'ClusterResourceQuota [quota.openshift.io/v1]'
    File: clusterresourcequota-quota-openshift-io-v1
  - Name: 'FlowSchema [flowcontrol.apiserver.k8s.io/v1]'
    File: flowschema-flowcontrol-apiserver-k8s-io-v1
  - Name: 'LimitRange [undefined/v1]'
    File: limitrange-v1
  - Name: 'PriorityClass [scheduling.k8s.io/v1]'
    File: priorityclass-scheduling-k8s-io-v1
  - Name: 'PriorityLevelConfiguration [flowcontrol.apiserver.k8s.io/v1]'
    File: prioritylevelconfiguration-flowcontrol-apiserver-k8s-io-v1
  - Name: 'ResourceQuota [undefined/v1]'
    File: resourcequota-v1
- Name: Security APIs
  Dir: security_apis
  Topics:
  - Name: About Security APIs
    File: security-apis-index
  - Name: 'CertificateSigningRequest [certificates.k8s.io/v1]'
    File: certificatesigningrequest-certificates-k8s-io-v1
  - Name: 'CredentialsRequest [cloudcredential.openshift.io/v1]'
    File: credentialsrequest-cloudcredential-openshift-io-v1
  - Name: 'PodSecurityPolicyReview [security.openshift.io/v1]'
    File: podsecuritypolicyreview-security-openshift-io-v1
  - Name: 'PodSecurityPolicySelfSubjectReview [security.openshift.io/v1]'
    File: podsecuritypolicyselfsubjectreview-security-openshift-io-v1
  - Name: 'PodSecurityPolicySubjectReview [security.openshift.io/v1]'
    File: podsecuritypolicysubjectreview-security-openshift-io-v1
  - Name: 'RangeAllocation [security.openshift.io/v1]'
    File: rangeallocation-security-openshift-io-v1
  - Name: 'Secret [undefined/v1]'
    File: secret-v1
  - Name: 'SecurityContextConstraints [security.openshift.io/v1]'
    File: securitycontextconstraints-security-openshift-io-v1
  - Name: 'ServiceAccount [undefined/v1]'
    File: serviceaccount-v1
- Name: Storage APIs
  Dir: storage_apis
  Topics:
  - Name: About Storage APIs
    File: storage-apis-index
  - Name: 'CSIDriver [storage.k8s.io/v1]'
    File: csidriver-storage-k8s-io-v1
  - Name: 'CSINode [storage.k8s.io/v1]'
    File: csinode-storage-k8s-io-v1
  - Name: 'CSIStorageCapacity [storage.k8s.io/v1]'
    File: csistoragecapacity-storage-k8s-io-v1
  - Name: 'PersistentVolume [undefined/v1]'
    File: persistentvolume-v1
  - Name: 'PersistentVolumeClaim [undefined/v1]'
    File: persistentvolumeclaim-v1
  - Name: 'StorageClass [storage.k8s.io/v1]'
    File: storageclass-storage-k8s-io-v1
  - Name: 'StorageState [migration.k8s.io/v1alpha1]'
    File: storagestate-migration-k8s-io-v1alpha1
  - Name: 'StorageVersionMigration [migration.k8s.io/v1alpha1]'
    File: storageversionmigration-migration-k8s-io-v1alpha1
  - Name: 'VolumeAttachment [storage.k8s.io/v1]'
    File: volumeattachment-storage-k8s-io-v1
  - Name: 'VolumeAttributesClass [storage.k8s.io/v1]'
    File: volumeattributesclass-storage-k8s-io-v1
  - Name: 'VolumePopulator [populator.storage.k8s.io/v1beta1]'
    File: volumepopulator-populator-storage-k8s-io-v1beta1
  - Name: 'VolumeSnapshot [snapshot.storage.k8s.io/v1]'
    File: volumesnapshot-snapshot-storage-k8s-io-v1
  - Name: 'VolumeSnapshotClass [snapshot.storage.k8s.io/v1]'
    File: volumesnapshotclass-snapshot-storage-k8s-io-v1
  - Name: 'VolumeSnapshotContent [snapshot.storage.k8s.io/v1]'
    File: volumesnapshotcontent-snapshot-storage-k8s-io-v1
- Name: Template APIs
  Dir: template_apis
  Topics:
  - Name: About Template APIs
    File: template-apis-index
  - Name: 'BrokerTemplateInstance [template.openshift.io/v1]'
    File: brokertemplateinstance-template-openshift-io-v1
  - Name: 'PodTemplate [undefined/v1]'
    File: podtemplate-v1
  - Name: 'Template [template.openshift.io/v1]'
    File: template-template-openshift-io-v1
  - Name: 'TemplateInstance [template.openshift.io/v1]'
    File: templateinstance-template-openshift-io-v1
- Name: User and group APIs
  Dir: user_and_group_apis
  Topics:
  - Name: About User and group APIs
    File: user-and-group-apis-index
  - Name: 'Group [user.openshift.io/v1]'
    File: group-user-openshift-io-v1
  - Name: 'Identity [user.openshift.io/v1]'
    File: identity-user-openshift-io-v1
  - Name: 'UserIdentityMapping [user.openshift.io/v1]'
    File: useridentitymapping-user-openshift-io-v1
  - Name: 'User [user.openshift.io/v1]'
    File: user-user-openshift-io-v1
- Name: Workloads APIs
  Dir: workloads_apis
  Topics:
  - Name: About Workloads APIs
    File: workloads-apis-index
  - Name: 'BuildConfig [build.openshift.io/v1]'
    File: buildconfig-build-openshift-io-v1
  - Name: 'Build [build.openshift.io/v1]'
    File: build-build-openshift-io-v1
  - Name: 'BuildLog [build.openshift.io/v1]'
    File: buildlog-build-openshift-io-v1
  - Name: 'BuildRequest [build.openshift.io/v1]'
    File: buildrequest-build-openshift-io-v1
  - Name: 'CronJob [batch/v1]'
    File: cronjob-batch-v1
  - Name: 'DaemonSet [apps/v1]'
    File: daemonset-apps-v1
  - Name: 'Deployment [apps/v1]'
    File: deployment-apps-v1
  - Name: 'DeploymentConfig [apps.openshift.io/v1]'
    File: deploymentconfig-apps-openshift-io-v1
  - Name: 'DeploymentConfigRollback [apps.openshift.io/v1]'
    File: deploymentconfigrollback-apps-openshift-io-v1
  - Name: 'DeploymentLog [apps.openshift.io/v1]'
    File: deploymentlog-apps-openshift-io-v1
  - Name: 'DeploymentRequest [apps.openshift.io/v1]'
    File: deploymentrequest-apps-openshift-io-v1
  - Name: 'Job [batch/v1]'
    File: job-batch-v1
  - Name: 'Pod [undefined/v1]'
    File: pod-v1
  - Name: 'ReplicationController [undefined/v1]'
    File: replicationcontroller-v1
  - Name: 'ReplicaSet [apps/v1]'
    File: replicaset-apps-v1
  - Name: 'StatefulSet [apps/v1]'
    File: statefulset-apps-v1
---
Name: OpenShift Lightspeed
Dir: lightspeed
Distros: openshift-enterprise
Topics:
- Name: About OpenShift Lightspeed
  Dir: about
  Topics:
  - Name: OpenShift Lightspeed overview
    File: ols-openshift-lightspeed-overview
---
Name: Service Mesh
Dir: service_mesh
Distros: openshift-enterprise
Topics:
- Name: Service Mesh 3.x
  Dir: v3x
  Topics:
  - Name: OpenShift Service Mesh 3.0 TP1 overview
    File: ossm-service-mesh-3-0-overview
- Name: Service Mesh 2.x
  Dir: v2x
  Topics:
  - Name: About OpenShift Service Mesh
    File: ossm-about
  - Name: Service Mesh 2.x release notes
    File: servicemesh-release-notes
  - Name: Upgrading Service Mesh
    File: upgrading-ossm
  - Name: Understanding Service Mesh
    File: ossm-architecture
  - Name: Service Mesh deployment models
    File: ossm-deployment-models
  - Name: Service Mesh and Istio differences
    File: ossm-vs-community
  - Name: Preparing to install Service Mesh
    File: preparing-ossm-installation
  - Name: Installing the Operators
    File: installing-ossm
  - Name: Creating the ServiceMeshControlPlane
    File: ossm-create-smcp
  - Name: Adding services to a service mesh
    File: ossm-create-mesh
  - Name: Enabling sidecar injection
    File: prepare-to-deploy-applications-ossm
  - Name: Managing users and profiles
    File: ossm-profiles-users
  - Name: Security
    File: ossm-security
  - Name: Traffic management
    File: ossm-traffic-manage
  - Name: Gateway migration
    File: ossm-gateway-migration
  - Name: Route migration
    File: ossm-route-migration
  - Name: Metrics, logs, and traces
    File: ossm-observability
  - Name: Performance and scalability
    File: ossm-performance-scalability
  - Name: Deploying to production
    File: ossm-deploy-production
  - Name: Federation
    File: ossm-federation
  - Name: Extensions
    File: ossm-extensions
  - Name: OpenShift Service Mesh Console plugin
    File: ossm-kiali-ossmc-plugin
  - Name: 3scale WebAssembly for 2.1
    File: ossm-threescale-webassembly-module
  - Name: 3scale Istio adapter for 2.0
    File: threescale-adapter
  - Name: Troubleshooting Service Mesh
    File: ossm-troubleshooting-istio
  - Name: Control plane configuration reference
    File: ossm-reference-smcp
  - Name: Kiali configuration reference
    File: ossm-reference-kiali
  - Name: Uninstalling Service Mesh
    File: removing-ossm
# - Name: Service Mesh 1.x
#   Dir: v1x
#   Topics:
#   - Name: Service Mesh 1.x release notes
#     File: servicemesh-release-notes
#   - Name: Service Mesh architecture
#     File: ossm-architecture
#   - Name: Service Mesh and Istio differences
#     File: ossm-vs-community
#   - Name: Preparing to install Service Mesh
#     File: preparing-ossm-installation
#   - Name: Installing Service Mesh
#     File: installing-ossm
#   - Name: Security
#     File: ossm-security
#   - Name: Traffic management
#     File: ossm-traffic-manage
#   - Name: Deploying applications on Service Mesh
#     File: prepare-to-deploy-applications-ossm
#   - Name: Data visualization and observability
#     File: ossm-observability
#   - Name: Custom resources
#     File: ossm-custom-resources
#   - Name: 3scale Istio adapter for 1.x
#     File: threescale-adapter
#   - Name: Removing Service Mesh
#     File: removing-ossm
---
Name: Virtualization
Dir: virt
Distros: openshift-enterprise,openshift-origin
Topics:
- Name: About
  Dir: about_virt
  Topics:
  - Name: About OpenShift Virtualization
    File: about-virt
    Distros: openshift-enterprise
  - Name: About OKD Virtualization
    File: about-virt
    Distros: openshift-origin
  - Name: Supported limits
    File: virt-supported-limits
  - Name: Security policies
    File: virt-security-policies
  - Name: Architecture
    File: virt-architecture
    Distros: openshift-enterprise
- Name: Release notes
  Dir: release_notes
  Topics:
  - Name: OpenShift Virtualization release notes
    File: virt-release-notes-placeholder
    Distros: openshift-enterprise
  # - Name: OKD Virtualization release notes
  #   File: virt-release-notes-placeholder
  #   Distros: openshift-origin
- Name: Getting started
  Dir: getting_started
  Topics:
  - Name: Getting started with OpenShift Virtualization
    File: virt-getting-started
    Distros: openshift-enterprise
  - Name: Getting started with OKD Virtualization
    File: virt-getting-started
    Distros: openshift-origin
  - Name: virtctl and libguestfs
    File: virt-using-the-cli-tools
    Distros: openshift-enterprise
- Name: Installing
  Dir: install
  Topics:
  - Name: Preparing your cluster
    File: preparing-cluster-for-virt
  - Name: Installing OpenShift Virtualization
    File: installing-virt
    Distros: openshift-enterprise
  - Name: Installing OKD Virtualization
    File: installing-virt
    Distros: openshift-origin
  - Name: Uninstalling OpenShift Virtualization
    File: uninstalling-virt
    Distros: openshift-enterprise
  - Name: Uninstalling OKD Virtualization
    File: uninstalling-virt
    Distros: openshift-origin
  - Name: Installing OpenShift Virtualization on IBM Cloud bare-metal nodes
    File: virt-install-ibm-cloud-bm-nodes
    Distros: openshift-enterprise
- Name: Postinstallation configuration
  Dir: post_installation_configuration
  Topics:
  - Name: Postinstallation configuration
    File: virt-post-install-config
  - Name: Node placement rules
    File: virt-node-placement-virt-components
  - Name: Network configuration
    File: virt-post-install-network-config
  - Name: Storage configuration
    File: virt-post-install-storage-config
  - Name: Self validation checkups
    File: virt-self-validation-checkups
  - Name: Allocate physical cores for virtual machines
    File: virt-physical-cores-allocation-vms
  - Name: Configuring higher VM workload density
    File: virt-configuring-higher-vm-workload-density
  - Name: Configuring certificate rotation
    File: virt-configuring-certificate-rotation
- Name: Updating
  Dir: updating
  Topics:
  - Name: Updating OpenShift Virtualization
    File: upgrading-virt
    Distros: openshift-enterprise
  - Name: Updating OKD Virtualization
    File: upgrading-virt
    Distros: openshift-origin
- Name: Creating a virtual machine
  Dir: creating_vm
  Topics:
  - Name: Creating VMs from instance types
    File: virt-creating-vms-from-instance-types
  - Name: Creating VMs from templates
    File: virt-creating-vms-from-templates
  - Name: Configuring IBM Secure Execution virtual machines on IBM Z and IBM LinuxONE
    File: virt-configuring-ibm-secure-execution-vms-ibm-z
  - Name: Creating AWS EC2 Windows License Included (LI) compliant VMs
    File: virt-creating-vms-aws-li-windows
- Name: Advanced VM creation
  Dir: creating_vms_advanced
  Topics:
  - Name: Creating VMs from Red Hat images
    Dir: creating_vms_advanced_web
    Topics:
    - Name: Creating virtual machines from Red Hat images
      File: virt-creating-vms-from-rh-images-overview
    - Name: Heterogeneous cluster support
      File: virt-golden-image-heterogeneous-clusters
  - Name: Creating VMs in the web console
    Dir: creating_vms_advanced_web
    Topics:
    - Name: Creating VMs by importing images from web pages
      File: virt-creating-vms-from-web-images
    - Name: Creating VMs by uploading images
      File: virt-creating-vms-uploading-images
    - Name: Cloning VMs
      File: virt-cloning-vms
  - Name: Creating VMs using the CLI
    Dir: creating_vms_cli
    Topics:
    - Name: Creating virtual machines from the command line
      File: virt-creating-vms-from-cli
    - Name: Creating VMs by using container disks
      File: virt-creating-vms-from-container-disks
    - Name: Creating VMs by cloning PVCs
      File: virt-creating-vms-by-cloning-pvcs
- Name: Managing VMs
  Dir: managing_vms
  Topics:
  - Name: Listing virtual machines
    File: virt-list-vms
  - Name: Install the QEMU guest agent
    File: virt-installing-qemu-guest-agent
  - Name: Install VirtIO drivers on Windows VMs
    File: virt-install-virtio-drivers-on-windows-vms
  - Name: Update VirtIO drivers
    File: virt-update-virtio-drivers
  - Name: Connecting to VM consoles
    File: virt-accessing-vm-consoles
  - Name: Configuring SSH access to VMs
    File: virt-accessing-vm-ssh
  - Name: Customize the web console
    File: virt-customize-web-console
  - Name: Editing virtual machines
    File: virt-edit-vms
  - Name: Editing boot order
    File: virt-edit-boot-order
  - Name: Deleting virtual machines
    File: virt-delete-vms
  - Name: Enabling or disabling virtual machine delete protection
    File: virt-enabling-disabling-vm-delete-protection
  - Name: Exporting virtual machines
    File: virt-exporting-vms
  - Name: Managing virtual machine instances
    File: virt-manage-vmis
  - Name: Controlling virtual machine states
    File: virt-controlling-vm-states
  - Name: Using virtual Trusted Platform Module devices
    File: virt-using-vtpm-devices
  - Name: Managing virtual machines with OpenShift Pipelines
    File: virt-managing-vms-openshift-pipelines
  - Name: Migrating VMs in a single cluster to a different storage class
    File: virt-migrating-vms-in-single-cluster-to-different-storage-class
  - Name: Advanced virtual machine management
    Dir: advanced_vm_management
    Topics:
    - Name: Working with resource quotas for virtual machines
      File: virt-working-with-resource-quotas-for-vms
    - Name: Configuring the Application-Aware Quota Operator
      File: virt-understanding-aaq-operator
    - Name: Specifying nodes for virtual machines
      File: virt-specifying-nodes-for-vms
    - Name: Configuring the default CPU model
      File: virt-configuring-default-cpu-model
    - Name: UEFI mode for virtual machines
      File: virt-uefi-mode-for-vms
    - Name: Configuring PXE booting for virtual machines
      File: virt-configuring-pxe-booting
    - Name: Using huge pages with virtual machines
      File: virt-using-huge-pages-with-vms
    - Name: Enabling dedicated resources for a virtual machine
      File: virt-dedicated-resources-vm
    - Name: Scheduling virtual machines
      File: virt-schedule-vms
    - Name: Configuring PCI passthrough
      File: virt-configuring-pci-passthrough
    - Name: Configuring virtual GPUs
      File: virt-configuring-virtual-gpus
    - Name: Configuring USB host passthrough
      File: virt-configuring-usb-host-passthrough
    - Name: Enabling descheduler evictions on virtual machines
      File: virt-enabling-descheduler-evictions
    - Name: About high availability for virtual machines
      File: virt-high-availability-for-vms
    - Name: Control plane tuning
      File: virt-vm-control-plane-tuning
    - Name: Assigning compute resources
      File: virt-assigning-compute-resources
    - Name: About multi-queue functionality
      File: virt-about-multi-queue
    - Name: Managing virtual machines by using OpenShift GitOps
      File: virt-managing-virtual-machines-by-using-openshift-gitops
    - Name: Working with NUMA topology for virtual machines
      File: virt-NUMA-topology
  - Name: VM disks
    Dir: virtual_disks
    Topics:
    - Name: Hot-plugging VM disks
      File: virt-hot-plugging-virtual-disks
    - Name: Expanding VM disks
      File: virt-expanding-vm-disks
    - Name: Configuring shared volumes
      File: virt-configuring-shared-volumes-for-vms
    - Name: Migrating VM disks to a different storage class
      File: virt-migrating-storage-class
    - Name: Inserting CD-ROMs in virtual machines
      File: virt-inserting-cd-roms-in-virtual-machines
- Name: Networking
  Dir: vm_networking
  Topics:
  - Name: Networking configuration overview
    File: virt-networking-overview
  - Name: Connecting a VM to the default pod network
    File: virt-connecting-vm-to-default-pod-network
  - Name: Connecting a VM to a primary user-defined network
    File: virt-connecting-vm-to-primary-udn
  - Name: Connecting a VM to a secondary localnet user-defined network
    File: virt-connecting-vm-to-secondary-udn
  - Name: Exposing a VM by using a service
    File: virt-exposing-vm-with-service
  - Name: Accessing a VM by using its internal FQDN
    File: virt-accessing-vm-internal-fqdn
  - Name: Connecting a VM to a Linux bridge network
    File: virt-connecting-vm-to-linux-bridge
  - Name: Connecting a VM to an SR-IOV network
    File: virt-connecting-vm-to-sriov
  - Name: Using DPDK with SR-IOV
    File: virt-using-dpdk-with-sriov
  - Name: Connecting a VM to an OVN-Kubernetes layer 2 secondary network
    File: virt-connecting-vm-to-ovn-secondary-network
  - Name: Hot plugging secondary network interfaces
    File: virt-hot-plugging-network-interfaces
  - Name: Setting VM interface link state
    File: virt-setting-interface-link-state
  - Name: Connecting a VM to a service mesh
    File: virt-connecting-vm-to-service-mesh
  - Name: Configuring physical networks
    File: virt-configuring-physical-networks
  - Name: Configuring a dedicated network for live migration
    File: virt-dedicated-network-live-migration
  - Name: Configuring and viewing IP addresses
    File: virt-configuring-viewing-ips-for-vms
  - Name: Accessing a VM by using its external FQDN
    File: virt-accessing-vm-secondary-network-fqdn
  - Name: Managing MAC address pools for network interfaces
    File: virt-using-mac-address-pool-for-vms
- Name: Storage
  Dir: storage
  Topics:
  - Name: Storage configuration overview
    File: virt-storage-config-overview
  - Name: Configuring storage profiles
    File: virt-configuring-storage-profile
  - Name: Managing automatic boot source updates
    File: virt-automatic-bootsource-updates
  - Name: Reserving PVC space for file system overhead
    File: virt-reserving-pvc-space-fs-overhead
  - Name: Configuring local storage by using HPP
    File: virt-configuring-local-storage-with-hpp
  - Name: Enabling user permissions to clone data volumes across namespaces
    File: virt-enabling-user-permissions-to-clone-datavolumes
  - Name: Configuring CDI to override CPU and memory quotas
    File: virt-configuring-cdi-for-namespace-resourcequota
  - Name: Preparing CDI scratch space
    File: virt-preparing-cdi-scratch-space
  - Name: Using preallocation for data volumes
    File: virt-using-preallocation-for-datavolumes
  - Name: Managing data volume annotations
    File: virt-managing-data-volume-annotations
  - Name: Understanding virtual machine storage with the CSI paradigm
    File: virt-storage-with-csi-paradigm
  - Name: Using OpenShift Virtualization with IBM Fusion Access for SAN
    File: install-configure-fusion-access-san
# Virtual machine live migration
- Name: Live migration
  Dir: live_migration
  Topics:
  - Name: About live migration
    File: virt-about-live-migration
  - Name: Configuring live migration
    File: virt-configuring-live-migration
  - Name: Initiating and canceling live migration
    File: virt-initiating-live-migration
  - Name: Configuring a cross-cluster live migration network
    File: virt-configuring-cross-cluster-live-migration-network
  - Name: About Migration Toolkit for Virtualization (MTV) providers
    File: virt-about-mtv-providers
  # Node maintenance mode
- Name: Nodes
  Dir: nodes
  Topics:
  - Name: Node maintenance mode
    File: virt-node-maintenance
  - Name: Configure eviction and run strategies
    File: virt-eviction-strategies
  - Name: Managing node labeling for obsolete CPU models
    File: virt-managing-node-labeling-obsolete-cpu-models
  - Name: Preventing node reconciliation
    File: virt-preventing-node-reconciliation
  - Name: Activating kernel samepage merging (KSM)
    File: virt-activating-ksm
- Name: Monitoring
  Dir: monitoring
  Topics:
  - Name: Monitoring overview
    File: virt-monitoring-overview
  - Name: Cluster checkup framework
    File: virt-running-cluster-checkups
  - Name: Storage checkups
    File: virt-storage-checkups
  - Name: Prometheus queries for virtual resources
    File: virt-prometheus-queries
  - Name: Virtual machine custom metrics
    File: virt-exposing-custom-metrics-for-vms
  - Name: Virtual machine downward metrics
    File: virt-exposing-downward-metrics
  - Name: Virtual machine health checks
    File: virt-monitoring-vm-health
  - Name: Runbooks
    File: virt-runbooks
- Name: Support
  Dir: support
  Topics:
  - Name: Support overview
    File: virt-support-overview
  - Name: Collecting data for Red Hat Support
    File: virt-collecting-virt-data
    Distros: openshift-enterprise
  - Name: Troubleshooting
    File: virt-troubleshooting
- Name: Backup and restore
  Dir: backup_restore
  Topics:
  - Name: Backup and restore by using VM snapshots
    File: virt-backup-restore-snapshots
  - Name: Backing up and restoring virtual machines
    File: virt-backup-restore-overview
  - Name: Disaster recovery
    File: virt-disaster-recovery
#  - Name: Collecting OKD Virtualization data for community report
#    File: virt-collecting-virt-data
#    Distros: openshift-origin