About Console <strong>api</strong>s - Console <strong>api</strong>s | <strong>api</strong> reference | OpenShift Container Platform 4.16

This is a cache of https://docs.openshift.com/container-platform/4.16/rest_api/console_apis/console-apis-index.html. It is a snapshot of the page at 2024-11-05T10:35:35.645+0000.

About Console <strong>api</strong>s - Console <strong>api</strong>s | <strong>api</strong> reference | OpenShift Container Platform 4.16

About
- Welcome
- Learn more about OpenShift Container Platform
- About OpenShift Kubernetes Engine
- Legal notice
Release notes
- OpenShift Container Platform 4.16 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
- NVIDIA GPU architecture overview
- 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 v1
  - Mirroring images for a disconnected installation using oc-mirror plugin v2
- Installing on Alibaba Cloud
  - Installing a cluster on Alibaba Cloud using the Assisted Installer
- Installing on AWS
  - Installation methods
  - Configuring an AWS account
  - Installer-provisioned infrastructure
  - User-provisioned infrastructure
  - Installing a three-node cluster
  - Uninstalling a cluster
  - Installation configuration parameters
  - AWS Local Zone or Wavelength Zone tasks
- Installing on Azure
  - Preparing to install on Azure
  - Configuring an Azure account
  - Enabling user-managed encryption on Azure
  - Installing a cluster quickly on Azure
  - Installing a cluster on Azure with customizations
  - Installing a cluster on Azure with network customizations
  - Installing a cluster on Azure into an existing VNet
  - Installing a private cluster on Azure
  - Installing a cluster on Azure into a government region
  - Installing a cluster on Azure in a restricted network with user-provisioned infrastructure
  - Installing a cluster on Azure using ARM templates
  - Installing a cluster on Azure in a restricted network
  - Installing a three-node cluster on Azure
  - Uninstalling a cluster on Azure
  - Installation configuration parameters for Azure
- Installing on Azure Stack Hub
  - Preparing to install on Azure Stack Hub
  - Configuring an Azure Stack Hub account
  - Installing a cluster on Azure Stack Hub with an installer-provisioned infrastructure
  - Installing a cluster on Azure Stack Hub with network customizations
  - Installing a cluster on Azure Stack Hub using ARM templates
  - Installation configuration parameters for Azure Stack Hub
  - Uninstalling a cluster on Azure Stack Hub
- Installing on GCP
  - Preparing to install on GCP
  - Configuring a GCP project
  - Installing a cluster quickly on GCP
  - Installing a cluster on GCP with customizations
  - Installing a cluster on GCP with network customizations
  - Installing a cluster on GCP in a restricted network
  - Installing a cluster on GCP into an existing VPC
  - Installing a cluster on GCP into a shared VPC
  - Installing a private cluster on GCP
  - Installing a cluster on GCP using Deployment Manager templates
  - Installing a cluster into a shared VPC on GCP using Deployment Manager templates
  - Installing a cluster on GCP in a restricted network with user-provisioned infrastructure
  - Installing a three-node cluster on GCP
  - Installation configuration parameters for GCP
  - Uninstalling a cluster on GCP
- Installing on IBM Cloud
  - Preparing to install on IBM Cloud
  - Configuring an IBM Cloud account
  - Configuring IAM for IBM Cloud
  - User-managed encryption
  - Installing a cluster on IBM Cloud with customizations
  - Installing a cluster on IBM Cloud with network customizations
  - Installing a cluster on IBM Cloud into an existing VPC
  - Installing a private cluster on IBM Cloud
  - Installing a cluster on IBM Cloud in a restricted network
  - Installation configuration parameters for IBM Cloud
  - Uninstalling a cluster on IBM Cloud
- Installing on Nutanix
  - Preparing to install on Nutanix
  - Fault tolerant deployments
  - Installing a cluster on Nutanix
  - Installing a cluster on Nutanix in a restricted network
  - Installing a three-node cluster on Nutanix
  - Uninstalling a cluster on Nutanix
  - Installation configuration parameters for Nutanix
- Installing on-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
- Installing on bare metal
  - Preparing to install on bare metal
  - Installing a user-provisioned cluster on bare metal
  - Installing a user-provisioned bare metal cluster with network customizations
  - Installing a user-provisioned bare metal cluster on a restricted network
  - Scaling a user-provisioned installation with the bare metal operator
  - Installation configuration parameters for bare metal
- Deploying installer-provisioned clusters on bare metal
  - Overview
  - Prerequisites
  - Setting up the environment for an OpenShift installation
  - Installing a cluster
  - Troubleshooting the installation
  - Postinstallation configuration
  - Expanding the cluster
- Installing IBM Cloud Bare Metal (Classic)
  - Prerequisites
  - Installation workflow
- Installing on 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
  - Installing a cluster in an LPAR on IBM Z and IBM LinuxONE
  - Restricted network IBM Z installation in an LPAR
  - Installation configuration parameters for IBM Z and IBM LinuxONE
  - Configuring additional devices in an IBM Z or IBM LinuxONE environment
- 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 on your own infrastructure
  - Installing a cluster on OpenStack in a restricted network
  - Configuring network settings after installing OpenStack
  - OpenStack Cloud Controller Manager reference guide
  - Deploying on OpenStack with rootVolume and etcd on local disk
  - Uninstalling a cluster on OpenStack
  - Uninstalling a cluster on OpenStack from your own infrastructure
  - Installation configuration parameters for OpenStack
- Installing on OCI
  - Installing a cluster on Oracle Cloud Infrastructure by using the Assisted Installer
  - Installing a cluster on Oracle Cloud Infrastructure by using the Agent-based Installer
- Installing on vSphere
  - Installation methods
  - Installer-provisioned infrastructure
  - User-provisioned infrastructure
  - Assisted Installer
  - Agent-based Installer
  - Installing a three-node cluster
  - Uninstalling a cluster
  - Using the vSphere Problem Detector Operator
  - Installation configuration parameters
  - Regions and zones for a VMware vCenter
  - Enabling encryption on a vSphere cluster
  - Configuring the vSphere connection settings after an installation
- Installing on any platform
  - Installing a cluster on any platform
- Installation configuration
  - Customizing nodes
  - Configuring your firewall
  - Enabling Linux control group version 1 (cgroup v1)
- Validation and troubleshooting
  - Validating an installation
  - Troubleshooting installation issues
Postinstallation configuration
- Postinstallation configuration overview
- Configuring a private cluster
- Bare metal configuration
- Configuring multi-architecture compute machines on an OpenShift cluster
- Cluster tasks
- Node tasks
- Postinstallation network configuration
- Configuring image streams and image registries
- Storage configuration
- Preparing for users
- Changing the cloud provider credentials configuration
- Configuring alert notifications
- Converting a connected cluster to a disconnected cluster
Updating clusters
- Understanding OpenShift updates
- Preparing to update a cluster
- Performing a cluster update
- 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
- Gathering data about your cluster
- Summarizing cluster specifications
- Troubleshooting
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
- Web terminal
- Disabling the web console
- Creating quick start tutorials
- Optional capabilities and products
CLI tools
- CLI tools overview
- OpenShift CLI (oc)
- Developer CLI (odo)
- Knative CLI (kn) for use with OpenShift Serverless
- Pipelines CLI (tkn)
- 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
- Configuring certificates
- Certificate types and descriptions
- Compliance Operator
- File Integrity Operator
- Security Profiles Operator
- NBDE Tang Server Operator
- 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)
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
- 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
Networking
- About networking
- Understanding networking
- Zero trust networking
- Accessing hosts
- Networking dashboards
- Network security
  - Understanding network policy apis
  - Admin network policy
  - Network policy
  - Audit logging for network security
  - Understanding the Ingress Node Firewall Operator
  - Egress Firewall
  - Configuring IPsec encryption
- Understanding the Cluster Network Operator
- Understanding the DNS Operator
- Understanding the Ingress Operator
- Configuring the Ingress Controller for manual DNS management
- Verifying connectivity to an endpoint
- Changing the cluster network MTU
- Configuring the node port service range
- Configuring the cluster network IP address range
- Configuring IP failover
- Configuring system controls and interface attributes using the tuning plugin
- Using SCTP
- Using PTP hardware
  - About PTP in OpenShift clusters
  - Configuring PTP hardware
  - Developing PTP events consumer applications with the REST api v2
  - PTP events REST api v2 reference
  - Developing PTP events consumer applications with the REST api v1
  - PTP events REST api v1 reference
- External DNS Operator
  - External DNS Operator release notes
  - Understanding the External DNS Operator
  - Installing the External DNS Operator
  - External DNS Operator configuration parameters
  - Creating DNS records on a public hosted zone for AWS
  - Creating DNS records on a public zone for Azure
  - Creating DNS records on a public managed zone for GCP
  - Creating DNS records on a public DNS zone for Infoblox
  - Configuring the cluster-wide proxy on the External DNS Operator
- CIDR range definitions
- AWS Load Balancer Operator
  - AWS Load Balancer Operator release notes
  - Understanding the AWS Load Balancer Operator
  - Installing the AWS Load Balancer Operator
  - Installing the AWS Load Balancer Operator on a cluster that uses AWS STS
  - Creating an instance of the AWS Load Balancer Controller
  - Serving multiple ingress resources through a single AWS Load Balancer
  - Adding TLS termination on the AWS Load Balancer
  - Configuring cluster-wide proxy on the AWS Load Balancer Operator
- Multiple networks
  - Understanding multiple networks
  - Configuring an additional network
  - About virtual routing and forwarding
  - Configuring multi-network policy
  - Attaching a pod to an additional network
  - Removing a pod from an additional network
  - Editing an additional network
  - Removing an additional network
  - Assigning a secondary network to a VRF
- Hardware networks
  - About Single Root I/O Virtualization (SR-IOV) hardware networks
  - Installing the SR-IOV Operator
  - Configuring the SR-IOV Operator
  - Configuring an SR-IOV network device
  - Configuring an SR-IOV Ethernet network attachment
  - Configuring an SR-IOV InfiniBand network attachment
  - Adding a pod to an SR-IOV network
  - Configuring interface-level network sysctl settings and all-multicast mode for SR-IOV networks
  - Configuring QinQ support for SR-IOV networks
  - Using high performance multicast
  - Using DPDK and RDMA
  - Using pod-level bonding for secondary networks
  - Configuring hardware offloading
  - Switching Bluefield-2 from NIC to DPU mode
  - Uninstalling the SR-IOV Operator
- OVN-Kubernetes network plugin
  - About the OVN-Kubernetes network plugin
  - OVN-Kubernetes architecture
  - OVN-Kubernetes troubleshooting
  - OVN-Kubernetes traffic tracing
  - Migrating from the OpenShift SDN network plugin
  - Rolling back to the OpenShift SDN network plugin
  - Converting to IPv4/IPv6 dual stack networking
  - Configuring internal subnets
  - Configure an external gateway on the default network
  - Configuring an egress IP address
  - Assigning an egress IP address
  - Configuring an egress service
  - Considerations for the use of an egress router pod
  - Deploying an egress router pod in redirect mode
  - Enabling multicast for a project
  - Disabling multicast for a project
  - Tracking network flows
  - Configuring hybrid networking
- OpenShift SDN network plugin
  - About the OpenShift SDN network plugin
  - Configuring egress IPs for a project
  - Configuring an egress firewall for a project
  - Viewing an egress firewall for a project
  - Editing an egress firewall for a project
  - Removing an egress firewall from a project
  - Considerations for the use of an egress router pod
  - Deploying an egress router pod in redirect mode
  - Deploying an egress router pod in HTTP proxy mode
  - Deploying an egress router pod in DNS proxy mode
  - Configuring an egress router pod destination list from a config map
  - Enabling multicast for a project
  - Disabling multicast for a project
  - Configuring multitenant isolation
  - Configuring kube-proxy
- Configuring Routes
  - Route configuration
  - Secured routes
- Configuring ingress cluster traffic
  - Overview
  - Configuring ExternalIPs for services
  - Configuring ingress cluster traffic using an Ingress Controller
  - Configuring the Ingress Controller endpoint publishing strategy
  - Configuring ingress cluster traffic using a load balancer
  - Configuring ingress cluster traffic on AWS
  - Configuring ingress cluster traffic using a service external IP
  - Configuring ingress cluster traffic using a NodePort
  - Configuring ingress cluster traffic using load balancer allowed source ranges
- Kubernetes NMState
  - About the Kubernetes NMState Operator
  - Observing and updating node network state and configuration
  - Troubleshooting node network configuration
- Configuring the cluster-wide proxy
- Configuring a custom PKI
- Load balancing on OpenStack
- Load balancing with MetalLB
  - About MetalLB and the MetalLB Operator
  - Installing the MetalLB Operator
  - Upgrading the MetalLB Operator
  - Configuring MetalLB address pools
  - Advertising the IP address pools
  - Configuring MetalLB BGP peers
  - Advertising an IP address pool using the community alias
  - Configuring MetalLB BFD profiles
  - Configuring services to use MetalLB
  - Managing symmetric routing with MetalLB
  - Configuring the integration of MetalLB and FRR-K8s
  - MetalLB logging, troubleshooting, and support
- Associating secondary interfaces metrics to network attachments
Storage
- Storage overview
- Understanding ephemeral storage
- Understanding persistent storage
- Configuring persistent storage
- Using Container Storage Interface (CSI)
- Generic ephemeral volumes
- Expanding persistent volumes
- Dynamic provisioning
Registry
- Registry overview
- Image Registry Operator in OpenShift Container Platform
- Setting up and configuring the registry
- Accessing the registry
- Exposing the registry
Operators
- Operators overview
- Understanding Operators
- User tasks
  - Creating applications from installed Operators
  - Installing Operators in your namespace
- Administrator tasks
- Developing Operators
- Cluster Operators reference
- OLM 1.0 (Technology Preview)
CI/CD
- CI/CD overview
- Builds using Shipwright
  - Overview of Builds
- Builds using BuildConfig
- Pipelines
  - About OpenShift Pipelines
- GitOps
  - About OpenShift GitOps
- Jenkins
Images
- Overview of images
- Configuring the Cluster Samples Operator
- Using the Cluster Samples Operator with an alternate registry
- Creating images
- Managing images
- 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
Building applications
- Building applications overview
- Projects
- Creating applications
- Viewing application composition by using the Topology view
- Exporting applications
- Working with Helm charts
- Deployments
- 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 configuration
- Machine configuration overview
- Using machine config objects to configure nodes
- Using node disruption policies to minimize disruption from machine config changes
- Configuring MCO-related custom resources
- Updated boot images
- Managing unused rendered machine configs
- Red Hat Enterprise Linux (RHEL) CoreOS image layering
- Machine Config Daemon metrics
Machine management
- Overview of machine management
- Managing compute machines with the Machine api
- 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
- Managing control plane machines
- Managing machines with the Cluster api
- Deploying machine health checks
Hosted control planes
- Hosted control planes overview
- Getting started with hosted control planes
- Authentication and authorization for hosted control planes
- Handling a machine configuration for hosted control planes
- Using feature gates in a hosted cluster
- Updating hosted control planes
- Hosted control planes Observability
- High availability for hosted control planes
- Troubleshooting hosted control planes
Nodes
- Overview of nodes
- Working with pods
- Automatically scaling pods with the Custom Metrics Autoscaler Operator
- Controlling pod placement onto nodes (scheduling)
- Using Jobs and DaemonSets
  - Running background tasks on nodes automatically with daemonsets
  - Running tasks in pods using jobs
- Working with nodes
- Working with containers
- Working with clusters
- 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
- Release notes
  - Red Hat OpenShift support for Windows Containers release notes
  - Past releases
- Getting support
- Understanding Windows container workloads
- Enabling Windows container workloads
- Creating Windows machine sets
- Scheduling Windows container workloads
- Windows node upgrades
- Using Bring-Your-Own-Host Windows instances as nodes
- Removing Windows nodes
- Disabling Windows container workloads
OpenShift sandboxed containers
- Documentation moved
Observability
- Observability overview
- Monitoring
- Logging
- Distributed tracing
- Red Hat build of OpenTelemetry
- Network Observability
- Power Monitoring
- Cluster Observability Operator
Scalability and performance
- Scalability and performance overview
- Recommended performance and scalability practices
- Reference design specifications
- Planning your environment according to object maximums
- Compute Resource Quotas
- 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
- Managing bare metal hosts
- Monitoring bare-metal events
- What huge pages do and how they are consumed by apps
- Low latency tuning
- Improving cluster stability in high latency environments using worker latency profiles
- Workload partitioning
- Using the Node Observability Operator
Edge computing
- Challenges of the network far edge
- Preparing the hub cluster for ZTP
- Updating GitOps ZTP
- Installing managed clusters with RHACM and SiteConfig resources
- Manually installing a single-node OpenShift cluster with GitOps ZTP
- Recommended single-node OpenShift cluster configuration for vDU application workloads
- Validating cluster tuning for vDU application workloads
- Advanced managed cluster configuration with SiteConfig resources
- Managing cluster polices with PolicyGenerator resources
- Managing cluster polices with PolicyGenTemplate resources
- Using hub templates in PolicyGenerator or PolicyGenTemplate CRs
- Updating managed clusters with the Topology Aware Lifecycle Manager
- Expanding single-node OpenShift clusters with GitOps ZTP
- Pre-caching images for single-node OpenShift deployments
- Image-based upgrade for single-node OpenShift clusters
- Day 2 operations for telco core CNF clusters
  - Upgrading telco core CNF clusters
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
- Control plane backup and restore
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
- 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]
  - SelfSubjectReview [authentication.k8s.io/v1]
  - TokenRequest [authentication.k8s.io/v1]
  - TokenReview [authentication.k8s.io/v1]
  - LocalSubjectAccessReview [authorization.k8s.io/v1]
  - SelfSubjectAccessReview [authorization.k8s.io/v1]
  - SelfSubjectRulesReview [authorization.k8s.io/v1]
  - SubjectAccessReview [authorization.k8s.io/v1]
- Autoscale apis
  - About Autoscale apis
  - ClusterAutoscaler [autoscaling.openshift.io/v1]
  - MachineAutoscaler [autoscaling.openshift.io/v1beta1]
  - HorizontalPodAutoscaler [autoscaling/v2]
  - Scale [autoscaling/v1]
- Config apis
  - About Config apis
  - apiServer [config.openshift.io/v1]
  - Authentication [config.openshift.io/v1]
  - Build [config.openshift.io/v1]
  - ClusterOperator [config.openshift.io/v1]
  - ClusterVersion [config.openshift.io/v1]
  - Console [config.openshift.io/v1]
  - DNS [config.openshift.io/v1]
  - FeatureGate [config.openshift.io/v1]
  - HelmChartRepository [helm.openshift.io/v1beta1]
  - Image [config.openshift.io/v1]
  - ImageDigestMirrorSet [config.openshift.io/v1]
  - ImageContentPolicy [config.openshift.io/v1]
  - ImageTagMirrorSet [config.openshift.io/v1]
  - Infrastructure [config.openshift.io/v1]
  - Ingress [config.openshift.io/v1]
  - Network [config.openshift.io/v1]
  - Node [config.openshift.io/v1]
  - OAuth [config.openshift.io/v1]
  - OperatorHub [config.openshift.io/v1]
  - Project [config.openshift.io/v1]
  - ProjectHelmChartRepository [helm.openshift.io/v1beta1]
  - Proxy [config.openshift.io/v1]
  - Scheduler [config.openshift.io/v1]
- Console apis
  - About Console apis
  - ConsoleCLIDownload [console.openshift.io/v1]
  - ConsoleExternalLogLink [console.openshift.io/v1]
  - ConsoleLink [console.openshift.io/v1]
  - ConsoleNotification [console.openshift.io/v1]
  - ConsolePlugin [console.openshift.io/v1]
  - ConsoleQuickStart [console.openshift.io/v1]
  - ConsoleSample [console.openshift.io/v1]
  - ConsoleYAMLSample [console.openshift.io/v1]
- Extension apis
  - About Extension apis
  - apiService [apiregistration.k8s.io/v1]
  - CustomResourceDefinition [apiextensions.k8s.io/v1]
  - MutatingWebhookConfiguration [admissionregistration.k8s.io/v1]
  - ValidatingWebhookConfiguration [admissionregistration.k8s.io/v1]
- Image apis
  - About Image apis
  - Image [image.openshift.io/v1]
  - ImageSignature [image.openshift.io/v1]
  - ImageStreamImage [image.openshift.io/v1]
  - ImageStreamImport [image.openshift.io/v1]
  - ImageStreamLayers [image.openshift.io/v1]
  - ImageStreamMapping [image.openshift.io/v1]
  - ImageStream [image.openshift.io/v1]
  - ImageStreamTag [image.openshift.io/v1]
  - ImageTag [image.openshift.io/v1]
  - SecretList [image.openshift.io/v1]
- Machine apis
  - About Machine apis
  - ContainerRuntimeConfig [machineconfiguration.openshift.io/v1]
  - ControllerConfig [machineconfiguration.openshift.io/v1]
  - ControlPlaneMachineSet [machine.openshift.io/v1]
  - KubeletConfig [machineconfiguration.openshift.io/v1]
  - MachineConfig [machineconfiguration.openshift.io/v1]
  - MachineConfigPool [machineconfiguration.openshift.io/v1]
  - MachineHealthCheck [machine.openshift.io/v1beta1]
  - Machine [machine.openshift.io/v1beta1]
  - MachineSet [machine.openshift.io/v1beta1]
- Metadata apis
  - About Metadata apis
  - apiRequestCount [apiserver.openshift.io/v1]
  - Binding [undefined/v1]
  - ComponentStatus [undefined/v1]
  - ConfigMap [undefined/v1]
  - ControllerRevision [apps/v1]
  - Event [events.k8s.io/v1]
  - Event [undefined/v1]
  - Lease [coordination.k8s.io/v1]
  - Namespace [undefined/v1]
- Monitoring apis
  - About Monitoring apis
  - Alertmanager [monitoring.coreos.com/v1]
  - AlertmanagerConfig [monitoring.coreos.com/v1beta1]
  - AlertRelabelConfig [monitoring.openshift.io/v1]
  - AlertingRule [monitoring.openshift.io/v1]
  - PodMonitor [monitoring.coreos.com/v1]
  - Probe [monitoring.coreos.com/v1]
  - Prometheus [monitoring.coreos.com/v1]
  - PrometheusRule [monitoring.coreos.com/v1]
  - ServiceMonitor [monitoring.coreos.com/v1]
  - ThanosRuler [monitoring.coreos.com/v1]
- Network apis
  - About Network apis
  - AdminNetworkPolicy [policy.networking.k8s.io/v1alpha1]
  - AdminPolicyBasedExternalRoute [k8s.ovn.org/v1]
  - BaselineAdminNetworkPolicy [policy.networking.k8s.io/v1alpha1]
  - CloudPrivateIPConfig [cloud.network.openshift.io/v1]
  - EgressFirewall [k8s.ovn.org/v1]
  - EgressIP [k8s.ovn.org/v1]
  - EgressQoS [k8s.ovn.org/v1]
  - EgressService [k8s.ovn.org/v1]
  - Endpoints [undefined/v1]
  - EndpointSlice [discovery.k8s.io/v1]
  - EgressRouter [network.operator.openshift.io/v1]
  - Ingress [networking.k8s.io/v1]
  - IngressClass [networking.k8s.io/v1]
  - IPAddress [ipam.cluster.x-k8s.io/v1beta1]
  - IPAddressClaim [ipam.cluster.x-k8s.io/v1beta1]
  - IPPool [whereabouts.cni.cncf.io/v1alpha1]
  - NetworkAttachmentDefinition [k8s.cni.cncf.io/v1]
  - NetworkPolicy [networking.k8s.io/v1]
  - OverlappingRangeIPReservation [whereabouts.cni.cncf.io/v1alpha1]
  - PodNetworkConnectivityCheck [controlplane.operator.openshift.io/v1alpha1]
  - Route [route.openshift.io/v1]
  - Service [undefined/v1]
- Node apis
  - About Node apis
  - Node [undefined/v1]
  - PerformanceProfile [performance.openshift.io/v2]
  - Profile [tuned.openshift.io/v1]
  - RuntimeClass [node.k8s.io/v1]
  - Tuned [tuned.openshift.io/v1]
- OAuth apis
  - About OAuth apis
  - OAuthAccessToken [oauth.openshift.io/v1]
  - OAuthAuthorizeToken [oauth.openshift.io/v1]
  - OAuthClientAuthorization [oauth.openshift.io/v1]
  - OAuthClient [oauth.openshift.io/v1]
  - UserOAuthAccessToken [oauth.openshift.io/v1]
- Operator apis
  - About Operator apis
  - Authentication [operator.openshift.io/v1]
  - CloudCredential [operator.openshift.io/v1]
  - ClusterCSIDriver [operator.openshift.io/v1]
  - Console [operator.openshift.io/v1]
  - Config [operator.openshift.io/v1]
  - Config [imageregistry.operator.openshift.io/v1]
  - Config [samples.operator.openshift.io/v1]
  - CSISnapshotController [operator.openshift.io/v1]
  - DNS [operator.openshift.io/v1]
  - DNSRecord [ingress.operator.openshift.io/v1]
  - Etcd [operator.openshift.io/v1]
  - ImageContentSourcePolicy [operator.openshift.io/v1alpha1]
  - ImagePruner [imageregistry.operator.openshift.io/v1]
  - IngressController [operator.openshift.io/v1]
  - InsightsOperator [operator.openshift.io/v1]
  - KubeapiServer [operator.openshift.io/v1]
  - KubeControllerManager [operator.openshift.io/v1]
  - KubeScheduler [operator.openshift.io/v1]
  - KubeStorageVersionMigrator [operator.openshift.io/v1]
  - MachineConfiguration [operator.openshift.io/v1]
  - Network [operator.openshift.io/v1]
  - OpenShiftapiServer [operator.openshift.io/v1]
  - OpenShiftControllerManager [operator.openshift.io/v1]
  - OperatorPKI [network.operator.openshift.io/v1]
  - ServiceCA [operator.openshift.io/v1]
  - Storage [operator.openshift.io/v1]
- OperatorHub apis
  - About OperatorHub apis
  - CatalogSource [operators.coreos.com/v1alpha1]
  - ClusterServiceVersion [operators.coreos.com/v1alpha1]
  - InstallPlan [operators.coreos.com/v1alpha1]
  - OLMConfig [operators.coreos.com/v1]
  - Operator [operators.coreos.com/v1]
  - OperatorCondition [operators.coreos.com/v2]
  - OperatorGroup [operators.coreos.com/v1]
  - PackageManifest [packages.operators.coreos.com/v1]
  - Subscription [operators.coreos.com/v1alpha1]
- Policy apis
  - About Policy apis
  - Eviction [policy/v1]
  - PodDisruptionBudget [policy/v1]
- Project apis
  - About Project apis
  - Project [project.openshift.io/v1]
  - ProjectRequest [project.openshift.io/v1]
- Provisioning apis
  - About Provisioning apis
  - BMCEventSubscription [metal3.io/v1alpha1]
  - BareMetalHost [metal3.io/v1alpha1]
  - DataImage [metal3.io/v1alpha1]
  - FirmwareSchema [metal3.io/v1alpha1]
  - HardwareData [metal3.io/v1alpha1]
  - HostFirmwareComponents [metal3.io/v1alpha1]
  - HostFirmwareSettings [metal3.io/v1alpha1]
  - Metal3Remediation [infrastructure.cluster.x-k8s.io/v1beta1]
  - Metal3RemediationTemplate [infrastructure.cluster.x-k8s.io/v1beta1]
  - PreprovisioningImage [metal3.io/v1alpha1]
  - Provisioning [metal3.io/v1alpha1]
- RBAC apis
  - About RBAC apis
  - ClusterRoleBinding [rbac.authorization.k8s.io/v1]
  - ClusterRole [rbac.authorization.k8s.io/v1]
  - RoleBinding [rbac.authorization.k8s.io/v1]
  - Role [rbac.authorization.k8s.io/v1]
- Role apis
  - About Role apis
  - ClusterRoleBinding [authorization.openshift.io/v1]
  - ClusterRole [authorization.openshift.io/v1]
  - RoleBindingRestriction [authorization.openshift.io/v1]
  - RoleBinding [authorization.openshift.io/v1]
  - Role [authorization.openshift.io/v1]
- Schedule and quota apis
  - About Schedule and quota apis
  - AppliedClusterResourceQuota [quota.openshift.io/v1]
  - ClusterResourceQuota [quota.openshift.io/v1]
  - FlowSchema [flowcontrol.apiserver.k8s.io/v1]
  - LimitRange [undefined/v1]
  - PriorityClass [scheduling.k8s.io/v1]
  - PriorityLevelConfiguration [flowcontrol.apiserver.k8s.io/v1]
  - ResourceQuota [undefined/v1]
- Security apis
  - About Security apis
  - CertificateSigningRequest [certificates.k8s.io/v1]
  - CredentialsRequest [cloudcredential.openshift.io/v1]
  - PodSecurityPolicyReview [security.openshift.io/v1]
  - PodSecurityPolicySelfSubjectReview [security.openshift.io/v1]
  - PodSecurityPolicySubjectReview [security.openshift.io/v1]
  - RangeAllocation [security.openshift.io/v1]
  - Secret [undefined/v1]
  - SecurityContextConstraints [security.openshift.io/v1]
  - ServiceAccount [undefined/v1]
- Storage apis
  - About Storage apis
  - CSIDriver [storage.k8s.io/v1]
  - CSINode [storage.k8s.io/v1]
  - CSIStorageCapacity [storage.k8s.io/v1]
  - PersistentVolume [undefined/v1]
  - PersistentVolumeClaim [undefined/v1]
  - StorageClass [storage.k8s.io/v1]
  - StorageState [migration.k8s.io/v1alpha1]
  - StorageVersionMigration [migration.k8s.io/v1alpha1]
  - VolumeAttachment [storage.k8s.io/v1]
  - VolumeSnapshot [snapshot.storage.k8s.io/v1]
  - VolumeSnapshotClass [snapshot.storage.k8s.io/v1]
  - VolumeSnapshotContent [snapshot.storage.k8s.io/v1]
- Template apis
  - About Template apis
  - BrokerTemplateInstance [template.openshift.io/v1]
  - PodTemplate [undefined/v1]
  - Template [template.openshift.io/v1]
  - TemplateInstance [template.openshift.io/v1]
- User and group apis
  - About User and group apis
  - Group [user.openshift.io/v1]
  - Identity [user.openshift.io/v1]
  - UserIdentityMapping [user.openshift.io/v1]
  - User [user.openshift.io/v1]
- Workloads apis
  - About Workloads apis
  - BuildConfig [build.openshift.io/v1]
  - Build [build.openshift.io/v1]
  - BuildLog [build.openshift.io/v1]
  - BuildRequest [build.openshift.io/v1]
  - CronJob [batch/v1]
  - DaemonSet [apps/v1]
  - Deployment [apps/v1]
  - DeploymentConfig [apps.openshift.io/v1]
  - DeploymentConfigRollback [apps.openshift.io/v1]
  - DeploymentLog [apps.openshift.io/v1]
  - DeploymentRequest [apps.openshift.io/v1]
  - Job [batch/v1]
  - Pod [undefined/v1]
  - ReplicationController [undefined/v1]
  - ReplicaSet [apps/v1]
  - StatefulSet [apps/v1]
Lightspeed
- About Lightspeed
  - OpenShift Lightspeed overview
Service Mesh
- Service Mesh 3.x
  - OpenShift Service Mesh 3.0 TP1 overview
- Service Mesh 2.x
- Service Mesh 1.x
Virtualization
- About
- Release notes
  - OpenShift Virtualization release notes
- Getting started
  - Getting started with OpenShift Virtualization
  - virtctl and libguestfs
- Installing
- Postinstallation configuration
- Updating
  - Updating OpenShift Virtualization
- Virtual machines
- Networking
- Storage
- Live migration
- Nodes
- Monitoring
- Support
- Backup and restore

ConsoleCLIDownload [console.openshift.io/v1]
ConsoleExternalLogLink [console.openshift.io/v1]
ConsoleLink [console.openshift.io/v1]
ConsoleNotification [console.openshift.io/v1]
ConsolePlugin [console.openshift.io/v1]
ConsoleQuickStart [console.openshift.io/v1]
ConsoleSample [console.openshift.io/v1]
ConsoleYAMLSample [console.openshift.io/v1]

ConsoleCLIDownload [console.openshift.io/v1]

Description: ConsoleCLIDownload is an extension for configuring openshift web console command line interface (CLI) downloads. Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).
Type: object

ConsoleExternalLogLink [console.openshift.io/v1]

Description: ConsoleExternalLogLink is an extension for customizing OpenShift web console log links. Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).
Type: object

ConsoleLink [console.openshift.io/v1]

Description: ConsoleLink is an extension for customizing OpenShift web console links. Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).
Type: object

ConsoleNotification [console.openshift.io/v1]

Description: ConsoleNotification is the extension for configuring openshift web console notifications. Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).
Type: object

ConsolePlugin [console.openshift.io/v1]

Description: ConsolePlugin is an extension for customizing OpenShift web console by dynamically loading code from another service running on the cluster. Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).
Type: object

ConsoleQuickStart [console.openshift.io/v1]

Description: ConsoleQuickStart is an extension for guiding user through various workflows in the OpenShift web console. Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).
Type: object

ConsoleSample [console.openshift.io/v1]

Description: ConsoleSample is an extension to customizing OpenShift web console by adding samples. Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).
Type: object

ConsoleYAMLSample [console.openshift.io/v1]

Description: ConsoleYAMLSample is an extension for customizing OpenShift web console YAML samples. Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).
Type: object