OpenShift Container Platform
This documentation may not be available for all versions.
About
Security and compliance
- Security and compliance
- OpenShift Container Platform security and compliance
- 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)
Architecture
- Architecture
- Architecture overview
- OpenShift Container Platform 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 Container Platform development
- Red Hat Enterprise Linux CoreOS (RHCOS)
- Admission plugins
Install
Disconnected installation mirroring
Installing on Alibaba
- 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
- Installing on AWS
- Preparing to install on AWS
- Configuring an AWS account
- Manually creating IAM for AWS
- 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 China
- Installing a cluster on user-provisioned infrastructure in AWS by 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
- Installing a three-node cluster on AWS
- Uninstalling a cluster on AWS
Installing on Azure
- Installing on Azure
- Preparing to install on Azure
- Configuring an Azure account
- Manually creating IAM for Azure
- Enabling user-managed encryption for 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
- Installing a three-node cluster on Azure
- Uninstalling a cluster on Azure
Installing on Azure Stack Hub
- 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
- Installing on GCP
- Preparing to install on GCP
- Configuring a GCP project
- Manually creating IAM for GCP
- 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 user-provisioned infrastructure in GCP by 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
- Uninstalling a cluster on GCP
Installing on IBM Cloud VPC
- 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
Assisted Installer for OpenShift Container Platform
- Assisted Installer for OpenShift Container Platform
- Installing an on-premise cluster using the Assisted Installer
- Preparing to install with the Assisted Installer
- Installing with the Assisted Installer UI
- Installing with the Assisted Installer API
- Optional: Enabling disk encryption
- Optional: Installing and modifying Operators
- Configuring the discovery image
- Booting hosts with the discovery image
- Assigning roles to hosts
- Pre-installation validation
- Network configuration
- Expanding the cluster
- Optional: Installing on Nutanix
- Optional: Installing on vSphere
- Troubleshooting
Installing an on-premise cluster with the Agent-based Installer
- Installing an on-premise cluster with the Agent-based Installer
- Preparing to install with the Agent-based Installer
- Understanding disconnected installation mirroring
- Installing a cluster
- Installing a cluster with customizations
- Preparing an Agent-based installed cluster for the multicluster engine for Kubernetes Operator
Installing on a single node
Installing on bare metal
- Installing on bare metal
- Preparing for bare metal cluster installation
- 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 cluster with the Bare Metal Operator
Installing IBM Cloud Bare Metal (Classic)
Installing on IBM Z and IBM LinuxONE
- 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
- Installing a cluster with z/VM on IBM Z and IBM LinuxONE in a restricted network
- Installing a cluster with RHEL KVM on IBM Z and IBM LinuxONE
- Installing a cluster with RHEL KVM on IBM Z and IBM LinuxONE in a restricted network
- Installation configuration parameters for IBM Z and IBM LinuxONE
Installing on IBM Power Virtual Server
- Installing on IBM Power Virtual Server
- Preparing to install on {ibmpowerProductName} 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
Installing on OpenStack
- 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 RHOSP from your own infrastructure
Installing on RHV
Installing on vSphere
- 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 network customizations
- Installing a cluster on vSphere in a restricted network
- Installing a cluster on vSphere in a restricted network with user-provisioned infrastructure
- Installing a three-node cluster on vSphere
- Multiple regions and zones configuration for a cluster on vSphere
- Enabling encryption on a vSphere cluster
- 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
- 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
- Installing a three-node cluster on VMC
- Uninstalling a cluster on VMC
Installing on any platform
Validation and troubleshooting
Upgrade
Updating clusters
- Updating clusters
- Updating clusters overview
- Understanding OpenShift updates
- Understanding update channels and releases
- Understanding OpenShift Container Platform update duration
- Preparing to update to OpenShift Container Platform 4.13
- 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
- Migrating to a cluster with multi-architecture compute machines
- Performing a canary rollout update
- Updating the boot loader on RHCOS nodes using bootupd
- Updating a cluster that includes RHEL compute machines
- Updating a cluster in a disconnected environment
- Updating hardware on nodes running on vSphere
- Preflight validation for Kernel Module Management (KMM) Modules
- Updating hosted control planes
Configure
Authentication and authorization
- Authentication and authorization
- Overview of authentication and authorization
- 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
- Networking
- About networking
- Understanding networking
- Accessing hosts
- Networking Operators overview
- Cluster Network Operator in OpenShift Container Platform
- DNS Operator in OpenShift Container Platform
- Ingress Operator in OpenShift Container Platform
- Ingress Node Firewall Operator in OpenShift Container Platform
- Configuring an Ingress Controller for manual DNS Management
- Verifying connectivity to an endpoint
- Changing the MTU for the cluster network
- Configuring the node port service range
- Configuring the cluster network range
- Configuring IP failover
- Configuring interface-level network sysctls
- Using the Stream Control Transmission Protocol (SCTP)
- Using Precision Time Protocol (PTP) hardware
- Developing Precision Time Protocol events consumer applications
- External DNS Operator
- Network policy
- CIDR range definitions
- AWS Load Balancer Operator
- Multiple networks
- Hardware networks
- OVN-Kubernetes network plugin
- OpenShift SDN network plugin
- Configuring Routes
- Configuring ingress cluster traffic
- Kubernetes NMState
- Configuring the cluster-wide proxy
- Configuring a custom PKI
- Load balancing on RHOSP
- Load balancing with MetalLB
- Associating secondary interfaces metrics to network attachments
Post-installation configuration
- Post-installation configuration
- Postinstallation configuration overview
- Configuring a private cluster
- Bare metal configuration
- Configuring multi-architecture compute machines on an OpenShift Container Platform cluster
- Postinstallation machine configuration tasks
- Postinstallation cluster tasks
- Postinstallation node tasks
- Postinstallation network configuration
- Configuring image streams and image registries
- Postinstallation 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
- RHCOS image layering
Storage
- Storage
- OpenShift Container Platform storage overview
- Understanding ephemeral storage
- Understanding persistent storage
- Configuring persistent storage
- Using Container Storage Interface (CSI)
- Generic ephemeral volumes
- Expanding persistent volumes
- Dynamic provisioning
- Detach volumes after non-graceful node shutdown
Scalability and performance
- Scalability and performance
- OpenShift Container Platform scalability and performance overview
- Recommended performance and scalability practices
- Planning your environment according to object maximums
- Using quotas and limit ranges
- Recommended host practices for IBM Z & IBM(R) 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 with the Bare Metal Event Relay
- What huge pages do and how they are consumed by applications
- Low latency tuning
- Performing latency tests for platform verification
- Improving cluster stability in high latency environments using worker latency profiles
- Creating a performance profile
- Workload partitioning
- Requesting CRI-O and Kubelet profiling data by using the Node Observability Operator
- Clusters at the network far edge
Manage
Machine management
- 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 an OpenShift Container Platform cluster
- Creating infrastructure machine sets
- Adding RHEL compute machines to an OpenShift Container Platform cluster
- Adding more RHEL compute machines to an OpenShift Container Platform cluster
- Managing user-provisioned infrastructure manually
- Managing control plane machines
- Managing machines with the Cluster API
- Deploying machine health checks
Nodes
- 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
- Working with nodes
- Working with containers
- Working with clusters
- Remote worker nodes on the network edge
- Worker nodes for single-node OpenShift clusters
Web console
- 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 in OpenShift Container Platform
- Customizing the web console in OpenShift Container Platform
- Dynamic plugins
- Web terminal
- Disabling the web console in OpenShift Container Platform
- Creating quick start tutorials in the web console
Migrate
Migrating from version 3 to 4
- Migrating from version 3 to 4
- Migration from OpenShift Container Platform 3 to 4 overview
- About migrating from OpenShift Container Platform 3 to 4
- Differences between OpenShift Container Platform 3 and 4
- Network considerations
- About the Migration Toolkit for Containers
- Installing the Migration Toolkit for Containers
- Installing the Migration Toolkit for Containers in a restricted network environment
- Upgrading the Migration Toolkit for Containers
- Premigration checklists
- Migrating your applications
- Advanced migration options
- Troubleshooting
Migration Toolkit for Containers
- Migration Toolkit for Containers
- About the Migration Toolkit for Containers
- MTC release notes
- Installing the Migration Toolkit for Containers
- Installing the Migration Toolkit for Containers in a restricted network environment
- Upgrading the Migration Toolkit for Containers
- Premigration checklists
- Network considerations
- Direct Migration Requirements
- Migrating your applications
- Advanced migration options
- Troubleshooting
Develop
Serverless
Building applications
- Building applications
- Building applications overview
- Projects
- Creating applications
- Viewing application composition by using the Topology view
- Exporting applications
- Connecting applications to services
- Working with Helm charts
- Deployments
- Quotas
- Using config maps with applications
- Monitoring project and application metrics using the Developer perspective
- Monitoring application health by using health checks
- Editing applications
- Pruning objects to reclaim resources
- Idling applications
- Deleting applications
- Using the Red Hat Marketplace
Images
- 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
Specialized hardware and driver enablement
OpenShift sandboxed containers
CI/CD
CI/CD overview
Builds
- 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
Observability
Observability overview
Monitoring
- Monitoring
- Monitoring overview
- Configuring the monitoring stack
- Configuring external Alertmanager instances
- Configuring secrets for Alertmanager
- Configuring pod topology spread constraints for monitoring
- Enabling monitoring for user-defined projects
- Enabling alert routing for user-defined projects
- Managing metrics
- Managing alerts
- Reviewing monitoring dashboards
- Accessing monitoring APIs by using the CLI
- Troubleshooting monitoring issues
- Config map reference for the Cluster Monitoring Operator
Logging
- Logging
- Release notes
- Support
- Troubleshooting logging
- About Logging
- Installing Logging
- Updating Logging
- Visualizing logs
- Configuring your Logging deployment
- Log collection and forwarding
- Log storage
- Logging alerts
- Performance and reliability tuning
- Scheduling resources
- Uninstalling Logging
- Log Record Fields
- tags
- kubernetes
- OpenShift
- API reference
- Glossary
Distributed Tracing
- Distributed Tracing
- Release notes for the Red Hat OpenShift Distributed Tracing Platform
- About the Distributed Tracing Platform
- Installing the Distributed Tracing Platform
- Configuring the Distributed Tracing Platform
- Troubleshooting the Distributed Tracing Platform
- Upgrading
- Removing the Distributed Tracing Platform
- Distributed Tracing Platform (Jaeger)
Red Hat build of OpenTelemetry
- Red Hat build of OpenTelemetry
- Release notes for the Red Hat build of OpenTelemetry
- Installing
- Configuring the Collector
- Configuring the instrumentation
- Sending traces, logs, and metrics to the OpenTelemetry Collector
- Configuring metrics for the monitoring stack
- Forwarding telemetry data
- Configuring the OpenTelemetry Collector metrics
- Gathering the observability data from multiple clusters
- Troubleshooting
- Migrating
- Upgrading
- Removing
Network Observability
- Network Observability
- Network Observability Operator release notes
- About Network Observability
- Installing the Network Observability Operator
- Network Observability Operator in OpenShift Container Platform
- Configuring the Network Observability Operator
- Network Policy
- Observing the network traffic
- Using metrics with dashboards and alerts
- Monitoring the Network Observability Operator
- Scheduling resources
- Secondary networks
- Network Observability CLI
- FlowCollector API reference
- FlowMetric configuration parameters
- Network flows format reference
- Troubleshooting Network Observability
Cluster Observability Operator
Integration
Virtualization
- Virtualization
- About OpenShift Virtualization
- Supported limits
- OpenShift Virtualization architecture
- Getting started with OpenShift Virtualization
- Web console overview
- OpenShift Virtualization release notes
- Installing
- Updating OpenShift Virtualization
- Security policies
- Using the virtctl and libguestfs CLI tools
- Virtual machines
- Virtual machine templates
- Live migration
- Node maintenance
- Support
- Backup and restore
Service Mesh
Windows Container Support for OpenShift
- Windows Container Support for OpenShift
- Red Hat OpenShift support for Windows Containers overview
- Release notes
- 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 (BYOH) Windows instances as nodes
- Removing Windows nodes
- Disabling Windows container workloads
API Reference
Installing on-premise with Assisted Installer
Common object reference
Authorization APIs
- Authorization APIs
- 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]
Config APIs
- Config APIs
- 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
- Console APIs
- 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]
Image APIs
- Image APIs
- 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
- Machine APIs
- 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]
Monitoring APIs
- Monitoring APIs
- 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
- Network APIs
- Network APIs
- CloudPrivateIPConfig [cloud.network.openshift.io/v1]
- EgressFirewall [k8s.ovn.org/v1]
- EgressIP [k8s.ovn.org/v1]
- EgressQoS [k8s.ovn.org/v1]
- Endpoints [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 [v1]
Operator APIs
- Operator APIs
- 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
- OperatorHub APIs
- 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]
Provisioning APIs
- Provisioning APIs
- Provisioning APIs
- BMCEventSubscription [metal3.io/v1alpha1]
- BareMetalHost [metal3.io/v1alpha1]
- FirmwareSchema [metal3.io/v1alpha1]
- HardwareData [metal3.io/v1alpha1]
- HostFirmwareSettings [metal3.io/v1alpha1]
- Metal3Remediation [infrastructure.cluster.x-k8s.io/v1beta1]
- Metal3RemediationTemplate [infrastructure.cluster.x-k8s.io/v1beta1]
- PreprovisioningImage [metal3.io/v1alpha1]
- Provisioning [metal3.io/v1alpha1]
Schedule and quota APIs
- Schedule and quota APIs
- Schedule and quota APIs
- AppliedClusterResourceQuota [quota.openshift.io/v1]
- ClusterResourceQuota [quota.openshift.io/v1]
- FlowSchema [flowcontrol.apiserver.k8s.io/v1beta1]
- LimitRange [v1]
- PriorityClass [scheduling.k8s.io/v1]
- PriorityLevelConfiguration [flowcontrol.apiserver.k8s.io/v1beta1]
- ResourceQuota [v1]
Security APIs
- Security APIs
- 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 [v1]
- SecurityContextConstraints [security.openshift.io/v1]
- ServiceAccount [v1]
Storage APIs
- Storage APIs
- Storage APIs
- CSIDriver [storage.k8s.io/v1]
- CSINode [storage.k8s.io/v1]
- CSIStorageCapacity [storage.k8s.io/v1]
- PersistentVolume [v1]
- PersistentVolumeClaim [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]
Workloads APIs
- Workloads APIs
- 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 [v1]
- ReplicationController [v1]
- ReplicaSet [apps/v1]
- StatefulSet [apps/v1]
- Legal Notice
Monitoring
OpenShift Container Platform4.13
Configuring and using the monitoring stack in OpenShift Container Platform
Red Hat OpenShift Documentation Team
Abstract
Use metrics and customized alerts provided by the monitoring stack to track the health and performance of your applications running on OpenShift Container Platform clusters.