1
0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-07 09:46:53 +01:00
Files
openshift-docs/_artifacts/toc.yml
2022-03-29 11:30:15 -04:00

2717 lines
163 KiB
YAML

main-menu:
- name: About
items:
- name: OpenShift Container Platform 4.9 Documentation
path: welcome/index.adoc
- name: Learn more about OpenShift Container Platform
path: welcome/learn_more_about_openshift.adoc
- name: About OpenShift Kubernetes Engine
path: welcome/oke_about.adoc
- name: Legal notice
path: welcome/legal-notice.adoc
- name: Release notes
items:
- name: OpenShift Container Platform 4.9 release notes
path: release_notes/ocp-4-10-release-notes.adoc
- name: Architecture
items:
- name: Architecture overview
path: architecture/index.adoc
- name: OpenShift Container Platform architecture
path: architecture/architecture.adoc
- name: Installation and update
path: architecture/architecture-installation.adoc
- name: The OpenShift Container Platform control plane
path: architecture/control-plane.adoc
- name: Understanding OpenShift Container Platform development
path: architecture/understanding-development.adoc
- name: Red Hat Enterprise Linux CoreOS (RHCOS)
path: architecture/architecture-rhcos.adoc
- name: Admission plug-ins
path: architecture/admission-plug-ins.adoc
- name: Installing
items:
- name: OpenShift Container Platform installation overview
path: installing/index.adoc
- name: Selecting a cluster installation method and preparing it for users
path: installing/installing-preparing.adoc
- name: Mirroring images for a disconnected installation
path: installing/installing-mirroring-installation-images.adoc
- name: Installing on AWS
items:
- name: Preparing to install on AWS
path: installing/installing_aws/preparing-to-install-on-aws.adoc
- name: Configuring an AWS account
path: installing/installing_aws/installing-aws-account.adoc
- name: Manually creating IAM for AWS
path: installing/installing_aws/manually-creating-iam.adoc
- name: Installing a cluster quickly on AWS
path: installing/installing_aws/installing-aws-default.adoc
- name: Installing a cluster on AWS with customizations
path: installing/installing_aws/installing-aws-customizations.adoc
- name: Installing a cluster on AWS with network customizations
path: installing/installing_aws/installing-aws-network-customizations.adoc
- name: Installing a cluster on AWS in a restricted network
path: installing/installing_aws/installing-restricted-networks-aws-installer-provisioned.adoc
- name: Installing a cluster on AWS into an existing VPC
path: installing/installing_aws/installing-aws-vpc.adoc
- name: Installing a private cluster on AWS
path: installing/installing_aws/installing-aws-private.adoc
- name: Installing a cluster on AWS into a government or secret region
path: installing/installing_aws/installing-aws-government-region.adoc
- name: Installing a cluster on AWS China
path: installing/installing_aws/installing-aws-china.adoc
- name: Installing a cluster on user-provisioned infrastructure in AWS by using CloudFormation templates
path: installing/installing_aws/installing-aws-user-infra.adoc
- name: Installing a cluster on AWS in a restricted network with user-provisioned infrastructure
path: installing/installing_aws/installing-restricted-networks-aws.adoc
- name: Uninstalling a cluster on AWS
path: installing/installing_aws/uninstalling-cluster-aws.adoc
- name: Installing on Azure
items:
- name: Preparing to install on Azure
path: installing/installing_azure/preparing-to-install-on-azure.adoc
- name: Configuring an Azure account
path: installing/installing_azure/installing-azure-account.adoc
- name: Manually creating IAM for Azure
path: installing/installing_azure/manually-creating-iam-azure.adoc
- name: Installing a cluster quickly on Azure
path: installing/installing_azure/installing-azure-default.adoc
- name: Installing a cluster on Azure with customizations
path: installing/installing_azure/installing-azure-customizations.adoc
- name: Installing a cluster on Azure with network customizations
path: installing/installing_azure/installing-azure-network-customizations.adoc
- name: Installing a cluster on Azure into an existing VNet
path: installing/installing_azure/installing-azure-vnet.adoc
- name: Installing a private cluster on Azure
path: installing/installing_azure/installing-azure-private.adoc
- name: Installing a cluster on Azure into a government region
path: installing/installing_azure/installing-azure-government-region.adoc
- name: Installing a cluster on Azure using ARM templates
path: installing/installing_azure/installing-azure-user-infra.adoc
- name: Uninstalling a cluster on Azure
path: installing/installing_azure/uninstalling-cluster-azure.adoc
- name: Installing on Azure Stack Hub
items:
- name: Preparing to install on Azure Stack Hub
path: installing/installing_azure_stack_hub/preparing-to-install-on-azure-stack-hub.adoc
- name: Configuring an Azure Stack Hub account
path: installing/installing_azure_stack_hub/installing-azure-stack-hub-account.adoc
- name: Manually creating IAM for Azure Stack Hub
path: installing/installing_azure_stack_hub/manually-creating-iam-azure-stack-hub.adoc
- name: Installing a cluster on Azure Stack Hub using ARM templates
path: installing/installing_azure_stack_hub/installing-azure-stack-hub-user-infra.adoc
- name: Installing on GCP
items:
- name: Preparing to install on GCP
path: installing/installing_gcp/preparing-to-install-on-gcp.adoc
- name: Configuring a GCP project
path: installing/installing_gcp/installing-gcp-account.adoc
- name: Manually creating IAM for GCP
path: installing/installing_gcp/manually-creating-iam-gcp.adoc
- name: Installing a cluster quickly on GCP
path: installing/installing_gcp/installing-gcp-default.adoc
- name: Installing a cluster on GCP with customizations
path: installing/installing_gcp/installing-gcp-customizations.adoc
- name: Installing a cluster on GCP with network customizations
path: installing/installing_gcp/installing-gcp-network-customizations.adoc
- name: Installing a cluster on GCP in a restricted network
path: installing/installing_gcp/installing-restricted-networks-gcp-installer-provisioned.adoc
- name: Installing a cluster on GCP into an existing VPC
path: installing/installing_gcp/installing-gcp-vpc.adoc
- name: Installing a private cluster on GCP
path: installing/installing_gcp/installing-gcp-private.adoc
- name: Installing a cluster on user-provisioned infrastructure in GCP by using Deployment Manager templates
path: installing/installing_gcp/installing-gcp-user-infra.adoc
- name: Installing a cluster into a shared VPC on GCP using Deployment Manager templates
path: installing/installing_gcp/installing-gcp-user-infra-vpc.adoc
- name: Installing a cluster on GCP in a restricted network with user-provisioned infrastructure
path: installing/installing_gcp/installing-restricted-networks-gcp.adoc
- name: Uninstalling a cluster on GCP
path: installing/installing_gcp/uninstalling-cluster-gcp.adoc
- name: Installing on bare metal
items:
- name: Preparing for bare metal cluster installation
path: installing/installing_bare_metal/preparing-to-install-on-bare-metal.adoc
- name: Installing a user-provisioned cluster on bare metal
path: installing/installing_bare_metal/installing-bare-metal.adoc
- name: Installing a user-provisioned bare metal cluster with network customizations
path: installing/installing_bare_metal/installing-bare-metal-network-customizations.adoc
- name: Installing a user-provisioned bare metal cluster on a restricted network
path: installing/installing_bare_metal/installing-restricted-networks-bare-metal.adoc
- name: Installing on a single node
items:
- name: Preparing to install on a single node
path: installing/installing_sno/install-sno-preparing-to-install-sno.adoc
- name: Installing OpenShift on a single node
path: installing/installing_sno/install-sno-installing-sno.adoc
- name: Deploying installer-provisioned clusters on bare metal
items:
- name: Overview
path: installing/installing_bare_metal_ipi/ipi-install-overview.adoc
- name: Prerequisites
path: installing/installing_bare_metal_ipi/ipi-install-prerequisites.adoc
- name: Setting up the environment for an OpenShift installation
path: installing/installing_bare_metal_ipi/ipi-install-installation-workflow.adoc
- name: Installer-provisioned post-installation configuration
path: installing/installing_bare_metal_ipi/ipi-install-post-installation-configuration.adoc
- name: Expanding the cluster
path: installing/installing_bare_metal_ipi/ipi-install-expanding-the-cluster.adoc
- name: Troubleshooting
path: installing/installing_bare_metal_ipi/ipi-install-troubleshooting.adoc
- name: Deploying installer-provisioned clusters on IBM Cloud
items:
- name: Prerequisites
path: installing/installing_ibm_cloud/install-ibm-cloud-prerequisites.adoc
- name: Setting up the environment for an OpenShift Container Platform installation
path: installing/installing_ibm_cloud/install-ibm-cloud-installation-workflow.adoc
- name: Installing with z/VM on IBM Z and LinuxONE
items:
- name: Preparing to install with z/VM on IBM Z and LinuxONE
path: installing/installing_ibm_z/preparing-to-install-on-ibm-z.adoc
- name: Installing a cluster with z/VM on IBM Z and LinuxONE
path: installing/installing_ibm_z/installing-ibm-z.adoc
- name: Installing a cluster with z/VM on IBM Z and LinuxONE in a restricted network
path: installing/installing_ibm_z/installing-restricted-networks-ibm-z.adoc
- name: Installing with RHEL KVM on IBM Z and LinuxONE
items:
- name: Preparing to install with RHEL KVM on IBM Z and LinuxONE
path: installing/installing_ibm_z/preparing-to-install-on-ibm-z-kvm.adoc
- name: Installing a cluster with RHEL KVM on IBM Z and LinuxONE
path: installing/installing_ibm_z/installing-ibm-z-kvm.adoc
- name: Installing a cluster with RHEL KVM on IBM Z and LinuxONE in a restricted network
path: installing/installing_ibm_z/installing-restricted-networks-ibm-z-kvm.adoc
- name: Installing on IBM Power Systems
items:
- name: Preparing to install on IBM Power Systems
path: installing/installing_ibm_power/preparing-to-install-on-ibm-power.adoc
- name: Installing a cluster on IBM Power Systems
path: installing/installing_ibm_power/installing-ibm-power.adoc
- name: Installing a cluster on IBM Power Systems in a restricted network
path: installing/installing_ibm_power/installing-restricted-networks-ibm-power.adoc
- name: Installing on OpenStack
items:
- name: Preparing to install on OpenStack
path: installing/installing_openstack/preparing-to-install-on-openstack.adoc
- name: Installing a cluster on OpenStack with customizations
path: installing/installing_openstack/installing-openstack-installer-custom.adoc
- name: Installing a cluster on OpenStack with Kuryr
path: installing/installing_openstack/installing-openstack-installer-kuryr.adoc
- name: Installing a cluster on OpenStack that supports SR-IOV-connected compute machines
path: installing/installing_openstack/installing-openstack-installer-sr-iov.adoc
- name: Installing a cluster on OpenStack on your own infrastructure
path: installing/installing_openstack/installing-openstack-user.adoc
- name: Installing a cluster on OpenStack with Kuryr on your own infrastructure
path: installing/installing_openstack/installing-openstack-user-kuryr.adoc
- name: Installing a cluster on OpenStack on your own SR-IOV infrastructure
path: installing/installing_openstack/installing-openstack-user-sr-iov.adoc
- name: Installing a cluster on OpenStack in a restricted network
path: installing/installing_openstack/installing-openstack-installer-restricted.adoc
- name: Uninstalling a cluster on OpenStack
path: installing/installing_openstack/uninstalling-cluster-openstack.adoc
- name: Uninstalling a cluster on RHOSP from your own infrastructure
path: installing/installing_openstack/uninstalling-openstack-user.adoc
- name: Installing on RHV
items:
- name: Preparing to install on Red Hat Virtualization (RHV)
path: installing/installing_rhv/preparing-to-install-on-rhv.adoc
- name: Installing a cluster quickly on RHV
path: installing/installing_rhv/installing-rhv-default.adoc
- name: Installing a cluster on RHV with customizations
path: installing/installing_rhv/installing-rhv-customizations.adoc
- name: Installing a cluster on RHV with user-provisioned infrastructure
path: installing/installing_rhv/installing-rhv-user-infra.adoc
- name: Installing a cluster on RHV in a restricted network
path: installing/installing_rhv/installing-rhv-restricted-network.adoc
- name: Uninstalling a cluster on RHV
path: installing/installing_rhv/uninstalling-cluster-rhv.adoc
- name: Installing on vSphere
items:
- name: Preparing to install on vSphere
path: installing/installing_vsphere/preparing-to-install-on-vsphere.adoc
- name: Installing a cluster on vSphere
path: installing/installing_vsphere/installing-vsphere-installer-provisioned.adoc
- name: Installing a cluster on vSphere with customizations
path: installing/installing_vsphere/installing-vsphere-installer-provisioned-customizations.adoc
- name: Installing a cluster on vSphere with network customizations
path: installing/installing_vsphere/installing-vsphere-installer-provisioned-network-customizations.adoc
- name: Installing a cluster on vSphere with user-provisioned infrastructure
path: installing/installing_vsphere/installing-vsphere.adoc
- name: Installing a cluster on vSphere with network customizations
path: installing/installing_vsphere/installing-vsphere-network-customizations.adoc
- name: Installing a cluster on vSphere in a restricted network
path: installing/installing_vsphere/installing-restricted-networks-installer-provisioned-vsphere.adoc
- name: Installing a cluster on vSphere in a restricted network with user-provisioned infrastructure
path: installing/installing_vsphere/installing-restricted-networks-vsphere.adoc
- name: Uninstalling a cluster on vSphere that uses installer-provisioned infrastructure
path: installing/installing_vsphere/uninstalling-cluster-vsphere-installer-provisioned.adoc
- name: Using the vSphere Problem Detector Operator
path: installing/installing_vsphere/using-vsphere-problem-detector-operator.adoc
- name: Installing on VMC
items:
- name: Preparing to install on VMC
path: installing/installing_vmc/preparing-to-install-on-vmc.adoc
- name: Installing a cluster on VMC
path: installing/installing_vmc/installing-vmc.adoc
- name: Installing a cluster on VMC with customizations
path: installing/installing_vmc/installing-vmc-customizations.adoc
- name: Installing a cluster on VMC with network customizations
path: installing/installing_vmc/installing-vmc-network-customizations.adoc
- name: Installing a cluster on VMC in a restricted network
path: installing/installing_vmc/installing-restricted-networks-vmc.adoc
- name: Installing a cluster on VMC with user-provisioned infrastructure
path: installing/installing_vmc/installing-vmc-user-infra.adoc
- name: Installing a cluster on VMC with user-provisioned infrastructure and network customizations
path: installing/installing_vmc/installing-vmc-network-customizations-user-infra.adoc
- name: Installing a cluster on VMC in a restricted network with user-provisioned infrastructure
path: installing/installing_vmc/installing-restricted-networks-vmc-user-infra.adoc
- name: Uninstalling a cluster on VMC
path: installing/installing_vmc/uninstalling-cluster-vmc.adoc
- name: Installing on any platform
items:
- name: Installing a cluster on any platform
path: installing/installing_platform_agnostic/installing-platform-agnostic.adoc
- name: Installation configuration
items:
- name: Customizing nodes
path: installing/install_config/installing-customizing.adoc
- name: Configuring your firewall
path: installing/install_config/configuring-firewall.adoc
- name: Validating an installation
path: installing/validating-an-installation.adoc
- name: Troubleshooting installation issues
path: installing/installing-troubleshooting.adoc
- name: Support for FIPS cryptography
path: installing/installing-fips.adoc
- name: Post-installation configuration
items:
- name: Post-installation configuration overview
path: post_installation_configuration/index.adoc
- name: Configuring a private cluster
path: post_installation_configuration/configuring-private-cluster.adoc
- name: Post-installation machine configuration tasks
path: post_installation_configuration/machine-configuration-tasks.adoc
- name: Post-installation cluster tasks
path: post_installation_configuration/cluster-tasks.adoc
- name: Post-installation node tasks
path: post_installation_configuration/node-tasks.adoc
- name: Post-installation network configuration
path: post_installation_configuration/network-configuration.adoc
- name: Post-installation storage configuration
path: post_installation_configuration/storage-configuration.adoc
- name: Preparing for users
path: post_installation_configuration/preparing-for-users.adoc
- name: Configuring alert notifications
path: post_installation_configuration/configuring-alert-notifications.adoc
- name: Converting a connected cluster to a disconnected cluster
path: post_installation_configuration/connected-to-disconnected.adoc
- name: Updating clusters
items:
- name: Understanding the OpenShift Update Service
path: updating/understanding-the-update-service.adoc
- name: Installing and configuring the OpenShift Update Service
path: updating/installing-update-service.adoc
- name: Understanding upgrade channels and releases
path: updating/understanding-upgrade-channels-release.adoc
- name: Updating a cluster within a minor version using the web console
path: updating/updating-cluster-within-minor.adoc
- name: Updating a cluster within a minor version using the CLI
path: updating/updating-cluster-cli.adoc
- name: Performing a canary rollout update
path: updating/update-using-custom-machine-config-pools.adoc
- name: Updating a cluster that includes RHEL compute machines
path: updating/updating-cluster-rhel-compute.adoc
- name: Updating a restricted network cluster
path: updating/updating-restricted-network-cluster.adoc
- name: Updating hardware on nodes running on vSphere
path: updating/updating-hardware-on-nodes-running-on-vsphere.adoc
- name: Support
items:
- name: Support overview
path: support/index.adoc
- name: Managing your cluster resources
path: support/managing-cluster-resources.adoc
- name: Getting support
path: support/getting-support.adoc
- name: Remote health monitoring with connected clusters
items:
- name: About remote health monitoring
path: support/remote_health_monitoring/about-remote-health-monitoring.adoc
- name: Showing data collected by remote health monitoring
path: support/remote_health_monitoring/showing-data-collected-by-remote-health-monitoring.adoc
- name: Opting out of remote health reporting
path: support/remote_health_monitoring/opting-out-of-remote-health-reporting.adoc
- name: Enabling remote health reporting
path: support/remote_health_monitoring/enabling-remote-health-reporting.adoc
- name: Using Insights to identify issues with your cluster
path: support/remote_health_monitoring/using-insights-to-identify-issues-with-your-cluster.adoc
- name: Using remote health reporting in a restricted network
path: support/remote_health_monitoring/remote-health-reporting-from-restricted-network.adoc
- name: Importing RHEL Simple Content Access certificates with Insights Operator
path: support/remote_health_monitoring/insights-operator-simple-access.adoc
- name: Gathering data about your cluster
path: support/gathering-cluster-data.adoc
- name: Summarizing cluster specifications
path: support/summarizing-cluster-specifications.adoc
- name: Troubleshooting
items:
- name: Troubleshooting installations
path: support/troubleshooting/troubleshooting-installations.adoc
- name: Verifying node health
path: support/troubleshooting/verifying-node-health.adoc
- name: Troubleshooting CRI-O container runtime issues
path: support/troubleshooting/troubleshooting-crio-issues.adoc
- name: Troubleshooting operating system issues
path: support/troubleshooting/troubleshooting-operating-system-issues.adoc
- name: Troubleshooting network issues
path: support/troubleshooting/troubleshooting-network-issues.adoc
- name: Troubleshooting Operator issues
path: support/troubleshooting/troubleshooting-operator-issues.adoc
- name: Investigating pod issues
path: support/troubleshooting/investigating-pod-issues.adoc
- name: Troubleshooting the Source-to-Image process
path: support/troubleshooting/troubleshooting-s2i.adoc
- name: Troubleshooting storage issues
path: support/troubleshooting/troubleshooting-storage-issues.adoc
- name: Troubleshooting Windows container workload issues
path: support/troubleshooting/troubleshooting-windows-container-workload-issues.adoc
- name: Investigating monitoring issues
path: support/troubleshooting/investigating-monitoring-issues.adoc
- name: Diagnosing OpenShift CLI (<code>oc</code>) issues
path: support/troubleshooting/diagnosing-oc-issues.adoc
- name: Web console
items:
- name: Accessing the web console
path: web_console/web-console.adoc
- name: Using the OpenShift Container Platform dashboard to get cluster information
path: web_console/using-dashboard-to-get-cluster-information.adoc
- name: Adding user preferences
path: web_console/adding-user-preferences.adoc
- name: Configuring the web console in OpenShift Container Platform
path: web_console/configuring-web-console.adoc
- name: Customizing the web console in OpenShift Container Platform
path: web_console/customizing-the-web-console.adoc
- name: About the Developer perspective in the web console
path: web_console/odc-about-developer-perspective.adoc
- name: About the web terminal in the web console
path: web_console/odc-about-web-terminal.adoc
- name: Disabling the web console in OpenShift Container Platform
path: web_console/disabling-web-console.adoc
- name: Creating quick start tutorials in the web console
path: web_console/creating-quick-start-tutorials.adoc
- name: CLI tools
items:
- name: OpenShift Container Platform CLI tools overview
path: cli_reference/index.adoc
- name: OpenShift CLI (oc)
items:
- name: Getting started with the OpenShift CLI
path: cli_reference/openshift_cli/getting-started-cli.adoc
- name: Configuring the OpenShift CLI
path: cli_reference/openshift_cli/configuring-cli.adoc
- name: Extending the OpenShift CLI with plug-ins
path: cli_reference/openshift_cli/extending-cli-plugins.adoc
- name: OpenShift CLI developer command reference
path: cli_reference/openshift_cli/developer-cli-commands.adoc
- name: OpenShift CLI administrator command reference
path: cli_reference/openshift_cli/administrator-cli-commands.adoc
- name: Usage of oc and kubectl commands
path: cli_reference/openshift_cli/usage-oc-kubectl.adoc
- name: Developer CLI (odo)
items:
- name: <code>odo</code> release notes
path: cli_reference/developer_cli_odo/odo-release-notes.adoc
- name: Understanding odo
path: cli_reference/developer_cli_odo/understanding-odo.adoc
- name: Installing odo
path: cli_reference/developer_cli_odo/installing-odo.adoc
- name: Creating and deploying applications with odo
items:
- name: Working with projects
path: cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/working-with-projects.adoc
- name: Creating a single-component application with odo
path: cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/creating-a-single-component-application-with-odo.adoc
- name: Creating a multicomponent application with <code>odo</code>
path: cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/creating-a-multicomponent-application-with-odo.adoc
- name: Creating an application with a database
path: cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/creating-an-application-with-a-database.adoc
- name: Creating a Java application with a database
path: cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/creating-a-java-application-with-a-database.adoc
- name: Using devfiles in odo
path: cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/using-devfiles-in-odo.adoc
- name: Working with storage
path: cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/working-with-storage.adoc
- name: Deleting applications
path: cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/deleting-applications.adoc
- name: Debugging applications in <code>odo</code>
path: cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/debugging-applications-in-odo.adoc
- name: Sample applications
path: cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/sample-applications.adoc
- name: Using odo in a restricted environment
items:
- name: About odo in a restricted environment
path: cli_reference/developer_cli_odo/using_odo_in_a_restricted_environment/about-odo-in-a-restricted-environment.adoc
- name: Pushing the odo init image to the restricted cluster registry
path: cli_reference/developer_cli_odo/using_odo_in_a_restricted_environment/pushing-the-odo-init-image-to-the-restricted-cluster-registry.adoc
- name: Creating and deploying a component to the disconnected cluster
path: cli_reference/developer_cli_odo/using_odo_in_a_restricted_environment/creating-and-deploying-a-component-to-the-disconnected-cluster.adoc
- name: Creating and deploying devfile components to the disconnected cluster
path: cli_reference/developer_cli_odo/using_odo_in_a_restricted_environment/creating-and-deploying-devfile-components-to-the-disconnected-cluster.adoc
- name: Creating instances of services managed by Operators
path: cli_reference/developer_cli_odo/creating-instances-of-services-managed-by-operators.adoc
- name: Managing environment variables
path: cli_reference/developer_cli_odo/managing-environment-variables-in-odo.adoc
- name: Configuring the odo CLI
path: cli_reference/developer_cli_odo/configuring-the-odo-cli.adoc
- name: odo CLI reference
path: cli_reference/developer_cli_odo/odo-cli-reference.adoc
- name: odo architecture
path: cli_reference/developer_cli_odo/odo-architecture.adoc
- name: Knative CLI (kn) for use with OpenShift Serverless
path: cli_reference/kn-cli-tools.adoc
- name: Pipelines CLI (tkn)
items:
- name: Installing tkn
path: cli_reference/tkn_cli/installing-tkn.adoc
- name: Configuring the OpenShift Pipelines tkn CLI
path: cli_reference/tkn_cli/op-configuring-tkn.adoc
- name: OpenShift Pipelines tkn reference
path: cli_reference/tkn_cli/op-tkn-reference.adoc
- name: opm CLI
items:
- name: Installing the opm CLI
path: cli_reference/opm/cli-opm-install.adoc
- name: opm CLI reference
path: cli_reference/opm/cli-opm-ref.adoc
- name: Operator SDK
items:
- name: Installing the Operator SDK CLI
path: cli_reference/osdk/cli-osdk-install.adoc
- name: Operator SDK CLI reference
path: cli_reference/osdk/cli-osdk-ref.adoc
- name: Security and compliance
items:
- name: OpenShift Container Platform security and compliance
path: security/index.adoc
- name: Container security
items:
- name: Understanding container security
path: security/container_security/security-understanding.adoc
- name: Understanding host and VM security
path: security/container_security/security-hosts-vms.adoc
- name: Hardening RHCOS
path: security/container_security/security-hardening.adoc
- name: Container image signatures
path: security/container_security/security-container-signature.adoc
- name: Understanding compliance
path: security/container_security/security-compliance.adoc
- name: Securing container content
path: security/container_security/security-container-content.adoc
- name: Using container registries securely
path: security/container_security/security-registries.adoc
- name: Securing the build process
path: security/container_security/security-build.adoc
- name: Deploying containers
path: security/container_security/security-deploy.adoc
- name: Securing the container platform
path: security/container_security/security-platform.adoc
- name: Securing networks
path: security/container_security/security-network.adoc
- name: Securing attached storage
path: security/container_security/security-storage.adoc
- name: Monitoring cluster events and logs
path: security/container_security/security-monitoring.adoc
- name: Configuring certificates
items:
- name: Replacing the default ingress certificate
path: security/certificates/replacing-default-ingress-certificate.adoc
- name: Adding API server certificates
path: security/certificates/api-server.adoc
- name: Securing service traffic using service serving certificate secrets
path: security/certificates/service-serving-certificate.adoc
- name: Certificate types and descriptions
items:
- name: User-provided certificates for the API server
path: security/certificate_types_descriptions/user-provided-certificates-for-api-server.adoc
- name: Proxy certificates
path: security/certificate_types_descriptions/proxy-certificates.adoc
- name: Service CA certificates
path: security/certificate_types_descriptions/service-ca-certificates.adoc
- name: Node certificates
path: security/certificate_types_descriptions/node-certificates.adoc
- name: Bootstrap certificates
path: security/certificate_types_descriptions/bootstrap-certificates.adoc
- name: etcd certificates
path: security/certificate_types_descriptions/etcd-certificates.adoc
- name: OLM certificates
path: security/certificate_types_descriptions/olm-certificates.adoc
- name: User-provided certificates for default ingress
path: security/certificate_types_descriptions/user-provided-certificates-for-default-ingress.adoc
- name: Ingress certificates
path: security/certificate_types_descriptions/ingress-certificates.adoc
- name: Monitoring and OpenShift Logging Operator component certificates
path: security/certificate_types_descriptions/monitoring-and-cluster-logging-operator-component-certificates.adoc
- name: Control plane certificates
path: security/certificate_types_descriptions/control-plane-certificates.adoc
- name: Compliance Operator
items:
- name: Compliance Operator release notes
path: security/compliance_operator/compliance-operator-release-notes.adoc
- name: Supported compliance profiles
path: security/compliance_operator/compliance-operator-supported-profiles.adoc
- name: Installing the Compliance Operator
path: security/compliance_operator/compliance-operator-installation.adoc
- name: Compliance Operator scans
path: security/compliance_operator/compliance-scans.adoc
- name: Understanding the Compliance Operator
path: security/compliance_operator/compliance-operator-understanding.adoc
- name: Managing the Compliance Operator
path: security/compliance_operator/compliance-operator-manage.adoc
- name: Tailoring the Compliance Operator
path: security/compliance_operator/compliance-operator-tailor.adoc
- name: Retrieving Compliance Operator raw results
path: security/compliance_operator/compliance-operator-raw-results.adoc
- name: Managing Compliance Operator remediation
path: security/compliance_operator/compliance-operator-remediation.adoc
- name: Performing advanced Compliance Operator tasks
path: security/compliance_operator/compliance-operator-advanced.adoc
- name: Troubleshooting the Compliance Operator
path: security/compliance_operator/compliance-operator-troubleshooting.adoc
- name: Uninstalling the Compliance Operator
path: security/compliance_operator/compliance-operator-uninstallation.adoc
- name: Using the oc-compliance plug-in
path: security/compliance_operator/oc-compliance-plug-in-using.adoc
- name: File Integrity Operator
items:
- name: File Integrity Operator release notes
path: security/file_integrity_operator/file-integrity-operator-release-notes.adoc
- name: Installing the File Integrity Operator
path: security/file_integrity_operator/file-integrity-operator-installation.adoc
- name: Understanding the File Integrity Operator
path: security/file_integrity_operator/file-integrity-operator-understanding.adoc
- name: Configuring the Custom File Integrity Operator
path: security/file_integrity_operator/file-integrity-operator-configuring.adoc
- name: Performing advanced Custom File Integrity Operator tasks
path: security/file_integrity_operator/file-integrity-operator-advanced-usage.adoc
- name: Troubleshooting the File Integrity Operator
path: security/file_integrity_operator/file-integrity-operator-troubleshooting.adoc
- name: Viewing audit logs
path: security/audit-log-view.adoc
- name: Configuring the audit log policy
path: security/audit-log-policy-config.adoc
- name: Configuring TLS security profiles
path: security/tls-security-profiles.adoc
- name: Configuring seccomp profiles
path: security/seccomp-profiles.adoc
- name: Allowing JavaScript-based access to the API server from additional hosts
path: security/allowing-javascript-access-api-server.adoc
- name: Encrypting etcd data
path: security/encrypting-etcd.adoc
- name: Scanning pods for vulnerabilities
path: security/pod-vulnerability-scan.adoc
- name: Network-Bound Disk Encryption (NBDE)
items:
- name: About disk encryption technology
path: security/network_bound_disk_encryption/nbde-about-disk-encryption-technology.adoc
- name: Tang server installation considerations
path: security/network_bound_disk_encryption/nbde-tang-server-installation-considerations.adoc
- name: Tang server encryption key management
path: security/network_bound_disk_encryption/nbde-managing-encryption-keys.adoc
- name: Disaster recovery considerations
path: security/network_bound_disk_encryption/nbde-disaster-recovery-considerations.adoc
- name: Authentication and authorization
items:
- name: Understanding authentication
path: authentication/understanding-authentication.adoc
- name: Configuring the internal OAuth server
path: authentication/configuring-internal-oauth.adoc
- name: Configuring OAuth clients
path: authentication/configuring-oauth-clients.adoc
- name: Managing user-owned OAuth access tokens
path: authentication/managing-oauth-access-tokens.adoc
- name: Understanding identity provider configuration
path: authentication/understanding-identity-provider.adoc
- name: Configuring identity providers
items:
- name: Configuring an HTPasswd identity provider
path: authentication/identity_providers/configuring-htpasswd-identity-provider.adoc
- name: Configuring a Keystone identity provider
path: authentication/identity_providers/configuring-keystone-identity-provider.adoc
- name: Configuring an LDAP identity provider
path: authentication/identity_providers/configuring-ldap-identity-provider.adoc
- name: Configuring a basic authentication identity provider
path: authentication/identity_providers/configuring-basic-authentication-identity-provider.adoc
- name: Configuring a request header identity provider
path: authentication/identity_providers/configuring-request-header-identity-provider.adoc
- name: Configuring a GitHub or GitHub Enterprise identity provider
path: authentication/identity_providers/configuring-github-identity-provider.adoc
- name: Configuring a GitLab identity provider
path: authentication/identity_providers/configuring-gitlab-identity-provider.adoc
- name: Configuring a Google identity provider
path: authentication/identity_providers/configuring-google-identity-provider.adoc
- name: Configuring a OpenID Connect identity provider
path: authentication/identity_providers/configuring-oidc-identity-provider.adoc
- name: Using RBAC to define and apply permissions
path: authentication/using-rbac.adoc
- name: Removing the kubeadmin user
path: authentication/remove-kubeadmin.adoc
- name: Understanding and creating service accounts
path: authentication/understanding-and-creating-service-accounts.adoc
- name: Using service accounts in applications
path: authentication/using-service-accounts-in-applications.adoc
- name: Using a service account as an OAuth client
path: authentication/using-service-accounts-as-oauth-client.adoc
- name: Scoping tokens
path: authentication/tokens-scoping.adoc
- name: Using bound service account tokens
path: authentication/bound-service-account-tokens.adoc
- name: Managing security context constraints
path: authentication/managing-security-context-constraints.adoc
- name: Impersonating the system:admin user
path: authentication/impersonating-system-admin.adoc
- name: Syncing LDAP groups
path: authentication/ldap-syncing.adoc
- name: Managing cloud provider credentials
items:
- name: About the Cloud Credential Operator
path: authentication/managing_cloud_provider_credentials/about-cloud-credential-operator.adoc
- name: Using mint mode
path: authentication/managing_cloud_provider_credentials/cco-mode-mint.adoc
- name: Using passthrough mode
path: authentication/managing_cloud_provider_credentials/cco-mode-passthrough.adoc
- name: Using manual mode
path: authentication/managing_cloud_provider_credentials/cco-mode-manual.adoc
- name: Using manual mode with STS
path: authentication/managing_cloud_provider_credentials/cco-mode-sts.adoc
- name: Networking
items:
- name: Understanding networking
path: networking/understanding-networking.adoc
- name: Accessing hosts
path: networking/accessing-hosts.adoc
- name: Cluster Network Operator in OpenShift Container Platform
path: networking/cluster-network-operator.adoc
- name: DNS Operator in OpenShift Container Platform
path: networking/dns-operator.adoc
- name: Ingress Operator in OpenShift Container Platform
path: networking/ingress-operator.adoc
- name: Verifying connectivity to an endpoint
path: networking/verifying-connectivity-endpoint.adoc
- name: Configuring the node port service range
path: networking/configuring-node-port-service-range.adoc
- name: Configuring IP failover
path: networking/configuring-ipfailover.adoc
- name: Using the Stream Control Transmission Protocol (SCTP) on a bare metal cluster
path: networking/using-sctp.adoc
- name: Using PTP hardware
path: networking/using-ptp.adoc
- name: Network policy
items:
- name: About network policy
path: networking/network_policy/about-network-policy.adoc
- name: Logging network policy events
path: networking/network_policy/logging-network-policy.adoc
- name: Creating a network policy
path: networking/network_policy/creating-network-policy.adoc
- name: Viewing a network policy
path: networking/network_policy/viewing-network-policy.adoc
- name: Editing a network policy
path: networking/network_policy/editing-network-policy.adoc
- name: Deleting a network policy
path: networking/network_policy/deleting-network-policy.adoc
- name: Defining a default network policy for projects
path: networking/network_policy/default-network-policy.adoc
- name: Configuring multitenant isolation with network policy
path: networking/network_policy/multitenant-network-policy.adoc
- name: Multiple networks
items:
- name: Understanding multiple networks
path: networking/multiple_networks/understanding-multiple-networks.adoc
- name: Configuring an additional network
path: networking/multiple_networks/configuring-additional-network.adoc
- name: About virtual routing and forwarding
path: networking/multiple_networks/about-virtual-routing-and-forwarding.adoc
- name: Configuring multi-network policy
path: networking/multiple_networks/configuring-multi-network-policy.adoc
- name: Attaching a pod to an additional network
path: networking/multiple_networks/attaching-pod.adoc
- name: Removing a pod from an additional network
path: networking/multiple_networks/removing-pod.adoc
- name: Editing an additional network
path: networking/multiple_networks/edit-additional-network.adoc
- name: Removing an additional network
path: networking/multiple_networks/remove-additional-network.adoc
- name: Assigning a secondary network to a VRF
path: networking/multiple_networks/assigning-a-secondary-network-to-a-vrf.adoc
- name: Hardware networks
items:
- name: About Single Root I/O Virtualization (SR-IOV) hardware networks
path: networking/hardware_networks/about-sriov.adoc
- name: Installing the SR-IOV Network Operator
path: networking/hardware_networks/installing-sriov-operator.adoc
- name: Configuring the SR-IOV Network Operator
path: networking/hardware_networks/configuring-sriov-operator.adoc
- name: Configuring an SR-IOV network device
path: networking/hardware_networks/configuring-sriov-device.adoc
- name: Configuring an SR-IOV Ethernet network attachment
path: networking/hardware_networks/configuring-sriov-net-attach.adoc
- name: Configuring an SR-IOV InfiniBand network attachment
path: networking/hardware_networks/configuring-sriov-ib-attach.adoc
- name: Adding a pod to an SR-IOV additional network
path: networking/hardware_networks/add-pod.adoc
- name: Using high performance multicast
path: networking/hardware_networks/using-sriov-multicast.adoc
- name: Using DPDK and RDMA
path: networking/hardware_networks/using-dpdk-and-rdma.adoc
- name: OpenShift SDN default CNI network provider
items:
- name: About the OpenShift SDN default CNI network provider
path: networking/openshift_sdn/about-openshift-sdn.adoc
- name: Configuring egress IPs for a project
path: networking/openshift_sdn/assigning-egress-ips.adoc
- name: Configuring an egress firewall for a project
path: networking/openshift_sdn/configuring-egress-firewall.adoc
- name: Editing an egress firewall for a project
path: networking/openshift_sdn/viewing-egress-firewall.adoc
- name: Editing an egress firewall for a project
path: networking/openshift_sdn/editing-egress-firewall.adoc
- name: Removing an egress firewall from a project
path: networking/openshift_sdn/removing-egress-firewall.adoc
- name: Considerations for the use of an egress router pod
path: networking/openshift_sdn/using-an-egress-router.adoc
- name: Deploying an egress router pod in redirect mode
path: networking/openshift_sdn/deploying-egress-router-layer3-redirection.adoc
- name: Deploying an egress router pod in HTTP proxy mode
path: networking/openshift_sdn/deploying-egress-router-http-redirection.adoc
- name: Deploying an egress router pod in DNS proxy mode
path: networking/openshift_sdn/deploying-egress-router-dns-redirection.adoc
- name: Configuring an egress router pod destination list from a config map
path: networking/openshift_sdn/configuring-egress-router-configmap.adoc
- name: Enabling multicast for a project
path: networking/openshift_sdn/enabling-multicast.adoc
- name: Disabling multicast for a project
path: networking/openshift_sdn/disabling-multicast.adoc
- name: Configuring network isolation using OpenShift SDN
path: networking/openshift_sdn/multitenant-isolation.adoc
- name: Configuring kube-proxy
path: networking/openshift_sdn/configuring-kube-proxy.adoc
- name: OVN-Kubernetes default CNI network provider
items:
- name: About the OVN-Kubernetes default Container Network Interface (CNI) network provider
path: networking/ovn_kubernetes_network_provider/about-ovn-kubernetes.adoc
- name: Migrating from the OpenShift SDN cluster network provider
path: networking/ovn_kubernetes_network_provider/migrate-from-openshift-sdn.adoc
- name: Rolling back to the OpenShift SDN network provider
path: networking/ovn_kubernetes_network_provider/rollback-to-openshift-sdn.adoc
- name: Converting to IPv4/IPv6 dual-stack networking
path: networking/ovn_kubernetes_network_provider/converting-to-dual-stack.adoc
- name: IPsec encryption configuration
path: networking/ovn_kubernetes_network_provider/about-ipsec-ovn.adoc
- name: Configuring an egress firewall for a project
path: networking/ovn_kubernetes_network_provider/configuring-egress-firewall-ovn.adoc
- name: Viewing an egress firewall for a project
path: networking/ovn_kubernetes_network_provider/viewing-egress-firewall-ovn.adoc
- name: Editing an egress firewall for a project
path: networking/ovn_kubernetes_network_provider/editing-egress-firewall-ovn.adoc
- name: Removing an egress firewall from a project
path: networking/ovn_kubernetes_network_provider/removing-egress-firewall-ovn.adoc
- name: Configuring an egress IP address
path: networking/ovn_kubernetes_network_provider/configuring-egress-ips-ovn.adoc
- name: Assigning an egress IP address
path: networking/ovn_kubernetes_network_provider/assigning-egress-ips-ovn.adoc
- name: Considerations for the use of an egress router pod
path: networking/ovn_kubernetes_network_provider/using-an-egress-router-ovn.adoc
- name: Deploying an egress router pod in redirect mode
path: networking/ovn_kubernetes_network_provider/deploying-egress-router-ovn-redirection.adoc
- name: Enabling multicast for a project
path: networking/ovn_kubernetes_network_provider/enabling-multicast.adoc
- name: Disabling multicast for a project
path: networking/ovn_kubernetes_network_provider/disabling-multicast.adoc
- name: Tracking network flows
path: networking/ovn_kubernetes_network_provider/tracking-network-flows.adoc
- name: Configuring hybrid networking
path: networking/ovn_kubernetes_network_provider/configuring-hybrid-networking.adoc
- name: Configuring Routes
items:
- name: Route configuration
path: networking/routes/route-configuration.adoc
- name: Secured routes
path: networking/routes/secured-routes.adoc
- name: Configuring ingress cluster traffic
items:
- name: Configuring ingress cluster traffic overview
path: networking/configuring_ingress_cluster_traffic/overview-traffic.adoc
- name: Configuring ExternalIPs for services
path: networking/configuring_ingress_cluster_traffic/configuring-externalip.adoc
- name: Configuring ingress cluster traffic using an Ingress Controller
path: networking/configuring_ingress_cluster_traffic/configuring-ingress-cluster-traffic-ingress-controller.adoc
- name: Configuring ingress cluster traffic using a load balancer
path: networking/configuring_ingress_cluster_traffic/configuring-ingress-cluster-traffic-load-balancer.adoc
- name: Configuring ingress cluster traffic on AWS using a Network Load Balancer
path: networking/configuring_ingress_cluster_traffic/configuring-ingress-cluster-traffic-aws-network-load-balancer.adoc
- name: Configuring ingress cluster traffic for a service external IP
path: networking/configuring_ingress_cluster_traffic/configuring-ingress-cluster-traffic-service-external-ip.adoc
- name: Configuring ingress cluster traffic using a NodePort
path: networking/configuring_ingress_cluster_traffic/configuring-ingress-cluster-traffic-nodeport.adoc
- name: Kubernetes NMState
items:
- name: About the Kubernetes NMState Operator
path: networking/k8s_nmstate/k8s-nmstate-about-the-k8s-nmstate-operator.adoc
- name: Observing node network state
path: networking/k8s_nmstate/k8s-nmstate-observing-node-network-state.adoc
- name: Updating node network configuration
path: networking/k8s_nmstate/k8s-nmstate-updating-node-network-config.adoc
- name: Troubleshooting node network configuration
path: networking/k8s_nmstate/k8s-nmstate-troubleshooting-node-network.adoc
- name: Configuring the cluster-wide proxy
path: networking/enable-cluster-wide-proxy.adoc
- name: Configuring a custom PKI
path: networking/configuring-a-custom-pki.adoc
- name: Load balancing on RHOSP
path: networking/load-balancing-openstack.adoc
- name: Load balancing with MetalLB
items:
- name: About MetalLB and the MetalLB Operator
path: networking/metallb/about-metallb.adoc
- name: Installing the MetalLB Operator
path: networking/metallb/metallb-operator-install.adoc
- name: Configuring MetalLB address pools
path: networking/metallb/metallb-configure-address-pools.adoc
- name: Configuring services to use MetalLB
path: networking/metallb/metallb-configure-services.adoc
- name: Associating secondary interfaces metrics to network attachments
path: networking/associating-secondary-interfaces-metrics-to-network-attachments.adoc
- name: Storage
items:
- name: OpenShift Container Platform storage overview
path: storage/index.adoc
- name: Understanding ephemeral storage
path: storage/understanding-ephemeral-storage.adoc
- name: Understanding persistent storage
path: storage/understanding-persistent-storage.adoc
- name: Configuring persistent storage
items:
- name: Persistent storage using AWS Elastic Block Store
path: storage/persistent_storage/persistent-storage-aws.adoc
- name: Persistent storage using Azure
path: storage/persistent_storage/persistent-storage-azure.adoc
- name: Persistent storage using Azure File
path: storage/persistent_storage/persistent-storage-azure-file.adoc
- name: Persistent storage using Cinder
path: storage/persistent_storage/persistent-storage-cinder.adoc
- name: Persistent storage using Fibre Channel
path: storage/persistent_storage/persistent-storage-fibre.adoc
- name: Persistent storage using FlexVolume
path: storage/persistent_storage/persistent-storage-flexvolume.adoc
- name: Persistent storage using GCE Persistent Disk
path: storage/persistent_storage/persistent-storage-gce.adoc
- name: Persistent storage using hostPath
path: storage/persistent_storage/persistent-storage-hostpath.adoc
- name: Persistent storage using iSCSI
path: storage/persistent_storage/persistent-storage-iscsi.adoc
- name: Persistent storage using local volumes
path: storage/persistent_storage/persistent-storage-local.adoc
- name: Persistent storage using NFS
path: storage/persistent_storage/persistent-storage-nfs.adoc
- name: Red Hat OpenShift Container Storage
path: storage/persistent_storage/persistent-storage-ocs.adoc
- name: Persistent storage using VMware vSphere volumes
path: storage/persistent_storage/persistent-storage-vsphere.adoc
- name: Using Container Storage Interface (CSI)
items:
- name: Configuring CSI volumes
path: storage/container_storage_interface/persistent-storage-csi.adoc
- name: CSI inline ephemeral volumes
path: storage/container_storage_interface/ephemeral-storage-csi-inline.adoc
- name: CSI volume snapshots
path: storage/container_storage_interface/persistent-storage-csi-snapshots.adoc
- name: CSI volume cloning
path: storage/container_storage_interface/persistent-storage-csi-cloning.adoc
- name: CSI automatic migration
path: storage/container_storage_interface/persistent-storage-csi-migration.adoc
- name: AWS Elastic Block Store CSI Driver Operator
path: storage/container_storage_interface/persistent-storage-csi-ebs.adoc
- name: AWS Elastic File Service CSI Driver Operator
path: storage/container_storage_interface/persistent-storage-csi-aws-efs.adoc
- name: Azure Disk CSI Driver Operator
path: storage/container_storage_interface/persistent-storage-csi-azure.adoc
- name: Azure Stack Hub CSI Driver Operator
path: storage/container_storage_interface/persistent-storage-csi-azure-stack-hub.adoc
- name: GCP PD CSI Driver Operator
path: storage/container_storage_interface/persistent-storage-csi-gcp-pd.adoc
- name: OpenStack Cinder CSI Driver Operator
path: storage/container_storage_interface/persistent-storage-csi-cinder.adoc
- name: OpenStack Manila CSI Driver Operator
path: storage/container_storage_interface/persistent-storage-csi-manila.adoc
- name: Red Hat Virtualization CSI Driver Operator
path: storage/container_storage_interface/persistent-storage-csi-ovirt.adoc
- name: VMware vSphere CSI Driver Operator
path: storage/container_storage_interface/persistent-storage-csi-vsphere.adoc
- name: Expanding persistent volumes
path: storage/expanding-persistent-volumes.adoc
- name: Dynamic provisioning
path: storage/dynamic-provisioning.adoc
- name: Registry
items:
- name: OpenShift Container Platform registry overview
path: registry/index.adoc
- name: Image Registry Operator in OpenShift Container Platform
path: registry/configuring-registry-operator.adoc
- name: Setting up and configuring the registry
items:
- name: Configuring the registry for AWS user-provisioned infrastructure
path: registry/configuring_registry_storage/configuring-registry-storage-aws-user-infrastructure.adoc
- name: Configuring the registry for GCP user-provisioned infrastructure
path: registry/configuring_registry_storage/configuring-registry-storage-gcp-user-infrastructure.adoc
- name: Configuring the registry for Azure user-provisioned infrastructure
path: registry/configuring_registry_storage/configuring-registry-storage-azure-user-infrastructure.adoc
- name: Configuring the registry for RHOSP
path: registry/configuring_registry_storage/configuring-registry-storage-osp.adoc
- name: Configuring the registry for bare metal
path: registry/configuring_registry_storage/configuring-registry-storage-baremetal.adoc
- name: Configuring the registry for vSphere
path: registry/configuring_registry_storage/configuring-registry-storage-vsphere.adoc
- name: Accessing the registry
path: registry/accessing-the-registry.adoc
- name: Exposing the registry
path: registry/securing-exposing-registry.adoc
- name: Operators
items:
- name: Understanding Operators
items:
- name: What are Operators?
path: operators/understanding/olm-what-operators-are.adoc
- name: Operator Framework packaging format
path: operators/understanding/olm-packaging-format.adoc
- name: Operator Framework glossary of common terms
path: operators/understanding/olm-common-terms.adoc
- name: Operator Lifecycle Manager (OLM)
items:
- name: Operator Lifecycle Manager concepts and resources
path: operators/understanding/olm/olm-understanding-olm.adoc
- name: Operator Lifecycle Manager architecture
path: operators/understanding/olm/olm-arch.adoc
- name: Operator Lifecycle Manager workflow
path: operators/understanding/olm/olm-workflow.adoc
- name: Operator Lifecycle Manager dependency resolution
path: operators/understanding/olm/olm-understanding-dependency-resolution.adoc
- name: Operator groups
path: operators/understanding/olm/olm-understanding-operatorgroups.adoc
- name: Operator conditions
path: operators/understanding/olm/olm-operatorconditions.adoc
- name: Operator Lifecycle Manager metrics
path: operators/understanding/olm/olm-understanding-metrics.adoc
- name: Webhook management in Operator Lifecycle Manager
path: operators/understanding/olm/olm-webhooks.adoc
- name: Understanding OperatorHub
path: operators/understanding/olm-understanding-operatorhub.adoc
- name: Red Hat-provided Operator catalogs
path: operators/understanding/olm-rh-catalogs.adoc
- name: CRDs
items:
- name: Extending the Kubernetes API with custom resource definitions
path: operators/understanding/crds/crd-extending-api-with-crds.adoc
- name: Managing resources from custom resource definitions
path: operators/understanding/crds/crd-managing-resources-from-crds.adoc
- name: User tasks
items:
- name: Creating applications from installed Operators
path: operators/user/olm-creating-apps-from-installed-operators.adoc
- name: Installing Operators in your namespace
path: operators/user/olm-installing-operators-in-namespace.adoc
- name: Administrator tasks
items:
- name: Adding Operators to a cluster
path: operators/admin/olm-adding-operators-to-cluster.adoc
- name: Upgrading installed Operators
path: operators/admin/olm-upgrading-operators.adoc
- name: Deleting Operators from a cluster
path: operators/admin/olm-deleting-operators-from-cluster.adoc
- name: Configuring proxy support in Operator Lifecycle Manager
path: operators/admin/olm-configuring-proxy-support.adoc
- name: Viewing Operator status
path: operators/admin/olm-status.adoc
- name: Managing Operator conditions
path: operators/admin/olm-managing-operatorconditions.adoc
- name: Allowing non-cluster administrators to install Operators
path: operators/admin/olm-creating-policy.adoc
- name: Managing custom catalogs
path: operators/admin/olm-managing-custom-catalogs.adoc
- name: Using Operator Lifecycle Manager on restricted networks
path: operators/admin/olm-restricted-networks.adoc
- name: Developing Operators
items:
- name: About the Operator SDK
path: operators/operator_sdk/osdk-about.adoc
- name: Installing the Operator SDK CLI
path: operators/operator_sdk/osdk-installing-cli.adoc
- name: Upgrading projects for newer Operator SDK versions
path: operators/operator_sdk/osdk-upgrading-projects.adoc
- name: Go-based Operators
items:
- name: Getting started with Operator SDK for Go-based Operators
path: operators/operator_sdk/golang/osdk-golang-quickstart.adoc
- name: Operator SDK tutorial for Go-based Operators
path: operators/operator_sdk/golang/osdk-golang-tutorial.adoc
- name: Project layout for Go-based Operators
path: operators/operator_sdk/golang/osdk-golang-project-layout.adoc
- name: Ansible-based Operators
items:
- name: Getting started with Operator SDK for Ansible-based Operators
path: operators/operator_sdk/ansible/osdk-ansible-quickstart.adoc
- name: Operator SDK tutorial for Ansible-based Operators
path: operators/operator_sdk/ansible/osdk-ansible-tutorial.adoc
- name: Project layout for Ansible-based Operators
path: operators/operator_sdk/ansible/osdk-ansible-project-layout.adoc
- name: Ansible support in Operator SDK
path: operators/operator_sdk/ansible/osdk-ansible-support.adoc
- name: Kubernetes Collection for Ansible
path: operators/operator_sdk/ansible/osdk-ansible-k8s-collection.adoc
- name: Using Ansible inside an Operator
path: operators/operator_sdk/ansible/osdk-ansible-inside-operator.adoc
- name: Custom resource status management
path: operators/operator_sdk/ansible/osdk-ansible-cr-status.adoc
- name: Helm-based Operators
items:
- name: Getting started with Operator SDK for Helm-based Operators
path: operators/operator_sdk/helm/osdk-helm-quickstart.adoc
- name: Operator SDK tutorial for Helm-based Operators
path: operators/operator_sdk/helm/osdk-helm-tutorial.adoc
- name: Project layout for Helm-based Operators
path: operators/operator_sdk/helm/osdk-helm-project-layout.adoc
- name: Helm support in Operator SDK
path: operators/operator_sdk/helm/osdk-helm-support.adoc
- name: Defining cluster service versions (CSVs)
path: operators/operator_sdk/osdk-generating-csvs.adoc
- name: Working with bundle images
path: operators/operator_sdk/osdk-working-bundle-images.adoc
- name: Validating Operators using the scorecard tool
path: operators/operator_sdk/osdk-scorecard.adoc
- name: High-availability or single node cluster detection and support
path: operators/operator_sdk/osdk-ha-sno.adoc
- name: Configuring built-in monitoring with Prometheus
path: operators/operator_sdk/osdk-monitoring-prometheus.adoc
- name: Configuring leader election
path: operators/operator_sdk/osdk-leader-election.adoc
- name: Migrating package manifest projects to bundle format
path: operators/operator_sdk/osdk-pkgman-to-bundle.adoc
- name: Operator SDK CLI reference
path: operators/operator_sdk/osdk-cli-ref.adoc
- name: Red Hat Operators
path: operators/operator-reference.adoc
- name: CI/CD
items:
- name: Builds
items:
- name: Understanding image builds
path: cicd/builds/understanding-image-builds.adoc
- name: Understanding build configurations
path: cicd/builds/understanding-buildconfigs.adoc
- name: Creating build inputs
path: cicd/builds/creating-build-inputs.adoc
- name: Managing build output
path: cicd/builds/managing-build-output.adoc
- name: Using build strategies
path: cicd/builds/build-strategies.adoc
- name: Custom image builds with Buildah
path: cicd/builds/custom-builds-buildah.adoc
- name: Performing and configuring basic builds
path: cicd/builds/basic-build-operations.adoc
- name: Triggering and modifying builds
path: cicd/builds/triggering-builds-build-hooks.adoc
- name: Performing advanced builds
path: cicd/builds/advanced-build-operations.adoc
- name: Using Red Hat subscriptions in builds
path: cicd/builds/running-entitled-builds.adoc
- name: Securing builds by strategy
path: cicd/builds/securing-builds-by-strategy.adoc
- name: Build configuration resources
path: cicd/builds/build-configuration.adoc
- name: Troubleshooting builds
path: cicd/builds/troubleshooting-builds.adoc
- name: Setting up additional trusted certificate authorities for builds
path: cicd/builds/setting-up-trusted-ca.adoc
- name: Pipelines
items:
- name: Red Hat OpenShift Pipelines release notes
path: cicd/pipelines/op-release-notes.adoc
- name: Understanding OpenShift Pipelines
path: cicd/pipelines/understanding-openshift-pipelines.adoc
- name: Installing OpenShift Pipelines
path: cicd/pipelines/installing-pipelines.adoc
- name: Uninstalling OpenShift Pipelines
path: cicd/pipelines/uninstalling-pipelines.adoc
- name: Creating CI/CD solutions for applications using OpenShift Pipelines
path: cicd/pipelines/creating-applications-with-cicd-pipelines.adoc
- name: Working with Red Hat OpenShift Pipelines using the Developer perspective
path: cicd/pipelines/working-with-pipelines-using-the-developer-perspective.adoc
- name: Reducing resource consumption of OpenShift Pipelines
path: cicd/pipelines/reducing-pipelines-resource-consumption.adoc
- name: Setting compute resource quota for OpenShift Pipelines
path: cicd/pipelines/setting-compute-resource-quota-for-openshift-pipelines.adoc
- name: Using pods in a privileged security context
path: cicd/pipelines/using-pods-in-a-privileged-security-context.adoc
- name: Securing webhooks with event listeners
path: cicd/pipelines/securing-webhooks-with-event-listeners.adoc
- name: Authenticating pipelines using git secret
path: cicd/pipelines/authenticating-pipelines-using-git-secret.adoc
- name: Viewing pipeline logs using the OpenShift Logging Operator
path: cicd/pipelines/viewing-pipeline-logs-using-the-openshift-logging-operator.adoc
- name: GitOps
items:
- name: Red Hat OpenShift GitOps release notes
path: cicd/gitops/gitops-release-notes.adoc
- name: Understanding OpenShift GitOps
path: cicd/gitops/understanding-openshift-gitops.adoc
- name: Getting started with OpenShift GitOps
path: cicd/gitops/installing-openshift-gitops.adoc
- name: Uninstalling OpenShift GitOps
path: cicd/gitops/uninstalling-openshift-gitops.adoc
- name: Configuring Argo CD to recursively sync a Git repository with your application
items:
- name: Configuring an OpenShift cluster by deploying an application with cluster configurations
path: cicd/gitops/configuring_argo_cd_to_recursively_sync_a_git_repository_with_your_application/configuring-an-openshift-cluster-by-deploying-an-application-with-cluster-configurations.adoc
- name: Deploying a Spring Boot application with Argo CD
path: cicd/gitops/configuring_argo_cd_to_recursively_sync_a_git_repository_with_your_application/deploying-a-spring-boot-application-with-argo-cd.adoc
- name: Configuring SSO for Argo CD using Dex
path: cicd/gitops/configuring-sso-on-argo-cd-using-dex.adoc
- name: Configuring SSO for Argo CD using Keycloak
path: cicd/gitops/configuring-sso-for-argo-cd-using-keycloak.adoc
- name: Running GitOps control plane workloads on infrastructure nodes
path: cicd/gitops/run-gitops-control-plane-workload-on-infra-nodes.adoc
- Name: Jenkins
Dir: jenkins
Distros: openshift-enterprise
Topics:
- Name: Migrating from Jenkins to OpenShift Pipelines
File: migrating-from-jenkins-to-openshift-pipelines
- name: Images
items:
- name: Overview of images
path: openshift_images/index.adoc
- name: Configuring the Cluster Samples Operator
path: openshift_images/configuring-samples-operator.adoc
- name: Using the Cluster Samples Operator with an alternate registry
path: openshift_images/samples-operator-alt-registry.adoc
- name: Creating images
path: openshift_images/create-images.adoc
- name: Managing images
items:
- name: Managing images overview
path: openshift_images/managing_images/managing-images-overview.adoc
- name: Tagging images
path: openshift_images/managing_images/tagging-images.adoc
- name: Image pull policy
path: openshift_images/managing_images/image-pull-policy.adoc
- name: Using image pull secrets
path: openshift_images/managing_images/using-image-pull-secrets.adoc
- name: Managing image streams
path: openshift_images/image-streams-manage.adoc
- name: Using image streams with Kubernetes resources
path: openshift_images/using-imagestreams-with-kube-resources.adoc
- name: Triggering updates on image stream changes
path: openshift_images/triggering-updates-on-imagestream-changes.adoc
- name: Image configuration resources
path: openshift_images/image-configuration.adoc
- name: Using templates
path: openshift_images/using-templates.adoc
- name: Using Ruby on Rails
path: openshift_images/templates-using-ruby-on-rails.adoc
- name: Using images
items:
- name: Using images overview
path: openshift_images/using_images/using-images-overview.adoc
- name: Configuring Jenkins images
path: openshift_images/using_images/images-other-jenkins.adoc
- name: Jenkins agent
path: openshift_images/using_images/images-other-jenkins-agent.adoc
- name: Source-to-image
path: openshift_images/using_images/using-s21-images.adoc
- name: Customizing source-to-image images
path: openshift_images/using_images/customizing-s2i-images.adoc
- name: Building applications
items:
- name: Projects
items:
- name: Working with projects
path: applications/projects/working-with-projects.adoc
- name: Creating a project as another user
path: applications/projects/creating-project-other-user.adoc
- name: Configuring project creation
path: applications/projects/configuring-project-creation.adoc
- name: Creating applications
items:
- name: Creating applications using the Developer perspective
path: applications/creating_applications/odc-creating-applications-using-developer-perspective.adoc
- name: Creating applications from installed Operators
path: applications/creating_applications/creating-apps-from-installed-operators.adoc
- name: Creating applications using the CLI
path: applications/creating_applications/creating-applications-using-cli.adoc
- name: Viewing application composition using the Topology view
path: applications/odc-viewing-application-composition-using-topology-view.adoc
- name: Connecting applications to services
items:
- name: Service Binding Operator release notes
path: applications/connecting_applications_to_services/sbo-release-notes.adoc
- name: Understanding Service Binding Operator
path: applications/connecting_applications_to_services/understanding-service-binding-operator.adoc
- name: Installing Service Binding Operator
path: applications/connecting_applications_to_services/installing-sbo.adoc
- name: Getting started with service binding
path: applications/connecting_applications_to_services/getting-started-with-service-binding.adoc
- name: Getting started with service binding on IBM Power Systems, IBM Z, and LinuxONE
path: applications/connecting_applications_to_services/getting-started-with-service-binding-ibm-power-ibm-z.adoc
- name: Exposing binding data from a service
path: applications/connecting_applications_to_services/exposing-binding-data-from-a-service.adoc
- name: Projecting binding data
path: applications/connecting_applications_to_services/projecting-binding-data.adoc
- name: Binding workloads using Service Binding Operator
path: applications/connecting_applications_to_services/binding-workloads-using-sbo.adoc
- name: Connecting an application to a service using the Developer perspective
path: applications/connecting_applications_to_services/odc-connecting-an-application-to-a-service-using-the-developer-perspective.adoc
- name: Working with Helm charts
items:
- name: Understanding Helm
path: applications/working_with_helm_charts/understanding-helm.adoc
- name: Installing Helm
path: applications/working_with_helm_charts/installing-helm.adoc
- name: Configuring custom Helm chart repositories
path: applications/working_with_helm_charts/configuring-custom-helm-chart-repositories.adoc
- name: Working with Helm releases
path: applications/working_with_helm_charts/odc-working-with-helm-releases.adoc
- name: Deployments
items:
- name: Understanding Deployment and DeploymentConfig objects
path: applications/deployments/what-deployments-are.adoc
- name: Managing deployment processes
path: applications/deployments/managing-deployment-processes.adoc
- name: Using deployment strategies
path: applications/deployments/deployment-strategies.adoc
- name: Using route-based deployment strategies
path: applications/deployments/route-based-deployment-strategies.adoc
- name: Quotas
items:
- name: Resource quotas per project
path: applications/quotas/quotas-setting-per-project.adoc
- name: Resource quotas across multiple projects
path: applications/quotas/quotas-setting-across-multiple-projects.adoc
- name: Using config maps with applications
path: applications/config-maps.adoc
- name: Monitoring project and application metrics using the Developer perspective
path: applications/odc-monitoring-project-and-application-metrics-using-developer-perspective.adoc
- name: Monitoring application health by using health checks
path: applications/application-health.adoc
- name: Editing applications
path: applications/odc-editing-applications.adoc
- name: Pruning objects to reclaim resources
path: applications/pruning-objects.adoc
- name: Idling applications
path: applications/idling-applications.adoc
- name: Deleting applications
path: applications/odc-deleting-applications.adoc
- name: Using the Red Hat Marketplace
path: applications/red-hat-marketplace.adoc
- name: Machine management
items:
- name: Overview of machine management
path: machine_management/index.adoc
- name: Creating machine sets
items:
- name: Creating a machine set on AWS
path: machine_management/creating_machinesets/creating-machineset-aws.adoc
- name: Creating a machine set on Azure
path: machine_management/creating_machinesets/creating-machineset-azure.adoc
- name: Creating a machine set on GCP
path: machine_management/creating_machinesets/creating-machineset-gcp.adoc
- name: Creating a machine set on OpenStack
path: machine_management/creating_machinesets/creating-machineset-osp.adoc
- name: Creating a machine set on RHV
path: machine_management/creating_machinesets/creating-machineset-rhv.adoc
- name: Creating a machine set on vSphere
path: machine_management/creating_machinesets/creating-machineset-vsphere.adoc
- name: Manually scaling a machine set
path: machine_management/manually-scaling-machineset.adoc
- name: Modifying a machine set
path: machine_management/modifying-machineset.adoc
- name: Deleting a machine
path: machine_management/deleting-machine.adoc
- name: Applying autoscaling to an OpenShift Container Platform cluster
path: machine_management/applying-autoscaling.adoc
- name: Creating infrastructure machine sets
path: machine_management/creating-infrastructure-machinesets.adoc
- name: Adding RHEL compute machines to an OpenShift Container Platform cluster
path: machine_management/adding-rhel-compute.adoc
- name: Adding more RHEL compute machines to an OpenShift Container Platform cluster
path: machine_management/more-rhel-compute.adoc
- name: User-provisioned infrastructure
items:
- name: Adding compute machines to clusters with user-provisioned infrastructure
path: machine_management/user_infra/adding-compute-user-infra-general.adoc
- name: Adding compute machines to AWS by using CloudFormation templates
path: machine_management/user_infra/adding-aws-compute-user-infra.adoc
- name: Adding compute machines to vSphere
path: machine_management/user_infra/adding-vsphere-compute-user-infra.adoc
- name: Adding compute machines to bare metal
path: machine_management/user_infra/adding-bare-metal-compute-user-infra.adoc
- name: Deploying machine health checks
path: machine_management/deploying-machine-health-checks.adoc
- name: Nodes
items:
- name: Overview of nodes
path: nodes/index.adoc
- name: Working with pods
items:
- name: Using pods
path: nodes/pods/nodes-pods-using.adoc
- name: Viewing pods
path: nodes/pods/nodes-pods-viewing.adoc
- name: Configuring an OpenShift Container Platform cluster for pods
path: nodes/pods/nodes-pods-configuring.adoc
- name: Automatically scaling pods with the horizontal pod autoscaler
path: nodes/pods/nodes-pods-autoscaling.adoc
- name: Automatically adjust pod resource levels with the vertical pod autoscaler
path: nodes/pods/nodes-pods-vertical-autoscaler.adoc
- name: Providing sensitive data to pods
path: nodes/pods/nodes-pods-secrets.adoc
- name: Creating and using config maps
path: nodes/pods/nodes-pods-configmaps.adoc
- name: Using device plug-ins to access external resources with pods
path: nodes/pods/nodes-pods-plugins.adoc
- name: Including pod priority in pod scheduling decisions
path: nodes/pods/nodes-pods-priority.adoc
- name: Placing pods on specific nodes using node selectors
path: nodes/pods/nodes-pods-node-selectors.adoc
- name: Controlling pod placement onto nodes (scheduling)
items:
- name: Controlling pod placement using the scheduler
path: nodes/scheduling/nodes-scheduler-about.adoc
- name: Configuring the default scheduler to control pod placement
path: nodes/scheduling/nodes-scheduler-default.adoc
- name: Scheduling pods using a scheduler profile
path: nodes/scheduling/nodes-scheduler-profiles.adoc
- name: Placing pods relative to other pods using affinity and anti-affinity rules
path: nodes/scheduling/nodes-scheduler-pod-affinity.adoc
- name: Controlling pod placement on nodes using node affinity rules
path: nodes/scheduling/nodes-scheduler-node-affinity.adoc
- name: Placing pods onto overcommited nodes
path: nodes/scheduling/nodes-scheduler-overcommit.adoc
- name: Controlling pod placement using node taints
path: nodes/scheduling/nodes-scheduler-taints-tolerations.adoc
- name: Placing pods on specific nodes using node selectors
path: nodes/scheduling/nodes-scheduler-node-selectors.adoc
- name: Controlling pod placement by using pod topology spread constraints
path: nodes/scheduling/nodes-scheduler-pod-topology-spread-constraints.adoc
- name: Running a custom scheduler
path: nodes/scheduling/nodes-custom-scheduler.adoc
- name: Evicting pods using the descheduler
path: nodes/scheduling/nodes-descheduler.adoc
- name: Using Jobs and DaemonSets
items:
- name: Running background tasks on nodes automatically with daemon sets
path: nodes/jobs/nodes-pods-daemonsets.adoc
- name: Running tasks in pods using jobs
path: nodes/jobs/nodes-nodes-jobs.adoc
- name: Working with nodes
items:
- name: Viewing and listing the nodes in your OpenShift Container Platform cluster
path: nodes/nodes/nodes-nodes-viewing.adoc
- name: Working with nodes
path: nodes/nodes/nodes-nodes-working.adoc
- name: Managing nodes
path: nodes/nodes/nodes-nodes-managing.adoc
- name: Managing the maximum number of pods per node
path: nodes/nodes/nodes-nodes-managing-max-pods.adoc
- name: Using the Node Tuning Operator
path: nodes/nodes/nodes-node-tuning-operator.adoc
- name: Remediating nodes with the Poison Pill Operator
path: nodes/nodes/eco-poison-pill-operator.adoc
- name: Deploying node health checks by using the Node Health Check Operator
path: nodes/nodes/eco-node-health-check-operator.adoc
- name: Understanding node rebooting
path: nodes/nodes/nodes-nodes-rebooting.adoc
- name: Freeing node resources using garbage collection
path: nodes/nodes/nodes-nodes-garbage-collection.adoc
- name: Allocating resources for nodes in an OpenShift Container Platform cluster
path: nodes/nodes/nodes-nodes-resources-configuring.adoc
- name: Allocating specific CPUs for nodes in a cluster
path: nodes/nodes/nodes-nodes-resources-cpus.adoc
- name: Enabling TLS security profiles for the kubelet
path: nodes/nodes/nodes-nodes-tls.adoc
- name: Machine Config Daemon metrics
path: nodes/nodes/nodes-nodes-machine-config-daemon-metrics.adoc
- name: Working with containers
items:
- name: Understanding Containers
path: nodes/containers/nodes-containers-using.adoc
- name: Using Init Containers to perform tasks before a pod is deployed
path: nodes/containers/nodes-containers-init.adoc
- name: Using volumes to persist container data
path: nodes/containers/nodes-containers-volumes.adoc
- name: Mapping volumes using projected volumes
path: nodes/containers/nodes-containers-projected-volumes.adoc
- name: Allowing containers to consume API objects
path: nodes/containers/nodes-containers-downward-api.adoc
- name: Copying files to or from an OpenShift Container Platform container
path: nodes/containers/nodes-containers-copying-files.adoc
- name: Executing remote commands in an OpenShift Container Platform container
path: nodes/containers/nodes-containers-remote-commands.adoc
- name: Using port forwarding to access applications in a container
path: nodes/containers/nodes-containers-port-forwarding.adoc
- name: Using sysctls in containers
path: nodes/containers/nodes-containers-sysctls.adoc
- name: Working with clusters
items:
- name: Viewing system event information in an OpenShift Container Platform cluster
path: nodes/clusters/nodes-containers-events.adoc
- name: Estimating the number of pods your OpenShift Container Platform nodes can hold
path: nodes/clusters/nodes-cluster-resource-levels.adoc
- name: Restrict resource consumption with limit ranges
path: nodes/clusters/nodes-cluster-limit-ranges.adoc
- name: Configuring cluster memory to meet container memory and risk requirements
path: nodes/clusters/nodes-cluster-resource-configure.adoc
- name: Configuring your cluster to place pods on overcommitted nodes
path: nodes/clusters/nodes-cluster-overcommit.adoc
- name: Enabling features using feature gates
path: nodes/clusters/nodes-cluster-enabling-features.adoc
- name: Remote worker nodes on the network edge
items:
- name: Using remote worker nodes at the network edge
path: nodes/edge/nodes-edge-remote-workers.adoc
- name: Windows Container Support for OpenShift
items:
- name: Windows Container Support for OpenShift overview
path: windows_containers/index.adoc
- name: Windows Container Support for Red Hat OpenShift release notes
path: windows_containers/windows-containers-release-notes-4-x.adoc
- name: Understanding Windows container workloads
path: windows_containers/understanding-windows-container-workloads.adoc
- name: Enabling Windows container workloads
path: windows_containers/enabling-windows-container-workloads.adoc
- name: Creating Windows MachineSet objects
items:
- name: Creating a Windows <code>MachineSet</code> object on AWS
path: windows_containers/creating_windows_machinesets/creating-windows-machineset-aws.adoc
- name: Creating a Windows <code>MachineSet</code> object on Azure
path: windows_containers/creating_windows_machinesets/creating-windows-machineset-azure.adoc
- name: Creating a Windows MachineSet object on vSphere
path: windows_containers/creating_windows_machinesets/creating-windows-machineset-vsphere.adoc
- name: Scheduling Windows container workloads
path: windows_containers/scheduling-windows-workloads.adoc
- name: Windows node upgrades
path: windows_containers/windows-node-upgrades.adoc
- name: Using Bring-Your-Own-Host (BYOH) Windows instances as nodes
path: windows_containers/byoh-windows-instance.adoc
- name: Removing Windows nodes
path: windows_containers/removing-windows-nodes.adoc
- name: Disabling Windows container workloads
path: windows_containers/disabling-windows-container-workloads.adoc
- name: Sandboxed Containers Support for OpenShift
items:
- name: OpenShift sandboxed containers 1.1 release notes
path: sandboxed_containers/sandboxed-containers-4.9-release-notes.adoc
- name: Understanding OpenShift sandboxed containers
path: sandboxed_containers/understanding-sandboxed-containers.adoc
- name: Deploying OpenShift sandboxed containers workloads
path: sandboxed_containers/deploying-sandboxed-container-workloads.adoc
- name: Uninstalling OpenShift sandboxed containers
path: sandboxed_containers/uninstalling-sandboxed-containers.adoc
- name: Upgrade OpenShift sandboxed containers
path: sandboxed_containers/upgrade-sandboxed-containers.adoc
- name: Collecting OpenShift sandboxed containers data for Red Hat Support
path: sandboxed_containers/troubleshooting-sandboxed-containers.adoc
- name: Logging
items:
- name: Release notes for Red Hat OpenShift Logging 5.3
path: logging/cluster-logging-release-notes.adoc
- name: Understanding Red Hat OpenShift Logging
path: logging/cluster-logging.adoc
- name: Installing OpenShift Logging
path: logging/cluster-logging-deploying.adoc
- name: Configuring your Logging deployment
items:
- name: About the Cluster Logging custom resource
path: logging/config/cluster-logging-configuring-cr.adoc
- name: Configuring the logging collector
path: logging/config/cluster-logging-collector.adoc
- name: Configuring the log store
path: logging/config/cluster-logging-log-store.adoc
- name: Configuring the log visualizer
path: logging/config/cluster-logging-visualizer.adoc
- name: Configuring OpenShift Logging storage
path: logging/config/cluster-logging-storage-considerations.adoc
- name: Configuring CPU and memory limits for OpenShift Logging components
path: logging/config/cluster-logging-memory.adoc
- name: Using tolerations to control OpenShift Logging pod placement
path: logging/config/cluster-logging-tolerations.adoc
- name: Moving OpenShift Logging resources with node selectors
path: logging/config/cluster-logging-moving-nodes.adoc
- name: Configuring systemd-journald and Fluentd
path: logging/config/cluster-logging-systemd.adoc
- name: Maintenance and support
path: logging/config/cluster-logging-maintenance-support.adoc
- name: Viewing logs for a resource
path: logging/viewing-resource-logs.adoc
- name: Viewing cluster logs by using Kibana
path: logging/cluster-logging-visualizer.adoc
- name: Forwarding logs to external third-party logging systems
path: logging/cluster-logging-external.adoc
- name: Enabling JSON logging
path: logging/cluster-logging-enabling-json-logging.adoc
- name: Collecting and storing Kubernetes events
path: logging/cluster-logging-eventrouter.adoc
- name: Updating OpenShift Logging
path: logging/cluster-logging-upgrading.adoc
- name: Viewing cluster dashboards
path: logging/cluster-logging-dashboards.adoc
- name: Troubleshooting Logging
items:
- name: Viewing OpenShift Logging status
path: logging/troubleshooting/cluster-logging-cluster-status.adoc
- name: Viewing the status of the Elasticsearch log store
path: logging/troubleshooting/cluster-logging-log-store-status.adoc
- name: Understanding OpenShift Logging alerts
path: logging/troubleshooting/cluster-logging-alerts.adoc
- name: Collecting logging data for Red Hat Support
path: logging/troubleshooting/cluster-logging-must-gather.adoc
- name: Troubleshooting for Critical Alerts
path: logging/troubleshooting/cluster-logging-troubleshooting-for-critical-alerts.adoc
- name: Uninstalling OpenShift Logging
path: logging/cluster-logging-uninstall.adoc
- name: Log Record Fields
path: logging/cluster-logging-exported-fields.adoc
- name: Monitoring
items:
- name: Understanding the monitoring stack
path: monitoring/understanding-the-monitoring-stack.adoc
- name: Configuring the monitoring stack
path: monitoring/configuring-the-monitoring-stack.adoc
- name: Enabling monitoring for user-defined projects
path: monitoring/enabling-monitoring-for-user-defined-projects.adoc
- name: Managing metrics
path: monitoring/managing-metrics.adoc
- name: Managing metrics targets
path: monitoring/managing-metrics-targets.adoc
- name: Managing alerts
path: monitoring/managing-alerts.adoc
- name: Reviewing monitoring dashboards
path: monitoring/reviewing-monitoring-dashboards.adoc
- name: Accessing third-party UIs
path: monitoring/accessing-third-party-uis.adoc
- name: Troubleshooting monitoring issues
path: monitoring/troubleshooting-monitoring-issues.adoc
- name: Scalability and performance
items:
- name: Recommended practices for installing large clusters
path: scalability_and_performance/recommended-install-practices.adoc
- name: Recommended host practices
path: scalability_and_performance/recommended-host-practices.adoc
- name: Recommended host practices for IBM Z &amp; LinuxONE environments
path: scalability_and_performance/ibm-z-recommended-host-practices.adoc
- name: Recommended cluster scaling practices
path: scalability_and_performance/recommended-cluster-scaling-practices.adoc
- name: Using the Node Tuning Operator
path: scalability_and_performance/using-node-tuning-operator.adoc
- name: Using Cluster Loader
path: scalability_and_performance/using-cluster-loader.adoc
- name: Using CPU Manager
path: scalability_and_performance/using-cpu-manager.adoc
- name: Using Topology Manager
path: scalability_and_performance/using-topology-manager.adoc
- name: Scaling the Cluster Monitoring Operator
path: scalability_and_performance/scaling-cluster-monitoring-operator.adoc
- name: Planning your environment according to object maximums
path: scalability_and_performance/planning-your-environment-according-to-object-maximums.adoc
- name: Optimizing storage
path: scalability_and_performance/optimizing-storage.adoc
- name: Optimizing routing
path: scalability_and_performance/routing-optimization.adoc
- name: Optimizing networking
path: scalability_and_performance/optimizing-networking.adoc
- name: Managing bare metal hosts
path: scalability_and_performance/managing-bare-metal-hosts.adoc
- name: What huge pages do and how they are consumed by applications
path: scalability_and_performance/what-huge-pages-do-and-how-they-are-consumed-by-apps.adoc
- name: Performance Addon Operator for low latency nodes
path: scalability_and_performance/cnf-performance-addon-operator-for-low-latency-nodes.adoc
- name: Creating a performance profile
path: scalability_and_performance/cnf-create-performance-profiles.adoc
- name: Deploying distributed units at scale in a disconnected environment
path: scalability_and_performance/ztp-deploying-disconnected.adoc
- name: Specialized hardware and driver enablement
items:
- name: About specialized hardware and driver enablement
path: hardware_enablement/about-hardware-enablement.adoc
- name: Driver Toolkit
path: hardware_enablement/psap-driver-toolkit.adoc
- name: Special Resource Operator
path: hardware_enablement/psap-special-resource-operator.adoc
- name: Node Feature Discovery Operator
path: hardware_enablement/psap-node-feature-discovery-operator.adoc
- name: Backup and restore
items:
- name: Backup and restore
path: backup_and_restore/index.adoc
- name: Shutting down the cluster gracefully
path: backup_and_restore/graceful-cluster-shutdown.adoc
- name: Restarting the cluster gracefully
path: backup_and_restore/graceful-cluster-restart.adoc
- name: Control plane backup and restore
items:
- name: Backing up etcd
path: backup_and_restore/control_plane_backup_and_restore/backing-up-etcd.adoc
- name: Replacing an unhealthy etcd member
path: backup_and_restore/control_plane_backup_and_restore/replacing-unhealthy-etcd-member.adoc
- name: Disaster recovery
items:
- name: About disaster recovery
path: backup_and_restore/control_plane_backup_and_restore/disaster_recovery/about-disaster-recovery.adoc
- name: Restoring to a previous cluster state
path: backup_and_restore/control_plane_backup_and_restore/disaster_recovery/scenario-2-restoring-cluster-state.adoc
- name: Recovering from expired control plane certificates
path: backup_and_restore/control_plane_backup_and_restore/disaster_recovery/scenario-3-expired-certs.adoc
- name: Migrating from version 3 to 4
items:
- name: About migrating from OpenShift Container Platform 3 to 4
path: migrating_from_ocp_3_to_4/about-migrating-from-3-to-4.adoc
- name: Differences between OpenShift Container Platform 3 and 4
path: migrating_from_ocp_3_to_4/planning-migration-3-4.adoc
- name: Network considerations
path: migrating_from_ocp_3_to_4/planning-considerations-3-4.adoc
- name: About the Migration Toolkit for Containers
path: migrating_from_ocp_3_to_4/about-mtc-3-4.adoc
- name: Installing the Migration Toolkit for Containers
path: migrating_from_ocp_3_to_4/installing-3-4.adoc
- name: Installing the Migration Toolkit for Containers in a restricted network environment
path: migrating_from_ocp_3_to_4/installing-restricted-3-4.adoc
- name: Upgrading the Migration Toolkit for Containers
path: migrating_from_ocp_3_to_4/upgrading-3-4.adoc
- name: Premigration checklists
path: migrating_from_ocp_3_to_4/premigration-checklists-3-4.adoc
- name: Migrating your applications
path: migrating_from_ocp_3_to_4/migrating-applications-3-4.adoc
- name: Advanced migration options
path: migrating_from_ocp_3_to_4/advanced-migration-options-3-4.adoc
- name: Troubleshooting
path: migrating_from_ocp_3_to_4/troubleshooting-3-4.adoc
- name: Migration Toolkit for Containers
items:
- name: About the Migration Toolkit for Containers
path: migration_toolkit_for_containers/about-mtc.adoc
- name: Migration Toolkit for Containers release notes
path: migration_toolkit_for_containers/mtc-release-notes.adoc
- name: Installing the Migration Toolkit for Containers
path: migration_toolkit_for_containers/installing-mtc.adoc
- name: Installing the Migration Toolkit for Containers in a restricted network environment
path: migration_toolkit_for_containers/installing-mtc-restricted.adoc
- name: Upgrading the Migration Toolkit for Containers
path: migration_toolkit_for_containers/upgrading-mtc.adoc
- name: Premigration checklists
path: migration_toolkit_for_containers/premigration-checklists-mtc.adoc
- name: Network considerations
path: migration_toolkit_for_containers/network-considerations-mtc.adoc
- name: Migrating your applications
path: migration_toolkit_for_containers/migrating-applications-with-mtc.adoc
- name: Advanced migration options
path: migration_toolkit_for_containers/advanced-migration-options-mtc.adoc
- name: Troubleshooting
path: migration_toolkit_for_containers/troubleshooting-mtc.adoc
- name: API reference
items:
- name: Understanding API tiers
path: rest_api/understanding-api-support-tiers.adoc
- name: Understanding API compatibility guidelines
path: rest_api/understanding-compatibility-guidelines.adoc
- name: Editing kubelet log level verbosity and gathering logs
path: rest_api/editing-kubelet-log-level-verbosity.adoc
- name: API index
path: rest_api/index.adoc
- name: Common object reference
items:
- name: Common object reference
path: rest_api/objects/index.adoc
- name: Authorization APIs
items:
- name: Authorization APIs
path: rest_api/authorization_apis/authorization-apis-index.adoc
- name: LocalResourceAccessReview [authorization.openshift.io/v1]
path: rest_api/authorization_apis/localresourceaccessreview-authorization-openshift-io-v1.adoc
- name: LocalSubjectAccessReview [authorization.openshift.io/v1]
path: rest_api/authorization_apis/localsubjectaccessreview-authorization-openshift-io-v1.adoc
- name: ResourceAccessReview [authorization.openshift.io/v1]
path: rest_api/authorization_apis/resourceaccessreview-authorization-openshift-io-v1.adoc
- name: SelfSubjectRulesReview [authorization.openshift.io/v1]
path: rest_api/authorization_apis/selfsubjectrulesreview-authorization-openshift-io-v1.adoc
- name: SubjectAccessReview [authorization.openshift.io/v1]
path: rest_api/authorization_apis/subjectaccessreview-authorization-openshift-io-v1.adoc
- name: SubjectRulesReview [authorization.openshift.io/v1]
path: rest_api/authorization_apis/subjectrulesreview-authorization-openshift-io-v1.adoc
- name: TokenReview [authentication.k8s.io/v1]
path: rest_api/authorization_apis/tokenreview-authentication-k8s-io-v1.adoc
- name: LocalSubjectAccessReview [authorization.k8s.io/v1]
path: rest_api/authorization_apis/localsubjectaccessreview-authorization-k8s-io-v1.adoc
- name: SelfSubjectAccessReview [authorization.k8s.io/v1]
path: rest_api/authorization_apis/selfsubjectaccessreview-authorization-k8s-io-v1.adoc
- name: SelfSubjectRulesReview [authorization.k8s.io/v1]
path: rest_api/authorization_apis/selfsubjectrulesreview-authorization-k8s-io-v1.adoc
- name: SubjectAccessReview [authorization.k8s.io/v1]
path: rest_api/authorization_apis/subjectaccessreview-authorization-k8s-io-v1.adoc
- name: Autoscale APIs
items:
- name: Autoscale APIs
path: rest_api/autoscale_apis/autoscale-apis-index.adoc
- name: ClusterAutoscaler [autoscaling.openshift.io/v1]
path: rest_api/autoscale_apis/clusterautoscaler-autoscaling-openshift-io-v1.adoc
- name: MachineAutoscaler [autoscaling.openshift.io/v1beta1]
path: rest_api/autoscale_apis/machineautoscaler-autoscaling-openshift-io-v1beta1.adoc
- name: HorizontalPodAutoscaler [autoscaling/v1]
path: rest_api/autoscale_apis/horizontalpodautoscaler-autoscaling-v1.adoc
- name: Config APIs
items:
- name: Config APIs
path: rest_api/config_apis/config-apis-index.adoc
- name: APIServer [config.openshift.io/v1]
path: rest_api/config_apis/apiserver-config-openshift-io-v1.adoc
- name: Authentication [config.openshift.io/v1]
path: rest_api/config_apis/authentication-config-openshift-io-v1.adoc
- name: Build [config.openshift.io/v1]
path: rest_api/config_apis/build-config-openshift-io-v1.adoc
- name: ClusterOperator [config.openshift.io/v1]
path: rest_api/config_apis/clusteroperator-config-openshift-io-v1.adoc
- name: ClusterVersion [config.openshift.io/v1]
path: rest_api/config_apis/clusterversion-config-openshift-io-v1.adoc
- name: Console [config.openshift.io/v1]
path: rest_api/config_apis/console-config-openshift-io-v1.adoc
- name: DNS [config.openshift.io/v1]
path: rest_api/config_apis/dns-config-openshift-io-v1.adoc
- name: FeatureGate [config.openshift.io/v1]
path: rest_api/config_apis/featuregate-config-openshift-io-v1.adoc
- name: HelmChartRepository [helm.openshift.io/v1beta1]
path: rest_api/config_apis/helmchartrepository-helm-openshift-io-v1beta1.adoc
- name: Image [config.openshift.io/v1]
path: rest_api/config_apis/image-config-openshift-io-v1.adoc
- name: Infrastructure [config.openshift.io/v1]
path: rest_api/config_apis/infrastructure-config-openshift-io-v1.adoc
- name: Ingress [config.openshift.io/v1]
path: rest_api/config_apis/ingress-config-openshift-io-v1.adoc
- name: Network [config.openshift.io/v1]
path: rest_api/config_apis/network-config-openshift-io-v1.adoc
- name: OAuth [config.openshift.io/v1]
path: rest_api/config_apis/oauth-config-openshift-io-v1.adoc
- name: OperatorHub [config.openshift.io/v1]
path: rest_api/config_apis/operatorhub-config-openshift-io-v1.adoc
- name: Project [config.openshift.io/v1]
path: rest_api/config_apis/project-config-openshift-io-v1.adoc
- name: Proxy [config.openshift.io/v1]
path: rest_api/config_apis/proxy-config-openshift-io-v1.adoc
- name: Scheduler [config.openshift.io/v1]
path: rest_api/config_apis/scheduler-config-openshift-io-v1.adoc
- name: Console APIs
items:
- name: Console APIs
path: rest_api/console_apis/console-apis-index.adoc
- name: ConsoleCLIDownload [console.openshift.io/v1]
path: rest_api/console_apis/consoleclidownload-console-openshift-io-v1.adoc
- name: ConsoleExternalLogLink [console.openshift.io/v1]
path: rest_api/console_apis/consoleexternalloglink-console-openshift-io-v1.adoc
- name: ConsoleLink [console.openshift.io/v1]
path: rest_api/console_apis/consolelink-console-openshift-io-v1.adoc
- name: ConsoleNotification [console.openshift.io/v1]
path: rest_api/console_apis/consolenotification-console-openshift-io-v1.adoc
- name: ConsolePlugin [console.openshift.io/v1alpha1]
path: rest_api/console_apis/consoleplugin-console-openshift-io-v1alpha1.adoc
- name: ConsoleQuickStart [console.openshift.io/v1]
path: rest_api/console_apis/consolequickstart-console-openshift-io-v1.adoc
- name: ConsoleYAMLSample [console.openshift.io/v1]
path: rest_api/console_apis/consoleyamlsample-console-openshift-io-v1.adoc
- name: Extension APIs
items:
- name: Extension APIs
path: rest_api/extension_apis/extension-apis-index.adoc
- name: APIService [apiregistration.k8s.io/v1]
path: rest_api/extension_apis/apiservice-apiregistration-k8s-io-v1.adoc
- name: CustomResourceDefinition [apiextensions.k8s.io/v1]
path: rest_api/extension_apis/customresourcedefinition-apiextensions-k8s-io-v1.adoc
- name: MutatingWebhookConfiguration [admissionregistration.k8s.io/v1]
path: rest_api/extension_apis/mutatingwebhookconfiguration-admissionregistration-k8s-io-v1.adoc
- name: ValidatingWebhookConfiguration [admissionregistration.k8s.io/v1]
path: rest_api/extension_apis/validatingwebhookconfiguration-admissionregistration-k8s-io-v1.adoc
- name: Image APIs
items:
- name: Image APIs
path: rest_api/image_apis/image-apis-index.adoc
- name: Image [image.openshift.io/v1]
path: rest_api/image_apis/image-image-openshift-io-v1.adoc
- name: ImageSignature [image.openshift.io/v1]
path: rest_api/image_apis/imagesignature-image-openshift-io-v1.adoc
- name: ImageStreamImage [image.openshift.io/v1]
path: rest_api/image_apis/imagestreamimage-image-openshift-io-v1.adoc
- name: ImageStreamImport [image.openshift.io/v1]
path: rest_api/image_apis/imagestreamimport-image-openshift-io-v1.adoc
- name: ImageStreamMapping [image.openshift.io/v1]
path: rest_api/image_apis/imagestreammapping-image-openshift-io-v1.adoc
- name: ImageStream [image.openshift.io/v1]
path: rest_api/image_apis/imagestream-image-openshift-io-v1.adoc
- name: ImageStreamTag [image.openshift.io/v1]
path: rest_api/image_apis/imagestreamtag-image-openshift-io-v1.adoc
- name: ImageTag [image.openshift.io/v1]
path: rest_api/image_apis/imagetag-image-openshift-io-v1.adoc
- name: Machine APIs
items:
- name: Machine APIs
path: rest_api/machine_apis/machine-apis-index.adoc
- name: ContainerRuntimeConfig [machineconfiguration.openshift.io/v1]
path: rest_api/machine_apis/containerruntimeconfig-machineconfiguration-openshift-io-v1.adoc
- name: ControllerConfig [machineconfiguration.openshift.io/v1]
path: rest_api/machine_apis/controllerconfig-machineconfiguration-openshift-io-v1.adoc
- name: KubeletConfig [machineconfiguration.openshift.io/v1]
path: rest_api/machine_apis/kubeletconfig-machineconfiguration-openshift-io-v1.adoc
- name: MachineConfigPool [machineconfiguration.openshift.io/v1]
path: rest_api/machine_apis/machineconfigpool-machineconfiguration-openshift-io-v1.adoc
- name: MachineConfig [machineconfiguration.openshift.io/v1]
path: rest_api/machine_apis/machineconfig-machineconfiguration-openshift-io-v1.adoc
- name: MachineHealthCheck [machine.openshift.io/v1beta1]
path: rest_api/machine_apis/machinehealthcheck-machine-openshift-io-v1beta1.adoc
- name: Machine [machine.openshift.io/v1beta1]
path: rest_api/machine_apis/machine-machine-openshift-io-v1beta1.adoc
- name: MachineSet [machine.openshift.io/v1beta1]
path: rest_api/machine_apis/machineset-machine-openshift-io-v1beta1.adoc
- name: Metadata APIs
items:
- name: Metadata APIs
path: rest_api/metadata_apis/metadata-apis-index.adoc
- name: APIRequestCount [apiserver.openshift.io/v1]
path: rest_api/metadata_apis/apirequestcount-apiserver-openshift-io-v1.adoc
- name: Binding [core/v1]
path: rest_api/metadata_apis/binding-core-v1.adoc
- name: ComponentStatus [core/v1]
path: rest_api/metadata_apis/componentstatus-core-v1.adoc
- name: ConfigMap [core/v1]
path: rest_api/metadata_apis/configmap-core-v1.adoc
- name: ControllerRevision [apps/v1]
path: rest_api/metadata_apis/controllerrevision-apps-v1.adoc
- name: Event [events.k8s.io/v1]
path: rest_api/metadata_apis/event-events-k8s-io-v1.adoc
- name: Event [core/v1]
path: rest_api/metadata_apis/event-core-v1.adoc
- name: Lease [coordination.k8s.io/v1]
path: rest_api/metadata_apis/lease-coordination-k8s-io-v1.adoc
- name: Namespace [core/v1]
path: rest_api/metadata_apis/namespace-core-v1.adoc
- name: Monitoring APIs
items:
- name: Monitoring APIs
path: rest_api/monitoring_apis/monitoring-apis-index.adoc
- name: Alertmanager [monitoring.coreos.com/v1]
path: rest_api/monitoring_apis/alertmanager-monitoring-coreos-com-v1.adoc
- name: AlertmanagerConfig [monitoring.coreos.com/v1alpha1]
path: rest_api/monitoring_apis/alertmanagerconfig-monitoring-coreos-com-v1alpha1.adoc
- name: PodMonitor [monitoring.coreos.com/v1]
path: rest_api/monitoring_apis/podmonitor-monitoring-coreos-com-v1.adoc
- name: Probe [monitoring.coreos.com/v1]
path: rest_api/monitoring_apis/probe-monitoring-coreos-com-v1.adoc
- name: Prometheus [monitoring.coreos.com/v1]
path: rest_api/monitoring_apis/prometheus-monitoring-coreos-com-v1.adoc
- name: PrometheusRule [monitoring.coreos.com/v1]
path: rest_api/monitoring_apis/prometheusrule-monitoring-coreos-com-v1.adoc
- name: ServiceMonitor [monitoring.coreos.com/v1]
path: rest_api/monitoring_apis/servicemonitor-monitoring-coreos-com-v1.adoc
- name: ThanosRuler [monitoring.coreos.com/v1]
path: rest_api/monitoring_apis/thanosruler-monitoring-coreos-com-v1.adoc
- name: Network APIs
items:
- name: Network APIs
path: rest_api/network_apis/network-apis-index.adoc
- name: ClusterNetwork [network.openshift.io/v1]
path: rest_api/network_apis/clusternetwork-network-openshift-io-v1.adoc
- name: Endpoints [core/v1]
path: rest_api/network_apis/endpoints-core-v1.adoc
- name: EndpointSlice [discovery.k8s.io/v1]
path: rest_api/network_apis/endpointslice-discovery-k8s-io-v1.adoc
- name: EgressNetworkPolicy [network.openshift.io/v1]
path: rest_api/network_apis/egressnetworkpolicy-network-openshift-io-v1.adoc
- name: EgressRouter [network.operator.openshift.io/v1]
path: rest_api/network_apis/egressrouter-network-operator-openshift-io-v1.adoc
- name: HostSubnet [network.openshift.io/v1]
path: rest_api/network_apis/hostsubnet-network-openshift-io-v1.adoc
- name: Ingress [networking.k8s.io/v1]
path: rest_api/network_apis/ingress-networking-k8s-io-v1.adoc
- name: IngressClass [networking.k8s.io/v1]
path: rest_api/network_apis/ingressclass-networking-k8s-io-v1.adoc
- name: IPPool [whereabouts.cni.cncf.io/v1alpha1]
path: rest_api/network_apis/ippool-whereabouts-cni-cncf-io-v1alpha1.adoc
- name: NetNamespace [network.openshift.io/v1]
path: rest_api/network_apis/netnamespace-network-openshift-io-v1.adoc
- name: NetworkAttachmentDefinition [k8s.cni.cncf.io/v1]
path: rest_api/network_apis/networkattachmentdefinition-k8s-cni-cncf-io-v1.adoc
- name: NetworkPolicy [networking.k8s.io/v1]
path: rest_api/network_apis/networkpolicy-networking-k8s-io-v1.adoc
- name: PodNetworkConnectivityCheck [controlplane.operator.openshift.io/v1alpha1]
path: rest_api/network_apis/podnetworkconnectivitycheck-controlplane-operator-openshift-io-v1alpha1.adoc
- name: Route [route.openshift.io/v1]
path: rest_api/network_apis/route-route-openshift-io-v1.adoc
- name: Service [core/v1]
path: rest_api/network_apis/service-core-v1.adoc
- name: Node APIs
items:
- name: Node APIs
path: rest_api/node_apis/node-apis-index.adoc
- name: Node [core/v1]
path: rest_api/node_apis/node-core-v1.adoc
- name: Profile [tuned.openshift.io/v1]
path: rest_api/node_apis/profile-tuned-openshift-io-v1.adoc
- name: RuntimeClass [node.k8s.io/v1]
path: rest_api/node_apis/runtimeclass-node-k8s-io-v1.adoc
- name: Tuned [tuned.openshift.io/v1]
path: rest_api/node_apis/tuned-tuned-openshift-io-v1.adoc
- name: OAuth APIs
items:
- name: OAuth APIs
path: rest_api/oauth_apis/oauth-apis-index.adoc
- name: OAuthAccessToken [oauth.openshift.io/v1]
path: rest_api/oauth_apis/oauthaccesstoken-oauth-openshift-io-v1.adoc
- name: OAuthAuthorizeToken [oauth.openshift.io/v1]
path: rest_api/oauth_apis/oauthauthorizetoken-oauth-openshift-io-v1.adoc
- name: OAuthClientAuthorization [oauth.openshift.io/v1]
path: rest_api/oauth_apis/oauthclientauthorization-oauth-openshift-io-v1.adoc
- name: OAuthClient [oauth.openshift.io/v1]
path: rest_api/oauth_apis/oauthclient-oauth-openshift-io-v1.adoc
- name: UserOAuthAccessToken [oauth.openshift.io/v1]
path: rest_api/oauth_apis/useroauthaccesstoken-oauth-openshift-io-v1.adoc
- name: Operator APIs
items:
- name: Operator APIs
path: rest_api/operator_apis/operator-apis-index.adoc
- name: Authentication [operator.openshift.io/v1]
path: rest_api/operator_apis/authentication-operator-openshift-io-v1.adoc
- name: CloudCredential [operator.openshift.io/v1]
path: rest_api/operator_apis/cloudcredential-operator-openshift-io-v1.adoc
- name: ClusterCSIDriver [operator.openshift.io/v1]
path: rest_api/operator_apis/clustercsidriver-operator-openshift-io-v1.adoc
- name: Console [operator.openshift.io/v1]
path: rest_api/operator_apis/console-operator-openshift-io-v1.adoc
- name: Config [operator.openshift.io/v1]
path: rest_api/operator_apis/config-operator-openshift-io-v1.adoc
- name: Config [imageregistry.operator.openshift.io/v1]
path: rest_api/operator_apis/config-imageregistry-operator-openshift-io-v1.adoc
- name: Config [samples.operator.openshift.io/v1]
path: rest_api/operator_apis/config-samples-operator-openshift-io-v1.adoc
- name: CSISnapshotController [operator.openshift.io/v1]
path: rest_api/operator_apis/csisnapshotcontroller-operator-openshift-io-v1.adoc
- name: DNS [operator.openshift.io/v1]
path: rest_api/operator_apis/dns-operator-openshift-io-v1.adoc
- name: DNSRecord [ingress.operator.openshift.io/v1]
path: rest_api/operator_apis/dnsrecord-ingress-operator-openshift-io-v1.adoc
- name: Etcd [operator.openshift.io/v1]
path: rest_api/operator_apis/etcd-operator-openshift-io-v1.adoc
- name: ImageContentSourcePolicy [operator.openshift.io/v1alpha1]
path: rest_api/operator_apis/imagecontentsourcepolicy-operator-openshift-io-v1alpha1.adoc
- name: ImagePruner [imageregistry.operator.openshift.io/v1]
path: rest_api/operator_apis/imagepruner-imageregistry-operator-openshift-io-v1.adoc
- name: IngressController [operator.openshift.io/v1]
path: rest_api/operator_apis/ingresscontroller-operator-openshift-io-v1.adoc
- name: KubeAPIServer [operator.openshift.io/v1]
path: rest_api/operator_apis/kubeapiserver-operator-openshift-io-v1.adoc
- name: KubeControllerManager [operator.openshift.io/v1]
path: rest_api/operator_apis/kubecontrollermanager-operator-openshift-io-v1.adoc
- name: KubeScheduler [operator.openshift.io/v1]
path: rest_api/operator_apis/kubescheduler-operator-openshift-io-v1.adoc
- name: KubeStorageVersionMigrator [operator.openshift.io/v1]
path: rest_api/operator_apis/kubestorageversionmigrator-operator-openshift-io-v1.adoc
- name: Network [operator.openshift.io/v1]
path: rest_api/operator_apis/network-operator-openshift-io-v1.adoc
- name: OpenShiftAPIServer [operator.openshift.io/v1]
path: rest_api/operator_apis/openshiftapiserver-operator-openshift-io-v1.adoc
- name: OpenShiftControllerManager [operator.openshift.io/v1]
path: rest_api/operator_apis/openshiftcontrollermanager-operator-openshift-io-v1.adoc
- name: OperatorPKI [network.operator.openshift.io/v1]
path: rest_api/operator_apis/operatorpki-network-operator-openshift-io-v1.adoc
- name: ServiceCA [operator.openshift.io/v1]
path: rest_api/operator_apis/serviceca-operator-openshift-io-v1.adoc
- name: Storage [operator.openshift.io/v1]
path: rest_api/operator_apis/storage-operator-openshift-io-v1.adoc
- name: OperatorHub APIs
items:
- name: OperatorHub APIs
path: rest_api/operatorhub_apis/operatorhub-apis-index.adoc
- name: CatalogSource [operators.coreos.com/v1alpha1]
path: rest_api/operatorhub_apis/catalogsource-operators-coreos-com-v1alpha1.adoc
- name: ClusterServiceVersion [operators.coreos.com/v1alpha1]
path: rest_api/operatorhub_apis/clusterserviceversion-operators-coreos-com-v1alpha1.adoc
- name: InstallPlan [operators.coreos.com/v1alpha1]
path: rest_api/operatorhub_apis/installplan-operators-coreos-com-v1alpha1.adoc
- name: Operator [operators.coreos.com/v1]
path: rest_api/operatorhub_apis/operator-operators-coreos-com-v1.adoc
- name: OperatorCondition [operators.coreos.com/v2]
path: rest_api/operatorhub_apis/operatorcondition-operators-coreos-com-v2.adoc
- name: OperatorGroup [operators.coreos.com/v1]
path: rest_api/operatorhub_apis/operatorgroup-operators-coreos-com-v1.adoc
- name: PackageManifest [packages.operators.coreos.com/v1]
path: rest_api/operatorhub_apis/packagemanifest-packages-operators-coreos-com-v1.adoc
- name: Subscription [operators.coreos.com/v1alpha1]
path: rest_api/operatorhub_apis/subscription-operators-coreos-com-v1alpha1.adoc
- name: Policy APIs
items:
- name: Policy APIs
path: rest_api/policy_apis/policy-apis-index.adoc
- name: PodDisruptionBudget [policy/v1]
path: rest_api/policy_apis/poddisruptionbudget-policy-v1.adoc
- name: Project APIs
items:
- name: Project APIs
path: rest_api/project_apis/project-apis-index.adoc
- name: Project [project.openshift.io/v1]
path: rest_api/project_apis/project-project-openshift-io-v1.adoc
- name: ProjectRequest [project.openshift.io/v1]
path: rest_api/project_apis/projectrequest-project-openshift-io-v1.adoc
- name: Provisioning APIs
items:
- name: Provisioning APIs
path: rest_api/provisioning_apis/provisioning-apis-index.adoc
- name: BareMetalHost [metal3.io/v1alpha1]
path: rest_api/provisioning_apis/baremetalhost-metal3-io-v1alpha1.adoc
- name: Provisioning [metal3.io/v1alpha1]
path: rest_api/provisioning_apis/provisioning-metal3-io-v1alpha1.adoc
- name: RBAC APIs
items:
- name: RBAC APIs
path: rest_api/rbac_apis/rbac-apis-index.adoc
- name: ClusterRoleBinding [rbac.authorization.k8s.io/v1]
path: rest_api/rbac_apis/clusterrolebinding-rbac-authorization-k8s-io-v1.adoc
- name: ClusterRole [rbac.authorization.k8s.io/v1]
path: rest_api/rbac_apis/clusterrole-rbac-authorization-k8s-io-v1.adoc
- name: RoleBinding [rbac.authorization.k8s.io/v1]
path: rest_api/rbac_apis/rolebinding-rbac-authorization-k8s-io-v1.adoc
- name: Role [rbac.authorization.k8s.io/v1]
path: rest_api/rbac_apis/role-rbac-authorization-k8s-io-v1.adoc
- name: Role APIs
items:
- name: Role APIs
path: rest_api/role_apis/role-apis-index.adoc
- name: ClusterRoleBinding [authorization.openshift.io/v1]
path: rest_api/role_apis/clusterrolebinding-authorization-openshift-io-v1.adoc
- name: ClusterRole [authorization.openshift.io/v1]
path: rest_api/role_apis/clusterrole-authorization-openshift-io-v1.adoc
- name: RoleBindingRestriction [authorization.openshift.io/v1]
path: rest_api/role_apis/rolebindingrestriction-authorization-openshift-io-v1.adoc
- name: RoleBinding [authorization.openshift.io/v1]
path: rest_api/role_apis/rolebinding-authorization-openshift-io-v1.adoc
- name: Role [authorization.openshift.io/v1]
path: rest_api/role_apis/role-authorization-openshift-io-v1.adoc
- name: Schedule and quota APIs
items:
- name: Schedule and quota APIs
path: rest_api/schedule_and_quota_apis/schedule-and-quota-apis-index.adoc
- name: AppliedClusterResourceQuota [quota.openshift.io/v1]
path: rest_api/schedule_and_quota_apis/appliedclusterresourcequota-quota-openshift-io-v1.adoc
- name: ClusterResourceQuota [quota.openshift.io/v1]
path: rest_api/schedule_and_quota_apis/clusterresourcequota-quota-openshift-io-v1.adoc
- name: FlowSchema [flowcontrol.apiserver.k8s.io/v1beta1]
path: rest_api/schedule_and_quota_apis/flowschema-flowcontrol-apiserver-k8s-io-v1beta1.adoc
- name: LimitRange [core/v1]
path: rest_api/schedule_and_quota_apis/limitrange-core-v1.adoc
- name: PriorityClass [scheduling.k8s.io/v1]
path: rest_api/schedule_and_quota_apis/priorityclass-scheduling-k8s-io-v1.adoc
- name: PriorityLevelConfiguration [flowcontrol.apiserver.k8s.io/v1beta1]
path: rest_api/schedule_and_quota_apis/prioritylevelconfiguration-flowcontrol-apiserver-k8s-io-v1beta1.adoc
- name: ResourceQuota [core/v1]
path: rest_api/schedule_and_quota_apis/resourcequota-core-v1.adoc
- name: Security APIs
items:
- name: Security APIs
path: rest_api/security_apis/security-apis-index.adoc
- name: CertificateSigningRequest [certificates.k8s.io/v1]
path: rest_api/security_apis/certificatesigningrequest-certificates-k8s-io-v1.adoc
- name: CredentialsRequest [cloudcredential.openshift.io/v1]
path: rest_api/security_apis/credentialsrequest-cloudcredential-openshift-io-v1.adoc
- name: PodSecurityPolicyReview [security.openshift.io/v1]
path: rest_api/security_apis/podsecuritypolicyreview-security-openshift-io-v1.adoc
- name: PodSecurityPolicySelfSubjectReview [security.openshift.io/v1]
path: rest_api/security_apis/podsecuritypolicyselfsubjectreview-security-openshift-io-v1.adoc
- name: PodSecurityPolicySubjectReview [security.openshift.io/v1]
path: rest_api/security_apis/podsecuritypolicysubjectreview-security-openshift-io-v1.adoc
- name: RangeAllocation [security.openshift.io/v1]
path: rest_api/security_apis/rangeallocation-security-openshift-io-v1.adoc
- name: Secret [core/v1]
path: rest_api/security_apis/secret-core-v1.adoc
- name: SecurityContextConstraints [security.openshift.io/v1]
path: rest_api/security_apis/securitycontextconstraints-security-openshift-io-v1.adoc
- name: ServiceAccount [core/v1]
path: rest_api/security_apis/serviceaccount-core-v1.adoc
- name: Storage APIs
items:
- name: Storage APIs
path: rest_api/storage_apis/storage-apis-index.adoc
- name: CSIDriver [storage.k8s.io/v1]
path: rest_api/storage_apis/csidriver-storage-k8s-io-v1.adoc
- name: CSINode [storage.k8s.io/v1]
path: rest_api/storage_apis/csinode-storage-k8s-io-v1.adoc
- name: CSIStorageCapacity [storage.k8s.io/v1beta1]
path: rest_api/storage_apis/csistoragecapacity-storage-k8s-io-v1beta1.adoc
- name: PersistentVolumeClaim [core/v1]
path: rest_api/storage_apis/persistentvolumeclaim-core-v1.adoc
- name: StorageClass [storage.k8s.io/v1]
path: rest_api/storage_apis/storageclass-storage-k8s-io-v1.adoc
- name: StorageState [migration.k8s.io/v1alpha1]
path: rest_api/storage_apis/storagestate-migration-k8s-io-v1alpha1.adoc
- name: StorageVersionMigration [migration.k8s.io/v1alpha1]
path: rest_api/storage_apis/storageversionmigration-migration-k8s-io-v1alpha1.adoc
- name: VolumeAttachment [storage.k8s.io/v1]
path: rest_api/storage_apis/volumeattachment-storage-k8s-io-v1.adoc
- name: VolumeSnapshot [snapshot.storage.k8s.io/v1]
path: rest_api/storage_apis/volumesnapshot-snapshot-storage-k8s-io-v1.adoc
- name: VolumeSnapshotClass [snapshot.storage.k8s.io/v1]
path: rest_api/storage_apis/volumesnapshotclass-snapshot-storage-k8s-io-v1.adoc
- name: VolumeSnapshotContent [snapshot.storage.k8s.io/v1]
path: rest_api/storage_apis/volumesnapshotcontent-snapshot-storage-k8s-io-v1.adoc
- name: Template APIs
items:
- name: Template APIs
path: rest_api/template_apis/template-apis-index.adoc
- name: BrokerTemplateInstance [template.openshift.io/v1]
path: rest_api/template_apis/brokertemplateinstance-template-openshift-io-v1.adoc
- name: PodTemplate [core/v1]
path: rest_api/template_apis/podtemplate-core-v1.adoc
- name: Template [template.openshift.io/v1]
path: rest_api/template_apis/template-template-openshift-io-v1.adoc
- name: TemplateInstance [template.openshift.io/v1]
path: rest_api/template_apis/templateinstance-template-openshift-io-v1.adoc
- name: User and group APIs
items:
- name: User and group APIs
path: rest_api/user_and_group_apis/user-and-group-apis-index.adoc
- name: Group [user.openshift.io/v1]
path: rest_api/user_and_group_apis/group-user-openshift-io-v1.adoc
- name: Identity [user.openshift.io/v1]
path: rest_api/user_and_group_apis/identity-user-openshift-io-v1.adoc
- name: UserIdentityMapping [user.openshift.io/v1]
path: rest_api/user_and_group_apis/useridentitymapping-user-openshift-io-v1.adoc
- name: User [user.openshift.io/v1]
path: rest_api/user_and_group_apis/user-user-openshift-io-v1.adoc
- name: Workloads APIs
items:
- name: Workloads APIs
path: rest_api/workloads_apis/workloads-apis-index.adoc
- name: BuildConfig [build.openshift.io/v1]
path: rest_api/workloads_apis/buildconfig-build-openshift-io-v1.adoc
- name: Build [build.openshift.io/v1]
path: rest_api/workloads_apis/build-build-openshift-io-v1.adoc
- name: CronJob [batch/v1]
path: rest_api/workloads_apis/cronjob-batch-v1.adoc
- name: DaemonSet [apps/v1]
path: rest_api/workloads_apis/daemonset-apps-v1.adoc
- name: Deployment [apps/v1]
path: rest_api/workloads_apis/deployment-apps-v1.adoc
- name: DeploymentConfig [apps.openshift.io/v1]
path: rest_api/workloads_apis/deploymentconfig-apps-openshift-io-v1.adoc
- name: Job [batch/v1]
path: rest_api/workloads_apis/job-batch-v1.adoc
- name: Pod [core/v1]
path: rest_api/workloads_apis/pod-core-v1.adoc
- name: ReplicationController [core/v1]
path: rest_api/workloads_apis/replicationcontroller-core-v1.adoc
- name: PersistentVolume [core/v1]
path: rest_api/workloads_apis/persistentvolume-core-v1.adoc
- name: ReplicaSet [apps/v1]
path: rest_api/workloads_apis/replicaset-apps-v1.adoc
- name: StatefulSet [apps/v1]
path: rest_api/workloads_apis/statefulset-apps-v1.adoc
- name: Service Mesh
items:
- name: Service Mesh 2.x
items:
- name: About OpenShift Service Mesh
path: service_mesh/v2x/ossm-about.adoc
- name: Service Mesh Release Notes
path: service_mesh/v2x/servicemesh-release-notes.adoc
- name: Understanding Service Mesh
path: service_mesh/v2x/ossm-architecture.adoc
- name: Service mesh deployment models
path: service_mesh/v2x/ossm-deployment-models.adoc
- name: Service Mesh and Istio differences
path: service_mesh/v2x/ossm-vs-community.adoc
- name: Preparing to install Service Mesh
path: service_mesh/v2x/preparing-ossm-installation.adoc
- name: Installing the Operators
path: service_mesh/v2x/installing-ossm.adoc
- name: Creating the ServiceMeshControlPlane
path: service_mesh/v2x/ossm-create-smcp.adoc
- name: Adding services to a service mesh
path: service_mesh/v2x/ossm-create-mesh.adoc
- name: Enabling sidecar injection
path: service_mesh/v2x/prepare-to-deploy-applications-ossm.adoc
- name: Upgrading Service Mesh from version 2.0 to version 2.1
path: service_mesh/v2x/upgrading-ossm-to-2-1.adoc
- name: Upgrading Service Mesh from version 1.1 to version 2.0
path: service_mesh/v2x/upgrading-ossm.adoc
- name: Managing users and profiles
path: service_mesh/v2x/ossm-profiles-users.adoc
- name: Security
path: service_mesh/v2x/ossm-security.adoc
- name: Configuring traffic management
path: service_mesh/v2x/ossm-traffic-manage.adoc
- name: Metrics, logs, and traces
path: service_mesh/v2x/ossm-observability.adoc
- name: Performance and scalability
path: service_mesh/v2x/ossm-performance-scalability.adoc
- name: Configuring Service Mesh for production
path: service_mesh/v2x/ossm-deploy-production.adoc
- name: Connecting service meshes
path: service_mesh/v2x/ossm-federation.adoc
- name: Extensions
path: service_mesh/v2x/ossm-extensions.adoc
- name: Using the 3scale WebAssembly module
path: service_mesh/v2x/ossm-threescale-webassembly-module.adoc
- name: Using the 3scale Istio adapter
path: service_mesh/v2x/threescale-adapter.adoc
- name: Troubleshooting your service mesh
path: service_mesh/v2x/ossm-troubleshooting-istio.adoc
- name: Service Mesh control plane configuration reference
path: service_mesh/v2x/ossm-reference-smcp.adoc
- name: Jaeger configuration reference
path: service_mesh/v2x/ossm-reference-jaeger.adoc
- name: Uninstalling Service Mesh
path: service_mesh/v2x/removing-ossm.adoc
- name: Service Mesh 1.x
items:
- name: Service Mesh Release Notes
path: service_mesh/v1x/servicemesh-release-notes.adoc
- name: Understanding Service Mesh
path: service_mesh/v1x/ossm-architecture.adoc
- name: Service Mesh and Istio differences
path: service_mesh/v1x/ossm-vs-community.adoc
- name: Preparing to install Service Mesh
path: service_mesh/v1x/preparing-ossm-installation.adoc
- name: Installing Service Mesh
path: service_mesh/v1x/installing-ossm.adoc
- name: Customizing security in a Service Mesh
path: service_mesh/v1x/ossm-security.adoc
- name: Traffic management
path: service_mesh/v1x/ossm-traffic-manage.adoc
- name: Deploying applications on Service Mesh
path: service_mesh/v1x/prepare-to-deploy-applications-ossm.adoc
- name: Data visualization and observability
path: service_mesh/v1x/ossm-observability.adoc
- name: Custom resources
path: service_mesh/v1x/ossm-custom-resources.adoc
- name: Using the 3scale Istio adapter
path: service_mesh/v1x/threescale-adapter.adoc
- name: Removing Service Mesh
path: service_mesh/v1x/removing-ossm.adoc
- name: Distributed tracing
items:
- name: Distributed tracing release notes
path: distr_tracing/distributed-tracing-release-notes.adoc
- name: Distributed tracing architecture
items:
- name: Distributed tracing architecture
path: distr_tracing/distr_tracing_arch/distr-tracing-architecture.adoc
- name: Distributed tracing installation
items:
- name: Installing distributed tracing
path: distr_tracing/distr_tracing_install/distr-tracing-installing.adoc
- name: Configuring and deploying distributed tracing
path: distr_tracing/distr_tracing_install/distr-tracing-deploying.adoc
- name: Configuring and deploying distributed tracing data collection
path: distr_tracing/distr_tracing_install/distr-tracing-deploying-otel.adoc
- name: Upgrading distributed tracing
path: distr_tracing/distr_tracing_install/distr-tracing-updating.adoc
- name: Removing distributed tracing
path: distr_tracing/distr_tracing_install/distr-tracing-removing.adoc
- name: Virtualization
items:
- name: About OpenShift Virtualization
path: virt/about-virt.adoc
- name: Cluster administrator
path: virt/virt-learn-more-about-openshift-virtualization.adoc
- name: undefined
path: virt/virt-4-8-release-notes.adoc
- name: Installing
items:
- name: Configuring your cluster for OpenShift Virtualization
path: virt/install/preparing-cluster-for-virt.adoc
- name: Additional resources
path: virt/install/virt-planning-environment-object-maximums.adoc
- name: Specifying nodes for OpenShift Virtualization components
path: virt/install/virt-specifying-nodes-for-virtualization-components.adoc
- name: Installing OpenShift Virtualization using the web console
path: virt/install/installing-virt-web.adoc
- name: Installing OpenShift Virtualization using the CLI
path: virt/install/installing-virt-cli.adoc
- name: Enabling the virtctl client
path: virt/install/virt-enabling-virtctl.adoc
- name: Prerequisites
path: virt/install/uninstalling-virt-web.adoc
- name: Prerequisites
path: virt/install/uninstalling-virt-cli.adoc
- name: Configuring automatic workload updates
path: virt/upgrading-virt.adoc
- name: Additional security privileges granted for kubevirt-controller and virt-launcher
path: virt/virt-additional-security-privileges-controller-and-launcher.adoc
- name: Using the CLI tools
path: virt/virt-using-the-cli-tools.adoc
- name: Virtual machines
items:
- name: Creating virtual machines
path: virt/virtual_machines/virt-create-vms.adoc
- name: Editing virtual machines
path: virt/virtual_machines/virt-edit-vms.adoc
- name: Editing boot order
path: virt/virtual_machines/virt-edit-boot-order.adoc
- name: Deleting virtual machines
path: virt/virtual_machines/virt-delete-vms.adoc
- name: Managing virtual machine instances
path: virt/virtual_machines/virt-manage-vmis.adoc
- name: Controlling virtual machine states
path: virt/virtual_machines/virt-controlling-vm-states.adoc
- name: Accessing virtual machine consoles
path: virt/virtual_machines/virt-accessing-vm-consoles.adoc
- name: Triggering virtual machine failover by resolving a failed node
path: virt/virtual_machines/virt-triggering-vm-failover-resolving-failed-node.adoc
- name: Installing the QEMU guest agent on virtual machines
path: virt/virtual_machines/virt-installing-qemu-guest-agent.adoc
- name: Viewing the QEMU guest agent information for virtual machines
path: virt/virtual_machines/virt-viewing-qemu-guest-agent-web.adoc
- name: Managing config maps, secrets, and service accounts in virtual machines
path: virt/virtual_machines/virt-managing-configmaps-secrets-service-accounts.adoc
- name: Installing VirtIO driver on an existing Windows virtual machine
path: virt/virtual_machines/virt-installing-virtio-drivers-on-existing-windows-vm.adoc
- name: Installing VirtIO driver on a new Windows virtual machine
path: virt/virtual_machines/virt-installing-virtio-drivers-on-new-windows-vm.adoc
- name: Advanced virtual machine management
items:
- name: Specifying nodes for virtual machines
path: virt/virtual_machines/advanced_vm_management/virt-specifying-nodes-for-vms.adoc
- name: Configuring certificate rotation
path: virt/virtual_machines/advanced_vm_management/virt-configuring-certificate-rotation.adoc
- name: Automating management tasks
path: virt/virtual_machines/advanced_vm_management/virt-automating-management-tasks.adoc
- name: Using EFI mode for virtual machines
path: virt/virtual_machines/advanced_vm_management/virt-efi-mode-for-vms.adoc
- name: Configuring PXE booting for virtual machines
path: virt/virtual_machines/advanced_vm_management/virt-configuring-pxe-booting.adoc
- name: Managing guest memory
path: virt/virtual_machines/advanced_vm_management/virt-managing-guest-memory.adoc
- name: Using huge pages with virtual machines
path: virt/virtual_machines/advanced_vm_management/virt-using-huge-pages-with-vms.adoc
- name: Enabling dedicated resources for virtual machines
path: virt/virtual_machines/advanced_vm_management/virt-dedicated-resources-vm.adoc
- name: Scheduling virtual machines
path: virt/virtual_machines/advanced_vm_management/virt-schedule-vms.adoc
- name: Configuring PCI passthrough
path: virt/virtual_machines/advanced_vm_management/virt-configuring-pci-passthrough.adoc
- name: Configuring a watchdog
path: virt/virtual_machines/advanced_vm_management/virt-configuring-a-watchdog.adoc
- name: Importing virtual machines
items:
- name: TLS certificates for data volume imports
path: virt/virtual_machines/importing_vms/virt-tls-certificates-for-dv-imports.adoc
- name: Importing virtual machine images with data volumes
path: virt/virtual_machines/importing_vms/virt-importing-virtual-machine-images-datavolumes.adoc
- name: Importing virtual machine images to block storage with data volumes
path: virt/virtual_machines/importing_vms/virt-importing-virtual-machine-images-datavolumes-block.adoc
- name: Cloning virtual machines
items:
- name: Enabling user permissions to clone data volumes across namespaces
path: virt/virtual_machines/cloning_vms/virt-enabling-user-permissions-to-clone-datavolumes.adoc
- name: Cloning a virtual machine disk into a new data volume
path: virt/virtual_machines/cloning_vms/virt-cloning-vm-disk-into-new-datavolume.adoc
- name: Cloning a virtual machine by using a data volume template
path: virt/virtual_machines/cloning_vms/virt-cloning-vm-using-datavolumetemplate.adoc
- name: Cloning a virtual machine disk into a new block storage data volume
path: virt/virtual_machines/cloning_vms/virt-cloning-vm-disk-into-new-datavolume-block.adoc
- name: Virtual machine networking
items:
- name: Using the default pod network for virtual machines
path: virt/virtual_machines/vm_networking/virt-using-the-default-pod-network-with-virt.adoc
- name: Attaching a virtual machine to multiple networks
path: virt/virtual_machines/vm_networking/virt-attaching-vm-multiple-networks.adoc
- name: Configuring IP addresses for virtual machines
path: virt/virtual_machines/vm_networking/virt-configuring-ip-for-vms.adoc
- name: Configuring an SR-IOV network device for virtual machines
path: virt/virtual_machines/vm_networking/virt-configuring-sriov-device-for-vms.adoc
- name: Connecting virtual machines to a service mesh
path: virt/virtual_machines/vm_networking/virt-connecting-vm-to-service-mesh.adoc
- name: Defining an SR-IOV network
path: virt/virtual_machines/vm_networking/virt-defining-an-sriov-network.adoc
- name: Attaching a virtual machine to an SR-IOV network
path: virt/virtual_machines/vm_networking/virt-attaching-vm-to-sriov-network.adoc
- name: Viewing the IP address of NICs on a virtual machine
path: virt/virtual_machines/vm_networking/virt-viewing-ip-of-vm-nic.adoc
- name: Using a MAC address pool for virtual machines
path: virt/virtual_machines/vm_networking/virt-using-mac-address-pool-for-vms.adoc
- name: Virtual machine disks
items:
- name: Storage features
path: virt/virtual_machines/virtual_disks/virt-features-for-storage.adoc
- name: Configuring local storage for virtual machines
path: virt/virtual_machines/virtual_disks/virt-configuring-local-storage-for-vms.adoc
- name: Creating data volumes
path: virt/virtual_machines/virtual_disks/virt-creating-data-volumes.adoc
- name: Reserving PVC space for file system overhead
path: virt/virtual_machines/virtual_disks/virt-reserving-pvc-space-fs-overhead.adoc
- name: Configuring CDI to work with namespaces that have a compute resource quota
path: virt/virtual_machines/virtual_disks/virt-configuring-cdi-for-namespace-resourcequota.adoc
- name: Managing data volume annotations
path: virt/virtual_machines/virtual_disks/virt-managing-data-volume-annotations.adoc
- name: Using preallocation for data volumes
path: virt/virtual_machines/virtual_disks/virt-using-preallocation-for-datavolumes.adoc
- name: Uploading local disk images by using the web console
path: virt/virtual_machines/virtual_disks/virt-uploading-local-disk-images-web.adoc
- name: Uploading local disk images by using the virtctl tool
path: virt/virtual_machines/virtual_disks/virt-uploading-local-disk-images-virtctl.adoc
- name: Uploading a local disk image to a block storage data volume
path: virt/virtual_machines/virtual_disks/virt-uploading-local-disk-images-block.adoc
- name: Managing virtual machine snapshots
path: virt/virtual_machines/virtual_disks/virt-managing-vm-snapshots.adoc
- name: Moving a local virtual machine disk to a different node
path: virt/virtual_machines/virtual_disks/virt-moving-local-vm-disk-to-different-node.adoc
- name: Expanding virtual storage by adding blank disk images
path: virt/virtual_machines/virtual_disks/virt-expanding-virtual-storage-with-blank-disk-images.adoc
- name: Cloning a data volume using smart-cloning
path: virt/virtual_machines/virtual_disks/virt-cloning-a-datavolume-using-smart-cloning.adoc
- name: Storage defaults for data volumes
path: virt/virtual_machines/virtual_disks/virt-storage-defaults-for-datavolumes.adoc
- name: Creating and using boot sources
path: virt/virtual_machines/virtual_disks/virt-creating-and-using-boot-sources.adoc
- name: Hot-plugging virtual disks
path: virt/virtual_machines/virtual_disks/virt-hot-plugging-virtual-disks.adoc
- name: Using container disks with virtual machines
path: virt/virtual_machines/virtual_disks/virt-using-container-disks-with-vms.adoc
- name: Preparing CDI scratch space
path: virt/virtual_machines/virtual_disks/virt-preparing-cdi-scratch-space.adoc
- name: Re-using persistent volumes
path: virt/virtual_machines/virtual_disks/virt-reusing-statically-provisioned-persistent-volumes.adoc
- name: Deleting data volumes
path: virt/virtual_machines/virtual_disks/virt-deleting-datavolumes.adoc
- name: Virtual machine templates
items:
- name: Creating virtual machine templates
path: virt/vm_templates/virt-creating-vm-template.adoc
- name: Editing virtual machine templates
path: virt/vm_templates/virt-editing-vm-template.adoc
- name: Enabling dedicated resources for virtual machine templates
path: virt/vm_templates/virt-dedicated-resources-vm-template.adoc
- name: Deleting a virtual machine template
path: virt/vm_templates/virt-deleting-vm-template.adoc
- name: Live migration
items:
- name: Virtual machine live migration
path: virt/live_migration/virt-live-migration.adoc
- name: Live migration limits and timeouts
path: virt/live_migration/virt-live-migration-limits.adoc
- name: Migrating a virtual machine instance to another node
path: virt/live_migration/virt-migrate-vmi.adoc
- name: Monitoring live migration of a virtual machine instance
path: virt/live_migration/virt-monitor-vmi-migration.adoc
- name: Cancelling the live migration of a virtual machine instance
path: virt/live_migration/virt-cancel-vmi-migration.adoc
- name: Configuring virtual machine eviction strategy
path: virt/live_migration/virt-configuring-vmi-eviction-strategy.adoc
- name: Node maintenance
items:
- name: About node maintenance
path: virt/node_maintenance/virt-about-node-maintenance.adoc
- name: Setting a node to maintenance mode
path: virt/node_maintenance/virt-setting-node-maintenance.adoc
- name: Resuming a node from maintenance mode
path: virt/node_maintenance/virt-resuming-node.adoc
- name: Automatic renewal of TLS certificates
path: virt/node_maintenance/virt-automatic-certificates.adoc
- name: Managing node labeling for obsolete CPU models
path: virt/node_maintenance/virt-managing-node-labeling-obsolete-cpu-models.adoc
- name: Preventing node reconciliation
path: virt/node_maintenance/virt-preventing-node-reconciliation.adoc
- name: Node networking
items:
- name: Observing node network state
path: virt/node_network/virt-observing-node-network-state.adoc
- name: Updating node network configuration
path: virt/node_network/virt-updating-node-network-config.adoc
- name: Troubleshooting node network configuration
path: virt/node_network/virt-troubleshooting-node-network.adoc
- name: Logging, events, and monitoring
items:
- name: Reviewing Virtualization Overview
path: virt/logging_events_monitoring/virt-reviewing-virtualization-overview.adoc
- name: Viewing virtual machine logs
path: virt/logging_events_monitoring/virt-logs.adoc
- name: Viewing events
path: virt/logging_events_monitoring/virt-events.adoc
- name: Diagnosing data volumes using events and conditions
path: virt/logging_events_monitoring/virt-diagnosing-datavolumes-using-events-and-conditions.adoc
- name: Viewing information about virtual machine workloads
path: virt/logging_events_monitoring/virt-viewing-information-about-vm-workloads.adoc
- name: Monitoring virtual machine health
path: virt/logging_events_monitoring/virt-monitoring-vm-health.adoc
- name: Using the OpenShift Container Platform dashboard to get cluster information
path: virt/logging_events_monitoring/virt-using-dashboard-to-get-cluster-info.adoc
- name: Reviewing resource usage by virtual machines
path: virt/logging_events_monitoring/virt-reviewing-vm-dashboard.adoc
- name: OpenShift Container Platform cluster monitoring, logging, and Telemetry
path: virt/logging_events_monitoring/virt-openshift-cluster-monitoring.adoc
- name: Prometheus queries for virtual resources
path: virt/logging_events_monitoring/virt-prometheus-queries.adoc
- name: Collecting OpenShift Virtualization data for Red Hat Support
path: virt/logging_events_monitoring/virt-collecting-virt-data.adoc
- name: Serverless
items:
- name: OpenShift Serverless Release Notes
path: serverless/serverless-release-notes.adoc
- name: Discover
items:
- name: About OpenShift Serverless
path: serverless/discover/about-serverless.adoc
- name: About OpenShift Serverless Functions
path: serverless/discover/serverless-functions-about.adoc
- name: Knative Serving components
path: serverless/discover/serverless-serving-components.adoc
- name: Knative Eventing components
path: serverless/discover/serverless-eventing-components.adoc
- name: Event sources
path: serverless/discover/knative-event-sources.adoc
- name: Channels
path: serverless/discover/serverless-channels.adoc
- name: Install
items:
- name: Installing the OpenShift Serverless Operator
path: serverless/install/install-serverless-operator.adoc
- name: Installing Knative Serving
path: serverless/install/installing-knative-serving.adoc
- name: Installing Knative Eventing
path: serverless/install/installing-knative-eventing.adoc
- name: Removing OpenShift Serverless
path: serverless/install/removing-openshift-serverless.adoc
- name: Update
path: serverless/serverless-update.adoc
- name: Develop
items:
- name: Serverless applications
path: serverless/develop/serverless-applications.adoc
- name: About autoscaling
path: serverless/develop/serverless-autoscaling.adoc
- name: Scale bounds
path: serverless/develop/serverless-autoscaling-scale-bounds.adoc
- name: Concurrency
path: serverless/develop/serverless-autoscaling-concurrency.adoc
- name: Traffic management
path: serverless/develop/serverless-traffic-management.adoc
- name: Routing
path: serverless/develop/serverless-configuring-routes.adoc
- name: Event sinks
path: serverless/develop/serverless-event-sinks.adoc
- name: Using the API server source
path: serverless/develop/serverless-apiserversource.adoc
- name: Using a ping source
path: serverless/develop/serverless-pingsource.adoc
- name: Custom event sources
path: serverless/develop/serverless-custom-event-sources.adoc
- name: Creating and deleting channels
path: serverless/develop/serverless-creating-channels.adoc
- name: Subscriptions
path: serverless/develop/serverless-subs.adoc
- name: Knative Kafka
path: serverless/develop/serverless-kafka-developer.adoc
- name: Administer
items:
- name: Configuring OpenShift Serverless
path: serverless/admin_guide/serverless-configuration.adoc
- name: Configuring channel defaults
path: serverless/admin_guide/serverless-configuring-channels.adoc
- name: Knative Kafka
path: serverless/admin_guide/serverless-kafka-admin.adoc
- name: Creating Eventing components in the Administrator perspective
path: serverless/admin_guide/serverless-cluster-admin-eventing.adoc
- name: Creating Knative Serving components in the Administrator perspective
path: serverless/admin_guide/serverless-cluster-admin-serving.adoc
- name: Configuring the Knative Serving custom resource
path: serverless/admin_guide/knative-serving-CR-config.adoc
- name: Integrating Service Mesh with OpenShift Serverless
path: serverless/admin_guide/serverless-ossm-setup.adoc
- name: Monitoring serverless components
path: serverless/admin_guide/serverless-admin-monitoring.adoc
- name: Metrics
path: serverless/admin_guide/serverless-admin-metrics.adoc
- name: High availability on OpenShift Serverless
path: serverless/admin_guide/serverless-ha.adoc
- name: Monitor
items:
- name: Using OpenShift Logging with OpenShift Serverless
path: serverless/monitor/cluster-logging-serverless.adoc
- name: Tracing requests using Jaeger
path: serverless/monitor/serverless-tracing.adoc
- name: Metrics
path: serverless/monitor/serverless-serving-metrics.adoc
- name: Monitoring Knative services
path: serverless/monitor/serverless-service-monitoring.adoc
- name: Autoscaling dashboard
path: serverless/monitor/serverless-autoscaling-dashboard.adoc
- name: OpenShift Serverless support
path: serverless/serverless-support.adoc
- name: Security
items:
- name: Configuring JSON Web Token authentication for Knative services
path: serverless/security/serverless-ossm-with-kourier-jwt.adoc
- name: Configuring a custom domain for a Knative service
path: serverless/security/serverless-custom-domains.adoc
- name: Using a custom TLS certificate for domain mapping
path: serverless/security/serverless-custom-tls-cert-domain-mapping.adoc
- name: Security configuration for Knative Kafka
path: serverless/security/serverless-kafka-security.adoc
- name: Knative Eventing
items:
- name: Brokers
path: serverless/knative_eventing/serverless-using-brokers.adoc
- name: Filtering events from a broker by using triggers
path: serverless/knative_eventing/serverless-triggers.adoc
- name: Event delivery
path: serverless/knative_eventing/serverless-event-delivery.adoc
- name: Functions
items:
- name: Setting up OpenShift Serverless Functions
path: serverless/functions/serverless-functions-setup.adoc
- name: Getting started with functions
path: serverless/functions/serverless-functions-getting-started.adoc
- name: Developing Node.js functions
path: serverless/functions/serverless-developing-nodejs-functions.adoc
- name: Developing TypeScript functions
path: serverless/functions/serverless-developing-typescript-functions.adoc
- name: Developing Golang functions
path: serverless/functions/serverless-developing-go-functions.adoc
- name: Developing Python functions
path: serverless/functions/serverless-developing-python-functions.adoc
- name: Developing Quarkus functions
path: serverless/functions/serverless-developing-quarkus-functions.adoc
- name: Using functions with Knative Eventing
path: serverless/functions/serverless-functions-eventing.adoc
- name: Function project configuration in func.yaml
path: serverless/functions/serverless-functions-yaml.adoc
- name: Accessing secrets and config maps from Serverless functions
path: serverless/functions/serverless-functions-accessing-secrets-configmaps.adoc
- name: Adding annotations to functions
path: serverless/functions/serverless-functions-annotations.adoc
- name: Functions development reference guide
path: serverless/functions/serverless-functions-reference-guide.adoc
- name: Integrations
items:
- name: Using NVIDIA GPU resources with serverless applications
path: serverless/integrations/gpu-resources.adoc
- name: CLI tools
items:
- name: Installing the Knative CLI
path: serverless/cli_tools/installing-kn.adoc
- name: Knative CLI advanced configuration
path: serverless/cli_tools/advanced-kn-config.adoc
- name: Reference
items:
- name: kn flags reference
path: serverless/reference/kn-flags-reference.adoc
- name: Knative Serving CLI commands
path: serverless/reference/kn-serving-ref.adoc
- name: Knative Eventing CLI commands
path: serverless/reference/kn-eventing-ref.adoc
- name: Listing event sources and event source types
path: serverless/reference/serverless-listing-event-sources.adoc
- name: kn func
path: serverless/reference/kn-func-ref.adoc