Installing the cluster Observability Operator - cluster Observability Operator | Observability

This is a cache of https://docs.okd.io/4.13/observability/cluster_observability_operator/installing-the-cluster-observability-operator.html. It is a snapshot of the page at 2025-02-19T00:45:41.141+0000.

Installing the cluster Observability Operator - cluster Observability Operator | Observability | OKD 4.13

About
- Welcome
What's new?
- New features and enhancements
- Deprecated features
Architecture
- Architecture overview
- Product architecture
- Installation and update
- Control plane architecture
- Understanding OKD development
- Fedora CoreOS
Installing
- Installation overview
- Disconnected installation mirroring
- Installing on Alibaba
- Installing on AWS
- Installing on Azure
- Installing on Azure Stack Hub
- Installing on GCP
- Installing on IBM Cloud VPC
- Installing on Nutanix
- Installing on bare metal
- Deploying installer-provisioned clusters on bare metal
- Installing IBM Cloud Bare Metal (Classic)
  - Prerequisites
  - Installation workflow
- Installing on OpenStack
- Installing on oVirt
- Installing on vSphere
- Installing on VMC
- Installing on any platform
  - Installing a cluster on any platform
- Installation configuration
  - Customizing nodes
  - Configuring your firewall
- Validation and troubleshooting
  - Validating an installation
  - Troubleshooting installation issues
Post-installation configuration
- Configuring a private cluster
- Bare metal configuration
- Machine configuration tasks
- cluster tasks
- Node tasks
- Postinstallation network configuration
- Configuring image streams and image registries
- 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
- Fedora CoreOS (FCOS) image layering
Updating clusters
- Updating clusters overview
- Understanding OpenShift update duration
- Preparing to update to OKD 4.13
- 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 update using canary rollout strategy
- Updating the boot loader on Fedora CoreOS nodes using bootupd
- 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
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
- Disabling the web console
- Creating quick start tutorials
CLI tools
- CLI tools overview
- OpenShift CLI (oc)
- Developer CLI (odo)
- Knative CLI (kn) for use with OpenShift Serverless
- opm CLI
  - Installing the opm CLI
  - opm CLI reference
- Operator SDK
  - Installing the Operator SDK CLI
  - Operator SDK CLI reference
Security and compliance
- Security and compliance overview
- Container security
- Configuring certificates
- Certificate types and descriptions
- Compliance Operator
- File Integrity Operator
- Security Profiles Operator
- Viewing audit logs
- Configuring the audit log policy
- Configuring TLS security profiles
- Configuring seccomp profiles
- Allowing JavaScript-based access to the API server from additional hosts
- Encrypting etcd data
- Scanning pods for vulnerabilities
- Network-Bound Disk Encryption (NBDE)
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
- 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
- Verifying connectivity to an endpoint
- Changing the cluster network MTU
- Configuring the node port service range
- Configuring the cluster network IP address range
- Configuring IP failover
- Configuring interface-level network sysctls
- Using Stream Control Transmission Protocol
- Using Precision Time Protocol hardware
- Developing Precision Time Protocol events consumer applications
- 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
  - Migrating from Kuryr
  - 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 OVN-Kubernetes network plugin
  - Configuring egress IPs for a project
  - Configuring an egress firewall for a project
  - Viewing an egress firewall for a project
  - Editing an egress firewall for a project
  - Removing an egress firewall from a project
  - Considerations for the use of an egress router pod
  - Deploying an egress router pod in redirect mode
  - Deploying an egress router pod in HTTP proxy mode
  - Deploying an egress router pod in DNS proxy mode
  - Configuring an egress router pod destination list from a config map
  - Enabling multicast for a project
  - Disabling multicast for a project
  - Configuring multitenant isolation
  - Configuring kube-proxy
- Configuring Routes
  - Route configuration
  - Secured routes
- Configuring ingress cluster traffic
  - Overview
  - Configuring ExternalIPs for services
  - Configuring ingress cluster traffic using an Ingress Controller
  - Configuring 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
  - Patching existing ingress objects
- 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
- Using Container Storage Interface (CSI)
- Generic ephemeral volumes
- Expanding persistent volumes
- Dynamic provisioning
Registry
- Registry overview
- Image Registry Operator in OKD
- 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
CI/CD
- CI/CD overview
  - About CI/CD
- Builds
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
- Connecting applications to services
- 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
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
- 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
- Configuring hosted control planes
- Managing hosted control planes
- Backup, restore, and disaster recovery for 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
Windows Container Support for OpenShift
- Red Hat OpenShift support for Windows Containers overview
- Release notes
- 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
Observability
- Observability overview
  - About Observability
- Monitoring
- Logging
- Network Observability
- cluster Observability Operator
Scalability and performance
- Scalability and performance overview
- Recommended performance and scalability practices
- Planning your environment according to object maximums
- Compute Resource Quotas
- 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
- 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
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 OKD 3 to 4
- Differences between OKD 3 and 4
- Network considerations
- About MTC
- Installing MTC
- Installing MTC in a restricted network environment
- Upgrading MTC
- Premigration checklists
- Migrating your applications
- Advanced migration options
- Troubleshooting
Migration Toolkit for Containers
- About MTC
- MTC release notes
- 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]
  - ImageDigestMirrorSet [config.openshift.io/v1]
  - ImageContentPolicy [config.openshift.io/v1]
  - ImageTagMirrorSet [config.openshift.io/v1]
  - Infrastructure [config.openshift.io/v1]
  - Ingress [config.openshift.io/v1]
  - Network [config.openshift.io/v1]
  - Node [config.openshift.io/v1]
  - OAuth [config.openshift.io/v1]
  - OperatorHub [config.openshift.io/v1]
  - Project [config.openshift.io/v1]
  - ProjectHelmChartRepository [helm.openshift.io/v1beta1]
  - Proxy [config.openshift.io/v1]
  - Scheduler [config.openshift.io/v1]
- Console APIs
  - About Console APIs
  - ConsoleCLIDownload [console.openshift.io/v1]
  - ConsoleExternalLogLink [console.openshift.io/v1]
  - ConsoleLink [console.openshift.io/v1]
  - ConsoleNotification [console.openshift.io/v1]
  - ConsolePlugin [console.openshift.io/v1]
  - ConsoleQuickStart [console.openshift.io/v1]
  - ConsoleYAMLSample [console.openshift.io/v1]
- Extension APIs
  - About Extension APIs
  - APIService [apiregistration.k8s.io/v1]
  - CustomResourceDefinition [apiextensions.k8s.io/v1]
  - MutatingWebhookConfiguration [admissionregistration.k8s.io/v1]
  - ValidatingWebhookConfiguration [admissionregistration.k8s.io/v1]
- Image APIs
  - About Image APIs
  - Image [image.openshift.io/v1]
  - ImageSignature [image.openshift.io/v1]
  - ImageStreamImage [image.openshift.io/v1]
  - ImageStreamImport [image.openshift.io/v1]
  - ImageStreamLayers [image.openshift.io/v1]
  - ImageStreamMapping [image.openshift.io/v1]
  - ImageStream [image.openshift.io/v1]
  - ImageStreamTag [image.openshift.io/v1]
  - ImageTag [image.openshift.io/v1]
  - SecretList [image.openshift.io/v1]
- Machine APIs
  - About Machine APIs
  - ContainerRuntimeConfig [machineconfiguration.openshift.io/v1]
  - ControllerConfig [machineconfiguration.openshift.io/v1]
  - ControlPlaneMachineSet [machine.openshift.io/v1]
  - KubeletConfig [machineconfiguration.openshift.io/v1]
  - MachineConfigPool [machineconfiguration.openshift.io/v1]
  - MachineConfig [machineconfiguration.openshift.io/v1]
  - MachineHealthCheck [machine.openshift.io/v1beta1]
  - Machine [machine.openshift.io/v1beta1]
  - MachineSet [machine.openshift.io/v1beta1]
- Metadata APIs
  - About Metadata APIs
  - APIRequestCount [apiserver.openshift.io/v1]
  - Binding [undefined/v1]
  - ComponentStatus [undefined/v1]
  - ConfigMap [undefined/v1]
  - ControllerRevision [apps/v1]
  - Event [events.k8s.io/v1]
  - Event [undefined/v1]
  - Lease [coordination.k8s.io/v1]
  - Namespace [undefined/v1]
- Monitoring APIs
  - About Monitoring APIs
  - Alertmanager [monitoring.coreos.com/v1]
  - AlertmanagerConfig [monitoring.coreos.com/v1beta1]
  - PodMonitor [monitoring.coreos.com/v1]
  - Probe [monitoring.coreos.com/v1]
  - Prometheus [monitoring.coreos.com/v1]
  - PrometheusRule [monitoring.coreos.com/v1]
  - ServiceMonitor [monitoring.coreos.com/v1]
  - ThanosRuler [monitoring.coreos.com/v1]
- Network APIs
  - About Network APIs
  - CloudPrivateIPConfig [cloud.network.openshift.io/v1]
  - EgressFirewall [k8s.ovn.org/v1]
  - EgressIP [k8s.ovn.org/v1]
  - EgressQoS [k8s.ovn.org/v1]
  - Endpoints [undefined/v1]
  - EndpointSlice [discovery.k8s.io/v1]
  - EgressRouter [network.operator.openshift.io/v1]
  - Ingress [networking.k8s.io/v1]
  - IngressClass [networking.k8s.io/v1]
  - IPPool [whereabouts.cni.cncf.io/v1alpha1]
  - NetworkAttachmentDefinition [k8s.cni.cncf.io/v1]
  - NetworkPolicy [networking.k8s.io/v1]
  - OverlappingRangeIPReservation [whereabouts.cni.cncf.io/v1alpha1]
  - PodNetworkConnectivityCheck [controlplane.operator.openshift.io/v1alpha1]
  - Route [route.openshift.io/v1]
  - Service [undefined/v1]
- Node APIs
  - About Node APIs
  - Node [undefined/v1]
  - PerformanceProfile [performance.openshift.io/v2]
  - Profile [tuned.openshift.io/v1]
  - RuntimeClass [node.k8s.io/v1]
  - Tuned [tuned.openshift.io/v1]
- OAuth APIs
  - About OAuth APIs
  - OAuthAccessToken [oauth.openshift.io/v1]
  - OAuthAuthorizeToken [oauth.openshift.io/v1]
  - OAuthClientAuthorization [oauth.openshift.io/v1]
  - OAuthClient [oauth.openshift.io/v1]
  - UserOAuthAccessToken [oauth.openshift.io/v1]
- Operator APIs
  - About Operator APIs
  - Authentication [operator.openshift.io/v1]
  - CloudCredential [operator.openshift.io/v1]
  - clusterCSIDriver [operator.openshift.io/v1]
  - Console [operator.openshift.io/v1]
  - Config [operator.openshift.io/v1]
  - Config [imageregistry.operator.openshift.io/v1]
  - Config [samples.operator.openshift.io/v1]
  - CSISnapshotController [operator.openshift.io/v1]
  - DNS [operator.openshift.io/v1]
  - DNSRecord [ingress.operator.openshift.io/v1]
  - Etcd [operator.openshift.io/v1]
  - ImageContentSourcePolicy [operator.openshift.io/v1alpha1]
  - ImagePruner [imageregistry.operator.openshift.io/v1]
  - IngressController [operator.openshift.io/v1]
  - InsightsOperator [operator.openshift.io/v1]
  - KubeAPIServer [operator.openshift.io/v1]
  - KubeControllerManager [operator.openshift.io/v1]
  - KubeScheduler [operator.openshift.io/v1]
  - KubeStorageVersionMigrator [operator.openshift.io/v1]
  - Network [operator.openshift.io/v1]
  - OpenShiftAPIServer [operator.openshift.io/v1]
  - OpenShiftControllerManager [operator.openshift.io/v1]
  - OperatorPKI [network.operator.openshift.io/v1]
  - ServiceCA [operator.openshift.io/v1]
  - Storage [operator.openshift.io/v1]
- OperatorHub APIs
  - About OperatorHub APIs
  - CatalogSource [operators.coreos.com/v1alpha1]
  - clusterServiceVersion [operators.coreos.com/v1alpha1]
  - InstallPlan [operators.coreos.com/v1alpha1]
  - OLMConfig [operators.coreos.com/v1]
  - Operator [operators.coreos.com/v1]
  - OperatorCondition [operators.coreos.com/v2]
  - OperatorGroup [operators.coreos.com/v1]
  - PackageManifest [packages.operators.coreos.com/v1]
  - Subscription [operators.coreos.com/v1alpha1]
- Policy APIs
  - About Policy APIs
  - Eviction [policy/v1]
  - PodDisruptionBudget [policy/v1]
- Project APIs
  - About Project APIs
  - Project [project.openshift.io/v1]
  - ProjectRequest [project.openshift.io/v1]
- Provisioning APIs
  - About Provisioning APIs
  - BMCEventSubscription [metal3.io/v1alpha1]
  - BareMetalHost [metal3.io/v1alpha1]
  - FirmwareSchema [metal3.io/v1alpha1]
  - HardwareData [metal3.io/v1alpha1]
  - HostFirmwareSettings [metal3.io/v1alpha1]
  - Metal3Remediation [infrastructure.cluster.x-k8s.io/v1beta1]
  - Metal3RemediationTemplate [infrastructure.cluster.x-k8s.io/v1beta1]
  - PreprovisioningImage [metal3.io/v1alpha1]
  - Provisioning [metal3.io/v1alpha1]
- RBAC APIs
  - About RBAC APIs
  - clusterRoleBinding [rbac.authorization.k8s.io/v1]
  - clusterRole [rbac.authorization.k8s.io/v1]
  - RoleBinding [rbac.authorization.k8s.io/v1]
  - Role [rbac.authorization.k8s.io/v1]
- Role APIs
  - About Role APIs
  - clusterRoleBinding [authorization.openshift.io/v1]
  - clusterRole [authorization.openshift.io/v1]
  - RoleBindingRestriction [authorization.openshift.io/v1]
  - RoleBinding [authorization.openshift.io/v1]
  - Role [authorization.openshift.io/v1]
- Schedule and quota APIs
  - About Schedule and quota APIs
  - AppliedclusterResourceQuota [quota.openshift.io/v1]
  - clusterResourceQuota [quota.openshift.io/v1]
  - FlowSchema [flowcontrol.apiserver.k8s.io/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]
  - PersistentVolume [undefined/v1]
  - PersistentVolumeClaim [undefined/v1]
  - StorageClass [storage.k8s.io/v1]
  - StorageState [migration.k8s.io/v1alpha1]
  - StorageVersionMigration [migration.k8s.io/v1alpha1]
  - VolumeAttachment [storage.k8s.io/v1]
  - VolumeSnapshot [snapshot.storage.k8s.io/v1]
  - VolumeSnapshotClass [snapshot.storage.k8s.io/v1]
  - VolumeSnapshotContent [snapshot.storage.k8s.io/v1]
- Template APIs
  - About Template APIs
  - BrokerTemplateInstance [template.openshift.io/v1]
  - PodTemplate [undefined/v1]
  - Template [template.openshift.io/v1]
  - TemplateInstance [template.openshift.io/v1]
- User and group APIs
  - About User and group APIs
  - Group [user.openshift.io/v1]
  - Identity [user.openshift.io/v1]
  - UserIdentityMapping [user.openshift.io/v1]
  - User [user.openshift.io/v1]
- Workloads APIs
  - About Workloads APIs
  - BuildConfig [build.openshift.io/v1]
  - Build [build.openshift.io/v1]
  - BuildLog [build.openshift.io/v1]
  - BuildRequest [build.openshift.io/v1]
  - CronJob [batch/v1]
  - DaemonSet [apps/v1]
  - Deployment [apps/v1]
  - DeploymentConfig [apps.openshift.io/v1]
  - DeploymentConfigRollback [apps.openshift.io/v1]
  - DeploymentLog [apps.openshift.io/v1]
  - DeploymentRequest [apps.openshift.io/v1]
  - Job [batch/v1]
  - Pod [undefined/v1]
  - ReplicationController [undefined/v1]
  - ReplicaSet [apps/v1]
  - StatefulSet [apps/v1]
Virtualization
- About OpenShift Virtualization
- About OKD Virtualization
- Getting started with OKD Virtualization
- Installing
- Updating OKD Virtualization
- Security policies
- Using the virtctl and libguestfs CLI tools
- Virtual machines
- Virtual machine templates
- Live migration
- Node maintenance
- Support
- Backup and restore

Installing the cluster Observability Operator in the web console
Uninstalling the cluster Observability Operator using the web console

As a cluster administrator, you can install or remove the cluster Observability Operator (COO) from OperatorHub by using the OKD web console. OperatorHub is a user interface that works in conjunction with Operator Lifecycle Manager (OLM), which installs and manages Operators on a cluster.

Installing the cluster Observability Operator in the web console

Install the cluster Observability Operator (COO) from OperatorHub by using the OKD web console.

Prerequisites

You have access to the cluster as a user with the cluster-admin cluster role.
You have logged in to the OKD web console.

Procedure

In the OKD web console, click Operators → OperatorHub.
Type cluster observability operator in the Filter by keyword box.
Click cluster Observability Operator in the list of results.
Read the information about the Operator, and configure the following installation settings:
- Update channel → stable
- Version → 1.0.0 or later
- Installation mode → All namespaces on the cluster (default)
- Installed Namespace → Operator recommended Namespace: openshift-cluster-observability-operator
- Select Enable Operator recommended cluster monitoring on this Namespace
- Update approval → Automatic
Optional: You can change the installation settings to suit your requirements. For example, you can select to subscribe to a different update channel, to install an older released version of the Operator, or to require manual approval for updates to new versions of the Operator.
Click Install.

Verification

Go to Operators → Installed Operators, and verify that the cluster Observability Operator entry appears in the list.

Additional resources

Adding Operators to a cluster

Uninstalling the cluster Observability Operator using the web console

If you have installed the cluster Observability Operator (COO) by using OperatorHub, you can uninstall it in the OKD web console.

Prerequisites

You have access to the cluster as a user with the cluster-admin cluster role.
You have logged in to the OKD web console.

Procedure

Go to Operators → Installed Operators.
Locate the cluster Observability Operator entry in the list.
Click for this entry and select Uninstall Operator.

Verification

Go to Operators → Installed Operators, and verify that the cluster Observability Operator entry no longer appears in the list.