# This configuration file dictates the organization of the topic groups and # topics on the main page of the doc site for this branch. Each record # consists of the following: # # --- <= Record delimiter # Name: Origin of the Species <= Display name of topic group # Dir: origin_of_the_species <= Directory name of topic group # Topics: # - Name: The Majestic Marmoset <= Topic name # File: the_majestic_marmoset <= Topic file under group dir +/- # - Name: The Curious Crocodile <= Topic 2 name # File: the_curious_crocodile <= Topic 2 file # - Name: The Numerous Nematodes <= Sub-topic group name # Dir: the_numerous_nematodes <= Sub-topic group dir # Topics: # - Name: The Wily Worm <= Sub-topic name # File: the_wily_worm <= Sub-topic file under / # - Name: The Acrobatic Ascarid <= Sub-topic 2 name # File: the_acrobatic_ascarid <= Sub-topic 2 file under / # # The ordering of the records in this document determines the ordering of the # topic groups and topics on the main page. --- Name: Welcome Dir: welcome Distros: openshift-enterprise,openshift-webscale,openshift-origin,openshift-dedicated,openshift-online Topics: - Name: Welcome File: index - Name: About OpenShift Kubernetes Engine File: oke_about Distros: openshift-enterprise,openshift-webscale - Name: Legal notice File: legal-notice --- Name: What's new? Dir: whats_new Distros: openshift-origin Topics: - Name: New features and enhancements File: new-features - Name: Deprecated features File: deprecated-features --- Name: Getting started Dir: getting_started Distros: openshift-dedicated Topics: - Name: Accessing your services File: accessing-your-services - Name: Scaling your cluster File: scaling-your-cluster - Name: Deleting your cluster File: deleting-your-cluster - Name: Networking File: dedicated-networking --- Name: Cloud infrastructure access Dir: cloud_infrastructure_access Distros: openshift-dedicated Topics: - Name: Understanding cloud infrastructure access File: dedicated-understanding-aws - Name: Accessing AWS infrastructure File: dedicated-aws-access - Name: Configuring AWS VPC peering File: dedicated-aws-peering - Name: Configuring AWS VPN File: dedicated-aws-vpn - Name: Configuring AWS Direct Connect File: dedicated-aws-dc - Name: Configuring a private cluster File: dedicated-aws-private-cluster --- Name: Release notes Dir: release_notes Distros: openshift-enterprise,openshift-webscale,openshift-origin Topics: - Name: OpenShift Container Platform 4.6 release notes File: ocp-4-6-release-notes - Name: Versioning policy File: versioning-policy --- Name: Architecture Dir: architecture Distros: openshift-enterprise,openshift-webscale,openshift-origin,openshift-dedicated,openshift-online Topics: - Name: Product architecture File: architecture - Name: Installation and update Distros: openshift-enterprise,openshift-webscale,openshift-origin File: architecture-installation - Name: The control plane File: control-plane Distros: openshift-enterprise,openshift-webscale,openshift-origin,openshift-dedicated,openshift-online - Name: Understanding OpenShift development File: understanding-development - Name: Fedora CoreOS File: architecture-rhcos Distros: openshift-origin - Name: Red Hat Enterprise Linux CoreOS File: architecture-rhcos Distros: openshift-enterprise,openshift-webscale - Name: The CI/CD methodology and practice File: cicd_gitops Distros: openshift-enterprise,openshift-webscale - Name: Using ArgoCD File: argocd - Name: Admission plug-ins File: admission-plug-ins Distros: openshift-enterprise,openshift-webscale,openshift-aro --- Name: Administering a cluster Dir: administering_a_cluster Distros: openshift-dedicated Topics: - Name: The dedicated-admin role File: dedicated-admin-role - Name: The cluster-admin role File: cluster-admin-role --- Name: Installing Dir: installing Distros: openshift-origin,openshift-enterprise,openshift-webscale Topics: - Name: Installing on AWS Dir: installing_aws Topics: - Name: Configuring an AWS account File: installing-aws-account - Name: Manually creating IAM File: manually-creating-iam - Name: Installing a cluster quickly on AWS File: installing-aws-default - Name: Installing a cluster on AWS with customizations File: installing-aws-customizations - Name: Installing a cluster on AWS with network customizations File: installing-aws-network-customizations - Name: Installing a cluster on AWS into an existing VPC File: installing-aws-vpc - Name: Installing a private cluster on AWS File: installing-aws-private - Name: Installing a cluster on AWS into a government region File: installing-aws-government-region - Name: Installing a cluster on AWS using CloudFormation templates File: installing-aws-user-infra - Name: Installing a cluster on AWS in a restricted network File: installing-restricted-networks-aws - Name: Uninstalling a cluster on AWS File: uninstalling-cluster-aws - Name: Installing on Azure Dir: installing_azure Topics: - Name: Configuring an Azure account File: installing-azure-account - Name: Manually creating IAM File: manually-creating-iam-azure - Name: Installing a cluster quickly on Azure File: installing-azure-default - Name: Installing a cluster on Azure with customizations File: installing-azure-customizations - Name: Installing a cluster on Azure with network customizations File: installing-azure-network-customizations - Name: Installing a cluster on Azure into an existing VNet File: installing-azure-vnet - Name: Installing a private cluster on Azure File: installing-azure-private - Name: Installing a cluster on Azure using ARM templates File: installing-azure-user-infra - Name: Uninstalling a cluster on Azure File: uninstalling-cluster-azure - Name: Installing on GCP Dir: installing_gcp Topics: - Name: Configuring a GCP project File: installing-gcp-account - Name: Manually creating IAM File: manually-creating-iam-gcp - Name: Installing a cluster quickly on GCP File: installing-gcp-default - Name: Installing a cluster on GCP with customizations File: installing-gcp-customizations - Name: Installing a cluster on GCP with network customizations File: installing-gcp-network-customizations - Name: Installing a cluster on GCP into an existing VPC File: installing-gcp-vpc - Name: Installing a private cluster on GCP File: installing-gcp-private - Name: Installing a cluster on GCP using Deployment Manager templates File: installing-gcp-user-infra - Name: Installing a cluster on GCP using Deployment Manager templates and a shared VPC File: installing-gcp-user-infra-vpc - Name: Restricted network GCP installation File: installing-restricted-networks-gcp - Name: Uninstalling a cluster on GCP File: uninstalling-cluster-gcp - Name: Installing on bare metal Dir: installing_bare_metal Topics: - Name: Installing a cluster on bare metal File: installing-bare-metal - Name: Installing a cluster on bare metal with network customizations File: installing-bare-metal-network-customizations - Name: Restricted network bare metal installation File: installing-restricted-networks-bare-metal - Name: Deploying IPI bare metal Dir: installing_bare_metal_ipi Distros: openshift-origin,openshift-enterprise,openshift-webscale Topics: - Name: Overview File: ipi-install-overview - Name: Prerequisites File: ipi-install-prerequisites - Name: Setting up the environment for an OpenShift installation File: ipi-install-installation-workflow - Name: Troubleshooting File: ipi-install-troubleshooting - Name: Installing on IBM Z and LinuxONE Dir: installing_ibm_z Distros: openshift-enterprise,openshift-webscale Topics: - Name: Installing a cluster on IBM Z and LinuxONE File: installing-ibm-z - Name: Restricted network IBM Z installation File: installing-restricted-networks-ibm-z - Name: Installing on IBM Power Dir: installing_ibm_power Distros: openshift-enterprise,openshift-webscale Topics: - Name: Installing a cluster on IBM Power File: installing-ibm-power - Name: Restricted network IBM Power installation File: installing-restricted-networks-ibm-power - Name: Installing on OpenStack Dir: installing_openstack Topics: # - Name: Installing a cluster on OpenStack # File: installing-openstack-installer - Name: Installing a cluster on OpenStack with customizations File: installing-openstack-installer-custom - Name: Installing a cluster on OpenStack with Kuryr File: installing-openstack-installer-kuryr - Name: Installing a cluster on OpenStack on your own infrastructure File: installing-openstack-user - Name: Installing a cluster on OpenStack with Kuryr on your own infrastructure File: installing-openstack-user-kuryr # - Name: Load balancing deployments on OpenStack # File: installing-openstack-load-balancing - Name: Uninstalling a cluster on OpenStack File: uninstalling-cluster-openstack - Name: Uninstalling a cluster on OpenStack from your own infrastructure File: uninstalling-openstack-user - Name: Installing on RHV Dir: installing_rhv Topics: - Name: Installing a cluster quickly on RHV File: installing-rhv-default - Name: Installing a cluster on RHV with customizations File: installing-rhv-customizations - Name: Uninstalling a cluster on RHV File: uninstalling-cluster-rhv - Name: Installing on vSphere Dir: installing_vsphere Topics: - Name: Installing a cluster on vSphere File: installing-vsphere-installer-provisioned - Name: Installing a cluster on vSphere with customizations File: installing-vsphere-installer-provisioned-customizations - Name: Installing a cluster on vSphere with network customizations File: installing-vsphere-installer-provisioned-network-customizations - Name: Installing a cluster on vSphere with user-provisioned infrastructure File: installing-vsphere - Name: Installing a cluster on vSphere with user-provisioned infrastructure and network customizations File: installing-vsphere-network-customizations - Name: Restricted network vSphere installation with user-provisioned infrastructure File: installing-restricted-networks-vsphere - Name: Uninstalling a cluster on vSphere that uses installer-provisioned infrastructure File: uninstalling-cluster-vsphere-installer-provisioned - Name: Installation configuration Dir: install_config Topics: - Name: Installation methods for different platforms File: installation-types - Name: Customizing nodes File: installing-customizing - Name: Creating a mirror registry for a restricted network File: installing-restricted-networks-preparations - Name: Available cluster customizations File: customizations Distros: openshift-enterprise,openshift-webscale,openshift-origin - Name: Configuring your firewall File: configuring-firewall - Name: Configuring a private cluster Distros: openshift-enterprise,openshift-webscale,openshift-origin File: configuring-private-cluster - Name: Troubleshooting installation issues File: installing-troubleshooting - Name: Support for FIPS cryptography File: installing-fips Distros: openshift-enterprise,openshift-webscale,openshift-dedicated,openshift-online --- Name: Updating clusters Dir: updating Distros: openshift-origin,openshift-enterprise,openshift-webscale Topics: - Name: Updating a cluster between minor versions File: updating-cluster-between-minor - Name: Updating a cluster within a minor version from the web console File: updating-cluster - Name: Updating a cluster within a minor version by using the CLI File: updating-cluster-cli - Name: Updating a cluster that includes RHEL compute machines File: updating-cluster-rhel-compute Distros: openshift-enterprise,openshift-webscale - Name: Updating a restricted network cluster File: updating-restricted-network-cluster Distros: openshift-enterprise,openshift-webscale # - Name: Troubleshooting an update # File: updating-troubleshooting --- Name: Post-installation configuration Dir: post_installation_configuration Distros: openshift-origin,openshift-enterprise,openshift-webscale Topics: - Name: Machine configuration tasks File: machine-configuration-tasks - Name: Cluster tasks File: cluster-tasks - Name: Node tasks File: node-tasks - Name: Network configuration File: network-configuration - Name: Storage configuration File: storage-configuration - Name: Preparing for users File: preparing-for-users --- Name: Support Dir: support Distros: openshift-enterprise,openshift-webscale,openshift-online,openshift-dedicated Topics: - Name: Getting support File: getting-support - Name: Gathering data about your cluster File: gathering-cluster-data Distros: openshift-enterprise,openshift-webscale - Name: Summarizing cluster specifications File: summarizing-cluster-specifications Distros: openshift-enterprise,openshift-webscale,openshift-origin - Name: Remote health monitoring with connected clusters Dir: remote_health_monitoring Distros: openshift-enterprise,openshift-webscale,openshift-dedicated Topics: - Name: About remote health monitoring File: about-remote-health-monitoring - Name: Showing data collected by remote health monitoring File: showing-data-collected-by-remote-health-monitoring - Name: Opting out of remote health reporting File: opting-out-of-remote-health-reporting - Name: Using Insights to identify issues with your cluster File: using-insights-to-identify-issues-with-your-cluster - Name: Troubleshooting Dir: troubleshooting Distros: openshift-enterprise,openshift-dedicated,openshift-webscale,openshift-origin Topics: - Name: Troubleshooting installations File: troubleshooting-installations - Name: Verifying node health File: verifying-node-health - Name: Troubleshooting CRI-O container runtime issues File: troubleshooting-crio-issues - Name: Troubleshooting Operator issues File: troubleshooting-operator-issues - Name: Investigating Pod issues File: investigating-pod-issues - Name: Troubleshooting the Source-to-Image process File: troubleshooting-s2i - Name: Troubleshooting storage issues File: troubleshooting-storage-issues - Name: Investigating monitoring issues File: investigating-monitoring-issues - Name: Diagnosing OpenShift CLI (oc) issues File: diagnosing-oc-issues --- Name: Web console Dir: web_console Distros: openshift-enterprise,openshift-webscale,openshift-origin,openshift-dedicated,openshift-online Topics: - Name: Accessing the web console File: web-console - Name: Viewing cluster information File: using-dashboard-to-get-cluster-information Distros: openshift-enterprise,openshift-webscale,openshift-origin - Name: Configuring the web console File: configuring-web-console Distros: openshift-enterprise,openshift-webscale,openshift-origin - Name: Customizing the web console File: customizing-the-web-console Distros: openshift-enterprise,openshift-webscale,openshift-origin - Name: Developer perspective File: odc-about-developer-perspective - Name: Disabling the web console File: disabling-web-console Distros: openshift-enterprise,openshift-webscale,openshift-origin --- Name: Security and compliance Dir: security Distros: openshift-enterprise,openshift-webscale,openshift-origin,openshift-aro Topics: - Name: Compliance Operator Dir: compliance_operator Topics: - Name: Understanding the Compliance Operator File: compliance-operator-understanding - Name: Managing the Compliance Operator File: compliance-operator-manage - Name: Managing Compliance Operator remediation File: compliance-operator-remediation - Name: Tailoring the Compliance Operator File: compliance-operator-tailor - Name: Retrieving Compliance Operator raw results File: compliance-operator-raw-results - Name: Performing advanced Compliance Operator tasks File: compliance-operator-advanced - Name: Troubleshooting the Compliance Operator File: compliance-operator-troubleshooting - Name: File Integrity Operator Dir: file_integrity_operator Topics: - Name: Understanding the File Integrity Operator File: file-integrity-operator-understanding - Name: Configuring the File Integrity Operator File: file-integrity-operator-configuring - Name: Performing advanced File Integrity Operator tasks File: file-integrity-operator-advanced-usage - Name: Troubleshooting the File Integrity Operator File: file-integrity-operator-troubleshooting - Name: Container security Dir: container_security Topics: - Name: Understanding container security File: security-understanding - Name: Understanding host and VM security File: security-hosts-vms - Name: Hardening Red Hat Enterprise Linux CoreOS File: security-hardening Distros: openshift-enterprise,openshift-webscale,openshift-aro - Name: Hardening Fedora CoreOS File: security-hardening Distros: openshift-origin - Name: Understanding compliance File: security-compliance - Name: Securing container content File: security-container-content - Name: Using container registries securely File: security-registries - Name: Securing the build process File: security-build - Name: Deploying containers File: security-deploy - Name: Securing the container platform File: security-platform - Name: Securing networks File: security-network - Name: Securing attached storage File: security-storage - Name: Monitoring cluster events and logs File: security-monitoring - Name: Configuring certificates Dir: certificates Distros: openshift-enterprise,openshift-webscale,openshift-origin Topics: - Name: Replacing the default ingress certificate File: replacing-default-ingress-certificate - Name: Adding API server certificates File: api-server - Name: Securing service traffic using service serving certificates File: service-serving-certificate - Name: Certificate types and descriptions File: certificate-types-descriptions Distros: openshift-enterprise,openshift-webscale,openshift-origin - Name: Allowing JavaScript-based access to the API server from additional hosts File: allowing-javascript-access-api-server Distros: openshift-enterprise,openshift-webscale,openshift-origin - Name: Encrypting etcd data File: encrypting-etcd Distros: openshift-enterprise,openshift-webscale,openshift-origin - Name: Scanning pods for vulnerabilities File: pod-vulnerability-scan Distros: openshift-enterprise,openshift-webscale,openshift-origin --- Name: Authentication and authorization Dir: authentication Distros: openshift-enterprise,openshift-webscale,openshift-origin,openshift-dedicated Topics: - Name: Understanding authentication File: understanding-authentication Distros: openshift-enterprise,openshift-webscale,openshift-origin,openshift-dedicated,openshift-online - Name: Understanding identity provider configuration File: dedicated-understanding-authentication Distros: openshift-dedicated - Name: Configuring the internal OAuth server File: configuring-internal-oauth - Name: Configuring OAuth clients File: configuring-oauth-clients Distros: openshift-enterprise,openshift-webscale,openshift-origin - Name: Understanding identity provider configuration File: understanding-identity-provider Distros: openshift-enterprise,openshift-webscale,openshift-origin - Name: Configuring identity providers Dir: identity_providers Topics: - Name: Configuring an HTPasswd identity provider File: configuring-htpasswd-identity-provider Distros: openshift-enterprise,openshift-webscale,openshift-origin - Name: Configuring a Keystone identity provider File: configuring-keystone-identity-provider Distros: openshift-enterprise,openshift-webscale,openshift-origin - Name: Configuring an LDAP identity provider File: configuring-ldap-identity-provider - Name: Configuring a basic authentication identity provider File: configuring-basic-authentication-identity-provider Distros: openshift-enterprise,openshift-webscale,openshift-origin - Name: Configuring a request header identity provider File: configuring-request-header-identity-provider Distros: openshift-enterprise,openshift-webscale,openshift-origin - Name: Configuring a GitHub or GitHub Enterprise identity provider File: configuring-github-identity-provider - Name: Configuring a GitLab identity provider File: configuring-gitlab-identity-provider Distros: openshift-enterprise,openshift-webscale,openshift-origin - Name: Configuring a Google identity provider File: configuring-google-identity-provider - Name: Configuring an OpenID Connect identity provider File: configuring-oidc-identity-provider - Name: Using RBAC to define and apply permissions File: using-rbac - Name: Removing the kubeadmin user File: remove-kubeadmin Distros: openshift-enterprise,openshift-webscale,openshift-origin #- Name: Configuring LDAP failover # File: configuring-ldap-failover - Name: Configuring the user agent File: configuring-user-agent Distros: openshift-enterprise,openshift-webscale,openshift-origin - Name: Understanding and creating service accounts File: understanding-and-creating-service-accounts - Name: Using service accounts in applications File: using-service-accounts-in-applications - Name: Using a service account as an OAuth client File: using-service-accounts-as-oauth-client - Name: Scoping tokens File: tokens-scoping - Name: Using bound service account tokens File: bound-service-account-tokens - Name: Managing Security Context Constraints File: managing-security-context-constraints Distros: openshift-enterprise,openshift-webscale,openshift-origin - Name: Impersonating the system:admin user File: impersonating-system-admin Distros: openshift-enterprise,openshift-webscale,openshift-origin - Name: Syncing LDAP groups File: ldap-syncing Distros: openshift-enterprise,openshift-webscale,openshift-origin,openshift-dedicated --- Name: Networking Dir: networking Distros: openshift-enterprise,openshift-webscale,openshift-origin,openshift-dedicated Topics: - Name: Understanding networking File: understanding-networking - Name: Accessing hosts File: accessing-hosts - Name: Understanding the Cluster Network Operator File: cluster-network-operator Distros: openshift-enterprise,openshift-webscale,openshift-origin - Name: Understanding the DNS Operator File: dns-operator Distros: openshift-enterprise,openshift-webscale,openshift-origin - Name: Understanding the Ingress Operator File: ingress-operator Distros: openshift-enterprise,openshift-webscale,openshift-origin - Name: Configuring the node port service range File: configuring-node-port-service-range - Name: Using SCTP File: using-sctp Distros: openshift-enterprise,openshift-webscale,openshift-origin #- Name: Configuring network policy # File: configuring-networkpolicy - Name: Network policy Dir: network_policy Topics: - Name: About network policy File: about-network-policy - Name: Creating a network policy File: creating-network-policy - Name: Viewing a network policy File: viewing-network-policy - Name: Editing a network policy File: editing-network-policy - Name: Deleting a network policy File: deleting-network-policy - Name: Defining a default network policy File: default-network-policy - Name: Configuring multitenant network policy File: multitenant-network-policy - Name: Multiple networks Dir: multiple_networks Distros: openshift-enterprise,openshift-webscale,openshift-origin Topics: - Name: Understanding multiple networks File: understanding-multiple-networks - Name: Attaching a Pod to an additional network File: attaching-pod - Name: Removing a Pod from an additional network File: removing-pod - Name: Configuring a bridge network File: configuring-bridge - Name: Configuring a host-device network File: configuring-host-device - Name: Configuring an ipvlan network File: configuring-ipvlan - Name: Configuring a macvlan network with basic customizations File: configuring-macvlan-basic - Name: Configuring a macvlan network File: configuring-macvlan - Name: Editing an additional network File: edit-additional-network - Name: Removing an additional network File: remove-additional-network - Name: Configuring PTP File: configuring-ptp - Name: Hardware networks Dir: hardware_networks Distros: openshift-enterprise,openshift-webscale,openshift-origin Topics: - Name: About Single Root I/O Virtualization (SR-IOV) hardware networks File: about-sriov - Name: Installing the SR-IOV Operator File: installing-sriov-operator - Name: Configuring the SR-IOV Operator File: configuring-sriov-operator - Name: Configuring an SR-IOV network device File: configuring-sriov-device - Name: Configuring an SR-IOV Ethernet network attachment File: configuring-sriov-net-attach - Name: Configuring an SR-IOV InfiniBand network attachment File: configuring-sriov-ib-attach - Name: Adding Pod to an SR-IOV network File: add-pod - Name: Using high performance multicast File: using-sriov-multicast - Name: Using DPDK and RDMA File: using-dpdk-and-rdma - Name: OpenShift SDN default CNI network provider Dir: openshift_sdn Topics: - Name: About the OpenShift SDN default CNI network provider File: about-openshift-sdn - Name: Configuring egress IPs for a project File: assigning-egress-ips Distros: openshift-origin,openshift-enterprise,openshift-webscale - Name: Configuring an egress firewall for a project File: configuring-egress-firewall - Name: Viewing an egress firewall for a project File: viewing-egress-firewall - Name: Editing an egress firewall for a project File: editing-egress-firewall - Name: Removing an egress firewall from a project File: removing-egress-firewall - Name: Enabling multicast for a project File: enabling-multicast Distros: openshift-origin,openshift-enterprise - Name: Disabling multicast for a project File: disabling-multicast Distros: openshift-origin,openshift-enterprise,openshift-webscale - Name: Configuring multitenant isolation File: multitenant-isolation Distros: openshift-origin,openshift-enterprise,openshift-webscale - Name: Configuring kube-proxy File: configuring-kube-proxy Distros: openshift-enterprise,openshift-webscale,openshift-origin - Name: OVN-Kubernetes default CNI network provider Dir: ovn_kubernetes_network_provider Topics: - Name: About the OVN-Kubernetes network provider File: about-ovn-kubernetes - Name: Migrate from the OpenShift SDN default CNI network provider File: migrate-from-openshift-sdn - Name: Rollback to the OpenShift SDN default CNI network provider File: rollback-to-openshift-sdn - Name: Configuring an egress firewall for a project File: configuring-egress-firewall-ovn - Name: Viewing an egress firewall for a project File: viewing-egress-firewall-ovn - Name: Editing an egress firewall for a project File: editing-egress-firewall-ovn - Name: Removing an egress firewall from a project File: removing-egress-firewall-ovn - Name: Configuring an egress IP address File: configuring-egress-ips-ovn - Name: Assigning an egress IP address File: assigning-egress-ips-ovn - Name: Enabling multicast for a project File: enabling-multicast Distros: openshift-origin,openshift-enterprise,openshift-webscale - Name: Disabling multicast for a project File: disabling-multicast Distros: openshift-origin,openshift-enterprise,openshift-webscale - Name: Configuring Routes Dir: routes Topics: - Name: Route configuration File: route-configuration - Name: Secured routes File: secured-routes - Name: Configuring ingress cluster traffic Dir: configuring_ingress_cluster_traffic Topics: - Name: Overview File: overview-traffic Distros: openshift-enterprise,openshift-webscale,openshift-origin - Name: Configuring ExternalIPs for services File: configuring-externalip Distros: openshift-enterprise,openshift-webscale,openshift-origin - Name: Configuring ingress cluster traffic using an Ingress Controller File: configuring-ingress-cluster-traffic-ingress-controller - Name: Configuring ingress cluster traffic using a load balancer File: configuring-ingress-cluster-traffic-load-balancer Distros: openshift-enterprise,openshift-webscale,openshift-origin - Name: Configuring ingress cluster traffic on AWS using a Network Load Balancer File: configuring-ingress-cluster-traffic-aws-network-load-balancer Distros: openshift-enterprise,openshift-webscale,openshift-origin - Name: Configuring ingress cluster traffic using a service external IP File: configuring-ingress-cluster-traffic-service-external-ip Distros: openshift-enterprise,openshift-webscale,openshift-origin - Name: Configuring ingress cluster traffic using a NodePort File: configuring-ingress-cluster-traffic-nodeport Distros: openshift-enterprise,openshift-webscale,openshift-origin - Name: Configuring the cluster-wide proxy File: enable-cluster-wide-proxy Distros: openshift-enterprise,openshift-webscale,openshift-origin - Name: Configuring a custom PKI File: configuring-a-custom-pki Distros: openshift-enterprise,openshift-webscale,openshift-origin - Name: Load balancing on OpenStack File: load-balancing-openstack --- Name: Storage Dir: storage Distros: openshift-enterprise,openshift-webscale,openshift-origin,openshift-dedicated,openshift-online Topics: - Name: Understanding ephemeral storage File: understanding-ephemeral-storage Distros: openshift-enterprise,openshift-webscale,openshift-origin,openshift-dedicated,openshift-online - Name: Understanding persistent storage File: understanding-persistent-storage Distros: openshift-enterprise,openshift-webscale,openshift-origin,openshift-dedicated,openshift-online - Name: Configuring persistent storage Dir: persistent_storage Distros: openshift-enterprise,openshift-webscale,openshift-origin Topics: - Name: Persistent storage using Amazon EFS File: persistent-storage-efs - Name: Persistent storage using AWS Elastic Block Store File: persistent-storage-aws - Name: Persistent storage using Azure Disk File: persistent-storage-azure - Name: Persistent storage using Azure File File: persistent-storage-azure-file - Name: Persistent storage using Cinder File: persistent-storage-cinder - Name: Persistent storage using Fibre Channel File: persistent-storage-fibre - Name: Persistent storage using FlexVolume File: persistent-storage-flexvolume - Name: Persistent storage using GCE Persistent Disk File: persistent-storage-gce - Name: Persistent storage using hostPath File: persistent-storage-hostpath - Name: Persistent Storage using iSCSI File: persistent-storage-iscsi - Name: Persistent storage using local volumes File: persistent-storage-local - Name: Persistent storage using NFS File: persistent-storage-nfs - Name: Persistent storage using Red Hat OpenShift Container Storage File: persistent-storage-ocs - Name: Persistent storage using VMware vSphere File: persistent-storage-vsphere - Name: Using Container Storage Interface (CSI) Dir: container_storage_interface Distros: openshift-enterprise,openshift-webscale,openshift-origin Topics: - Name: Configuring CSI volumes File: persistent-storage-csi - Name: CSI inline ephemeral volumes File: ephemeral-storage-csi-inline - Name: CSI volume snapshots File: persistent-storage-csi-snapshots - Name: CSI volume cloning File: persistent-storage-csi-cloning - Name: AWS Elastic Block Store CSI Driver Operator File: persistent-storage-csi-ebs - Name: OpenStack Manila CSI Driver Operator File: persistent-storage-csi-manila - Name: Red Hat Virtualization (oVirt) CSI Driver Operator File: persistent-storage-csi-ovirt - Name: Expanding persistent volumes File: expanding-persistent-volumes Distros: openshift-enterprise,openshift-webscale,openshift-origin,openshift-dedicated - Name: Dynamic provisioning File: dynamic-provisioning Distros: openshift-enterprise,openshift-webscale,openshift-origin --- Name: Registry Dir: registry Distros: openshift-enterprise,openshift-webscale,openshift-origin,openshift-dedicated Topics: - Name: Overview File: architecture-component-imageregistry - Name: Image Registry Operator in OpenShift Container Platform File: configuring-registry-operator Distros: openshift-enterprise,openshift-webscale,openshift-origin - Name: Setting up and configuring the registry Dir: configuring_registry_storage Distros: openshift-enterprise,openshift-webscale,openshift-origin Topics: - Name: Configuring the registry for AWS user-provisioned infrastructure File: configuring-registry-storage-aws-user-infrastructure - Name: Configuring the registry for GCP user-provisioned infrastructure File: configuring-registry-storage-gcp-user-infrastructure # - Name: Configuring the registry for OpenStack user-provisioned infrastructure # File: configuring-registry-storage-openstack-user-infrastructure - Name: Configuring the registry for Azure user-provisioned infrastructure File: configuring-registry-storage-azure-user-infrastructure - Name: Configuring the registry for bare metal File: configuring-registry-storage-baremetal - Name: Configuring the registry for vSphere File: configuring-registry-storage-vsphere - Name: Registry options File: registry-options Distros: openshift-enterprise,openshift-webscale,openshift-origin - Name: Accessing the registry File: accessing-the-registry - Name: Exposing the registry File: securing-exposing-registry Distros: openshift-enterprise,openshift-webscale,openshift-origin --- Name: Operators Dir: operators Topics: - Name: Understanding Operators Dir: understanding Topics: - Name: What are Operators? File: olm-what-operators-are - Name: Common terms File: olm-common-terms - Name: Packaging formats File: olm-packaging-format - Name: Operator Lifecycle Manager (OLM) Dir: olm Distros: openshift-enterprise,openshift-webscale,openshift-origin Topics: - Name: Concepts File: olm-understanding-olm - Name: Architecture File: olm-arch - Name: Workflow File: olm-workflow - Name: Dependency resolution File: olm-understanding-dependency-resolution - Name: OperatorGroups File: olm-understanding-operatorgroups - Name: Metrics File: olm-understanding-metrics - Name: Webhooks File: olm-webhooks - Name: OperatorHub Distros: openshift-enterprise,openshift-webscale,openshift-origin File: olm-understanding-operatorhub - Name: CRDs Dir: crds Topics: - Name: Extending the Kubernetes API with CRDs File: crd-extending-api-with-crds Distros: openshift-origin,openshift-enterprise,openshift-webscale - Name: Managing resources from CRDs File: crd-managing-resources-from-crds Distros: openshift-origin,openshift-enterprise,openshift-webscale - Name: User tasks Dir: user Topics: - Name: Creating applications from installed Operators File: olm-creating-apps-from-installed-operators Distros: openshift-enterprise,openshift-webscale,openshift-origin,openshift-dedicated - Name: Installing Operators in your namespace File: olm-installing-operators-in-namespace Distros: openshift-enterprise,openshift-webscale,openshift-origin - Name: Administrator tasks Dir: admin Topics: - Name: Adding Operators to a cluster File: olm-adding-operators-to-cluster Distros: openshift-enterprise,openshift-webscale,openshift-origin,openshift-dedicated - Name: Upgrading installed Operators File: olm-upgrading-operators Distros: openshift-enterprise,openshift-webscale,openshift-origin,openshift-dedicated - Name: Deleting Operators from a cluster File: olm-deleting-operators-from-cluster Distros: openshift-enterprise,openshift-webscale,openshift-origin,openshift-dedicated - Name: Configuring proxy support File: olm-configuring-proxy-support Distros: openshift-enterprise,openshift-webscale,openshift-origin - Name: Viewing Operator status File: olm-status Distros: openshift-enterprise,openshift-webscale,openshift-origin,openshift-dedicated - Name: Allowing non-cluster administrators to install Operators File: olm-creating-policy Distros: openshift-origin,openshift-enterprise,openshift-webscale - Name: Managing custom catalogs File: olm-managing-custom-catalogs Distros: openshift-origin,openshift-enterprise,openshift-webscale - Name: Using OLM on restricted networks File: olm-restricted-networks Distros: openshift-origin,openshift-enterprise,openshift-webscale - Name: Developing Operators Dir: operator_sdk Distros: openshift-origin,openshift-enterprise,openshift-webscale Topics: - Name: Getting started with the Operator SDK File: osdk-getting-started - Name: Creating Ansible-based Operators File: osdk-ansible - Name: Creating Helm-based Operators File: osdk-helm - Name: Generating a ClusterServiceVersion (CSV) File: osdk-generating-csvs - Name: Working with bundle images File: osdk-working-bundle-images - Name: Validating Operators using the scorecard File: osdk-scorecard - Name: Configuring built-in monitoring with Prometheus File: osdk-monitoring-prometheus - Name: Configuring leader election File: osdk-leader-election - Name: Operator SDK CLI reference File: osdk-cli-reference - Name: Migrating to Operator SDK v0.1.0 File: osdk-migrating-to-v0-1-0 Distros: openshift-origin - Name: Appendices File: osdk-appendices - Name: Red Hat Operators reference File: operator-reference --- Name: Builds Dir: builds Distros: openshift-enterprise,openshift-webscale,openshift-origin,openshift-dedicated,openshift-online Topics: - Name: Understanding image builds File: understanding-image-builds - Name: Understanding build configurations File: understanding-buildconfigs - Name: Creating build inputs File: creating-build-inputs - Name: Managing build output File: managing-build-output - Name: Using build strategies File: build-strategies - Name: Custom image builds with Buildah File: custom-builds-buildah Distros: openshift-enterprise,openshift-webscale,openshift-origin - Name: Performing basic builds File: basic-build-operations Distros: openshift-enterprise,openshift-webscale,openshift-origin,openshift-dedicated,openshift-online - Name: Triggering and modifying builds File: triggering-builds-build-hooks Distros: openshift-enterprise,openshift-webscale,openshift-origin,openshift-dedicated,openshift-online - Name: Performing advanced builds File: advanced-build-operations Distros: openshift-enterprise,openshift-webscale,openshift-origin - Name: Using Red Hat subscriptions in builds File: running-entitled-builds Distros: openshift-enterprise,openshift-webscale,openshift-origin - Name: Securing builds by strategy File: securing-builds-by-strategy Distros: openshift-enterprise,openshift-webscale,openshift-origin - Name: Build configuration resources File: build-configuration Distros: openshift-enterprise,openshift-webscale,openshift-origin - Name: Troubleshooting builds File: troubleshooting-builds Distros: openshift-enterprise,openshift-webscale,openshift-origin - Name: Setting up additional trusted certificate authorities for builds File: setting-up-trusted-ca Distros: openshift-enterprise,openshift-webscale,openshift-origin - Name: Creating and using ConfigMaps File: builds-configmaps Distros: openshift-enterprise,openshift-webscale,openshift-origin,openshift-dedicated --- Name: Pipelines Dir: pipelines Distros: openshift-enterprise,openshift-webscale,openshift-origin Topics: - Name: Understanding OpenShift Pipelines File: understanding-openshift-pipelines - Name: Installing OpenShift Pipelines File: installing-pipelines - Name: Uninstalling OpenShift Pipelines File: uninstalling-pipelines - Name: Creating CI/CD solutions for applications using OpenShift Pipelines File: creating-applications-with-cicd-pipelines - Name: Working with Pipelines using the Developer perspective File: working-with-pipelines-using-the-developer-perspective - Name: OpenShift Pipelines release notes File: op-release-notes --- Name: Images Dir: openshift_images Distros: openshift-enterprise,openshift-webscale,openshift-origin,openshift-dedicated,openshift-online Topics: - Name: Configuring the Samples Operator File: configuring-samples-operator Distros: openshift-enterprise,openshift-webscale,openshift-origin - Name: Using the Samples Operator with an alternate registry File: samples-operator-alt-registry Distros: openshift-enterprise,openshift-webscale,openshift-origin - Name: Understanding containers, images, and imagestreams File: images-understand - Name: Creating images File: create-images - Name: Managing images Dir: managing_images Topics: - Name: Managing images overview File: managing-images-overview - Name: Tagging images File: tagging-images - Name: Image pull policy File: image-pull-policy - Name: Using image pull secrets File: using-image-pull-secrets - Name: Managing imagestreams File: image-streams-manage Distros: openshift-enterprise,openshift-webscale,openshift-origin - Name: Using imagestreams with Kubernetes resources File: using-imagestreams-with-kube-resources Distros: openshift-enterprise,openshift-webscale,openshift-origin - Name: Image configuration resources File: image-configuration Distros: openshift-enterprise,openshift-webscale,openshift-origin - Name: Using templates File: using-templates - Name: Using Ruby on Rails File: templates-using-ruby-on-rails - Name: Using images Dir: using_images Distros: openshift-enterprise,openshift-webscale,openshift-origin Topics: - Name: Using images overview File: using-images-overview - Name: Configuring Jenkins images File: images-other-jenkins - Name: Jenkins agent File: images-other-jenkins-agent - Name: Building and deploying a DPDK payload using the s2i image File: cnf-building-and-deploying-a-dpdk-payload Distros: openshift-webscale --- Name: Applications Dir: applications Distros: openshift-* Topics: - Name: Projects Dir: projects Topics: - Name: Working with projects File: working-with-projects - Name: Creating a project as another user File: creating-project-other-user Distros: openshift-enterprise,openshift-webscale,openshift-origin - Name: Configuring project creation File: configuring-project-creation Distros: openshift-enterprise,openshift-webscale,openshift-origin - Name: Application life cycle management Dir: application_life_cycle_management Topics: - Name: Creating applications using the Developer perspective File: odc-creating-applications-using-developer-perspective - Name: Creating applications from installed Operators File: creating-apps-from-installed-operators - Name: Creating applications using the CLI File: creating-applications-using-cli - Name: Viewing application composition using the Topology view File: odc-viewing-application-composition-using-topology-view - Name: Editing applications File: odc-editing-applications - Name: Working with Helm charts using the Developer perspective File: odc-working-with-helm-charts-using-developer-perspective - Name: Deleting applications File: odc-deleting-applications - Name: Deployments Dir: deployments Topics: - Name: Understanding Deployments and DeploymentConfigs File: what-deployments-are - Name: Managing deployment processes File: managing-deployment-processes - Name: Using DeploymentConfig strategies File: deployment-strategies - Name: Using route-based deployment strategies File: route-based-deployment-strategies - Name: Quotas Dir: quotas Distros: openshift-origin,openshift-enterprise,openshift-webscale Topics: - Name: Resource quotas per project File: quotas-setting-per-project - Name: Resource quotas across multiple projects File: quotas-setting-across-multiple-projects Distros: openshift-enterprise,openshift-webscale,openshift-origin - Name: Monitoring project and application metrics using the Developer perspective File: odc-monitoring-project-and-application-metrics-using-developer-perspective - Name: Monitoring application health File: application-health - Name: Working with quotas File: working-with-quotas Distros: openshift-online,openshift-dedicated - Name: Idling applications File: idling-applications Distros: openshift-origin,openshift-enterprise,openshift-webscale - Name: Pruning objects to reclaim resources File: pruning-objects Distros: openshift-origin,openshift-enterprise,openshift-webscale - Name: Using the Red Hat Marketplace File: red-hat-marketplace Distros: openshift-origin,openshift-enterprise,openshift-webscale --- Name: Machine management Dir: machine_management Distros: openshift-origin,openshift-enterprise,openshift-webscale Topics: - Name: Creating MachineSets Dir: creating_machinesets Distros: openshift-origin,openshift-enterprise,openshift-webscale Topics: - Name: Creating a MachineSet on AWS File: creating-machineset-aws - Name: Creating a MachineSet on Azure File: creating-machineset-azure - Name: Creating a MachineSet on GCP File: creating-machineset-gcp - Name: Creating a MachineSet on OpenStack File: creating-machineset-osp - Name: Manually scaling a MachineSet File: manually-scaling-machineset - Name: Modifying a MachineSet File: modifying-machineset - Name: Deleting a Machine File: deleting-machine - Name: Applying autoscaling to a cluster File: applying-autoscaling - Name: Creating infrastructure MachineSets File: creating-infrastructure-machinesets - Name: User-provisioned infrastructure Dir: user_infra Topics: - Name: Adding a RHEL compute machine File: adding-rhel-compute Distros: openshift-enterprise,openshift-webscale - Name: Adding more RHEL compute machines File: more-rhel-compute Distros: openshift-enterprise,openshift-webscale - Name: Adding compute machines to vSphere File: adding-vsphere-compute-user-infra - Name: Adding compute machines to bare metal File: adding-bare-metal-compute-user-infra - Name: Deploying machine health checks File: deploying-machine-health-checks --- Name: Nodes Dir: nodes Distros: openshift-* Topics: - Name: Working with pods Dir: pods Topics: - Name: About Pods File: nodes-pods-using - Name: Viewing Pods File: nodes-pods-viewing - Name: Configuring a cluster for Pods File: nodes-pods-configuring Distros: openshift-enterprise,openshift-webscale,openshift-origin - Name: Automatically scaling pods with the Horizontal Pod Autoscaler File: nodes-pods-autoscaling - Name: Automatically adjust pod resource levels with the Vertical Pod Autoscaler File: nodes-pods-vertical-autoscaler - Name: Providing sensitive data to Pods File: nodes-pods-secrets - Name: Using Device Manager to make devices available to nodes File: nodes-pods-plugins Distros: openshift-enterprise,openshift-webscale,openshift-origin - Name: Including pod priority in Pod scheduling decisions File: nodes-pods-priority Distros: openshift-enterprise,openshift-webscale,openshift-origin - Name: Placing pods on specific nodes using node selectors File: nodes-pods-node-selectors Distros: openshift-enterprise,openshift-webscale,openshift-origin - Name: Controlling pod placement onto nodes (scheduling) Dir: scheduling Distros: openshift-enterprise,openshift-webscale,openshift-origin Topics: - Name: About pod placement using the scheduler File: nodes-scheduler-about - Name: Configuring the default scheduler to control pod placement File: nodes-scheduler-default - Name: Placing pods relative to other pods using pod affinity and anti-affinity rules File: nodes-scheduler-pod-affinity - Name: Controlling pod placement on nodes using node affinity rules File: nodes-scheduler-node-affinity - Name: Placing pods onto overcommited nodes File: nodes-scheduler-overcommit - Name: Controlling pod placement using node taints File: nodes-scheduler-taints-tolerations - Name: Placing pods on specific nodes using node selectors File: nodes-scheduler-node-selectors - Name: Controlling pod placement using pod topology spread constraints File: nodes-scheduler-pod-topology-spread-constraints # - Name: Placing a pod on a specific node by name # File: nodes-scheduler-node-names # - Name: Placing a pod in a specific project # File: nodes-scheduler-node-projects # - Name: Keeping your cluster balanced using the descheduler # File: nodes-scheduler-descheduler - Name: Evicting pods using the descheduler File: nodes-descheduler - Name: Using Jobs and DaemonSets Dir: jobs Topics: - Name: Running background tasks on nodes automatically with daemonsets File: nodes-pods-daemonsets Distros: openshift-enterprise,openshift-webscale,openshift-origin - Name: Running tasks in pods using jobs File: nodes-nodes-jobs - Name: Working with nodes Dir: nodes Distros: openshift-enterprise,openshift-webscale,openshift-origin Topics: - Name: Viewing and listing the nodes in your cluster File: nodes-nodes-viewing - Name: Working with nodes File: nodes-nodes-working - Name: Managing Nodes File: nodes-nodes-managing - Name: Managing the maximum number of Pods per Node File: nodes-nodes-managing-max-pods - Name: Using the Node Tuning Operator File: nodes-node-tuning-operator - Name: Understanding node rebooting File: nodes-nodes-rebooting - Name: Freeing node resources using garbage collection File: nodes-nodes-garbage-collection - Name: Allocating resources for nodes File: nodes-nodes-resources-configuring # - Name: Monitoring for problems in your nodes # File: nodes-nodes-problem-detector - Name: Viewing node audit logs File: nodes-nodes-audit-log - Name: Configuring the node audit log policy File: nodes-nodes-audit-config - Name: Machine Config Daemon metrics File: nodes-nodes-machine-config-daemon-metrics - Name: Working with containers Dir: containers Topics: - Name: Using containers File: nodes-containers-using - Name: Using Init Containers to perform tasks before a pod is deployed File: nodes-containers-init Distros: openshift-enterprise,openshift-webscale,openshift-origin - Name: Using volumes to persist container data File: nodes-containers-volumes - Name: Mapping volumes using projected volumes File: nodes-containers-projected-volumes - Name: Allowing containers to consume API objects File: nodes-containers-downward-api - Name: Copying files to or from a container File: nodes-containers-copying-files - Name: Executing remote commands in a container File: nodes-containers-remote-commands - Name: Using port forwarding to access applications in a container File: nodes-containers-port-forwarding - Name: Using sysctls in containers File: nodes-containers-sysctls - Name: Working with clusters Dir: clusters Topics: - Name: Viewing system event information in a cluster File: nodes-containers-events - Name: Analyzing cluster resource levels File: nodes-cluster-resource-levels Distros: openshift-enterprise,openshift-webscale,openshift-origin - Name: Setting limit ranges File: nodes-cluster-limit-ranges - Name: Configuring cluster memory to meet container memory and risk requirements File: nodes-cluster-resource-configure Distros: openshift-enterprise,openshift-webscale,openshift-origin - Name: Configuring your cluster to place pods on overcommited nodes File: nodes-cluster-overcommit Distros: openshift-enterprise,openshift-webscale,openshift-origin - Name: Enabling features using FeatureGates File: nodes-cluster-enabling-features Distros: openshift-enterprise,openshift-webscale,openshift-origin - Name: Remote worker nodes on the network edge Dir: edge Distros: openshift-enterprise,openshift-webscale,openshift-origin Topics: - Name: Using remote worker node at the network edge File: nodes-edge-remote-workers --- Name: Logging Dir: logging Distros: openshift-enterprise,openshift-webscale,openshift-origin,openshift-dedicated Topics: - Name: About cluster logging File: cluster-logging - Name: Installing cluster logging File: cluster-logging-deploying Distros: openshift-enterprise,openshift-webscale,openshift-origin - Name: Installing the Cluster Logging and Elasticsearch Operators File: dedicated-cluster-deploying Distros: openshift-dedicated - Name: Configuring your cluster logging deployment Dir: config Distros: openshift-enterprise,openshift-webscale,openshift-origin Topics: - Name: About the Cluster Logging Custom Resource File: cluster-logging-configuring-cr - Name: Configuring the logging collector File: cluster-logging-collector - Name: Configuring the log store File: cluster-logging-log-store - Name: Configuring the log visualizer File: cluster-logging-visualizer - Name: Configuring cluster logging storage File: cluster-logging-storage-considerations - Name: Configuring CPU and memory limits for cluster logging components File: cluster-logging-memory - Name: Using tolerations to control cluster logging pod placement File: cluster-logging-tolerations - Name: Moving the cluster logging resources with node selectors File: cluster-logging-moving-nodes - Name: Configuring systemd-journald for cluster logging File: cluster-logging-systemd - Name: Configuring the log curator File: cluster-logging-curator - Name: Maintenance and support File: cluster-logging-maintenance-support - Name: Viewing cluster logs Dir: viewing Distros: openshift-enterprise,openshift-webscale,openshift-origin Topics: - Name: Viewing cluster logs in the console or CLI File: cluster-logging-viewing - Name: Viewing cluster logs using Kibana File: cluster-logging-visualizer - Name: Viewing cluster logs using Kibana File: cluster-logging-kibana-interface Distros: openshift-dedicated - Name: Forwarding logs to third party systems File: cluster-logging-external Distros: openshift-enterprise,openshift-webscale,openshift-origin - Name: Collecting and storing Kubernetes events File: cluster-logging-eventrouter Distros: openshift-enterprise,openshift-webscale,openshift-origin # - Name: Forwarding logs using ConfigMaps # File: cluster-logging-external-configmap # Distros: openshift-enterprise,openshift-webscale,openshift-origin - Name: Updating cluster logging File: cluster-logging-upgrading - Name: Uninstalling cluster logging File: cluster-logging-uninstall Distros: openshift-dedicated - Name: Viewing cluster dashboards File: cluster-logging-dashboards - Name: Troubleshooting cluster logging Dir: troubleshooting Distros: openshift-enterprise,openshift-webscale,openshift-origin Topics: - Name: Viewing cluster logging status File: cluster-logging-cluster-status - Name: Viewing the status of the log store File: cluster-logging-log-store-status - Name: Understanding cluster logging alerts File: cluster-logging-alerts - Name: Troubleshooting the log visualizer File: cluster-logging-troubleshooting-visualizer - Name: Troubleshooting the log curator File: cluster-logging-troubleshooting-curator - Name: Uninstalling cluster logging File: cluster-logging-uninstall - Name: Exported fields File: cluster-logging-exported-fields Distros: openshift-enterprise,openshift-webscale,openshift-origin --- Name: Monitoring Dir: monitoring Distros: openshift-enterprise,openshift-webscale,openshift-origin Topics: - Name: Understanding the monitoring stack File: understanding-the-monitoring-stack - Name: Configuring the monitoring stack File: configuring-the-monitoring-stack - Name: Enabling monitoring for user-defined projects File: enabling-monitoring-for-user-defined-projects - Name: Managing metrics File: managing-metrics - Name: Managing alerts File: managing-alerts - Name: Reviewing monitoring dashboards File: reviewing-monitoring-dashboards - Name: Accessing third-party UIs File: accessing-third-party-uis - Name: Exposing custom application metrics for autoscaling File: exposing-custom-application-metrics-for-autoscaling - Name: Troubleshooting monitoring issues File: troubleshooting-monitoring-issues --- Name: Metering Dir: metering Distros: openshift-enterprise,openshift-webscale,openshift-origin Topics: - Name: About metering File: metering-about-metering - Name: Installing metering File: metering-installing-metering - Name: Upgrading metering File: metering-upgrading-metering - Name: Configuring metering Dir: configuring_metering Topics: - Name: About configuring metering File: metering-about-configuring - Name: Common configuration options File: metering-common-config-options - Name: Configuring persistent storage File: metering-configure-persistent-storage - Name: Configuring the Hive metastore File: metering-configure-hive-metastore - Name: Configuring the reporting operator File: metering-configure-reporting-operator - Name: Configuring AWS billing correlation File: metering-configure-aws-billing-correlation - Name: Reports Dir: reports Topics: - Name: About reports File: metering-about-reports - Name: Storage Locations File: metering-storage-locations - Name: Using metering File: metering-using-metering - Name: Examples of using metering File: metering-usage-examples - Name: Troubleshooting and debugging File: metering-troubleshooting-debugging - Name: Uninstalling metering File: metering-uninstall --- Name: Scalability and performance Dir: scalability_and_performance Distros: openshift-origin,openshift-enterprise,openshift-webscale Topics: - Name: Recommended installation practices File: recommended-install-practices - Name: Recommended host practices File: recommended-host-practices - Name: Recommended cluster scaling practices File: recommended-cluster-scaling-practices - Name: Using the Node Tuning Operator File: using-node-tuning-operator - Name: Using Cluster Loader File: using-cluster-loader - Name: Using CPU Manager File: using-cpu-manager - Name: Using Topology Manager File: using-topology-manager - Name: Scaling the Cluster Monitoring Operator File: scaling-cluster-monitoring-operator - Name: Planning your environment according to object maximums File: planning-your-environment-according-to-object-maximums - Name: Optimizing storage File: optimizing-storage - Name: Optimizing routing File: routing-optimization - Name: What huge pages do and how they are consumed by apps File: what-huge-pages-do-and-how-they-are-consumed-by-apps - Name: Performance Addon Operator for low latency nodes File: cnf-performance-addon-operator-for-low-latency-nodes Distros: openshift-webscale --- Name: Backup and restore Dir: backup_and_restore Distros: openshift-origin,openshift-enterprise,openshift-webscale Topics: - Name: Backing up etcd data File: backing-up-etcd - Name: Replacing an unhealthy etcd member File: replacing-unhealthy-etcd-member - Name: Shutting down a cluster gracefully File: graceful-cluster-shutdown - Name: Restarting a cluster gracefully File: graceful-cluster-restart - Name: Disaster recovery Dir: disaster_recovery Topics: - Name: About disaster recovery File: about-disaster-recovery - Name: Recovering from lost master hosts File: scenario-1-infra-recovery - Name: Restoring to a previous cluster state File: scenario-2-restoring-cluster-state - Name: Recovering from expired control plane certificates File: scenario-3-expired-certs --- Name: Migration Toolkit for Containers Dir: migration Distros: openshift-enterprise,openshift-webscale Topics: - Name: Migrating from OpenShift Container Platform 3 Dir: migrating_3_4 Topics: - Name: About migrating from OpenShift Container Platform 3 to 4 File: about-migration - Name: Planning your migration from OpenShift Container Platform 3 to 4 File: planning-migration-3-to-4 - Name: Migration tools and prerequisites File: migrating-application-workloads-3-4 - Name: Deploying the Migration Toolkit for Containers File: deploying-cam-3-4 - Name: Upgrading the Migration Toolkit for Containers File: upgrading-migration-tool-3-4 - Name: Configuring a replication repository File: configuring-replication-repository-3-4 - Name: Migrating your applications File: migrating-applications-with-cam-3-4 - Name: Migrating your control plane settings File: migrating-with-cpma - Name: Troubleshooting File: troubleshooting-3-4 - Name: Migrating from OpenShift Container Platform 4.1 Dir: migrating_4_1_4 Topics: - Name: Migration tools and prerequisites File: migrating-application-workloads-4-1-4 - Name: Deploying the Migration Toolkit for Containers File: deploying-cam-4-1-4 - Name: Upgrading the Migration Toolkit for Containers File: upgrading-migration-tool-4-1-4 - Name: Configuring a replication repository File: configuring-replication-repository-4-1-4 - Name: Migrating your applications File: migrating-applications-with-cam-4-1-4 - Name: Troubleshooting File: troubleshooting-4-1-4 - Name: Migrating from OpenShift Container Platform 4.2 and later Dir: migrating_4_2_4 Topics: - Name: Migration tools and prerequisites File: migrating-application-workloads-4-2-4 - Name: Deploying the Migration Toolkit for Containers File: deploying-cam-4-2-4 - Name: Upgrading the Migration Toolkit for Containers File: upgrading-migration-tool-4-2-4 - Name: Configuring a replication repository File: configuring-replication-repository-4-2-4 - Name: Migrating your applications File: migrating-applications-with-cam-4-2-4 - Name: Troubleshooting File: troubleshooting-4-2-4 --- Name: CLI tools Dir: cli_reference Distros: openshift-enterprise,openshift-webscale,openshift-origin,openshift-dedicated,openshift-online Topics: - Name: OpenShift CLI (oc) Dir: openshift_cli Topics: - Name: Getting started with the CLI File: getting-started-cli - Name: Configuring the CLI File: configuring-cli - Name: Extending the CLI with plug-ins File: extending-cli-plugins Distros: openshift-enterprise,openshift-webscale,openshift-origin - Name: Developer CLI commands File: developer-cli-commands - Name: Administrator CLI commands File: administrator-cli-commands Distros: openshift-enterprise,openshift-webscale,openshift-origin - Name: Usage of oc and kubectl commands File: usage-oc-kubectl - Name: Developer CLI (odo) Dir: developer_cli_odo Distros: openshift-enterprise,openshift-webscale,openshift-origin,openshift-dedicated,openshift-online Topics: - Name: Understanding odo File: understanding-odo - Name: odo architecture File: odo-architecture - Name: Installing odo File: installing-odo - Name: Using odo in a restricted environment Dir: using_odo_in_a_restricted_environment Topics: - Name: About odo in a restricted environment File: about-odo-in-a-restricted-environment - Name: Pushing the odo init image to the restricted cluster registry File: pushing-the-odo-init-image-to-the-restricted-cluster-registry - Name: Creating and deploying a component to the disconnected cluster File: creating-and-deploying-a-component-to-the-disconnected-cluster - Name: Creating a single-component application with odo File: creating-a-single-component-application-with-odo - Name: Creating a multicomponent application with odo File: creating-a-multicomponent-application-with-odo - Name: Creating an application with a database File: creating-an-application-with-a-database - Name: Using devfiles in odo File: using-devfiles-in-odo - Name: Using sample applications File: using-sample-applications - Name: Creating instances of services managed by Operators File: creating-instances-of-services-managed-by-operators - Name: Debugging applications in odo File: debugging-applications-in-odo - Name: Managing environment variables in odo File: managing-environment-variables-in-odo - Name: Configuring the odo CLI File: configuring-the-odo-cli - Name: odo CLI reference File: odo-cli-reference - Name: odo release notes File: odo-release-notes - Name: Helm CLI Dir: helm_cli Distros: openshift-enterprise,openshift-webscale,openshift-origin Topics: - Name: Getting started with Helm on OpenShift Container Platform File: getting-started-with-helm-on-openshift-container-platform - Name: Configuring custom Helm chart repositories File: configuring-custom-helm-chart-repositories - Name: Knative CLI (kn) for use with OpenShift Serverless File: kn-cli-tools - Name: Pipelines CLI (tkn) Dir: tkn_cli Distros: openshift-enterprise,openshift-webscale,openshift-origin Topics: - Name: Installing tkn File: installing-tkn - Name: Configuring tkn File: op-configuring-tkn - Name: Basic tkn commands File: op-tkn-reference - Name: opm CLI File: opm-cli Distros: openshift-enterprise,openshift-webscale,openshift-origin --- Name: API reference Dir: rest_api Topics: - Name: API list File: index - Name: Common object reference Dir: objects Topics: - Name: Index File: index - Name: Authorization APIs Dir: authorization_apis Topics: - Name: About Authorization APIs File: authorization-apis-index - Name: 'LocalResourceAccessReview [authorization.openshift.io/v1]' File: localresourceaccessreview-authorization-openshift-io-v1 - Name: 'LocalSubjectAccessReview [authorization.openshift.io/v1]' File: localsubjectaccessreview-authorization-openshift-io-v1 - Name: 'ResourceAccessReview [authorization.openshift.io/v1]' File: resourceaccessreview-authorization-openshift-io-v1 - Name: 'SelfSubjectRulesReview [authorization.openshift.io/v1]' File: selfsubjectrulesreview-authorization-openshift-io-v1 - Name: 'SubjectAccessReview [authorization.openshift.io/v1]' File: subjectaccessreview-authorization-openshift-io-v1 - Name: 'SubjectRulesReview [authorization.openshift.io/v1]' File: subjectrulesreview-authorization-openshift-io-v1 - Name: 'TokenReview [authentication.k8s.io/v1]' File: tokenreview-authentication-k8s-io-v1 - Name: 'LocalSubjectAccessReview [authorization.k8s.io/v1]' File: localsubjectaccessreview-authorization-k8s-io-v1 - Name: 'SelfSubjectAccessReview [authorization.k8s.io/v1]' File: selfsubjectaccessreview-authorization-k8s-io-v1 - Name: 'SelfSubjectRulesReview [authorization.k8s.io/v1]' File: selfsubjectrulesreview-authorization-k8s-io-v1 - Name: 'SubjectAccessReview [authorization.k8s.io/v1]' File: subjectaccessreview-authorization-k8s-io-v1 - Name: Autoscale APIs Dir: autoscale_apis Topics: - Name: About Autoscale APIs File: autoscale-apis-index - Name: 'ClusterAutoscaler [autoscaling.openshift.io/v1]' File: clusterautoscaler-autoscaling-openshift-io-v1 - Name: 'MachineAutoscaler [autoscaling.openshift.io/v1beta1]' File: machineautoscaler-autoscaling-openshift-io-v1beta1 - Name: 'HorizontalPodAutoscaler [autoscaling/v1]' File: horizontalpodautoscaler-autoscaling-v1 - Name: Config APIs Dir: config_apis Topics: - Name: About Config APIs File: config-apis-index - Name: 'APIServer [config.openshift.io/v1]' File: apiserver-config-openshift-io-v1 - Name: 'Authentication [config.openshift.io/v1]' File: authentication-config-openshift-io-v1 - Name: 'Build [config.openshift.io/v1]' File: build-config-openshift-io-v1 - Name: 'ClusterOperator [config.openshift.io/v1]' File: clusteroperator-config-openshift-io-v1 - Name: 'ClusterVersion [config.openshift.io/v1]' File: clusterversion-config-openshift-io-v1 - Name: 'Console [config.openshift.io/v1]' File: console-config-openshift-io-v1 - Name: 'DNS [config.openshift.io/v1]' File: dns-config-openshift-io-v1 - Name: 'FeatureGate [config.openshift.io/v1]' File: featuregate-config-openshift-io-v1 - Name: 'Image [config.openshift.io/v1]' File: image-config-openshift-io-v1 - Name: 'Infrastructure [config.openshift.io/v1]' File: infrastructure-config-openshift-io-v1 - Name: 'Ingress [config.openshift.io/v1]' File: ingress-config-openshift-io-v1 - Name: 'Network [config.openshift.io/v1]' File: network-config-openshift-io-v1 - Name: 'OAuth [config.openshift.io/v1]' File: oauth-config-openshift-io-v1 - Name: 'OperatorHub [config.openshift.io/v1]' File: operatorhub-config-openshift-io-v1 - Name: 'Project [config.openshift.io/v1]' File: project-config-openshift-io-v1 - Name: 'Proxy [config.openshift.io/v1]' File: proxy-config-openshift-io-v1 - Name: 'Scheduler [config.openshift.io/v1]' File: scheduler-config-openshift-io-v1 - Name: Console APIs Dir: console_apis Topics: - Name: About Console APIs File: console-apis-index - Name: 'ConsoleCLIDownload [console.openshift.io/v1]' File: consoleclidownload-console-openshift-io-v1 - Name: 'ConsoleExternalLogLink [console.openshift.io/v1]' File: consoleexternalloglink-console-openshift-io-v1 - Name: 'ConsoleLink [console.openshift.io/v1]' File: consolelink-console-openshift-io-v1 - Name: 'ConsoleNotification [console.openshift.io/v1]' File: consolenotification-console-openshift-io-v1 - Name: 'ConsoleYAMLSample [console.openshift.io/v1]' File: consoleyamlsample-console-openshift-io-v1 - Name: Extension APIs Dir: extension_apis Topics: - Name: About Extension APIs File: extension-apis-index - Name: 'APIService [apiregistration.k8s.io/v1]' File: apiservice-apiregistration-k8s-io-v1 - Name: 'CustomResourceDefinition [apiextensions.k8s.io/v1]' File: customresourcedefinition-apiextensions-k8s-io-v1 - Name: 'MutatingWebhookConfiguration [admissionregistration.k8s.io/v1]' File: mutatingwebhookconfiguration-admissionregistration-k8s-io-v1 - Name: 'ValidatingWebhookConfiguration [admissionregistration.k8s.io/v1]' File: validatingwebhookconfiguration-admissionregistration-k8s-io-v1 - Name: Image APIs Dir: image_apis Topics: - Name: About Image APIs File: image-apis-index - Name: 'Image [image.openshift.io/v1]' File: image-image-openshift-io-v1 - Name: 'ImageSignature [image.openshift.io/v1]' File: imagesignature-image-openshift-io-v1 - Name: 'ImageStreamImage [image.openshift.io/v1]' File: imagestreamimage-image-openshift-io-v1 - Name: 'ImageStreamImport [image.openshift.io/v1]' File: imagestreamimport-image-openshift-io-v1 - Name: 'ImageStreamMapping [image.openshift.io/v1]' File: imagestreammapping-image-openshift-io-v1 - Name: 'ImageStream [image.openshift.io/v1]' File: imagestream-image-openshift-io-v1 - Name: 'ImageStreamTag [image.openshift.io/v1]' File: imagestreamtag-image-openshift-io-v1 - Name: 'ImageTag [image.openshift.io/v1]' File: imagetag-image-openshift-io-v1 - Name: Machine APIs Dir: machine_apis Topics: - Name: About Machine APIs File: machine-apis-index - Name: 'ContainerRuntimeConfig [machineconfiguration.openshift.io/v1]' File: containerruntimeconfig-machineconfiguration-openshift-io-v1 - Name: 'ControllerConfig [machineconfiguration.openshift.io/v1]' File: controllerconfig-machineconfiguration-openshift-io-v1 - Name: 'KubeletConfig [machineconfiguration.openshift.io/v1]' File: kubeletconfig-machineconfiguration-openshift-io-v1 - Name: 'MachineConfigPool [machineconfiguration.openshift.io/v1]' File: machineconfigpool-machineconfiguration-openshift-io-v1 - Name: 'MachineConfig [machineconfiguration.openshift.io/v1]' File: machineconfig-machineconfiguration-openshift-io-v1 - Name: 'MachineHealthCheck [machine.openshift.io/v1beta1]' File: machinehealthcheck-machine-openshift-io-v1beta1 - Name: 'Machine [machine.openshift.io/v1beta1]' File: machine-machine-openshift-io-v1beta1 - Name: 'MachineSet [machine.openshift.io/v1beta1]' File: machineset-machine-openshift-io-v1beta1 - Name: Metadata APIs Dir: metadata_apis Topics: - Name: About Metadata APIs File: metadata-apis-index - Name: 'Binding [core/v1]' File: binding-core-v1 - Name: 'ComponentStatus [core/v1]' File: componentstatus-core-v1 - Name: 'ConfigMap [core/v1]' File: configmap-core-v1 - Name: 'ControllerRevision [apps/v1]' File: controllerrevision-apps-v1 - Name: 'Event [events.k8s.io/v1beta1]' File: event-events-k8s-io-v1beta1 - Name: 'Event [core/v1]' File: event-core-v1 - Name: 'Lease [coordination.k8s.io/v1]' File: lease-coordination-k8s-io-v1 - Name: 'Namespace [core/v1]' File: namespace-core-v1 - Name: Monitoring APIs Dir: monitoring_apis Topics: - Name: About Monitoring APIs File: monitoring-apis-index - Name: 'Alertmanager [monitoring.coreos.com/v1]' File: alertmanager-monitoring-coreos-com-v1 - Name: 'PodMonitor [monitoring.coreos.com/v1]' File: podmonitor-monitoring-coreos-com-v1 - Name: 'Prometheus [monitoring.coreos.com/v1]' File: prometheus-monitoring-coreos-com-v1 - Name: 'PrometheusRule [monitoring.coreos.com/v1]' File: prometheusrule-monitoring-coreos-com-v1 - Name: 'ServiceMonitor [monitoring.coreos.com/v1]' File: servicemonitor-monitoring-coreos-com-v1 - Name: 'ThanosRuler [monitoring.coreos.com/v1]' File: thanosruler-monitoring-coreos-com-v1 - Name: Network APIs Dir: network_apis Topics: - Name: About Network APIs File: network-apis-index - Name: 'ClusterNetwork [network.openshift.io/v1]' File: clusternetwork-network-openshift-io-v1 - Name: 'Endpoints [core/v1]' File: endpoints-core-v1 - Name: 'EndpointSlice [discovery.k8s.io/v1beta1]' File: endpointslice-discovery-k8s-io-v1beta1 - Name: 'EgressNetworkPolicy [network.openshift.io/v1]' File: egressnetworkpolicy-network-openshift-io-v1 - Name: 'HostSubnet [network.openshift.io/v1]' File: hostsubnet-network-openshift-io-v1 - Name: 'Ingress [networking.k8s.io/v1beta1]' File: ingress-networking-k8s-io-v1beta1 - Name: 'IngressClass [networking.k8s.io/v1beta1]' File: ingressclass-networking-k8s-io-v1beta1 - Name: 'NetNamespace [network.openshift.io/v1]' File: netnamespace-network-openshift-io-v1 - Name: 'NetworkAttachmentDefinition [k8s.cni.cncf.io/v1]' File: networkattachmentdefinition-k8s-cni-cncf-io-v1 - Name: 'NetworkPolicy [networking.k8s.io/v1]' File: networkpolicy-networking-k8s-io-v1 - Name: 'Route [route.openshift.io/v1]' File: route-route-openshift-io-v1 - Name: 'Service [core/v1]' File: service-core-v1 - Name: Node APIs Dir: node_apis Topics: - Name: About Node APIs File: node-apis-index - Name: 'Node [core/v1]' File: node-core-v1 - Name: 'Profile [tuned.openshift.io/v1]' File: profile-tuned-openshift-io-v1 - Name: 'RuntimeClass [node.k8s.io/v1beta1]' File: runtimeclass-node-k8s-io-v1beta1 - Name: 'Tuned [tuned.openshift.io/v1]' File: tuned-tuned-openshift-io-v1 - Name: OAuth APIs Dir: oauth_apis Topics: - Name: About OAuth APIs File: oauth-apis-index - Name: 'OAuthAccessToken [oauth.openshift.io/v1]' File: oauthaccesstoken-oauth-openshift-io-v1 - Name: 'OAuthAuthorizeToken [oauth.openshift.io/v1]' File: oauthauthorizetoken-oauth-openshift-io-v1 - Name: 'OAuthClientAuthorization [oauth.openshift.io/v1]' File: oauthclientauthorization-oauth-openshift-io-v1 - Name: 'OAuthClient [oauth.openshift.io/v1]' File: oauthclient-oauth-openshift-io-v1 - Name: Operator APIs Dir: operator_apis Topics: - Name: About Operator APIs File: operator-apis-index - Name: 'Authentication [operator.openshift.io/v1]' File: authentication-operator-openshift-io-v1 - Name: 'Console [operator.openshift.io/v1]' File: console-operator-openshift-io-v1 - Name: 'Config [operator.openshift.io/v1]' File: config-operator-openshift-io-v1 - Name: 'Config [imageregistry.operator.openshift.io/v1]' File: config-imageregistry-operator-openshift-io-v1 - Name: 'Config [samples.operator.openshift.io/v1]' File: config-samples-operator-openshift-io-v1 - Name: 'CSISnapshotController [operator.openshift.io/v1]' File: csisnapshotcontroller-operator-openshift-io-v1 - Name: 'DNS [operator.openshift.io/v1]' File: dns-operator-openshift-io-v1 - Name: 'DNSRecord [ingress.operator.openshift.io/v1]' File: dnsrecord-ingress-operator-openshift-io-v1 - Name: 'Etcd [operator.openshift.io/v1]' File: etcd-operator-openshift-io-v1 - Name: 'ImageContentSourcePolicy [operator.openshift.io/v1alpha1]' File: imagecontentsourcepolicy-operator-openshift-io-v1alpha1 - Name: 'ImagePruner [imageregistry.operator.openshift.io/v1]' File: imagepruner-imageregistry-operator-openshift-io-v1 - Name: 'IngressController [operator.openshift.io/v1]' File: ingresscontroller-operator-openshift-io-v1 - Name: 'KubeAPIServer [operator.openshift.io/v1]' File: kubeapiserver-operator-openshift-io-v1 - Name: 'KubeControllerManager [operator.openshift.io/v1]' File: kubecontrollermanager-operator-openshift-io-v1 - Name: 'KubeScheduler [operator.openshift.io/v1]' File: kubescheduler-operator-openshift-io-v1 - Name: 'KubeStorageVersionMigrator [operator.openshift.io/v1]' File: kubestorageversionmigrator-operator-openshift-io-v1 - Name: 'Network [operator.openshift.io/v1]' File: network-operator-openshift-io-v1 - Name: 'OpenShiftAPIServer [operator.openshift.io/v1]' File: openshiftapiserver-operator-openshift-io-v1 - Name: 'OpenShiftControllerManager [operator.openshift.io/v1]' File: openshiftcontrollermanager-operator-openshift-io-v1 - Name: 'ServiceCA [operator.openshift.io/v1]' File: serviceca-operator-openshift-io-v1 - Name: OperatorHub APIs Dir: operatorhub_apis Topics: - Name: About OperatorHub APIs File: operatorhub-apis-index - Name: 'CatalogSource [operators.coreos.com/v1alpha1]' File: catalogsource-operators-coreos-com-v1alpha1 - Name: 'ClusterServiceVersion [operators.coreos.com/v1alpha1]' File: clusterserviceversion-operators-coreos-com-v1alpha1 - Name: 'InstallPlan [operators.coreos.com/v1alpha1]' File: installplan-operators-coreos-com-v1alpha1 - Name: 'OperatorGroup [operators.coreos.com/v1]' File: operatorgroup-operators-coreos-com-v1 - Name: 'OperatorSource [operators.coreos.com/v1]' File: operatorsource-operators-coreos-com-v1 - Name: 'PackageManifest [packages.operators.coreos.com/v1]' File: packagemanifest-packages-operators-coreos-com-v1 - Name: 'Subscription [operators.coreos.com/v1alpha1]' File: subscription-operators-coreos-com-v1alpha1 - Name: Policy APIs Dir: policy_apis Topics: - Name: About Policy APIs File: policy-apis-index - Name: 'PodDisruptionBudget [policy/v1beta1]' File: poddisruptionbudget-policy-v1beta1 - Name: Project APIs Dir: project_apis Topics: - Name: About Project APIs File: project-apis-index - Name: 'Project [project.openshift.io/v1]' File: project-project-openshift-io-v1 - Name: 'ProjectRequest [project.openshift.io/v1]' File: projectrequest-project-openshift-io-v1 - Name: RBAC APIs Dir: rbac_apis Topics: - Name: About RBAC APIs File: rbac-apis-index - Name: 'ClusterRoleBinding [rbac.authorization.k8s.io/v1]' File: clusterrolebinding-rbac-authorization-k8s-io-v1 - Name: 'ClusterRole [rbac.authorization.k8s.io/v1]' File: clusterrole-rbac-authorization-k8s-io-v1 - Name: 'RoleBinding [rbac.authorization.k8s.io/v1]' File: rolebinding-rbac-authorization-k8s-io-v1 - Name: 'Role [rbac.authorization.k8s.io/v1]' File: role-rbac-authorization-k8s-io-v1 - Name: Role APIs Dir: role_apis Topics: - Name: About Role APIs File: role-apis-index - Name: 'ClusterRoleBinding [authorization.openshift.io/v1]' File: clusterrolebinding-authorization-openshift-io-v1 - Name: 'ClusterRole [authorization.openshift.io/v1]' File: clusterrole-authorization-openshift-io-v1 - Name: 'RoleBindingRestriction [authorization.openshift.io/v1]' File: rolebindingrestriction-authorization-openshift-io-v1 - Name: 'RoleBinding [authorization.openshift.io/v1]' File: rolebinding-authorization-openshift-io-v1 - Name: 'Role [authorization.openshift.io/v1]' File: role-authorization-openshift-io-v1 - Name: Schedule and quota APIs Dir: schedule_and_quota_apis Topics: - Name: About Schedule and quota APIs File: schedule-and-quota-apis-index - Name: 'AppliedClusterResourceQuota [quota.openshift.io/v1]' File: appliedclusterresourcequota-quota-openshift-io-v1 - Name: 'ClusterResourceQuota [quota.openshift.io/v1]' File: clusterresourcequota-quota-openshift-io-v1 - Name: 'LimitRange [core/v1]' File: limitrange-core-v1 - Name: 'PriorityClass [scheduling.k8s.io/v1]' File: priorityclass-scheduling-k8s-io-v1 - Name: 'ResourceQuota [core/v1]' File: resourcequota-core-v1 - Name: Security APIs Dir: security_apis Topics: - Name: About Security APIs File: security-apis-index - Name: 'CertificateSigningRequest [certificates.k8s.io/v1beta1]' File: certificatesigningrequest-certificates-k8s-io-v1beta1 - Name: 'CredentialsRequest [cloudcredential.openshift.io/v1]' File: credentialsrequest-cloudcredential-openshift-io-v1 - Name: 'PodSecurityPolicyReview [security.openshift.io/v1]' File: podsecuritypolicyreview-security-openshift-io-v1 - Name: 'PodSecurityPolicySelfSubjectReview [security.openshift.io/v1]' File: podsecuritypolicyselfsubjectreview-security-openshift-io-v1 - Name: 'PodSecurityPolicySubjectReview [security.openshift.io/v1]' File: podsecuritypolicysubjectreview-security-openshift-io-v1 - Name: 'RangeAllocation [security.openshift.io/v1]' File: rangeallocation-security-openshift-io-v1 - Name: 'Secret [core/v1]' File: secret-core-v1 - Name: 'SecurityContextConstraints [security.openshift.io/v1]' File: securitycontextconstraints-security-openshift-io-v1 - Name: 'ServiceAccount [core/v1]' File: serviceaccount-core-v1 - Name: Storage APIs Dir: storage_apis Topics: - Name: About Storage APIs File: storage-apis-index - Name: 'CSIDriver [storage.k8s.io/v1]' File: csidriver-storage-k8s-io-v1 - Name: 'CSINode [storage.k8s.io/v1]' File: csinode-storage-k8s-io-v1 - Name: 'PersistentVolumeClaim [core/v1]' File: persistentvolumeclaim-core-v1 - Name: 'StorageClass [storage.k8s.io/v1]' File: storageclass-storage-k8s-io-v1 - Name: 'VolumeAttachment [storage.k8s.io/v1]' File: volumeattachment-storage-k8s-io-v1 - Name: 'VolumeSnapshot [snapshot.storage.k8s.io/v1beta1]' File: volumesnapshot-snapshot-storage-k8s-io-v1beta1 - Name: 'VolumeSnapshotClass [snapshot.storage.k8s.io/v1beta1]' File: volumesnapshotclass-snapshot-storage-k8s-io-v1beta1 - Name: 'VolumeSnapshotContent [snapshot.storage.k8s.io/v1beta1]' File: volumesnapshotcontent-snapshot-storage-k8s-io-v1beta1 - Name: Template APIs Dir: template_apis Topics: - Name: About Template APIs File: template-apis-index - Name: 'BrokerTemplateInstance [template.openshift.io/v1]' File: brokertemplateinstance-template-openshift-io-v1 - Name: 'PodTemplate [core/v1]' File: podtemplate-core-v1 - Name: 'Template [template.openshift.io/v1]' File: template-template-openshift-io-v1 - Name: 'TemplateInstance [template.openshift.io/v1]' File: templateinstance-template-openshift-io-v1 - Name: User and group APIs Dir: user_and_group_apis Topics: - Name: About User and group APIs File: user-and-group-apis-index - Name: 'Group [user.openshift.io/v1]' File: group-user-openshift-io-v1 - Name: 'Identity [user.openshift.io/v1]' File: identity-user-openshift-io-v1 - Name: 'UserIdentityMapping [user.openshift.io/v1]' File: useridentitymapping-user-openshift-io-v1 - Name: 'User [user.openshift.io/v1]' File: user-user-openshift-io-v1 - Name: Workloads APIs Dir: workloads_apis Topics: - Name: About Workloads APIs File: workloads-apis-index - Name: 'BuildConfig [build.openshift.io/v1]' File: buildconfig-build-openshift-io-v1 - Name: 'Build [build.openshift.io/v1]' File: build-build-openshift-io-v1 - Name: 'CronJob [batch/v1beta1]' File: cronjob-batch-v1beta1 - Name: 'DaemonSet [apps/v1]' File: daemonset-apps-v1 - Name: 'Deployment [apps/v1]' File: deployment-apps-v1 - Name: 'DeploymentConfig [apps.openshift.io/v1]' File: deploymentconfig-apps-openshift-io-v1 - Name: 'Job [batch/v1]' File: job-batch-v1 - Name: 'Pod [core/v1]' File: pod-core-v1 - Name: 'ReplicationController [core/v1]' File: replicationcontroller-core-v1 - Name: 'PersistentVolume [core/v1]' File: persistentvolume-core-v1 - Name: 'ReplicaSet [apps/v1]' File: replicaset-apps-v1 - Name: 'StatefulSet [apps/v1]' File: statefulset-apps-v1 --- Name: Service Mesh Dir: service_mesh Distros: openshift-enterprise,openshift-webscale Topics: #- Name: Service Mesh 2.x # Dir: v2x # Topics: # - Name: Service Mesh 2.x release notes # File: servicemesh-release-notes # - Name: Service Mesh architecture # File: ossm-architecture # - Name: Service Mesh and Istio differences # File: ossm-vs-community # - Name: Preparing to install Service Mesh # File: preparing-ossm-installation # - Name: Installing Service Mesh # File: installing-ossm # - Name: Customizing the installation # File: customizing-installation-ossm # - Name: Deploying applications on Service Mesh # File: prepare-to-deploy-applications-ossm # - Name: Data visualization and observability # File: ossm-observability # - Name: Security # File: ossm-security # - Name: Traffic management # File: ossm-traffic-manage # - Name: Using the 3scale Istio adapter # File: threescale-adapter - Name: Service Mesh 1.x Dir: v1x Topics: - Name: Service Mesh 1.x release notes File: servicemesh-release-notes - Name: Service Mesh architecture File: ossm-architecture - Name: Service Mesh and Istio differences File: ossm-vs-community - Name: Preparing to install Service Mesh File: preparing-ossm-installation - Name: Installing Service Mesh File: installing-ossm - Name: Customizing the installation File: customizing-installation-ossm - Name: Deploying applications on Service Mesh File: prepare-to-deploy-applications-ossm - Name: Data visualization and observability File: ossm-observability - Name: Security File: ossm-security - Name: Traffic management File: ossm-traffic-manage - Name: Using the 3scale Istio adapter File: threescale-adapter --- Name: Jaeger Dir: jaeger Distros: openshift-enterprise Topics: - Name: Jaeger release notes File: rhbjaeger-release-notes - Name: Jaeger architecture Dir: jaeger_arch Topics: - Name: Jaeger architecture File: rhbjaeger-architecture - Name: Jaeger installation Dir: jaeger_install Topics: - Name: Installing Jaeger File: rhbjaeger-installation - Name: Configuring Jaeger File: rhbjaeger-deploying - Name: Upgrading Jaeger File: rhbjaeger-updating - Name: Removing Jaeger File: rhbjaeger-removing --- Name: OpenShift Virtualization Dir: virt Distros: openshift-enterprise,openshift-webscale Topics: - Name: About OpenShift Virtualization File: about-virt - Name: OpenShift Virtualization release notes File: virt-2-5-release-notes - Name: OpenShift Virtualization installation Dir: install Topics: - Name: Preparing your OpenShift cluster for OpenShift Virtualization File: preparing-cluster-for-virt - Name: Installing OpenShift Virtualization using the web console File: installing-virt-web - Name: Installing OpenShift Virtualization using the CLI File: installing-virt-cli - Name: Installing the virtctl client File: virt-installing-virtctl - Name: Uninstalling OpenShift Virtualization using the web console File: uninstalling-virt-web - Name: Uninstalling OpenShift Virtualization using the CLI File: uninstalling-virt-cli - Name: Upgrading OpenShift Virtualization File: upgrading-virt - Name: Additional security privileges granted for kubevirt-controller and virt-launcher File: virt-additional-security-privileges-controller-and-launcher - Name: Using the CLI tools File: virt-using-the-cli-tools - Name: Virtual machines Dir: virtual_machines Topics: ###VIRTUAL MACHINE CHESS SALAD (silly name to highlight that the commented out assemblies need to be checked against merged filenams) - Name: Creating virtual machines File: virt-create-vms - Name: Editing virtual machines File: virt-edit-vms - Name: Editing boot order File: virt-edit-boot-order - Name: Deleting virtual machines File: virt-delete-vms - Name: Managing virtual machine instances File: virt-manage-vmis - Name: Controlling virtual machines states File: virt-controlling-vm-states - Name: Accessing virtual machine consoles File: virt-accessing-vm-consoles - Name: Managing ConfigMaps, secrets, and service accounts in virtual machines File: virt-managing-configmaps-secrets-service-accounts - Name: Installing VirtIO driver on an existing Windows virtual machine File: virt-installing-virtio-drivers-on-existing-windows-vm - Name: Installing VirtIO driver on a new Windows virtual machine File: virt-installing-virtio-drivers-on-new-windows-vm - Name: Advanced virtual machine management Dir: advanced_vm_management Topics: #Advanced virtual machine configuration - Name: Automating management tasks File: virt-automating-management-tasks - Name: Configuring PXE booting for virtual machines File: virt-configuring-pxe-booting - Name: Managing guest memory File: virt-managing-guest-memory - Name: Using huge pages with virtual machines File: virt-using-huge-pages-with-vms - Name: Enabling dedicated resources for a virtual machine File: virt-dedicated-resources-vm - Name: Scheduling virtual machines File: virt-schedule-vms # Importing virtual machines - Name: Importing virtual machines Dir: importing_vms Topics: - Name: TLS certificates for DataVolume imports File: virt-tls-certificates-for-dv-imports - Name: Importing virtual machine images with DataVolumes File: virt-importing-virtual-machine-images-datavolumes - Name: Importing virtual machine images to block storage with DataVolumes File: virt-importing-virtual-machine-images-datavolumes-block - Name: Importing a Red Hat Virtualization virtual machine File: virt-importing-rhv-vm - Name: Importing a VMware virtual machine or template File: virt-importing-vmware-vm # Cloning virtual machines - Name: Cloning virtual machines Dir: cloning_vms Topics: - Name: Enabling user permissions to clone DataVolumes across namespaces File: virt-enabling-user-permissions-to-clone-datavolumes - Name: Cloning a virtual machine disk into a new DataVolume File: virt-cloning-vm-disk-into-new-datavolume - Name: Cloning a virtual machine by using a DataVolumeTemplate File: virt-cloning-vm-using-datavolumetemplate - Name: Cloning a virtual machine disk into a new block storage DataVolume File: virt-cloning-vm-disk-into-new-datavolume-block # Virtual machine networking - Name: Virtual machine networking Dir: vm_networking Topics: - Name: Using the default Pod network with OpenShift Virtualization File: virt-using-the-default-pod-network-with-virt - Name: Attaching a virtual machine to multiple networks File: virt-attaching-vm-multiple-networks - Name: Configuring an SR-IOV network device for virtual machines File: virt-configuring-sriov-device-for-vms - Name: Defining an SR-IOV network File: virt-defining-an-sriov-network - Name: Attaching a virtual machine to an SR-IOV network File: virt-attaching-vm-to-sriov-network - Name: Installing the QEMU guest agent on virtual machines File: virt-installing-qemu-guest-agent - Name: Viewing the QEMU guest agent information for virtual machines File: virt-viewing-qemu-guest-agent-web - Name: Viewing the IP address of NICs on a virtual machine File: virt-viewing-ip-of-vm-nic - Name: Using a MAC address pool for virtual machines File: virt-using-mac-address-pool-for-vms #A BETTER NAME THAN 'STORAGE 4 U' - Name: Virtual machine disks Dir: virtual_disks Topics: - Name: Features for storage File: virt-features-for-storage - Name: Configuring local storage for virtual machines File: virt-configuring-local-storage-for-vms - Name: Configuring CDI to work with namespaces that have a compute resource quota File: virt-configuring-cdi-for-namespace-resourcequota - Name: Uploading local disk images by using the web console File: virt-uploading-local-disk-images-web - Name: Uploading local disk images by using the virtctl tool File: virt-uploading-local-disk-images-virtctl - Name: Uploading a local disk image to a block storage DataVolume File: virt-uploading-local-disk-images-block - Name: Moving a local virtual machine disk to a different node File: virt-moving-local-vm-disk-to-different-node - Name: Expanding virtual storage by adding blank disk images File: virt-expanding-virtual-storage-with-blank-disk-images - Name: Cloning a DataVolume using smart-cloning File: virt-cloning-a-datavolume-using-smart-cloning - Name: Storage defaults for DataVolumes File: virt-storage-defaults-for-datavolumes - Name: Preparing CDI scratch space File: virt-preparing-cdi-scratch-space - Name: Re-using statically provisioned persistent volumes File: virt-reusing-statically-provisioned-persistent-volumes - Name: Deleting DataVolumes File: virt-deleting-datavolumes # Templates - Name: Virtual machine templates Dir: vm_templates Topics: - Name: Creating virtual machine templates File: virt-creating-vm-template - Name: Editing a virtual machine template File: virt-editing-vm-template - Name: Enabling dedicated resources for a virtual machine template File: virt-dedicated-resources-vm-template - Name: Deleting a virtual machine template File: virt-deleting-vm-template # Virtual machine live migration - Name: Live migration Dir: live_migration Topics: - Name: Virtual machine live migration File: virt-live-migration - Name: Live migration limits and timeouts File: virt-live-migration-limits - Name: Migrating a virtual machine instance to another node File: virt-migrate-vmi - Name: Monitoring live migration of a virtual machine instance File: virt-monitor-vmi-migration - Name: Cancelling the live migration of a virtual machine instance File: virt-cancel-vmi-migration - Name: Configuring virtual machine eviction strategy File: virt-configuring-vmi-eviction-strategy # Node maintenance mode - Name: Node maintenance Dir: node_maintenance Topics: - Name: Automatic renewal of TLS certificates File: virt-automatic-certificates - Name: Node maintenance mode File: virt-node-maintenance - Name: Setting a node to maintenance mode File: virt-setting-node-maintenance - Name: Resuming a node from maintenance mode File: virt-resuming-node # Node Networking - Name: Node networking Dir: node_network Topics: - Name: Observing node network state File: virt-observing-node-network-state - Name: Updating node network configuration File: virt-updating-node-network-config - Name: Troubleshooting node network configuration File: virt-troubleshooting-node-network # Logging, events, and monitoring - Name: Logging, events, and monitoring Dir: logging_events_monitoring Topics: - Name: Viewing logs File: virt-logs - Name: Viewing events File: virt-events - Name: Diagnosing DataVolumes using events and conditions File: virt-diagnosing-datavolumes-using-events-and-conditions - Name: Viewing information about virtual machine workloads File: virt-viewing-information-about-vm-workloads - Name: Monitoring virtual machine health File: virt-monitoring-vm-health - Name: Viewing cluster information File: virt-using-dashboard-to-get-cluster-info - Name: OpenShift cluster monitoring, logging, and Telemetry File: virt-openshift-cluster-monitoring - Name: Collecting OpenShift Virtualization data for Red Hat Support File: virt-collecting-virt-data --- # OpenShift Serverless Name: Serverless applications Dir: serverless Distros: openshift-enterprise,openshift-webscale Topics: # Intro / getting started - Name: Getting started File: serverless-getting-started # Installing OpenShift Serverless - Name: Installing OpenShift Serverless Dir: installing_serverless Topics: - Name: Installing OpenShift Serverless File: installing-openshift-serverless - Name: Installing Knative Serving File: installing-knative-serving - Name: Installing Knative Eventing File: installing-knative-eventing - Name: Advanced installation configuration options File: serverless-install-config-options - Name: Upgrading the OpenShift Serverless Operator File: upgrading-serverless - Name: Removing OpenShift Serverless File: removing-openshift-serverless - Name: Installing the Knative CLI File: installing-kn # Architecture - Name: Architecture Dir: architecture Topics: - Name: Knative Serving File: serverless-serving-architecture - Name: Knative Eventing File: serverless-event-architecture # Apps - Name: Creating and managing serverless applications File: serving-creating-managing-apps # HA - Name: High availability on OpenShift Serverless File: serverless-HA # Tracing - Name: Tracing requests File: serverless-tracing # Knative Serving - Name: Knative Serving Dir: knative_serving Topics: # Knative services - Name: Using kn to complete Serving tasks File: serving-kn-commands - Name: Configuring Knative Serving autoscaling File: configuring-knative-serving-autoscaling - Name: Cluster logging with OpenShift Serverless File: cluster-logging-serverless - Name: Splitting traffic between revisions File: splitting-traffic-between-revisions # Knative Eventing - Name: Event workflows Dir: event_workflows Topics: # Brokers - Name: Event delivery workflows using brokers and triggers File: serverless-using-brokers # Channels - Name: Event delivery workflows using channels File: serverless-channels # Sinkbinding - Name: Using SinkBinding File: serverless-sinkbinding # Event sources - Name: Event sources Dir: event_sources Topics: - Name: Getting started with event sources File: knative-event-sources - Name: Listing event sources and event source types File: serverless-listing-event-sources - Name: Using ApiServerSource File: serverless-apiserversource - Name: Using PingSource File: serverless-pingsource # Networking - Name: Networking Dir: networking Topics: - Name: Using Service Mesh with OpenShift Serverless File: serverless-ossm - Name: Using JSON Web Token authentication with Service Mesh and OpenShift Serverless File: serverless-ossm-jwt - Name: Using custom domains for Knative services with Service Mesh File: serverless-ossm-custom-domains # Metering - Name: Using metering with OpenShift Serverless File: serverless-metering # Integrations - Name: Integrations Dir: integrations Topics: - Name: Using NVIDIA GPU resources with serverless applications File: gpu-resources # Release notes - Name: Release Notes File: serverless-release-notes # Support - Name: Support File: serverless-support