docs.openshift.com
Open in
urlscan Pro
52.7.174.209
Public Scan
Submitted URL: http://docs.openshift.com/container-platform/4.14/updating/updating_a_cluster/updating-cluster-cli.html
Effective URL: https://docs.openshift.com/container-platform/4.14/updating/updating_a_cluster/updating-cluster-cli.html
Submission: On February 12 via api from LU — Scanned from DE
Effective URL: https://docs.openshift.com/container-platform/4.14/updating/updating_a_cluster/updating-cluster-cli.html
Submission: On February 12 via api from LU — Scanned from DE
Form analysis
0 forms found in the DOMText Content
* Products OVERVIEW * Features * Pricing FEATURED PRODUCTS * Red Hat OpenShift Container Platform Build, deploy and manage your applications across cloud- and on-premise infrastructure * Red Hat OpenShift Dedicated Single-tenant, high-availability Kubernetes clusters in the public cloud * Red Hat OpenShift Online The fastest way for developers to build, host and scale applications in the public cloud * All products * Learn LEARN * What is OpenShift * Get started * Partners * Customer success stories * Blog * Resources TECHNOLOGY TOPICS * Knative * Security * Kubernetes * Service Brokers * Community * OpenShift Commons * Open Source (OKD) * Startups * Grants * Support * Help Center * OpenShift Docs * Free Trial * Log In 1. Documentation 2. OpenShift Container Platform 4.14 4.13 4.12 4.11 4.10 4.9 4.8 4.7 4.6 4.5 4.4 4.3 4.2 4.1 3.11 3.10 3.9 3.7 3.6 3.5 3.4 3.3 3.2 3.1 3.0 3. Updating clusters 4. Performing a cluster update 5. Updating a cluster using the CLI history bug_report picture_as_pdf * About * Welcome * Learn more about OpenShift Container Platform * About OpenShift Kubernetes Engine * Legal notice * Release notes * OpenShift Container Platform 4.14 release notes * Getting started * Kubernetes overview * OpenShift Container Platform overview * Web console walkthrough * Command-line walkthrough * Architecture * Architecture overview * Product architecture * Installation and update * Red Hat OpenShift Cluster Manager * About multicluster engine for Kubernetes operator * Control plane architecture * NVIDIA GPU architecture overview * Understanding OpenShift development * Red Hat Enterprise Linux CoreOS * Admission plugins * Installing * 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 * Installing on Alibaba * Preparing to install on Alibaba Cloud * Creating the required Alibaba Cloud resources * Installing a cluster quickly on Alibaba Cloud * Installing a cluster on Alibaba Cloud with customizations * Installing a cluster on Alibaba Cloud with network customizations * Installing a cluster on Alibaba Cloud into an existing VPC * Installation configuration parameters for Alibaba Cloud * Uninstalling a cluster on Alibaba Cloud * Installing on AWS * Preparing to install on AWS * Configuring an AWS account * Installing a cluster quickly on AWS * Installing a cluster on AWS with customizations * Installing a cluster on AWS with network customizations * Installing a cluster on AWS in a restricted network * Installing a cluster on AWS into an existing VPC * Installing a private cluster on AWS * Installing a cluster on AWS into a government region * Installing a cluster on AWS into a Secret or Top Secret Region * Installing a cluster on AWS into a China region * Installing a cluster on AWS using CloudFormation templates * Installing a cluster on AWS with worker nodes on AWS Local Zones * Installing a cluster on AWS in a restricted network with user-provisioned infrastructure * Installing a cluster on AWS with remote workers on AWS Outposts * Installing a three-node cluster on AWS * Uninstalling a cluster on AWS * Installation configuration parameters for AWS * 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 * 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 * Installation configuration parameters for IBM Cloud * Uninstalling a cluster on IBM Cloud * Installing on Nutanix * Preparing to install on Nutanix * 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 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 * Installing on-premise with Assisted Installer * Installing an on-premise cluster using the Assisted Installer * Installing an on-premise cluster with the Agent-based Installer * Preparing to install with Agent-based Installer * Understanding disconnected installation mirroring * Installing a cluster with Agent-based Installer * Preparing PXE assets for OCP * Preparing an Agent-based installed cluster for the multicluster engine for Kubernetes * Installation configuration parameters for the Agent-based Installer * Installing on a single node * Preparing to install OpenShift on a single node * Installing OpenShift on a single node * Deploying installer-provisioned clusters on bare metal * Overview * Prerequisites * Setting up the environment for an OpenShift installation * Postinstallation configuration * Expanding the cluster * Troubleshooting * Installing IBM Cloud Bare Metal (Classic) * Prerequisites * Installation workflow * Installing on IBM Z and IBM LinuxONE * Preparing to install on IBM Z and IBM LinuxONE * Installing a cluster with z/VM on IBM Z and IBM LinuxONE * Restricted network IBM Z installation with z/VM * Installing a cluster with RHEL KVM on IBM Z and IBM LinuxONE * Restricted network IBM Z installation with RHEL KVM * Installation configuration parameters for IBM Z and IBM LinuxONE * Installing on IBM Power * Preparing to install on IBM Power * Installing a cluster on IBM Power * Restricted network IBM Power installation * Installation configuration parameters for IBM Power * Installing on IBM Power Virtual Server * Preparing to install on IBM Power Virtual Server * Configuring an IBM Cloud account * Creating an IBM Power Virtual Server workspace * Installing a cluster on IBM Power Virtual Server with customizations * Installing a cluster on IBM Power Virtual Server into an existing VPC * Installing a private cluster on IBM Power Virtual Server * Installing a cluster on IBM Power Virtual Server in a restricted network * Uninstalling a cluster on IBM Power Virtual Server * Installation configuration parameters for IBM Power Virtual Server * 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 with Kuryr * Installing a cluster on OpenStack on your own infrastructure * Installing a cluster on OpenStack with Kuryr on your own infrastructure * Installing a cluster on OpenStack in a restricted network * OpenStack Cloud Controller Manager reference guide * Uninstalling a cluster on OpenStack * Uninstalling a cluster on OpenStack from your own infrastructure * Installation configuration parameters for OpenStack * Installing on vSphere * Preparing to install on vSphere * Installing a cluster on vSphere * Installing a cluster on vSphere with customizations * Installing a cluster on vSphere with network customizations * Installing a cluster on vSphere with user-provisioned infrastructure * Installing a cluster on vSphere with user-provisioned infrastructure and network customizations * Installing a cluster on vSphere in a restricted network * Installing a cluster on vSphere in a restricted network with user-provisioned infrastructure * Installing a three-node cluster on vSphere * Configuring the vSphere connection settings after an installation * Uninstalling a cluster on vSphere that uses installer-provisioned infrastructure * Using the vSphere Problem Detector Operator * Installation configuration parameters for vSphere * Installing on any platform * Installing a cluster on any platform * Installation configuration * Customizing nodes * Configuring your firewall * Enabling Linux control group version 1 (cgroup v1) * Validating an installation * Troubleshooting installation issues * Support for FIPS cryptography * Postinstallation configuration * Postinstallation configuration overview * Configuring a private cluster * Bare metal configuration * Configuring multi-architecture compute machines on an OpenShift cluster * About clusters with multi-architecture compute machines * Creating a cluster with multi-architecture compute machines on Azure * Creating a cluster with multi-architecture compute machines on AWS * Creating a cluster with multi-architecture compute machines on GCP * Creating a cluster with multi-architecture compute machines on bare metal * Creating a cluster with multi-architecture compute machines on IBM Z and IBM LinuxONE with z/VM * Creating a cluster with multi-architecture compute machines on IBM Z and IBM LinuxONE with RHEL KVM * Creating a cluster with multi-architecture compute machines on IBM Power * Managing your cluster with multi-architecture compute machines * Enabling encryption on a vSphere cluster * Machine configuration tasks * Cluster tasks * Node tasks * Network configuration * Storage configuration * Preparing for users * Configuring alert notifications * Converting a connected cluster to a disconnected cluster * Enabling cluster capabilities * Configuring additional devices in an IBM Z or IBM LinuxONE environment * Regions and zones for a VMware vCenter * Red Hat Enterprise Linux CoreOS image layering * AWS Local Zone tasks * Updating clusters * Understanding OpenShift updates * Introduction to OpenShift updates * How cluster updates work * Understanding update channels and releases * Understanding OpenShift update duration * Preparing to update a cluster * Preparing to update to OpenShift Container Platform 4.14 * 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 an EUS-to-EUS update * Performing a canary rollout update * Updating a cluster that includes RHEL compute machines * 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 using OSUS * Updating a cluster in a disconnected environment without OSUS * Uninstalling OSUS from a cluster * Updating hardware on nodes running on vSphere * Migrating to a cluster with multi-architecture compute machines * Updating hosted control planes * 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 * Web terminal * Installing the web terminal * Configuring the web terminal * Using the web terminal * Troubleshooting the web terminal * Uninstalling the web terminal * Disabling the web console * Creating quick start tutorials * 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 * Pipelines CLI (tkn) * Installing tkn * Configuring tkn * Basic tkn commands * 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 * Hardening Red Hat Enterprise Linux CoreOS * Container image signatures * 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 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 the Compliance Operator * Using the oc-compliance plugin * File Integrity Operator * File Integrity Operator release notes * 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 * 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 * NBDE Tang Server Operator * NBDE Tang Server Operator overview * NBDE Tang Server Operator release notes * Understanding the NBDE Tang Server Operator * Installing the NBDE Tang Server Operator * Configuring and managing Tang servers using the NBDE Tang Server Operator * Identifying URL of a Tang server deployed with the NBDE Tang Server Operator * cert-manager Operator for Red Hat OpenShift * cert-manager Operator for Red Hat OpenShift overview * cert-manager Operator for Red Hat OpenShift release notes * Installing the cert-manager Operator for Red Hat OpenShift * Configuring an ACME issuer * Configuring certificates with an issuer * Enabling monitoring for the cert-manager Operator for Red Hat OpenShift * Configuring the egress proxy for the cert-manager Operator for Red Hat OpenShift * Customizing cert-manager by using the cert-manager Operator API fields * Authenticating the cert-manager Operator with AWS Security Token Service * Configuring log levels for cert-manager and the cert-manager Operator for Red Hat OpenShift * Authenticating the cert-manager Operator for Red Hat OpenShift with GCP Workload Identity * Authenticating the cert-manager Operator for Red Hat OpenShift on AWS * Authenticating the cert-manager Operator for Red Hat OpenShift on GCP * Uninstalling the cert-manager Operator for Red Hat OpenShift * 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 * Accessing hosts * Networking Operators overview * Understanding the Cluster Network Operator * Understanding the DNS Operator * Understanding the Ingress Operator * Ingress sharding * Understanding the Ingress Node Firewall Operator * Configuring the Ingress Controller for manual DNS management * Configuring the Ingress Controller endpoint publishing strategy * 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 interface-level network sysctls * 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 an public hosted zone for AWS * Creating DNS records on an public zone for Azure * Creating DNS records on an 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 * 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 * 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 Security Token Service cluster * Creating an instance of the AWS Load Balancer Controller * Serving Multiple Ingresses 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 * Tuning sysctl settings on an SR-IOV network * 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 * Migrating from Kuryr * Converting to IPv4/IPv6 dual stack networking * Logging for egress firewall and network policy rules * Configuring IPsec encryption * Configure an external gateway through a secondary network interface * 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 * 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 * Migrating to the OpenShift SDN network plugin * Rolling back to the OVN-Kubernetes 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 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 * 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 * Persistent storage using local volumes * Persistent storage using hostPath * Persistent storage using LVM Storage * Troubleshooting local persistent storage using LVMS * 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 * AliCloud Disk CSI Driver Operator * 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 * VMware vSphere CSI Driver Operator * Generic ephemeral volumes * Expanding persistent volumes * Dynamic provisioning * Registry * Registry overview * Image Registry Operator in OpenShift Container Platform * 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 * Red Hat-provided Operator catalogs * 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 * Managing platform Operators * 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 for Operators on cloud providers * 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 * Cluster Operators reference * OLM 1.0 (Technology Preview) * About OLM 1.0 * Components and architecture * Components overview * Operator Controller * RukPak * Dependency resolution * Catalogd * Installing an Operator from a catalog * Managing plain bundles * CI/CD * CI/CD overview * Builds using Shipwright * Overview of Builds * 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 * Pipelines * About OpenShift Pipelines * GitOps * About OpenShift GitOps * Jenkins * Configuring Jenkins images * Jenkins agent * Migrating from Jenkins to OpenShift Pipelines * Important changes to OpenShift Jenkins images * 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 using the CLI * Viewing application composition using the Topology view * Exporting applications * Connecting applications to services * Service Binding Operator release notes * Understanding Service Binding Operator * Installing Service Binding Operator * Getting started with service binding * Getting started with service binding on IBM Power, IBM Z, and IBM LinuxONE * Exposing binding data from a service * Projecting binding data * Binding workloads using Service Binding Operator * Connecting an application to a service using the Developer perspective * 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 * Serverless * About Serverless * Serverless overview * Machine management * Overview of machine management * Managing compute machines with the Machine API * Creating a compute machine set on Alibaba Cloud * 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 * Adding a RHEL compute machine * Adding more RHEL compute machines * 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 machines with the Cluster API * Managing control plane machines * About control plane machine sets * Getting started with control plane machine sets * Control plane machine set configuration * Using control plane machine sets * Control plane resiliency and recovery * Troubleshooting the control plane machine set * Disabling the control plane machine set * Deploying machine health checks * Hosted control planes * Hosted control planes overview * Configuring hosted control planes * Managing hosted control planes * Backup, restore, and disaster recovery for hosted control planes * 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 * Run Once Duration Override Operator * Run Once Duration Override Operator overview * Run Once Duration Override Operator release notes * Overriding the active deadline for run-once pods * Uninstalling the Run Once Duration Override Operator * Automatically scaling pods with the Custom Metrics Autoscaler Operator * Custom Metrics Autoscaler Operator overview * Custom Metrics Autoscaler Operator release notes * 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 * Evicting pods using the descheduler * Secondary scheduler * Secondary scheduler overview * Secondary Scheduler Operator release notes * Scheduling pods using a secondary scheduler * Uninstalling the Secondary Scheduler Operator * 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 * Machine Config Daemon metrics * 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 * 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 your cluster to place pods on overcommited nodes * Configuring the Linux cgroup version on your nodes * Enabling features using FeatureGates * Improving cluster stability in high latency environments using worker latency profiles * Remote worker nodes on the network edge * Using remote worker node at the network edge * Worker nodes for single-node OpenShift clusters * Adding worker nodes to single-node OpenShift clusters * Node metrics dashboard * Windows Container Support for OpenShift * Red Hat OpenShift support for Windows Containers overview * Red Hat OpenShift support for Windows Containers release notes * 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 * Sandboxed Containers Support for OpenShift * OpenShift sandboxed containers documentation has been moved * Logging * Release notes * Logging 5.8 * Logging 5.7 * 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 * 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 * Monitoring * Monitoring overview * 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 third-party monitoring APIs * Troubleshooting monitoring issues * Config map reference for the Cluster Monitoring Operator * 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 * Power monitoring * Power monitoring release notes * Power monitoring overview * Installing power monitoring * Configuring power monitoring * Visualizing power monitoring metrics * Uninstalling power monitoring * Distributed tracing * Distributed tracing release notes * Distributed tracing 3.0 * Distributed tracing 2.9.2 * Distributed tracing 2.9.1 * Distributed tracing 2.9 * Distributed tracing 2.8 * Distributed tracing 2.7 * Distributed tracing 2.6 * Distributed tracing 2.5 * Distributed tracing 2.4 * Distributed tracing 2.3 * Distributed tracing 2.2 * Distributed tracing 2.1 * Distributed tracing 2.0 * Distributed tracing architecture * Distributed tracing architecture * Distributed tracing platform (Jaeger) * Installation * Configuration * Updating * Removal * Distributed tracing platform (Tempo) * Installation * Configuration * Updating * Removal * Red Hat build of OpenTelemetry * Release notes * Installation * Collector configuration * Instrumentation * Use * Troubleshooting * Migration * Updating * Removal * 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 * Monitoring the Network Observability Operator * API reference * JSON flows format reference * Troubleshooting Network Observability * Scalability and performance * Recommended performance and scalability practices * Recommended control plane practices * Recommended infrastructure practices * Recommended etcd practices * Planning your environment according to object maximums * Recommended host practices for IBM Z & IBM LinuxONE environments * 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 * Performing latency tests for platform verification * Improving cluster stability in high latency environments using worker latency profiles * Creating a performance profile * Workload partitioning * Requesting CRI-O and Kubelet profiling data by using the Node Observability Operator * Clusters at the network far edge * Challenges of the network far edge * Preparing the hub cluster for ZTP * Installing managed clusters with RHACM and SiteConfig resources * Configuring managed clusters with policies and PolicyGenTemplate resources * Manually installing a single-node OpenShift cluster with 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 * Advanced managed cluster configuration with PolicyGenTemplate resources * Updating managed clusters with the Topology Aware Lifecycle Manager * Updating managed clusters in a disconnected environment with the Topology Aware Lifecycle Manager * Updating GitOps ZTP * Expanding single-node OpenShift clusters with GitOps ZTP * Pre-caching images for single-node OpenShift deployments * 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.3 release notes * OADP 1.2 release notes * OADP 1.1 release notes * OADP features and plugins * Installing and configuring OADP * About installing OADP * Installing the OADP Operator * Configuring OADP with AWS * Configuring OADP with Azure * Configuring OADP with GCP * Configuring OADP with MCG * Configuring OADP with ODF * 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 Data Mover * Introduction to OADP Data Mover * Using Data Mover for CSI snapshots * Using OADP 1.2 Data Mover with Ceph storage * Cleaning up after a backup using OADP 1.1 Data Mover * OADP 1.3 Data Mover * About the OADP 1.3 Data Mover * Backing up and restoring volumes by using CSI snapshots * 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 OpenShift Container Platform 3 to 4 * Differences between OpenShift Container Platform 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 * Installing MTC * Installing MTC in a restricted network environment * Upgrading MTC * Premigration checklists * Network considerations * Migrating your applications * Advanced migration options * Troubleshooting * API reference * Understanding API tiers * API compatibility guidelines * Editing kubelet log level verbosity and gathering logs * API list * Common object reference * Index * 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] * 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] * 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] * MachineConfigPool [machineconfiguration.openshift.io/v1] * MachineConfig [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] * 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 * AdminPolicyBasedExternalRoute [k8s.ovn.org/v1] * CloudPrivateIPConfig [cloud.network.openshift.io/v1] * EgressFirewall [k8s.ovn.org/v1] * EgressIP [k8s.ovn.org/v1] * EgressQoS [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] * 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] * 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] * FirmwareSchema [metal3.io/v1alpha1] * HardwareData [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/v1beta3] * LimitRange [undefined/v1] * PriorityClass [scheduling.k8s.io/v1] * PriorityLevelConfiguration [flowcontrol.apiserver.k8s.io/v1beta3] * 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] * Service Mesh * Service Mesh 2.x * About OpenShift Service Mesh * Service Mesh 2.x release notes * Service Mesh architecture * Service Mesh deployment models * Service Mesh and Istio differences * Preparing to install Service Mesh * Installing the Operators * Creating the ServiceMeshControlPlane * Adding services to a service mesh * Enabling sidecar injection * Upgrading Service Mesh * Managing users and profiles * Security * Traffic management * Metrics, logs, and traces * Performance and scalability * Deploying to production * Federation * Extensions * 3scale WebAssembly for 2.1 * 3scale Istio adapter for 2.0 * Troubleshooting Service Mesh * Control plane configuration reference * Kiali configuration reference * Jaeger configuration reference * Uninstalling Service Mesh * Service Mesh 1.x * Service Mesh 1.x release notes * Service Mesh architecture * Service Mesh and Istio differences * Preparing to install Service Mesh * Installing Service Mesh * Security * Traffic management * Deploying applications on Service Mesh * Data visualization and observability * Custom resources * 3scale Istio adapter for 1.x * Removing Service Mesh * Virtualization * About * About OpenShift Virtualization * Security policies * Architecture * Release notes * OpenShift Virtualization release notes * Getting started * Getting started with OpenShift Virtualization * virtctl and libguestfs * Web console overview * Installing * Preparing your cluster * Installing OpenShift Virtualization * Uninstalling OpenShift Virtualization * Postinstallation configuration * Postinstallation configuration * Node placement rules * Network configuration * Storage configuration * Updating * Updating OpenShift Virtualization * Virtual machines * Creating VMs from Red Hat images * Creating VMs from Red Hat images overview * Creating VMs from templates * Creating VMs from instance types * 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 * Creating VMs by cloning PVCs * Installing the QEMU guest agent and VirtIO drivers * Connecting to VM consoles * 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 * 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 * VM disks * Hot-plugging VM disks * Expanding VM disks * Networking * Networking configuration overview * Connecting a VM to the default pod network * Exposing a VM by using a service * 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 the cluster 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 health checks * Runbooks * Support * Support overview * Collecting data for Red Hat Support * Troubleshooting * Backup and restore * Backup and restore by using VM snapshots * Installing and configuring OADP * Backing up and restoring virtual machines * Backing up virtual machines * Restoring virtual machines × Show more results UPDATING A CLUSTER USING THE CLI * Prerequisites * Pausing a MachineHealthCheck resource * About updating single node OpenShift Container Platform * Updating a cluster by using the CLI * Updating along a conditional update path * Changing the update server by using the CLI You can update, or upgrade, an OpenShift Container Platform cluster within a minor version by using the OpenShift CLI (oc). You can also update a cluster between minor versions by following the same instructions. PREREQUISITES * Have access to the cluster as a user with admin privileges. See Using RBAC to define and apply permissions. * Have a recent etcd backup in case your update fails and you must restore your cluster to a previous state. * Have a recent Container Storage Interface (CSI) volume snapshot in case you need to restore persistent volumes due to a pod failure. * Your RHEL7 workers are replaced with RHEL8 or RHCOS workers. Red Hat does not support in-place RHEL7 to RHEL8 updates for RHEL workers; those hosts must be replaced with a clean operating system install. * You have updated all Operators previously installed through Operator Lifecycle Manager (OLM) to a version that is compatible with your target release. Updating the Operators ensures they have a valid update path when the default OperatorHub catalogs switch from the current minor version to the next during a cluster update. See Updating installed Operators for more information on how to check compatibility and, if necessary, update the installed Operators. * Ensure that all machine config pools (MCPs) are running and not paused. Nodes associated with a paused MCP are skipped during the update process. You can pause the MCPs if you are performing a canary rollout update strategy. * If your cluster uses manually maintained credentials, update the cloud provider resources for the new release. For more information, including how to determine if this is a requirement for your cluster, see Preparing to update a cluster with manually maintained credentials. * Ensure that you address all Upgradeable=False conditions so the cluster allows an update to the next minor version. An alert displays at the top of the Cluster Settings page when you have one or more cluster Operators that cannot be updated. You can still update to the next available patch update for the minor release you are currently on. * Review the list of APIs that were removed in Kubernetes 1.27, migrate any affected components to use the new API version, and provide the administrator acknowledgment. For more information, see Preparing to update to OpenShift Container Platform 4.14. * If you run an Operator or you have configured any application with the pod disruption budget, you might experience an interruption during the update process. If minAvailable is set to 1 in PodDisruptionBudget, the nodes are drained to apply pending machine configs which might block the eviction process. If several nodes are rebooted, all the pods might run on only one node, and the PodDisruptionBudget field can prevent the node drain. * When an update is failing to complete, the Cluster Version Operator (CVO) reports the status of any blocking components while attempting to reconcile the update. Rolling your cluster back to a previous version is not supported. If your update is failing to complete, contact Red Hat support. * Using the unsupportedConfigOverrides section to modify the configuration of an Operator is unsupported and might block cluster updates. You must remove this setting before you can update your cluster. Additional resources * Support policy for unmanaged Operators PAUSING A MACHINEHEALTHCHECK RESOURCE During the update process, nodes in the cluster might become temporarily unavailable. In the case of worker nodes, the machine health check might identify such nodes as unhealthy and reboot them. To avoid rebooting such nodes, pause all the MachineHealthCheck resources before updating the cluster. Prerequisites * Install the OpenShift CLI (oc). Procedure 1. To list all the available MachineHealthCheck resources that you want to pause, run the following command: $ oc get machinehealthcheck -n openshift-machine-api 2. To pause the machine health checks, add the cluster.x-k8s.io/paused="" annotation to the MachineHealthCheck resource. Run the following command: $ oc -n openshift-machine-api annotate mhc <mhc-name> cluster.x-k8s.io/paused="" The annotated MachineHealthCheck resource resembles the following YAML file: apiVersion: machine.openshift.io/v1beta1 kind: MachineHealthCheck metadata: name: example namespace: openshift-machine-api annotations: cluster.x-k8s.io/paused: "" spec: selector: matchLabels: role: worker unhealthyConditions: - type: "Ready" status: "Unknown" timeout: "300s" - type: "Ready" status: "False" timeout: "300s" maxUnhealthy: "40%" status: currentHealthy: 5 expectedMachines: 5 Resume the machine health checks after updating the cluster. To resume the check, remove the pause annotation from the MachineHealthCheck resource by running the following command: $ oc -n openshift-machine-api annotate mhc <mhc-name> cluster.x-k8s.io/paused- ABOUT UPDATING SINGLE NODE OPENSHIFT CONTAINER PLATFORM You can update, or upgrade, a single-node OpenShift Container Platform cluster by using either the console or CLI. However, note the following limitations: * The prerequisite to pause the MachineHealthCheck resources is not required because there is no other node to perform the health check. * Restoring a single-node OpenShift Container Platform cluster using an etcd backup is not officially supported. However, it is good practice to perform the etcd backup in case your update fails. If your control plane is healthy, you might be able to restore your cluster to a previous state by using the backup. * Updating a single-node OpenShift Container Platform cluster requires downtime and can include an automatic reboot. The amount of downtime depends on the update payload, as described in the following scenarios: * If the update payload contains an operating system update, which requires a reboot, the downtime is significant and impacts cluster management and user workloads. * If the update contains machine configuration changes that do not require a reboot, the downtime is less, and the impact on the cluster management and user workloads is lessened. In this case, the node draining step is skipped with single-node OpenShift Container Platform because there is no other node in the cluster to reschedule the workloads to. * If the update payload does not contain an operating system update or machine configuration changes, a short API outage occurs and resolves quickly. There are conditions, such as bugs in an updated package, that can cause the single node to not restart after a reboot. In this case, the update does not rollback automatically. Additional resources * For information on which machine configuration changes require a reboot, see the note in About the Machine Config Operator. UPDATING A CLUSTER BY USING THE CLI You can use the OpenShift CLI (oc) to review and request cluster updates. You can find information about available OpenShift Container Platform advisories and updates in the errata section of the Customer Portal. Prerequisites * Install the OpenShift CLI (oc) that matches the version for your updated version. * Log in to the cluster as user with cluster-admin privileges. * Pause all MachineHealthCheck resources. Procedure 1. View the available updates and note the version number of the update that you want to apply: $ oc adm upgrade Example output Cluster version is 4.13.10 Upstream is unset, so the cluster will use an appropriate default. Channel: stable-4.13 (available channels: candidate-4.13, candidate-4.14, fast-4.13, stable-4.13) Recommended updates: VERSION IMAGE 4.13.14 quay.io/openshift-release-dev/ocp-release@sha256:406fcc160c097f61080412afcfa7fd65284ac8741ac7ad5b480e304aba73674b 4.13.13 quay.io/openshift-release-dev/ocp-release@sha256:d62495768e335c79a215ba56771ff5ae97e3cbb2bf49ed8fb3f6cefabcdc0f17 4.13.12 quay.io/openshift-release-dev/ocp-release@sha256:73946971c03b43a0dc6f7b0946b26a177c2f3c9d37105441315b4e3359373a55 4.13.11 quay.io/openshift-release-dev/ocp-release@sha256:e1c2377fdae1d063aaddc753b99acf25972b6997ab9a0b7e80cfef627b9ef3dd * If there are no available updates, updates that are supported but not recommended might still be available. See Updating along a conditional update path for more information. * For details and information on how to perform an EUS-to-EUS channel update, please refer to the Preparing to perform an EUS-to-EUS upgrade page, listed in the Additional resources section. 2. Based on your organization requirements, set the appropriate update channel. For example, you can set your channel to stable-4.13 or fast-4.13. For more information about channels, refer to Understanding update channels and releases listed in the Additional resources section. $ oc adm upgrade channel <channel> For example, to set the channel to stable-4.14: $ oc adm upgrade channel stable-4.14 For production clusters, you must subscribe to a stable-*, eus-*, or fast-* channel. When you are ready to move to the next minor version, choose the channel that corresponds to that minor version. The sooner the update channel is declared, the more effectively the cluster can recommend update paths to your target version. The cluster might take some time to evaluate all the possible updates that are available and offer the best update recommendations to choose from. Update recommendations can change over time, as they are based on what update options are available at the time. If you cannot see an update path to your target minor version, keep updating your cluster to the latest patch release for your current version until the next minor version is available in the path. 3. Apply an update: * To update to the latest version: $ oc adm upgrade --to-latest=true (1) * To update to a specific version: $ oc adm upgrade --to=<version> (1) 1 <version> is the update version that you obtained from the output of the oc adm upgrade command. When using oc adm upgrade --help, there is a listed option for --force. This is heavily discouraged, as using the --force option bypasses cluster-side guards, including release verification and precondition checks. Using --force does not guarantee a successful update. Bypassing guards put the cluster at risk. 4. Review the status of the Cluster Version Operator: $ oc adm upgrade 5. After the update completes, you can confirm that the cluster version has updated to the new version: $ oc adm upgrade Example output Cluster version is <version> Upstream is unset, so the cluster will use an appropriate default. Channel: stable-<version> (available channels: candidate-<version>, eus-<version>, fast-<version>, stable-<version>) No updates available. You may force an update to a specific release image, but doing so might not be supported and might result in downtime or data loss. 6. If you are updating your cluster to the next minor version, such as version X.y to X.(y+1), it is recommended to confirm that your nodes are updated before deploying workloads that rely on a new feature: $ oc get nodes Example output NAME STATUS ROLES AGE VERSION ip-10-0-168-251.ec2.internal Ready master 82m v1.27.3 ip-10-0-170-223.ec2.internal Ready master 82m v1.27.3 ip-10-0-179-95.ec2.internal Ready worker 70m v1.27.3 ip-10-0-182-134.ec2.internal Ready worker 70m v1.27.3 ip-10-0-211-16.ec2.internal Ready master 82m v1.27.3 ip-10-0-250-100.ec2.internal Ready worker 69m v1.27.3 Additional resources * Performing an EUS-to-EUS update * Updating along a conditional update path * Understanding update channels and releases UPDATING ALONG A CONDITIONAL UPDATE PATH You can update along a recommended conditional update path using the web console or the OpenShift CLI (oc). When a conditional update is not recommended for your cluster, you can update along a conditional update path using the OpenShift CLI (oc) 4.10 or later. Procedure 1. To view the description of the update when it is not recommended because a risk might apply, run the following command: $ oc adm upgrade --include-not-recommended 2. If the cluster administrator evaluates the potential known risks and decides it is acceptable for the current cluster, then the administrator can waive the safety guards and proceed the update by running the following command: $ oc adm upgrade --allow-not-recommended --to <version> (1) 1 <version> is the supported but not recommended update version that you obtained from the output of the previous command. Additional resources * Understanding update channels and releases CHANGING THE UPDATE SERVER BY USING THE CLI Changing the update server is optional. If you have an OpenShift Update Service (OSUS) installed and configured locally, you must set the URL for the server as the upstream to use the local server during updates. The default value for upstream is https://api.openshift.com/api/upgrades_info/v1/graph. Procedure * Change the upstream parameter value in the cluster version: $ oc patch clusterversion/version --patch '{"spec":{"upstream":"<update-server-url>"}}' --type=merge The <update-server-url> variable specifies the URL for the update server. Example output clusterversion.config.openshift.io/version patched Copyright © 2024 Red Hat, Inc. Privacy statement Terms of use All policies and guidelines Cookie-präferenzen