docs.openshift.com
Open in
urlscan Pro
35.175.81.208
Public Scan
URL:
https://docs.openshift.com/container-platform/4.12/installing/installing_with_agent_based_installer/preparing-to-install-wi...
Submission: On August 01 via api from IL — Scanned from IL
Submission: On August 01 via api from IL — Scanned from IL
Form analysis 0 forms found in the DOM
Text 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.16 4.15 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. Installing
4. Installing an on-premise cluster with the Agent-based Installer
5. Preparing to install with Agent-based installer
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.12 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 the multicluster engine for Kubernetes Operator
* Control plane architecture
* Understanding OpenShift development
* Red Hat Enterprise Linux CoreOS
* Admission plugins
* Installing
* Installation overview
* Installation overview
* Selecting an installation method and preparing a cluster
* Cluster capabilities
* Support for FIPS cryptography
* 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
* Uninstalling a cluster on Alibaba Cloud
* Installing on AWS
* Preparing to install on AWS
* Configuring an AWS account
* Manually creating IAM
* 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 using 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
* Uninstalling a cluster on AWS
* Installing on Azure
* Preparing to install on Azure
* Configuring an Azure account
* Manually creating IAM
* 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 using ARM templates
* Uninstalling a cluster on 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
* Uninstalling a cluster on Azure Stack Hub
* Installing on GCP
* Preparing to install on GCP
* Configuring a GCP project
* Manually creating IAM
* 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
* Uninstalling a cluster on GCP
* Installing on IBM Cloud VPC
* Preparing to install on IBM Cloud VPC
* Configuring an IBM Cloud account
* Configuring IAM for IBM Cloud VPC
* Installing a cluster on IBM Cloud VPC with customizations
* Installing a cluster on IBM Cloud VPC with network customizations
* Installing a cluster on IBM Cloud VPC into an existing VPC
* Installing a private cluster on IBM Cloud VPC
* Uninstalling a cluster on IBM Cloud VPC
* Installing on Nutanix
* Preparing to install on Nutanix
* Installing a cluster on Nutanix
* Installing a cluster on Nutanix in a restricted network
* Uninstalling a cluster on 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
* 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 an Agent-based installed cluster for the multicluster engine
for Kubernetes
* 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
* Post-installation 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
* 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
* Configuring network settings after installing OpenStack
* OpenStack Cloud Controller Manager reference guide
* Uninstalling a cluster on OpenStack
* Uninstalling a cluster on OpenStack from your own infrastructure
* Installing on RHV
* Preparing to install on RHV
* Installing a cluster quickly on RHV
* Installing a cluster on RHV with customizations
* Installing a cluster on RHV with user-provisioned infrastructure
* Installing a cluster on RHV in a restricted network
* Uninstalling a cluster on RHV
* 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
* Configuring the vSphere connection settings after an installation
* Uninstalling a cluster on vSphere that uses installer-provisioned
infrastructure
* Using the vSphere Problem Detector Operator
* Installing on VMC
* Preparing to install on VMC
* Installing a cluster on VMC
* Installing a cluster on VMC with customizations
* Installing a cluster on VMC with network customizations
* Installing a cluster on VMC in a restricted network
* Installing a cluster on VMC with user-provisioned infrastructure
* Installing a cluster on VMC with user-provisioned infrastructure and
network customizations
* Installing a cluster on VMC in a restricted network with user-provisioned
infrastructure
* Uninstalling a cluster on VMC
* Installing on any platform
* Installing a cluster on any platform
* Installation configuration
* Customizing nodes
* Configuring your firewall
* Enabling Linux control group version 2 (cgroup v2)
* Validation and troubleshooting
* Validating an installation
* Troubleshooting installation issues
* Post-installation configuration
* Post-installation configuration overview
* Configuring a private cluster
* Bare metal configuration
* Configuring multi-architecture compute machines on an OpenShift cluster
* Machine configuration tasks
* Cluster tasks
* Node tasks
* Postinstallation 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
* Red Hat Enterprise Linux CoreOS image layering
* Updating clusters
* Updating clusters overview
* Understanding OpenShift updates
* Introduction to OpenShift updates
* How cluster updates work
* Understanding update channels and releases
* Understanding OpenShift update duration
* Preparing to update to OpenShift Container Platform 4.12
* Preparing to perform an EUS-to-EUS update
* Preparing to update a cluster with manually maintained credentials
* Updating a cluster using the web console
* Updating a cluster using the CLI
* Performing update using canary rollout strategy
* Updating the boot loader on Red Hat Enterprise Linux CoreOS nodes using
bootupd
* Updating a cluster that includes RHEL compute machines
* Updating a cluster in a disconnected environment
* About cluster updates in a disconnected environment
* Mirroring the OpenShift Container Platform image repository
* 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
* Preflight validation for Kernel Module Management (KMM) Modules
* 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
* 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
* GitOps CLI (argocd) for use with OpenShift GitOps
* 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
* 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 on AWS
* Authenticating the cert-manager Operator for Red Hat OpenShift with GCP
Workload Identity
* 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
* Using mint mode
* Using passthrough mode
* Using manual mode
* Using manual mode with AWS Security Token Service
* Using manual mode with GCP Workload Identity
* Networking
* About networking
* Understanding networking
* Accessing hosts
* Networking Operators overview
* Understanding the Cluster Network Operator
* Understanding the DNS Operator
* Understanding the Ingress Operator
* 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 IP failover
* Configuring interface-level network sysctls
* Using SCTP
* Using PTP hardware
* External DNS Operator
* 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
* 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
* Preparing for the AWS Load Balancer Operator on a cluster using the AWS
Security Token Service (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
* 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
* Converting to IPv4/IPv6 dual stack networking
* Logging for egress firewall and network policy rules
* Configuring IPsec encryption
* 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
* 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 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 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
* 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
* CSI automatic migration
* 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
* OpenStack Cinder CSI Driver Operator
* OpenStack Manila CSI Driver Operator
* Red Hat Virtualization 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
* 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
* 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
* Object pruning utility
* Migrating package manifest projects to bundle format
* Operator SDK CLI reference
* Cluster Operators reference
* CI/CD
* CI/CD overview
* Builds
* 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 by using the CLI
* Viewing application composition by 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 and DeploymentConfigs
* 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 Nutanix
* Creating a compute machine set on OpenStack
* Creating a compute machine set on RHV
* 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 a cluster on RHV
* Adding compute machines to bare metal
* 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
* 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
* Troubleshooting Cluster API clusters
* Deploying machine health checks
* 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
* 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
* 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
* 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 vSphere
* Creating a Windows machine set on GCP
* 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
* Documentation has moved
* Observability
* Observability overview
* Monitoring
* Monitoring overview
* Configuring the monitoring stack
* Enabling monitoring for user-defined projects
* Enabling alert routing for user-defined projects
* Managing metrics
* Querying metrics
* Managing metrics targets
* Managing alerts
* Reviewing monitoring dashboards
* The NVIDIA GPU administration dashboard
* Accessing monitoring APIs by using the CLI
* Troubleshooting monitoring issues
* Config map reference for the Cluster Monitoring Operator
* Logging
* Release notes
* Logging 5.8
* Logging 5.7
* Logging 5.6
* Logging 5.5
* 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
* 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
* Distributed tracing
* Release notes
* Distributed tracing architecture
* Distributed tracing architecture
* Distributed tracing platform (Tempo)
* Installing
* Configuring
* Upgrading
* Removing
* Distributed tracing platform (Jaeger)
* Installing
* Configuring
* Upgrading
* Removing
* Red Hat build of OpenTelemetry
* Release notes
* Installing
* Configuring the Collector
* Receivers
* Processors
* Exporters
* Connectors
* Extensions
* Target Allocator
* Configuring the instrumentation
* Sending traces and metrics to the Collector
* Configuring metrics for the monitoring stack
* Forwarding traces to a TempoStack
* Configuring the Collector metrics
* Gathering the observability data from multiple clusters
* Troubleshooting
* Migrating
* Upgrading
* Removing
* 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
* 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
* 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 in single-node OpenShift
* 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 Restic
* 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
* Backing up and restoring etcd on a hosted cluster
* Disaster recovery
* About disaster recovery
* Restoring to a previous cluster state
* Recovering from expired control plane certificates
* Disaster recovery for a hosted cluster within an AWS region
* 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
* 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
* 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]
* ImageContentPolicy [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
* 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]
* 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/v1beta1]
* LimitRange [undefined/v1]
* PriorityClass [scheduling.k8s.io/v1]
* PriorityLevelConfiguration [flowcontrol.apiserver.k8s.io/v1beta1]
* 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]
* 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]
* PersistentVolume [undefined/v1]
* ReplicaSet [apps/v1]
* StatefulSet [apps/v1]
* Service Mesh
* Service Mesh 2.x
* About OpenShift Service Mesh
* Service Mesh 2.x release notes
* Upgrading Service Mesh
* Understanding Service Mesh
* 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
* Managing users and profiles
* Security
* Traffic management
* Metrics, logs, and traces
* Performance and scalability
* Deploying to production
* Federation
* Extensions
* OpenShift Service Mesh Console plugin
* 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 OpenShift Virtualization
* OpenShift Virtualization architecture
* Getting started with OpenShift Virtualization
* Web console overview
* OpenShift Virtualization release notes
* Installing
* Preparing your cluster for OpenShift Virtualization
* Specifying nodes for OpenShift Virtualization components
* Installing OpenShift Virtualization using the web console
* Installing OpenShift Virtualization using the CLI
* Installing the virtctl client
* Uninstalling OpenShift Virtualization
* Updating OpenShift Virtualization
* Security policies
* Using the CLI tools
* Virtual machines
* Creating virtual machines
* Editing virtual machines
* Editing boot order
* Deleting virtual machines
* Exporting virtual machines
* Managing virtual machine instances
* Controlling virtual machine states
* Accessing virtual machine consoles
* Automating Windows installation with sysprep
* Triggering virtual machine failover by resolving a failed node
* Installing the QEMU guest agent on virtual machines
* Viewing the QEMU guest agent information for virtual machines
* Managing config maps, secrets, and service accounts in virtual machines
* Installing VirtIO driver on an existing Windows virtual machine
* Installing VirtIO driver on a new Windows virtual machine
* 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
* 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 vGPU passthrough
* Configuring mediated devices
* Configuring a watchdog device
* Automatic importing and updating of pre-defined boot sources
* Enabling descheduler evictions on virtual machines
* Importing virtual machines
* TLS certificates for data volume imports
* Importing virtual machine images with data volumes
* Importing virtual machine images into block storage with data volumes
* Cloning virtual machines
* Enabling user permissions to clone data volumes across namespaces
* Cloning a virtual machine disk into a new data volume
* Cloning a virtual machine by using a data volume template
* Cloning a virtual machine disk into a new block storage data volume
* Virtual machine networking
* Configuring a virtual machine for the default pod network
* Creating a service to expose a virtual machine
* Connecting a virtual machine to a Linux bridge network
* Connecting a virtual machine to an SR-IOV network
* Connecting a virtual machine to a service mesh
* Configuring IP addresses for virtual machines
* Viewing the IP address of NICs on a virtual machine
* Using a MAC address pool for virtual machines
* Virtual machine disks
* Features for storage
* Configuring local storage for virtual machines
* Creating data volumes
* Reserving PVC space for file system overhead
* Configuring CDI to work with namespaces that have a compute resource
quota
* Managing data volume annotations
* Using preallocation for data volumes
* Uploading local disk images by using the web console
* Uploading local disk images by using the virtctl tool
* Uploading a local disk image to a block storage data volume
* Managing virtual machine snapshots
* Moving a local virtual machine disk to a different node
* Expanding virtual storage by adding blank disk images
* Cloning a data volume using smart-cloning
* Creating and using boot sources
* Hot plugging virtual disks
* Using container disks with virtual machines
* Preparing CDI scratch space
* Re-using statically provisioned persistent volumes
* Expanding a virtual machine disk
* Virtual machine templates
* Creating virtual machine templates
* Editing virtual machine templates
* Enabling dedicated resources for a virtual machine template
* Deploying a virtual machine template to a custom namespace
* Deleting a virtual machine template
* Live migration
* Virtual machine live migration
* Live migration limits and timeouts
* Migrating a virtual machine instance to another node
* Migrating a virtual machine over a dedicated additional network
* Cancelling the live migration of a virtual machine instance
* Configuring virtual machine eviction strategy
* Configuring live migration policies
* Node maintenance
* About node maintenance
* Automatic renewal of TLS certificates
* Managing node labeling for obsolete CPU models
* Preventing node reconciliation
* Logging, events, and monitoring
* Virtualization Overview page
* Viewing OpenShift Virtualization logs
* Viewing events
* Monitoring live migration
* Diagnosing data volumes using events and conditions
* Viewing information about virtual machine workloads
* Monitoring virtual machine health
* Viewing cluster information
* Reviewing resource usage by virtual machines
* OpenShift cluster monitoring, logging, and Telemetry
* Running OpenShift cluster checkups
* Prometheus queries for virtual resources
* Exposing custom metrics for virtual machines
* OpenShift Virtualization runbooks
* Collecting data for Red Hat Support
* Backup and restore
* Installing and configuring OADP
* Backing up and restoring virtual machines
* Backing up virtual machines
* Restoring virtual machines
×
Show more results
PREPARING TO INSTALL WITH THE AGENT-BASED INSTALLER
* About the Agent-based Installer
* Understanding Agent-based Installer
* Agent-based Installer workflow
* Recommended resources for topologies
* About FIPS compliance
* Configuring FIPS through the Agent-based Installer
* About networking
* DHCP
* Static networking
* Example: Bonds and VLAN interface node network configuration
* Sample install-config.yaml file for bare metal
* Validation checks before agent ISO creation
* ZTP manifests
* About root device hints
* Next steps
ABOUT THE AGENT-BASED INSTALLER
The Agent-based installation method provides the flexibility to boot your
on-premises servers in any way that you choose. It combines the ease of use of
the Assisted Installation service with the ability to run offline, including in
air-gapped environments. Agent-based installation is a subcommand of the
OpenShift Container Platform installer. It generates a bootable ISO image
containing all of the information required to deploy an OpenShift Container
Platform cluster, with an available release image.
The configuration is in the same format as for the installer-provisioned
infrastructure and user-provisioned infrastructure installation methods. The
Agent-based Installer can also optionally generate or accept Zero Touch
Provisioning (ZTP) custom resources. ZTP allows you to provision new edge sites
with declarative configurations of bare-metal equipment.
UNDERSTANDING AGENT-BASED INSTALLER
As an OpenShift Container Platform user, you can leverage the advantages of the
Assisted Installer hosted service in disconnected environments.
The Agent-based installation comprises a bootable ISO that contains the Assisted
discovery agent and the Assisted Service. Both are required to perform the
cluster installation, but the latter runs on only one of the hosts.
The openshift-install agent create image subcommand generates an ephemeral ISO
based on the inputs that you provide. You can choose to provide inputs through
the following manifests:
Preferred:
* install-config.yaml
* agent-config.yaml
or
Optional: ZTP manifests
* cluster-manifests/cluster-deployment.yaml
* cluster-manifests/agent-cluster-install.yaml
* cluster-manifests/pull-secret.yaml
* cluster-manifests/infraenv.yaml
* cluster-manifests/cluster-image-set.yaml
* cluster-manifests/nmstateconfig.yaml
* mirror/registries.conf
* mirror/ca-bundle.crt
AGENT-BASED INSTALLER WORKFLOW
One of the control plane hosts runs the Assisted Service at the start of the
boot process and eventually becomes the bootstrap host. This node is called the
rendezvous host (node 0). The Assisted Service ensures that all the hosts meet
the requirements and triggers an OpenShift Container Platform cluster
deployment. All the nodes have the Red Hat Enterprise Linux CoreOS (RHCOS) image
written to the disk. The non-bootstrap nodes reboot and initiate a cluster
deployment. Once the nodes are rebooted, the rendezvous host reboots and joins
the cluster. The bootstrapping is complete and the cluster is deployed.
Figure 1. Node installation workflow
You can install a disconnected OpenShift Container Platform cluster through the
openshift-install agent create image subcommand for the following topologies:
* A single-node OpenShift Container Platform cluster (SNO): A node that is both
a master and worker.
* A three-node OpenShift Container Platform cluster : A compact cluster that
has three master nodes that are also worker nodes.
* Highly available OpenShift Container Platform cluster (HA): Three master
nodes with any number of worker nodes.
RECOMMENDED RESOURCES FOR TOPOLOGIES
Recommended cluster resources for the following topologies:
Table 1. Recommended cluster resources Topology Number of master nodes Number of
worker nodes vCPU Memory Storage
Single-node cluster
1
0
8 vCPU cores
16GB of RAM
120GB
Compact cluster
3
0 or 1
8 vCPU cores
16GB of RAM
120GB
HA cluster
3
2 and above
8 vCPU cores
16GB of RAM
120GB
The following platforms are supported:
* baremetal
* vsphere
* none
The none option is supported for only single-node OpenShift clusters with an
OVNKubernetes network type.
ABOUT FIPS COMPLIANCE
For many OpenShift Container Platform customers, regulatory readiness, or
compliance, on some level is required before any systems can be put into
production. That regulatory readiness can be imposed by national standards,
industry standards or the organization’s corporate governance framework. Federal
Information Processing Standards (FIPS) compliance is one of the most critical
components required in highly secure environments to ensure that only supported
cryptographic technologies are allowed on nodes.
To enable FIPS mode for your cluster, you must run the installation program from
a Red Hat Enterprise Linux (RHEL) computer configured to operate in FIPS mode.
For more information about configuring FIPS mode on RHEL, see Installing the
system in FIPS mode. The use of FIPS validated or Modules In Process
cryptographic libraries is supported on OpenShift Container Platform deployments
on the x86_64, ppc64le, and s390x architectures.
CONFIGURING FIPS THROUGH THE AGENT-BASED INSTALLER
During a cluster deployment, the Federal Information Processing Standards (FIPS)
change is applied when the Red Hat Enterprise Linux CoreOS (RHCOS) machines are
deployed in your cluster. For Red Hat Enterprise Linux (RHEL) machines, you must
enable FIPS mode when you install the operating system on the machines that you
plan to use as worker machines.
You can enable FIPS mode through the preferred method of install-config.yaml and
agent-config.yaml:
1. You must set value of the fips field to True in the install-config.yaml
file:
Sample install-config.yaml.file
apiVersion: v1
baseDomain: test.example.com
metadata:
name: sno-cluster
fips: True
2. Optional: If you are using the ZTP manifests, you must set the value of fips
as True in the Agent-install.openshift.io/install-config-overrides field in
the agent-cluster-install.yaml file:
Sample agent-cluster-install.yaml file
apiVersion: extensions.hive.openshift.io/v1beta1
kind: AgentClusterInstall
metadata:
annotations:
agent-install.openshift.io/install-config-overrides: '{"fips": True}'
name: sno-cluster
namespace: sno-cluster-test
Additional resources
* OpenShift Security Guide Book
* Support for FIPS cryptography
ABOUT NETWORKING
The rendezvous IP must be known at the time of generating the agent ISO, so that
during the initial boot all the hosts can check in to the assisted service. If
the IP addresses are assigned using a Dynamic Host Configuration Protocol (DHCP)
server, then the rendezvousIP field must be set to an IP address of one of the
hosts that will become part of the deployed control plane. In an environment
without a DHCP server, you can define IP addresses statically.
In addition to static IP addresses, you can apply any network configuration that
is in NMState format. This includes VLANs and NIC bonds.
DHCP
Preferred method: install-config.yaml and agent-config.yaml
You must specify the value for the rendezvousIP field. The networkConfig fields
can be left blank:
Sample agent-config.yaml.file
apiVersion: v1alpha1
kind: AgentConfig
metadata:
name: sno-cluster
rendezvousIP: 192.168.111.80 (1)
1 The IP address for the rendezvous host.
STATIC NETWORKING
a. Preferred method: install-config.yaml and agent-config.yaml
Sample agent-config.yaml.file
cat > agent-config.yaml << EOF
apiVersion: v1alpha1
kind: AgentConfig
metadata:
name: sno-cluster
rendezvousIP: 192.168.111.80 (1)
hosts:
- hostname: master-0
interfaces:
- name: eno1
macAddress: 00:ef:44:21:e6:a5 (2)
networkConfig:
interfaces:
- name: eno1
type: ethernet
state: up
mac-address: 00:ef:44:21:e6:a5
ipv4:
enabled: true
address:
- ip: 192.168.111.80 (3)
prefix-length: 23 (4)
dhcp: false
dns-resolver:
config:
server:
- 192.168.111.1 (5)
routes:
config:
- destination: 0.0.0.0/0
next-hop-address: 192.168.111.1 (6)
next-hop-interface: eno1
table-id: 254
EOF
1 If a value is not specified for the rendezvousIP field, one address will
be chosen from the static IP addresses specified in the networkConfig
fields. 2 The MAC address of an interface on the host, used to determine
which host to apply the configuration to. 3 The static IP address of the
target bare metal host. 4 The static IP address’s subnet prefix for the
target bare metal host. 5 The DNS server for the target bare metal host. 6
Next hop address for the node traffic. This must be in the same subnet as
the IP address set for the specified interface.
b. Optional method: ZTP manifests
The optional method of the ZTP custom resources comprises 6 custom
resources; you can configure static IPs in the nmstateconfig.yaml file.
apiVersion: agent-install.openshift.io/v1beta1
kind: NMStateConfig
metadata:
name: master-0
namespace: openshift-machine-api
labels:
cluster0-nmstate-label-name: cluster0-nmstate-label-value
spec:
config:
interfaces:
- name: eth0
type: ethernet
state: up
mac-address: 52:54:01:aa:aa:a1
ipv4:
enabled: true
address:
- ip: 192.168.122.2 (1)
prefix-length: 23 (2)
dhcp: false
dns-resolver:
config:
server:
- 192.168.122.1 (3)
routes:
config:
- destination: 0.0.0.0/0
next-hop-address: 192.168.122.1 (4)
next-hop-interface: eth0
table-id: 254
interfaces:
- name: eth0
macAddress: 52:54:01:aa:aa:a1 (5)
1 The static IP address of the target bare metal host. 2 The static IP
address’s subnet prefix for the target bare metal host. 3 The DNS server for
the target bare metal host. 4 Next hop address for the node traffic. This
must be in the same subnet as the IP address set for the specified
interface. 5 The MAC address of an interface on the host, used to determine
which host to apply the configuration to.
The rendezvous IP is chosen from the static IP addresses specified in the config
fields.
EXAMPLE: BONDS AND VLAN INTERFACE NODE NETWORK CONFIGURATION
The following agent-config.yaml file is an example of a manifest for bond and
VLAN interfaces.
apiVersion: v1alpha1
kind: AgentConfig
rendezvousIP: 10.10.10.14
hosts:
- hostname: master0
role: master
interfaces:
- name: enp0s4
macAddress: 00:21:50:90:c0:10
- name: enp0s5
macAddress: 00:21:50:90:c0:20
networkConfig:
interfaces:
- name: bond0.300 (1)
type: vlan (2)
state: up
vlan:
base-iface: bond0
id: 300
ipv4:
enabled: true
address:
- ip: 10.10.10.14
prefix-length: 24
dhcp: false
- name: bond0 (1)
type: bond (3)
state: up
mac-address: 00:21:50:90:c0:10 (4)
ipv4:
enabled: false
ipv6:
enabled: false
link-aggregation:
mode: active-backup (5)
options:
miimon: "150" (6)
port:
- enp0s4
- enp0s5
dns-resolver: (7)
config:
server:
- 10.10.10.11
- 10.10.10.12
routes:
config:
- destination: 0.0.0.0/0
next-hop-address: 10.10.10.10 (8)
next-hop-interface: bond0.300 (9)
table-id: 254
1 Name of the interface. 2 The type of interface. This example creates a VLAN. 3
The type of interface. This example creates a bond. 4 The mac address of the
interface. 5 The mode attribute specifies the bonding mode. 6 Specifies the MII
link monitoring frequency in milliseconds. This example inspects the bond link
every 150 milliseconds. 7 Optional: Specifies the search and server settings for
the DNS server. 8 Next hop address for the node traffic. This must be in the
same subnet as the IP address set for the specified interface. 9 Next hop
interface for the node traffic.
SAMPLE INSTALL-CONFIG.YAML FILE FOR BARE METAL
You can customize the install-config.yaml file to specify more details about
your OpenShift Container Platform cluster’s platform or modify the values of the
required parameters.
apiVersion: v1
baseDomain: example.com (1)
compute: (2)
- name: worker
replicas: 0 (3)
controlPlane: (2)
name: master
replicas: 1 (4)
metadata:
name: sno-cluster (5)
networking:
clusterNetwork:
- cidr: 10.128.0.0/14 (6)
hostPrefix: 23 (7)
networkType: OVNKubernetes (8)
serviceNetwork: (9)
- 172.30.0.0/16
platform:
none: {} (10)
fips: false (11)
pullSecret: '{"auths": ...}' (12)
sshKey: 'ssh-ed25519 AAAA...' (13)
1 The base domain of the cluster. All DNS records must be sub-domains of this
base and include the cluster name. 2 The controlPlane section is a single
mapping, but the compute section is a sequence of mappings. To meet the
requirements of the different data structures, the first line of the compute
section must begin with a hyphen, -, and the first line of the controlPlane
section must not. Only one control plane pool is used. 3 This parameter controls
the number of compute machines that the Agent-based installation waits to
discover before triggering the installation process. It is the number of compute
machines that must be booted with the generated ISO.
If you are installing a three-node cluster, do not deploy any compute machines
when you install the Red Hat Enterprise Linux CoreOS (RHCOS) machines.
4 The number of control plane machines that you add to the cluster. Because the
cluster uses these values as the number of etcd endpoints in the cluster, the
value must match the number of control plane machines that you deploy. 5 The
cluster name that you specified in your DNS records. 6 A block of IP addresses
from which pod IP addresses are allocated. This block must not overlap with
existing physical networks. These IP addresses are used for the pod network. If
you need to access the pods from an external network, you must configure load
balancers and routers to manage the traffic.
Class E CIDR range is reserved for a future use. To use the Class E CIDR range,
you must ensure your networking environment accepts the IP addresses within the
Class E CIDR range.
7 The subnet prefix length to assign to each individual node. For example, if
hostPrefix is set to 23, then each node is assigned a /23 subnet out of the
given cidr, which allows for 510 (2^(32 - 23) - 2) pod IP addresses. If you are
required to provide access to nodes from an external network, configure load
balancers and routers to manage the traffic. 8 The cluster network plugin to
install. The supported values are OVNKubernetes (default value) and
OpenShiftSDN. 9 The IP address pool to use for service IP addresses. You can
enter only one IP address pool. This block must not overlap with existing
physical networks. If you need to access the services from an external network,
configure load balancers and routers to manage the traffic. 10 You must set the
platform to none for a single-node cluster. You can set the platform to either
vsphere or baremetal for multi-node clusters.
If you set the platform to vsphere or baremetal, you can configure IP address
endpoints for cluster nodes in three ways:
* IPv4
* IPv6
* IPv4 and IPv6 in parallel (dual-stack)
Example of dual-stack networking
networking:
clusterNetwork:
- cidr: 172.21.0.0/16
hostPrefix: 23
- cidr: fd02::/48
hostPrefix: 64
machineNetwork:
- cidr: 192.168.11.0/16
- cidr: 2001:DB8::/32
serviceNetwork:
- 172.22.0.0/16
- fd03::/112
networkType: OVNKubernetes
platform:
baremetal:
apiVIPs:
- 192.168.11.3
- 2001:DB8::4
ingressVIPs:
- 192.168.11.4
- 2001:DB8::5
11 Whether to enable or disable FIPS mode. By default, FIPS mode is not enabled.
If FIPS mode is enabled, the Red Hat Enterprise Linux CoreOS (RHCOS) machines
that OpenShift Container Platform runs on bypass the default Kubernetes
cryptography suite and use the cryptography modules that are provided with RHCOS
instead.
The use of FIPS validated or Modules In Process cryptographic libraries is only
supported on OpenShift Container Platform deployments on the x86_64, ppc64le,
and s390x architectures.
12 This pull secret allows you to authenticate with the services that are
provided by the included authorities, including Quay.io, which serves the
container images for OpenShift Container Platform components. 13 The SSH public
key for the core user in Red Hat Enterprise Linux CoreOS (RHCOS).
For production OpenShift Container Platform clusters on which you want to
perform installation debugging or disaster recovery, specify an SSH key that
your ssh-agent process uses.
VALIDATION CHECKS BEFORE AGENT ISO CREATION
The Agent-based Installer performs validation checks on user defined YAML files
before the ISO is created. Once the validations are successful, the agent ISO is
created.
install-config.yaml
* baremetal, vsphere and none platforms are supported.
* If none is used as a platform, the number of control plane replicas must be 1
and the total number of worker replicas must be 0.
* The networkType parameter must be OVNKubernetes in the case of none platform.
* apiVIPs and ingressVIPs parameters must be set for bare metal and vSphere
platforms.
* Some host-specific fields in the bare metal platform configuration that have
equivalents in agent-config.yaml file are ignored. A warning message is
logged if these fields are set.
agent-config.yaml
* Each interface must have a defined MAC address. Additionally, all interfaces
must have a different MAC address.
* At least one interface must be defined for each host.
* World Wide Name (WWN) vendor extensions are not supported in root device
hints.
* The role parameter in the host object must have a value of either master or
worker.
ZTP MANIFESTS
agent-cluster-install.yaml
* For IPv6, the only supported value for the networkType parameter is
OVNKubernetes. The OpenshiftSDN value can be used only for IPv4.
cluster-image-set.yaml
* The ReleaseImage parameter must match the release defined in the installer.
ABOUT ROOT DEVICE HINTS
The rootDeviceHints parameter enables the installer to provision the Red Hat
Enterprise Linux CoreOS (RHCOS) image to a particular device. The installer
examines the devices in the order it discovers them, and compares the discovered
values with the hint values. The installer uses the first discovered device that
matches the hint value. The configuration can combine multiple hints, but a
device must match all hints for the installer to select it.
Table 2. Subfields Subfield Description
deviceName
A string containing a Linux device name like /dev/vda. The hint must match the
actual value exactly.
hctl
A string containing a SCSI bus address like 0:0:0:0. The hint must match the
actual value exactly.
model
A string containing a vendor-specific device identifier. The hint can be a
substring of the actual value.
vendor
A string containing the name of the vendor or manufacturer of the device. The
hint can be a sub-string of the actual value.
serialNumber
A string containing the device serial number. The hint must match the actual
value exactly.
minSizeGigabytes
An integer representing the minimum size of the device in gigabytes.
wwn
A string containing the unique storage identifier. The hint must match the
actual value exactly.
rotational
A boolean indicating whether the device should be a rotating disk (true) or not
(false).
Example usage
- name: master-0
role: master
rootDeviceHints:
deviceName: "/dev/sda"
NEXT STEPS
* Installing a cluster with the Agent-based Installer
Copyright © 2024 Red Hat, Inc.
Privacy statement Terms of use All policies and guidelines Cookie preferences
HOW WE USE COOKIES
We use cookies on our websites to deliver our online services. Details about how
we use cookies and how you may disable them are set out in our Privacy
Statement. By using this website you agree to our use of cookies.