Documentation
OKD
latest
4.17
4.16
4.15
4.14
4.13
4.12
4.11
4.10
4.9
4.8
4.7
4.6
3.11
3.10
3.9
3.7
3.6
Observability
Logging
Logging 6.0
Visualization for logging
About
Welcome
What's new?
New features and enhancements
Deprecated features
Architecture
Architecture overview
Product architecture
Installation and update
Control plane architecture
Understanding OKD development
Fedora CoreOS
Admission plugins
Installing
Installation overview
Installation overview
Selecting an installation method and preparing a cluster
Cluster capabilities
Disconnected installation mirroring
About disconnected installation mirroring
Creating a mirror registry with mirror registry for Red Hat OpenShift
Mirroring images for a disconnected installation
Mirroring images for a disconnected installation using the oc-mirror plugin v1
Mirroring images for a disconnected installation using oc-mirror plugin v2
Installing on Alibaba Cloud
Installing a cluster on Alibaba Cloud using the Assisted Installer
Installing on AWS
Installation methods
Configuring an AWS account
Installer-provisioned infrastructure
Preparing to install a cluster
Installing a cluster
Installing a cluster with customizations
Installing a cluster with network customizations
Installing a cluster in a restricted network
Installing a cluster into an existing VPC
Installing a private cluster
Installing a cluster into a government region
Installing a cluster into a Secret or Top Secret Region
Installing a cluster into a China region
Installing a cluster with compute nodes on Local Zones
Installing a cluster with compute nodes on Wavelength Zones
Extending an AWS VPC cluster into an AWS Outpost
User-provisioned infrastructure
Preparing to install a cluster
Installation requirements
Installing a cluster using CloudFormation templates
Installing a cluster in a restricted network with user-provisioned infrastructure
Installing a three-node cluster
Uninstalling a cluster
Installation configuration parameters
Installing on Azure
Preparing to install on Azure
Configuring an Azure account
Enabling user-managed encryption on Azure
Installing a cluster quickly on Azure
Installing a cluster on Azure with customizations
Installing a cluster on Azure with network customizations
Installing a cluster on Azure into an existing VNet
Installing a private cluster on Azure
Installing a cluster on Azure into a government region
Installing a cluster on Azure in a restricted network with user-provisioned infrastructure
Installing a cluster on Azure using ARM templates
Installing a cluster on Azure in a restricted network
Installing a three-node cluster on Azure
Uninstalling a cluster on Azure
Installation configuration parameters for Azure
Installing on Azure Stack Hub
Preparing to install on Azure Stack Hub
Configuring an Azure Stack Hub account
Installing a cluster on Azure Stack Hub with an installer-provisioned infrastructure
Installing a cluster on Azure Stack Hub with network customizations
Installing a cluster on Azure Stack Hub using ARM templates
Installation configuration parameters for Azure Stack Hub
Uninstalling a cluster on Azure Stack Hub
Installing on GCP
Preparing to install on GCP
Configuring a GCP project
Installing a cluster quickly on GCP
Installing a cluster on GCP with customizations
Installing a cluster on GCP with network customizations
Installing a cluster on GCP in a restricted network
Installing a cluster on GCP into an existing VPC
Installing a cluster on GCP into a shared VPC
Installing a private cluster on GCP
Installing a cluster on GCP using Deployment Manager templates
Installing a cluster into a shared VPC on GCP using Deployment Manager templates
Installing a cluster on GCP in a restricted network with user-provisioned infrastructure
Installing a three-node cluster on GCP
Installation configuration parameters for GCP
Uninstalling a cluster on GCP
Installing on IBM Cloud
Preparing to install on IBM Cloud
Configuring an IBM Cloud account
Configuring IAM for IBM Cloud
User-managed encryption
Installing a cluster on IBM Cloud with customizations
Installing a cluster on IBM Cloud with network customizations
Installing a cluster on IBM Cloud into an existing VPC
Installing a private cluster on IBM Cloud
Installing a cluster on IBM Cloud in a restricted network
Installation configuration parameters for IBM Cloud
Uninstalling a cluster on IBM Cloud
Installing on Nutanix
Preparing to install on Nutanix
Fault tolerant deployments
Installing a cluster on Nutanix
Installing a cluster on Nutanix in a restricted network
Installing a three-node cluster on Nutanix
Uninstalling a cluster on Nutanix
Installation configuration parameters for Nutanix
Installing on a single node
Preparing to install OpenShift on a single node
Installing OpenShift on a single node
Installing on bare metal
Preparing to install on bare metal
Installing a user-provisioned cluster on bare metal
Installing a user-provisioned bare metal cluster with network customizations
Installing a user-provisioned bare metal cluster on a restricted network
Scaling a user-provisioned installation with the bare metal operator
Installation configuration parameters for bare metal
Deploying installer-provisioned clusters on bare metal
Overview
Prerequisites
Setting up the environment for an OpenShift installation
Installing a cluster
Troubleshooting the installation
Postinstallation configuration
Expanding the cluster
Installing IBM Cloud Bare Metal (Classic)
Prerequisites
Installation workflow
Installing on OpenStack
Preparing to install on OpenStack
Preparing to install a cluster that uses SR-IOV or OVS-DPDK on OpenStack
Installing a cluster on OpenStack with customizations
Installing a cluster on OpenStack on your own infrastructure
Installing a cluster on OpenStack in a restricted network
Configuring network settings after installing OpenStack
OpenStack Cloud Controller Manager reference guide
Deploying on OpenStack with rootVolume and etcd on local disk
Uninstalling a cluster on OpenStack
Uninstalling a cluster on OpenStack from your own infrastructure
Installation configuration parameters for OpenStack
Installing on OCI
Installing a cluster on Oracle Cloud Infrastructure by using the Assisted Installer
Installing a cluster on Oracle Cloud Infrastructure by using the Agent-based Installer
Installing on vSphere
Installation methods
Installer-provisioned infrastructure
vSphere installation requirements
Preparing to install a cluster
Installing a cluster
Installing a cluster with customizations
Installing a cluster with network customizations
Installing a cluster in a restricted network
User-provisioned infrastructure
vSphere installation requirements
Preparing to install a cluster
Installing a cluster
Installing a cluster with network customizations
Installing a cluster in a restricted network
Installing a three-node cluster
Uninstalling a cluster
Using the vSphere Problem Detector Operator
Installation configuration parameters
Regions and zones for a VMware vCenter
Enabling encryption on a vSphere cluster
Configuring the vSphere connection settings after an installation
Installing on any platform
Installing a cluster on any platform
Installation configuration
Customizing nodes
Configuring your firewall
Validation and troubleshooting
Validating an installation
Troubleshooting installation issues
Postinstallation configuration
Configuring a private cluster
Bare metal configuration
Cluster tasks
Node tasks
Postinstallation network configuration
Configuring image streams and image registries
Storage configuration
Preparing for users
Changing the cloud provider credentials configuration
Configuring alert notifications
Converting a connected cluster to a disconnected cluster
Updating clusters
Updating clusters overview
Understanding OpenShift updates
Introduction to OpenShift updates
Understanding OpenShift update duration
Preparing to update a cluster
Preparing to update to OKD 4.16
Preparing to update a cluster with manually maintained credentials
Preflight validation for Kernel Module Management (KMM) Modules
Performing a cluster update
Updating a cluster using the CLI
Updating a cluster using the web console
Performing a canary rollout update
Updating a cluster in a disconnected environment
About cluster updates in a disconnected environment
Mirroring OpenShift Container Platform images
Updating a cluster in a disconnected environment by using the CLI
Updating hardware on nodes running on vSphere
Migrating to a cluster with multi-architecture compute machines
Updating hosted control planes
Updating the boot loader on Fedora CoreOS nodes using bootupd
Troubleshooting a cluster update
Gathering data about your cluster update
Support
Support overview
Managing your cluster resources
Getting support
Remote health monitoring with connected clusters
About remote health monitoring
Showing data collected by remote health monitoring
Opting out of remote health reporting
Enabling remote health reporting
Using Insights to identify issues with your cluster
Using the Insights Operator
Using remote health reporting in a restricted network
Importing simple content access entitlements with Insights Operator
Gathering data about your cluster
Summarizing cluster specifications
Troubleshooting
Troubleshooting installations
Verifying node health
Troubleshooting CRI-O container runtime issues
Troubleshooting operating system issues
Troubleshooting network issues
Troubleshooting Operator issues
Investigating pod issues
Troubleshooting the Source-to-Image process
Troubleshooting storage issues
Troubleshooting Windows container workload issues
Investigating monitoring issues
Diagnosing OpenShift CLI (oc) issues
Web console
Web console overview
Accessing the web console
Using the OpenShift Container Platform dashboard to get cluster information
Adding user preferences
Configuring the web console
Customizing the web console
Dynamic plugins
Overview of dynamic plugins
Getting started with dynamic plugins
Deploy your plugin on a cluster
Dynamic plugin example
Dynamic plugin reference
Disabling the web console
Creating quick start tutorials
Optional capabilities and products
CLI tools
CLI tools overview
OpenShift CLI (oc)
Getting started with the OpenShift CLI
Configuring the OpenShift CLI
Usage of oc and kubectl commands
Managing CLI profiles
Extending the OpenShift CLI with plugins
Managing CLI plugins with Krew
OpenShift CLI developer command reference
OpenShift CLI administrator command reference
Developer CLI (odo)
Knative CLI (kn) for use with OpenShift Serverless
opm CLI
Installing the opm CLI
opm CLI reference
Operator SDK
Installing the Operator SDK CLI
Operator SDK CLI reference
Security and compliance
Security and compliance overview
Container security
Understanding container security
Understanding host and VM security
Container image signatures
Hardening Fedora CoreOS
Understanding compliance
Securing container content
Using container registries securely
Securing the build process
Deploying containers
Securing the container platform
Securing networks
Securing attached storage
Monitoring cluster events and logs
Configuring certificates
Replacing the default ingress certificate
Adding API server certificates
Securing service traffic using service serving certificates
Updating the CA bundle
Certificate types and descriptions
User-provided certificates for the API server
Proxy certificates
Service CA certificates
Node certificates
Bootstrap certificates
etcd certificates
OLM certificates
Aggregated API client certificates
Machine Config Operator certificates
User-provided certificates for default ingress
Ingress certificates
Monitoring and cluster logging Operator component certificates
Control plane certificates
Compliance Operator
Compliance Operator overview
Compliance Operator release notes
Compliance Operator support
Compliance Operator concepts
Understanding the Compliance Operator
Understanding the Custom Resource Definitions
Compliance Operator management
Installing the Compliance Operator
Updating the Compliance Operator
Managing the Compliance Operator
Uninstalling the Compliance Operator
Compliance Operator scan management
Supported compliance profiles
Compliance Operator scans
Tailoring the Compliance Operator
Retrieving Compliance Operator raw results
Managing Compliance Operator remediation
Performing advanced Compliance Operator tasks
Troubleshooting Compliance Operator scans
Using the oc-compliance plugin
File Integrity Operator
File Integrity Operator Overview
File Integrity Operator release notes
File Integrity Operator support
Installing the File Integrity Operator
Updating the File Integrity Operator
Understanding the File Integrity Operator
Configuring the File Integrity Operator
Performing advanced File Integrity Operator tasks
Troubleshooting the File Integrity Operator
Security Profiles Operator
Security Profiles Operator overview
Security Profiles Operator release notes
Security Profiles Operator support
Understanding the Security Profiles Operator
Enabling the Security Profiles Operator
Managing seccomp profiles
Managing SELinux profiles
Advanced Security Profiles Operator tasks
Troubleshooting the Security Profiles Operator
Uninstalling the Security Profiles Operator
Viewing audit logs
Configuring the audit log policy
Configuring TLS security profiles
Configuring seccomp profiles
Allowing JavaScript-based access to the API server from additional hosts
Encrypting etcd data
Scanning pods for vulnerabilities
Network-Bound Disk Encryption (NBDE)
About disk encryption technology
Tang server installation considerations
Tang server encryption key management
Disaster recovery considerations
Authentication and authorization
Authentication and authorization overview
Understanding authentication
Configuring the internal OAuth server
Configuring OAuth clients
Managing user-owned OAuth access tokens
Understanding identity provider configuration
Configuring identity providers
Configuring an htpasswd identity provider
Configuring a Keystone identity provider
Configuring an LDAP identity provider
Configuring a basic authentication identity provider
Configuring a request header identity provider
Configuring a GitHub or GitHub Enterprise identity provider
Configuring a GitLab identity provider
Configuring a Google identity provider
Configuring an OpenID Connect identity provider
Using RBAC to define and apply permissions
Removing the kubeadmin user
Understanding and creating service accounts
Using service accounts in applications
Using a service account as an OAuth client
Scoping tokens
Using bound service account tokens
Managing security context constraints
Understanding and managing pod security admission
Impersonating the system:admin user
Syncing LDAP groups
Managing cloud provider credentials
About the Cloud Credential Operator
Mint mode
Passthrough mode
Manual mode with long-term credentials for components
Manual mode with short-term credentials for components
Networking
About networking
Understanding networking
Zero trust networking
Accessing hosts
Networking dashboards
Network security
Understanding network policy APIs
Admin network policy
About AdminNetworkPolicy
About BaselineAdminNetworkPolicy
Metrics for AdminNetworkPolicy
Northbound Traffic Controls for AdminNetworkPolicy
Troubleshooting
Best practices
Network policy
About network policy
Creating a network policy
Viewing a network policy
Editing a network policy
Deleting a network policy
Defining a default network policy for projects
Configuring multitenant isolation with network policy
Audit logging for network security
Understanding the Ingress Node Firewall Operator
Egress Firewall
Viewing an egress firewall for a project
Editing an egress firewall for a project
Removing an egress firewall from a project
Configuring an egress firewall for a project
Configuring IPsec encryption
Understanding the Cluster Network Operator
Understanding the DNS Operator
Understanding the Ingress Operator
Configuring the Ingress Controller for manual DNS management
Verifying connectivity to an endpoint
Changing the cluster network MTU
Configuring the node port service range
Configuring the cluster network IP address range
Configuring IP failover
Configuring system controls and interface attributes using the tuning plugin
Using SCTP
Using PTP hardware
About PTP in OpenShift clusters
Configuring PTP hardware
Using PTP events
Developing PTP events consumer applications
External DNS Operator
External DNS Operator release notes
Understanding the External DNS Operator
Installing the External DNS Operator
External DNS Operator configuration parameters
Creating DNS records on a public hosted zone for AWS
Creating DNS records on a public zone for Azure
Creating DNS records on a public managed zone for GCP
Creating DNS records on a public DNS zone for Infoblox
Configuring the cluster-wide proxy on the External DNS Operator
CIDR range definitions
AWS Load Balancer Operator
AWS Load Balancer Operator release notes
Understanding the AWS Load Balancer Operator
Installing the AWS Load Balancer Operator
Installing the AWS Load Balancer Operator on a cluster that uses AWS STS
Creating an instance of the AWS Load Balancer Controller
Serving multiple ingress resources through a single AWS Load Balancer
Adding TLS termination on the AWS Load Balancer
Configuring cluster-wide proxy on the AWS Load Balancer Operator
Multiple networks
Understanding multiple networks
Configuring an additional network
About virtual routing and forwarding
Configuring multi-network policy
Attaching a pod to an additional network
Removing a pod from an additional network
Editing an additional network
Removing an additional network
Assigning a secondary network to a VRF
Hardware networks
About Single Root I/O Virtualization (SR-IOV) hardware networks
Installing the SR-IOV Operator
Configuring the SR-IOV Operator
Configuring an SR-IOV network device
Configuring an SR-IOV Ethernet network attachment
Configuring an SR-IOV InfiniBand network attachment
Adding a pod to an SR-IOV network
Configuring interface-level network sysctl settings and all-multicast mode for SR-IOV networks
Configuring QinQ support for SR-IOV networks
Using high performance multicast
Using DPDK and RDMA
Using pod-level bonding for secondary networks
Configuring hardware offloading
Switching Bluefield-2 from NIC to DPU mode
Uninstalling the SR-IOV Operator
OVN-Kubernetes network plugin
About the OVN-Kubernetes network plugin
OVN-Kubernetes architecture
OVN-Kubernetes troubleshooting
OVN-Kubernetes traffic tracing
Migrating from the OpenShift SDN network plugin
Rolling back to the OpenShift SDN network plugin
Converting to IPv4/IPv6 dual stack networking
Configuring internal subnets
Configure an external gateway on the default network
Configuring an egress IP address
Assigning an egress IP address
Configuring an egress service
Considerations for the use of an egress router pod
Deploying an egress router pod in redirect mode
Enabling multicast for a project
Disabling multicast for a project
Tracking network flows
Configuring hybrid networking
OpenShift SDN network plugin
About the OpenShift SDN network plugin
Configuring egress IPs for a project
Configuring an egress firewall for a project
Viewing an egress firewall for a project
Editing an egress firewall for a project
Removing an egress firewall from a project
Considerations for the use of an egress router pod
Deploying an egress router pod in redirect mode
Deploying an egress router pod in HTTP proxy mode
Deploying an egress router pod in DNS proxy mode
Configuring an egress router pod destination list from a config map
Enabling multicast for a project
Disabling multicast for a project
Configuring multitenant isolation
Configuring kube-proxy
Configuring Routes
Route configuration
Secured routes
Configuring ingress cluster traffic
Overview
Configuring ExternalIPs for services
Configuring ingress cluster traffic using an Ingress Controller
Configuring the Ingress Controller endpoint publishing strategy
Configuring ingress cluster traffic using a load balancer
Configuring ingress cluster traffic on AWS
Configuring ingress cluster traffic using a service external IP
Configuring ingress cluster traffic using a NodePort
Configuring ingress cluster traffic using load balancer allowed source ranges
Kubernetes NMState
About the Kubernetes NMState Operator
Observing and updating node network state and configuration
Troubleshooting node network configuration
Configuring the cluster-wide proxy
Configuring a custom PKI
Load balancing on OpenStack
Load balancing with MetalLB
About MetalLB and the MetalLB Operator
Installing the MetalLB Operator
Upgrading the MetalLB Operator
Configuring MetalLB address pools
Advertising the IP address pools
Configuring MetalLB BGP peers
Advertising an IP address pool using the community alias
Configuring MetalLB BFD profiles
Configuring services to use MetalLB
Managing symmetric routing with MetalLB
Configuring the integration of MetalLB and FRR-K8s
MetalLB logging, troubleshooting, and support
Associating secondary interfaces metrics to network attachments
Storage
Storage overview
Understanding ephemeral storage
Understanding persistent storage
Configuring persistent storage
Persistent storage using AWS Elastic Block Store
Persistent storage using Azure Disk
Persistent storage using Azure File
Persistent storage using Cinder
Persistent storage using Fibre Channel
Persistent storage using FlexVolume
Persistent storage using GCE Persistent Disk
Persistent Storage using iSCSI
Persistent storage using NFS
Persistent storage using Red Hat OpenShift Data Foundation
Persistent storage using VMware vSphere
Persistent storage using local storage
Local storage overview
Persistent storage using local volumes
Persistent storage using hostPath
Persistent storage using LVM Storage
Using Container Storage Interface (CSI)
Configuring CSI volumes
CSI inline ephemeral volumes
Shared Resource CSI Driver Operator
CSI volume snapshots
CSI volume cloning
Managing the default storage class
CSI automatic migration
Detach CSI volumes after non-graceful node shutdown
AWS Elastic Block Store CSI Driver Operator
AWS Elastic File Service CSI Driver Operator
Azure Disk CSI Driver Operator
Azure File CSI Driver Operator
Azure Stack Hub CSI Driver Operator
GCP PD CSI Driver Operator
GCP Filestore CSI Driver Operator
IBM VPC Block CSI Driver Operator
IBM Power Virtual Server Block CSI Driver Operator
OpenStack Cinder CSI Driver Operator
OpenStack Manila CSI Driver Operator
Secrets Store CSI Driver Operator
CIFS/SMB CSI Driver Operator
VMware vSphere CSI Driver Operator
Generic ephemeral volumes
Expanding persistent volumes
Dynamic provisioning
Registry
Registry overview
Image Registry Operator in OKD
Setting up and configuring the registry
Configuring the registry for AWS user-provisioned infrastructure
Configuring the registry for GCP user-provisioned infrastructure
Configuring the registry for OpenStack user-provisioned infrastructure
Configuring the registry for Azure user-provisioned infrastructure
Configuring the registry for OpenStack
Configuring the registry for bare metal
Configuring the registry for vSphere
Configuring the registry for OpenShift Data Foundation
Configuring the registry for Nutanix
Accessing the registry
Exposing the registry
Operators
Operators overview
Understanding Operators
What are Operators?
Packaging format
Common terms
Operator Lifecycle Manager (OLM)
Concepts and resources
Architecture
Workflow
Dependency resolution
Operator groups
Multitenancy and Operator colocation
Operator conditions
Metrics
Webhooks
OperatorHub
Operators in multitenant clusters
CRDs
Extending the Kubernetes API with CRDs
Managing resources from CRDs
User tasks
Creating applications from installed Operators
Installing Operators in your namespace
Administrator tasks
Adding Operators to a cluster
Updating installed Operators
Deleting Operators from a cluster
Configuring OLM features
Configuring proxy support
Viewing Operator status
Managing Operator conditions
Allowing non-cluster administrators to install Operators
Managing custom catalogs
Using OLM on restricted networks
Catalog source pod scheduling
Troubleshooting Operator issues
Developing Operators
About the Operator SDK
Installing the Operator SDK CLI
Go-based Operators
Getting started
Tutorial
Project layout
Updating Go-based projects
Ansible-based Operators
Getting started
Tutorial
Project layout
Updating Ansible-based projects
Ansible support
Kubernetes Collection for Ansible
Using Ansible inside an Operator
Custom resource status management
Helm-based Operators
Getting started
Tutorial
Project layout
Updating Helm-based projects
Helm support
Hybrid Helm Operator
Updating Hybrid Helm-based projects
Java-based Operators
Getting started
Tutorial
Project layout
Updating Java-based projects
Defining cluster service versions (CSVs)
Working with bundle images
Complying with pod security admission
Token authentication
Token authentication for Operators on cloud providers
CCO-based workflow for OLM-managed Operators with AWS STS
CCO-based workflow for OLM-managed Operators with Microsoft Entra Workload ID
Validating Operators using the scorecard
Validating Operator bundles
High-availability or single-node cluster detection and support
Configuring built-in monitoring with Prometheus
Configuring leader election
Configuring support for multiple platforms
Object pruning utility
Migrating package manifest projects to bundle format
Operator SDK CLI reference
Migrating to Operator SDK v0.1.0
Cluster Operators reference
OLM 1.0 (Technology Preview)
About OLM 1.0
Components and architecture
Components overview
Operator Controller
RukPak
Catalogd
Installing an Operator from a catalog
CI/CD
CI/CD overview
Builds using BuildConfig
Understanding image builds
Understanding build configurations
Creating build inputs
Managing build output
Using build strategies
Custom image builds with Buildah
Performing and configuring basic builds
Triggering and modifying builds
Performing advanced builds
Using Red Hat subscriptions in builds
Securing builds by strategy
Build configuration resources
Troubleshooting builds
Setting up additional trusted certificate authorities for builds
Images
Overview of images
Configuring the Cluster Samples Operator
Using the Cluster Samples Operator with an alternate registry
Creating images
Managing images
Managing images overview
Tagging images
Image pull policy
Using image pull secrets
Managing image streams
Using image streams with Kubernetes resources
Triggering updates on image stream changes
Image configuration resources
Using templates
Using Ruby on Rails
Using images
Using images overview
Source-to-image
Customizing source-to-image images
Building applications
Building applications overview
Projects
Working with projects
Creating a project as another user
Configuring project creation
Creating applications
Creating applications using the Developer perspective
Creating applications from installed Operators
Creating applications by using the CLI
Viewing application composition by using the Topology view
Exporting applications
Working with Helm charts
Understanding Helm
Installing Helm
Configuring custom Helm chart repositories
Working with Helm releases
Deployments
Understanding deployments
Managing deployment processes
Using deployment strategies
Using route-based deployment strategies
Quotas
Resource quotas per project
Resource quotas across multiple projects
Using config maps with applications
Monitoring project and application metrics using the Developer perspective
Monitoring application health
Editing applications
Pruning objects to reclaim resources
Idling applications
Deleting applications
Using the Red Hat Marketplace
Machine configuration
Machine configuration overview
Using machine config objects to configure nodes
Using node disruption policies to minimize disruption from machine config changes
Configuring MCO-related custom resources
Updated boot images
Managing unused rendered machine configs
Fedora CoreOS image layering
Machine Config Daemon metrics
Machine management
Overview of machine management
Managing compute machines with the Machine API
Creating a compute machine set on AWS
Creating a compute machine set on Azure
Creating a compute machine set on Azure Stack Hub
Creating a compute machine set on GCP
Creating a compute machine set on IBM Cloud
Creating a compute machine set on IBM Power Virtual Server
Creating a compute machine set on Nutanix
Creating a compute machine set on OpenStack
Creating a compute machine set on vSphere
Creating a compute machine set on bare metal
Manually scaling a compute machine set
Modifying a compute machine set
Machine phases and lifecycle
Deleting a machine
Applying autoscaling to a cluster
Creating infrastructure machine sets
Managing user-provisioned infrastructure manually
Adding compute machines to clusters with user-provisioned infrastructure manually
Adding compute machines to AWS using CloudFormation templates
Adding compute machines to vSphere manually
Adding compute machines to bare metal
Managing control plane machines
About control plane machine sets
Getting started with control plane machine sets
Managing control plane machines with control plane machine sets
Control plane machine set configuration
Configuration options for control plane machines
Control plane configuration options for Amazon Web Services
Control plane configuration options for Microsoft Azure
Control plane configuration options for Google Cloud Platform
Control plane configuration options for Nutanix
Control plane configuration options for Red Hat OpenStack Platform
Control plane configuration options for VMware vSphere
Control plane resiliency and recovery
Troubleshooting the control plane machine set
Disabling the control plane machine set
Managing machines with the Cluster API
About the Cluster API
Getting started with the Cluster API
Managing machines with the Cluster API
Cluster API configuration
Configuration options for Cluster API machines
Cluster API configuration options for Amazon Web Services
Cluster API configuration options for Google Cloud Platform
Cluster API configuration options for VMware vSphere
Troubleshooting Cluster API clusters
Deploying machine health checks
Hosted control planes
Hosted control planes overview
Getting started with hosted control planes
Authentication and authorization for hosted control planes
Handling a machine configuration for hosted control planes
Using feature gates in a hosted cluster
Updating hosted control planes
Hosted control planes Observability
High availability for hosted control planes
About high availability for hosted control planes
Recovering a failing etcd cluster
Backing up and restoring etcd in an on-premise environment
Backing up and restoring etcd on AWS
Disaster recovery for a hosted cluster in AWS
Disaster recovery for a hosted cluster by using OADP
Troubleshooting hosted control planes
Nodes
Overview of nodes
Working with pods
About pods
Viewing pods
Configuring a cluster for pods
Automatically scaling pods with the horizontal pod autoscaler
Automatically adjust pod resource levels with the vertical pod autoscaler
Providing sensitive data to pods by using secrets
Providing sensitive data to pods by using an external secrets store
Creating and using config maps
Using Device Manager to make devices available to nodes
Including pod priority in pod scheduling decisions
Placing pods on specific nodes using node selectors
Automatically scaling pods with the Custom Metrics Autoscaler Operator
Release notes
Custom Metrics Autoscaler Operator release notes
Past releases
Custom Metrics Autoscaler Operator overview
Installing the custom metrics autoscaler
Understanding the custom metrics autoscaler triggers
Understanding custom metrics autoscaler trigger authentications
Pausing the custom metrics autoscaler
Gathering audit logs
Gathering debugging data
Viewing Operator metrics
Understanding how to add custom metrics autoscalers
Removing the Custom Metrics Autoscaler Operator
Controlling pod placement onto nodes (scheduling)
About pod placement using the scheduler
Scheduling pods using a scheduler profile
Placing pods relative to other pods using pod affinity and anti-affinity rules
Controlling pod placement on nodes using node affinity rules
Placing pods onto overcommited nodes
Controlling pod placement using node taints
Placing pods on specific nodes using node selectors
Controlling pod placement using pod topology spread constraints
Using Jobs and DaemonSets
Running background tasks on nodes automatically with daemonsets
Running tasks in pods using jobs
Working with nodes
Viewing and listing the nodes in your cluster
Working with nodes
Managing nodes
Managing the maximum number of pods per node
Using the Node Tuning Operator
Remediating, fencing, and maintaining nodes
Understanding node rebooting
Freeing node resources using garbage collection
Allocating resources for nodes
Allocating specific CPUs for nodes in a cluster
Enabling TLS security profiles for the kubelet
Creating infrastructure nodes
Working with containers
Understanding containers
Using Init Containers to perform tasks before a pod is deployed
Using volumes to persist container data
Mapping volumes using projected volumes
Allowing containers to consume API objects
Copying files to or from a container
Executing remote commands in a container
Using port forwarding to access applications in a container
Using sysctls in containers
Accessing faster builds with /dev/fuse
Working with clusters
Viewing system event information in a cluster
Analyzing cluster resource levels
Setting limit ranges
Configuring cluster memory to meet container memory and risk requirements
Configuring the Linux cgroup version on your nodes
Enabling features using FeatureGates
Improving cluster stability in high latency environments using worker latency profiles
Node metrics dashboard
Windows Container Support for OpenShift
Red Hat OpenShift support for Windows Containers overview
Release notes
Red Hat OpenShift support for Windows Containers release notes
Past releases
Understanding Windows container workloads
Enabling Windows container workloads
Creating Windows machine sets
Creating a Windows machine set on AWS
Creating a Windows machine set on Azure
Creating a Windows machine set on GCP
Creating a Windows machine set on Nutanix
Creating a Windows machine set on vSphere
Scheduling Windows container workloads
Windows node upgrades
Using Bring-Your-Own-Host Windows instances as nodes
Removing Windows nodes
Disabling Windows container workloads
Observability
Observability overview
Monitoring
Monitoring overview
Common monitoring configuration scenarios
Configuring the monitoring stack
Enabling monitoring for user-defined projects
Enabling alert routing for user-defined projects
Managing metrics
Managing alerts
Reviewing monitoring dashboards
Accessing monitoring APIs by using the CLI
Troubleshooting monitoring issues
Config map reference for the Cluster Monitoring Operator
Logging
Release notes
Logging 5.9
Logging 6.0
Release notes
About logging 6.0
Upgrading to Logging 6.0
Configuring log forwarding
Configuring LokiStack storage
Visualization for logging
Support
Troubleshooting logging
Viewing Logging status
Troubleshooting log forwarding
Troubleshooting logging alerts
Viewing the status of the Elasticsearch log store
About Logging
Installing Logging
Updating Logging
Visualizing logs
About log visualization
Log visualization with the web console
Viewing cluster dashboards
Log visualization with Kibana
Configuring your Logging deployment
Configuring CPU and memory limits for Logging components
Configuring systemd-journald for Logging
Log collection and forwarding
About log collection and forwarding
Log output types
Enabling JSON log forwarding
Configuring log forwarding
Configuring the logging collector
Collecting and storing Kubernetes events
Log storage
About log storage
Installing log storage
Configuring the LokiStack log store
Configuring the Elasticsearch log store
Logging alerts
Default logging alerts
Custom logging alerts
Performance and reliability tuning
Flow control mechanisms
Filtering logs by content
Filtering logs by metadata
Scheduling resources
Using node selectors to move logging resources
Using tolerations to control logging pod placement
Uninstalling Logging
Exported fields
API reference
5.6 Logging API reference
Glossary
Network Observability
Network Observability release notes
Network Observability overview
Installing the Network Observability Operator
Understanding Network Observability Operator
Configuring the Network Observability Operator
Network Policy
Observing the network traffic
Using metrics with dashboards and alerts
Monitoring the Network Observability Operator
Scheduling resources
Network Observability CLI
Installing the Network Observability CLI
Using the Network Observability CLI
Network Observability CLI reference
FlowCollector API reference
FlowMetric API reference
Flows format reference
Troubleshooting Network Observability
Power Monitoring
Power monitoring release notes
Power monitoring overview
Installing power monitoring
Configuring power monitoring
Visualizing power monitoring metrics
Uninstalling power monitoring
Cluster Observability Operator
Cluster Observability Operator release notes
Cluster Observability Operator overview
Installing the Cluster Observability Operator
Configuring the Cluster Observability Operator to monitor a service
Observability UI plugins
Observability UI plugins overview
Dashboard UI plugin
Distributed tracing UI plugin
Troubleshooting UI plugin
Logging UI plugin
Scalability and performance
Recommended performance and scalability practices
Recommended control plane practices
Recommended infrastructure practices
Recommended etcd practices
Reference design specifications
Telco reference design specifications
Telco RAN DU reference design specification
Telco RAN DU reference design overview
Telco RAN DU use model overview
RAN DU reference design components
RAN DU reference design configuration CRs
Telco RAN DU software specifications
Telco core reference design specification
Telco core reference design overview
Telco core use model overview
Core reference design components
Core reference design configuration CRs
Telco core software specifications
Planning your environment according to object maximums
Using the Node Tuning Operator
Using CPU Manager and Topology Manager
Scheduling NUMA-aware workloads
Scalability and performance optimization
Optimizing storage
Optimizing routing
Optimizing networking
Optimizing CPU usage
Managing bare metal hosts
Monitoring bare-metal events
What huge pages do and how they are consumed by apps
Low latency tuning
Understanding low latency
Tuning nodes for low latency with the performance profile
Provisioning real-time and low latency workloads
Debugging low latency tuning
Performing latency tests for platform verification
Improving cluster stability in high latency environments using worker latency profiles
Workload partitioning
Using the Node Observability Operator
Edge computing
Challenges of the network far edge
Preparing the hub cluster for ZTP
Updating GitOps ZTP
Installing managed clusters with RHACM and SiteConfig resources
Manually installing a single-node OpenShift cluster with GitOps ZTP
Recommended single-node OpenShift cluster configuration for vDU application workloads
Validating cluster tuning for vDU application workloads
Advanced managed cluster configuration with SiteConfig resources
Managing cluster polices with PolicyGenerator resources
Configuring managed cluster policies by using PolicyGenerator resources
Advanced managed cluster configuration with PolicyGenerator resources
Updating managed clusters in a disconnected environment with PolicyGenerator resources and TALM
Managing cluster polices with PolicyGenTemplate resources
Configuring managed cluster policies by using PolicyGenTemplate resources
Advanced managed cluster configuration with PolicyGenTemplate resources
Updating managed clusters in a disconnected environment with PolicyGenTemplate resources and TALM
Using hub templates in PolicyGenerator or PolicyGenTemplate CRs
Updating managed clusters with the Topology Aware Lifecycle Manager
Expanding single-node OpenShift clusters with GitOps ZTP
Pre-caching images for single-node OpenShift deployments
Image-based upgrade for single-node OpenShift clusters
Understanding the image-based upgrade for single-node OpenShift clusters
Preparing for an image-based upgrade for single-node OpenShift clusters
Configuring a shared container partition for the image-based upgrade
Installing Operators for the image-based upgrade
Generating a seed image for the image-based upgrade with the Lifecycle Agent
Creating ConfigMap objects for the image-based upgrade with the Lifecycle Agent
Creating ConfigMap objects for the image-based upgrade with Lifecycle Agent using GitOps ZTP
Configuring the automatic image cleanup of the container storage disk
Performing an image-based upgrade for single-node OpenShift clusters with the Lifecycle Agent
Performing an image-based upgrade for single-node OpenShift clusters using GitOps ZTP
Specialized hardware and driver enablement
About specialized hardware and driver enablement
Driver Toolkit
Node Feature Discovery Operator
Kernel Module Management Operator
Backup and restore
Overview of backup and restore operations
Shutting down a cluster gracefully
Restarting a cluster gracefully
OADP Application backup and restore
Introduction to OpenShift API for Data Protection
OADP release notes
OADP 1.4 release notes
OADP features and plugins
Installing and configuring OADP
About installing OADP
Installing the OADP Operator
Configuring OADP with AWS S3 compatible storage
Configuring OADP with Azure
Configuring OADP with GCP
Configuring OADP with MCG
Configuring OADP with ODF
Configuring OADP with OpenShift Virtualization
Configuring OADP with multiple backup storage locations
Configuring OADP with multiple Volume Snapshot Locations
Uninstalling OADP
Uninstalling OADP
OADP backing up
Backing up applications
Creating a Backup CR
Backing up persistent volumes with CSI snapshots
Backing up applications with File System Backup
Creating backup hooks
Scheduling backups using Schedule CR
Deleting backups
About Kopia
OADP restoring
Restoring applications
OADP and ROSA
Backing up applications on ROSA STS using OADP
OADP and AWS STS
Backing up applications on AWS STS using OADP
OADP 1.2 Data Mover
Introduction to OADP Data Mover
Using Data Mover for CSI snapshots
Using OADP 1.2 Data Mover with Ceph storage
OADP 1.3 Data Mover and later
About the OADP 1.3 Data Mover
Backing up and restoring volumes by using CSI snapshots data movement
Overriding Kopia algorithms
Troubleshooting
OADP API
Advanced OADP features and functionalities
Control plane backup and restore
Backing up etcd data
Replacing an unhealthy etcd member
Disaster recovery
About disaster recovery
Restoring to a previous cluster state
Recovering from expired control plane certificates
Migrating from version 3 to 4
Migrating from version 3 to 4 overview
About migrating from OKD 3 to 4
Differences between OKD 3 and 4
Network considerations
About MTC
Installing MTC
Installing MTC in a restricted network environment
Upgrading MTC
Premigration checklists
Migrating your applications
Advanced migration options
Troubleshooting
Migration Toolkit for Containers
About MTC
MTC release notes
MTC release notes 1.8
MTC release notes 1.7
MTC release notes 1.6
MTC release notes 1.5
Installing MTC
Installing MTC in a restricted network environment
Upgrading MTC
Premigration checklists
Network considerations
Direct Migration Requirements
Migrating your applications
Advanced migration options
Troubleshooting
API reference
API overview
Understanding API tiers
API compatibility guidelines
Editing kubelet log level verbosity and gathering logs
API list
Authorization APIs
About Authorization APIs
LocalResourceAccessReview [authorization.openshift.io/v1]
LocalSubjectAccessReview [authorization.openshift.io/v1]
ResourceAccessReview [authorization.openshift.io/v1]
SelfSubjectRulesReview [authorization.openshift.io/v1]
SubjectAccessReview [authorization.openshift.io/v1]
SubjectRulesReview [authorization.openshift.io/v1]
SelfSubjectReview [authentication.k8s.io/v1]
TokenRequest [authentication.k8s.io/v1]
TokenReview [authentication.k8s.io/v1]
LocalSubjectAccessReview [authorization.k8s.io/v1]
SelfSubjectAccessReview [authorization.k8s.io/v1]
SelfSubjectRulesReview [authorization.k8s.io/v1]
SubjectAccessReview [authorization.k8s.io/v1]
Autoscale APIs
About Autoscale APIs
ClusterAutoscaler [autoscaling.openshift.io/v1]
MachineAutoscaler [autoscaling.openshift.io/v1beta1]
HorizontalPodAutoscaler [autoscaling/v2]
Scale [autoscaling/v1]
Config APIs
About Config APIs
APIServer [config.openshift.io/v1]
Authentication [config.openshift.io/v1]
Build [config.openshift.io/v1]
ClusterOperator [config.openshift.io/v1]
ClusterVersion [config.openshift.io/v1]
Console [config.openshift.io/v1]
DNS [config.openshift.io/v1]
FeatureGate [config.openshift.io/v1]
HelmChartRepository [helm.openshift.io/v1beta1]
Image [config.openshift.io/v1]
ImageDigestMirrorSet [config.openshift.io/v1]
ImageContentPolicy [config.openshift.io/v1]
ImageTagMirrorSet [config.openshift.io/v1]
Infrastructure [config.openshift.io/v1]
Ingress [config.openshift.io/v1]
Network [config.openshift.io/v1]
Node [config.openshift.io/v1]
OAuth [config.openshift.io/v1]
OperatorHub [config.openshift.io/v1]
Project [config.openshift.io/v1]
ProjectHelmChartRepository [helm.openshift.io/v1beta1]
Proxy [config.openshift.io/v1]
Scheduler [config.openshift.io/v1]
Console APIs
About Console APIs
ConsoleCLIDownload [console.openshift.io/v1]
ConsoleExternalLogLink [console.openshift.io/v1]
ConsoleLink [console.openshift.io/v1]
ConsoleNotification [console.openshift.io/v1]
ConsolePlugin [console.openshift.io/v1]
ConsoleQuickStart [console.openshift.io/v1]
ConsoleSample [console.openshift.io/v1]
ConsoleYAMLSample [console.openshift.io/v1]
Extension APIs
About Extension APIs
APIService [apiregistration.k8s.io/v1]
CustomResourceDefinition [apiextensions.k8s.io/v1]
MutatingWebhookConfiguration [admissionregistration.k8s.io/v1]
ValidatingWebhookConfiguration [admissionregistration.k8s.io/v1]
Image APIs
About Image APIs
Image [image.openshift.io/v1]
ImageSignature [image.openshift.io/v1]
ImageStreamImage [image.openshift.io/v1]
ImageStreamImport [image.openshift.io/v1]
ImageStreamLayers [image.openshift.io/v1]
ImageStreamMapping [image.openshift.io/v1]
ImageStream [image.openshift.io/v1]
ImageStreamTag [image.openshift.io/v1]
ImageTag [image.openshift.io/v1]
SecretList [image.openshift.io/v1]
Machine APIs
About Machine APIs
ContainerRuntimeConfig [machineconfiguration.openshift.io/v1]
ControllerConfig [machineconfiguration.openshift.io/v1]
ControlPlaneMachineSet [machine.openshift.io/v1]
KubeletConfig [machineconfiguration.openshift.io/v1]
MachineConfig [machineconfiguration.openshift.io/v1]
MachineConfigPool [machineconfiguration.openshift.io/v1]
MachineHealthCheck [machine.openshift.io/v1beta1]
Machine [machine.openshift.io/v1beta1]
MachineSet [machine.openshift.io/v1beta1]
Metadata APIs
About Metadata APIs
APIRequestCount [apiserver.openshift.io/v1]
Binding [undefined/v1]
ComponentStatus [undefined/v1]
ConfigMap [undefined/v1]
ControllerRevision [apps/v1]
Event [events.k8s.io/v1]
Event [undefined/v1]
Lease [coordination.k8s.io/v1]
Namespace [undefined/v1]
Monitoring APIs
About Monitoring APIs
Alertmanager [monitoring.coreos.com/v1]
AlertmanagerConfig [monitoring.coreos.com/v1beta1]
AlertRelabelConfig [monitoring.openshift.io/v1]
AlertingRule [monitoring.openshift.io/v1]
PodMonitor [monitoring.coreos.com/v1]
Probe [monitoring.coreos.com/v1]
Prometheus [monitoring.coreos.com/v1]
PrometheusRule [monitoring.coreos.com/v1]
ServiceMonitor [monitoring.coreos.com/v1]
ThanosRuler [monitoring.coreos.com/v1]
Network APIs
About Network APIs
AdminNetworkPolicy [policy.networking.k8s.io/v1alpha1]
AdminPolicyBasedExternalRoute [k8s.ovn.org/v1]
BaselineAdminNetworkPolicy [policy.networking.k8s.io/v1alpha1]
CloudPrivateIPConfig [cloud.network.openshift.io/v1]
EgressFirewall [k8s.ovn.org/v1]
EgressIP [k8s.ovn.org/v1]
EgressQoS [k8s.ovn.org/v1]
EgressService [k8s.ovn.org/v1]
Endpoints [undefined/v1]
EndpointSlice [discovery.k8s.io/v1]
EgressRouter [network.operator.openshift.io/v1]
Ingress [networking.k8s.io/v1]
IngressClass [networking.k8s.io/v1]
IPAddress [ipam.cluster.x-k8s.io/v1beta1]
IPAddressClaim [ipam.cluster.x-k8s.io/v1beta1]
IPPool [whereabouts.cni.cncf.io/v1alpha1]
NetworkAttachmentDefinition [k8s.cni.cncf.io/v1]
NetworkPolicy [networking.k8s.io/v1]
OverlappingRangeIPReservation [whereabouts.cni.cncf.io/v1alpha1]
PodNetworkConnectivityCheck [controlplane.operator.openshift.io/v1alpha1]
Route [route.openshift.io/v1]
Service [undefined/v1]
Node APIs
About Node APIs
Node [undefined/v1]
PerformanceProfile [performance.openshift.io/v2]
Profile [tuned.openshift.io/v1]
RuntimeClass [node.k8s.io/v1]
Tuned [tuned.openshift.io/v1]
OAuth APIs
About OAuth APIs
OAuthAccessToken [oauth.openshift.io/v1]
OAuthAuthorizeToken [oauth.openshift.io/v1]
OAuthClientAuthorization [oauth.openshift.io/v1]
OAuthClient [oauth.openshift.io/v1]
UserOAuthAccessToken [oauth.openshift.io/v1]
Operator APIs
About Operator APIs
Authentication [operator.openshift.io/v1]
CloudCredential [operator.openshift.io/v1]
ClusterCSIDriver [operator.openshift.io/v1]
Console [operator.openshift.io/v1]
Config [operator.openshift.io/v1]
Config [imageregistry.operator.openshift.io/v1]
Config [samples.operator.openshift.io/v1]
CSISnapshotController [operator.openshift.io/v1]
DNS [operator.openshift.io/v1]
DNSRecord [ingress.operator.openshift.io/v1]
Etcd [operator.openshift.io/v1]
ImageContentSourcePolicy [operator.openshift.io/v1alpha1]
ImagePruner [imageregistry.operator.openshift.io/v1]
IngressController [operator.openshift.io/v1]
InsightsOperator [operator.openshift.io/v1]
KubeAPIServer [operator.openshift.io/v1]
KubeControllerManager [operator.openshift.io/v1]
KubeScheduler [operator.openshift.io/v1]
KubeStorageVersionMigrator [operator.openshift.io/v1]
MachineConfiguration [operator.openshift.io/v1]
Network [operator.openshift.io/v1]
OpenShiftAPIServer [operator.openshift.io/v1]
OpenShiftControllerManager [operator.openshift.io/v1]
OperatorPKI [network.operator.openshift.io/v1]
ServiceCA [operator.openshift.io/v1]
Storage [operator.openshift.io/v1]
OperatorHub APIs
About OperatorHub APIs
CatalogSource [operators.coreos.com/v1alpha1]
ClusterServiceVersion [operators.coreos.com/v1alpha1]
InstallPlan [operators.coreos.com/v1alpha1]
OLMConfig [operators.coreos.com/v1]
Operator [operators.coreos.com/v1]
OperatorCondition [operators.coreos.com/v2]
OperatorGroup [operators.coreos.com/v1]
PackageManifest [packages.operators.coreos.com/v1]
Subscription [operators.coreos.com/v1alpha1]
Policy APIs
About Policy APIs
Eviction [policy/v1]
PodDisruptionBudget [policy/v1]
Project APIs
About Project APIs
Project [project.openshift.io/v1]
ProjectRequest [project.openshift.io/v1]
Provisioning APIs
About Provisioning APIs
BMCEventSubscription [metal3.io/v1alpha1]
BareMetalHost [metal3.io/v1alpha1]
DataImage [metal3.io/v1alpha1]
FirmwareSchema [metal3.io/v1alpha1]
HardwareData [metal3.io/v1alpha1]
HostFirmwareComponents [metal3.io/v1alpha1]
HostFirmwareSettings [metal3.io/v1alpha1]
Metal3Remediation [infrastructure.cluster.x-k8s.io/v1beta1]
Metal3RemediationTemplate [infrastructure.cluster.x-k8s.io/v1beta1]
PreprovisioningImage [metal3.io/v1alpha1]
Provisioning [metal3.io/v1alpha1]
RBAC APIs
About RBAC APIs
ClusterRoleBinding [rbac.authorization.k8s.io/v1]
ClusterRole [rbac.authorization.k8s.io/v1]
RoleBinding [rbac.authorization.k8s.io/v1]
Role [rbac.authorization.k8s.io/v1]
Role APIs
About Role APIs
ClusterRoleBinding [authorization.openshift.io/v1]
ClusterRole [authorization.openshift.io/v1]
RoleBindingRestriction [authorization.openshift.io/v1]
RoleBinding [authorization.openshift.io/v1]
Role [authorization.openshift.io/v1]
Schedule and quota APIs
About Schedule and quota APIs
AppliedClusterResourceQuota [quota.openshift.io/v1]
ClusterResourceQuota [quota.openshift.io/v1]
FlowSchema [flowcontrol.apiserver.k8s.io/v1]
LimitRange [undefined/v1]
PriorityClass [scheduling.k8s.io/v1]
PriorityLevelConfiguration [flowcontrol.apiserver.k8s.io/v1]
ResourceQuota [undefined/v1]
Security APIs
About Security APIs
CertificateSigningRequest [certificates.k8s.io/v1]
CredentialsRequest [cloudcredential.openshift.io/v1]
PodSecurityPolicyReview [security.openshift.io/v1]
PodSecurityPolicySelfSubjectReview [security.openshift.io/v1]
PodSecurityPolicySubjectReview [security.openshift.io/v1]
RangeAllocation [security.openshift.io/v1]
Secret [undefined/v1]
SecurityContextConstraints [security.openshift.io/v1]
ServiceAccount [undefined/v1]
Storage APIs
About Storage APIs
CSIDriver [storage.k8s.io/v1]
CSINode [storage.k8s.io/v1]
CSIStorageCapacity [storage.k8s.io/v1]
PersistentVolume [undefined/v1]
PersistentVolumeClaim [undefined/v1]
StorageClass [storage.k8s.io/v1]
StorageState [migration.k8s.io/v1alpha1]
StorageVersionMigration [migration.k8s.io/v1alpha1]
VolumeAttachment [storage.k8s.io/v1]
VolumeSnapshot [snapshot.storage.k8s.io/v1]
VolumeSnapshotClass [snapshot.storage.k8s.io/v1]
VolumeSnapshotContent [snapshot.storage.k8s.io/v1]
Template APIs
About Template APIs
BrokerTemplateInstance [template.openshift.io/v1]
PodTemplate [undefined/v1]
Template [template.openshift.io/v1]
TemplateInstance [template.openshift.io/v1]
User and group APIs
About User and group APIs
Group [user.openshift.io/v1]
Identity [user.openshift.io/v1]
UserIdentityMapping [user.openshift.io/v1]
User [user.openshift.io/v1]
Workloads APIs
About Workloads APIs
BuildConfig [build.openshift.io/v1]
Build [build.openshift.io/v1]
BuildLog [build.openshift.io/v1]
BuildRequest [build.openshift.io/v1]
CronJob [batch/v1]
DaemonSet [apps/v1]
Deployment [apps/v1]
DeploymentConfig [apps.openshift.io/v1]
DeploymentConfigRollback [apps.openshift.io/v1]
DeploymentLog [apps.openshift.io/v1]
DeploymentRequest [apps.openshift.io/v1]
Job [batch/v1]
Pod [undefined/v1]
ReplicationController [undefined/v1]
ReplicaSet [apps/v1]
StatefulSet [apps/v1]
Virtualization
About
About OKD Virtualization
Security policies
Getting started
Getting started with OKD Virtualization
Installing
Preparing your cluster
Installing OKD Virtualization
Uninstalling OKD Virtualization
Postinstallation configuration
Postinstallation configuration
Node placement rules
Network configuration
Storage configuration
Configuring higher VM workload density
Updating
Updating OKD Virtualization
Virtual machines
Creating VMs from Red Hat images
Creating VMs from Red Hat images overview
Creating VMs from instance types
Creating VMs from templates
Creating VMs from the CLI
Creating VMs from custom images
Creating VMs from custom images overview
Creating VMs by using container disks
Creating VMs by importing images from web pages
Creating VMs by uploading images
Installing the QEMU guest agent and VirtIO drivers
Cloning VMs
Creating VMs by cloning PVCs
Connecting to VM consoles
Specifying an instance type or preference
Configuring SSH access to VMs
Editing virtual machines
Editing boot order
Deleting virtual machines
Exporting virtual machines
Managing virtual machine instances
Controlling virtual machine states
Using virtual Trusted Platform Module devices
Managing virtual machines with OpenShift Pipelines
Advanced virtual machine management
Working with resource quotas for virtual machines
Specifying nodes for virtual machines
Activating kernel samepage merging (KSM)
Configuring certificate rotation
Configuring the default CPU model
UEFI mode for virtual machines
Configuring PXE booting for virtual machines
Using huge pages with virtual machines
Enabling dedicated resources for a virtual machine
Scheduling virtual machines
Configuring PCI passthrough
Configuring virtual GPUs
Enabling descheduler evictions on virtual machines
About high availability for virtual machines
Control plane tuning
Assigning compute resources
About multi-queue functionality
VM disks
Hot-plugging VM disks
Expanding VM disks
Configuring shared volumes
Networking
Networking configuration overview
Connecting a VM to the default pod network
Exposing a VM by using a service
Accessing a VM by using its internal FQDN
Connecting a VM to a Linux bridge network
Connecting a VM to an SR-IOV network
Using DPDK with SR-IOV
Connecting a VM to an OVN-Kubernetes secondary network
Hot plugging secondary network interfaces
Connecting a VM to a service mesh
Configuring a dedicated network for live migration
Configuring and viewing IP addresses
Accessing a VM by using its external FQDN
Managing MAC address pools for network interfaces
Storage
Storage configuration overview
Configuring storage profiles
Managing automatic boot source updates
Reserving PVC space for file system overhead
Configuring local storage by using HPP
Enabling user permissions to clone data volumes across namespaces
Configuring CDI to override CPU and memory quotas
Preparing CDI scratch space
Using preallocation for data volumes
Managing data volume annotations
Live migration
About live migration
Configuring live migration
Initiating and canceling live migration
Nodes
Node maintenance
Managing node labeling for obsolete CPU models
Preventing node reconciliation
Deleting a failed node to trigger VM failover
Monitoring
Monitoring overview
Cluster checkup framework
Prometheus queries for virtual resources
Virtual machine custom metrics
Virtual machine downward metrics
Virtual machine health checks
Runbooks
Support
Support overview
Troubleshooting
Backup and restore
Backup and restore by using VM snapshots
Backing up and restoring virtual machines
Disaster recovery
×
Show more results
Visualization for logging
Visualization for logging is provided by installing the
Cluster Observability Operator
.