OpenShift Documentation

repository·main·Indexed 21 days ago

https://github.com/openshift/openshift-docs

Source files and guides for OpenShift, including the Knative (kn) CLI for OpenShift Serverless, Red Hat OpenShift Service on AWS (ROSA) infrastructure management, and image mirroring for disconnected environments using the oc-mirror plugin v2.

Tokens
219.9K
Snippets
432
Records
789
Agent score
75%

What's inside OpenShift Documentation

  1. Overview of the Knative (kn) CLI

    main

    The Knative (kn) CLI is a tool designed to simplify interaction with Knative components on OpenShift Serverless. It allows for managing serverless computing tasks through a concise command-line interface.

    Key capabilities include:

    • Deploying applications: Deploy serverless applications directly from the command line.
    • Managing Knative Serving: Control services, revisions, and traffic-splitting.
    • Managing Knative Eventing: Create and manage event sources and triggers.
    • Sink Bindings: Create sink bindings to connect existing Kubernetes applications with Knative services.
    • Extensibility: Use a flexible plugin architecture similar to kubectl to extend functionality.
    • Autoscaling: Configure autoscaling parameters for Knative services.
    • Automation: Support for scripted usage, such as waiting for operation results or implementing custom rollout and rollback strategies.
  2. What is Red Hat OpenShift Service on AWS (ROSA)?

    main

    Red Hat OpenShift Service on AWS (ROSA) is a fully-managed, turnkey application platform. It is designed to allow developers to focus on application delivery by offloading infrastructure management to Red Hat and AWS SRE experts.

    Key characteristics include:

    • Managed Infrastructure: Red Hat and AWS manage the underlying platform.
    • AWS Integration: Seamless integration with AWS compute, database, analytics, machine learning, networking, and other services.
    • Security Model: Uses AWS Security Token Service (STS) to manage infrastructure via short-term, limited-privilege credentials associated with specific IAM roles.
  3. Overview of mirroring images with oc-mirror plugin v2

    main

    In disconnected environments, you can run an OpenShift cluster by installing it from a mirrored set of container images hosted in a private registry. This registry must remain available as long as the cluster is running.

    To mirror images to a mirror registry in fully or partially disconnected environments, use the oc-mirror plugin v2.

    Important Requirements:

    • Internet Connectivity: To download required images from official Red Hat registries, you must run oc-mirror plugin v2 from a system with internet connectivity.
    • Registry Support: Your container image registry must support Docker V2-2.
    • High Availability: The mirror registry must be highly available to ensure that installation, updates, and workload relocations do not fail.
  4. Overview of the SR-IOV Operator

    main

    The SR-IOV Operator provisions and configures the SR-IOV CNI (Container Network Interface) and device plugins. It supports both netdevice (kernel VFs) and vfio (DPDK) device types, which are applicable to RAN DU (Radio Access Network Distributed Unit) use models.

    Key characteristics:

    • Driver Support: Supports netdevice and vfio drivers.
    • IOMMU: The SR-IOV Network Operator automatically enables IOMMU on the kernel command line via a MachineConfig CR at install time to prevent reboots when adding SriovOperator CRs later.
    • Link State: SR-IOV VFs do not receive link state updates from the Physical Function (PF). If link down detection is required, it must be configured at the protocol level.
  5. Identify Service Mesh add-ons and integrations

    main

    The Service Mesh includes several bundled add-ons for observability, management, and storage:

    • Kiali: The management console providing dashboards, observability, and mesh topology visualization. It integrates with Prometheus and Jaeger.
    • Prometheus: Used to store telemetry information from services. Kiali relies on Prometheus for metrics and health status.
    • Jaeger: A traceability server used to centralize and display traces for requests moving between multiple services.
    • Elasticsearch: A JSON-based search and analytics engine used by Jaeger for persistent storage.
    • Grafana: Provides advanced query and metrics analysis dashboards for Istio data.

    Supported Integrations

    • 3scale: Integration with Red Hat 3scale API Management.
      • For versions prior to 2.1: Achieved via the 3scale Istio adapter.
      • For version 2.1 and later: Achieved via a WebAssembly module.
  6. Capabilities included in {oke}

    main

    An {oke} subscription provides an enterprise-ready Kubernetes environment with the following capabilities:

    • Automated Operations: Fully automated installers (IPI), customizable installers (UPI), and over-the-air smart upgrades.
    • Security: Enterprise-secured Kubernetes using the same security context constraints (SCC), pod security policies, and SELinux integration as {product-title}.
    • Management: Administrator web console, Operator Lifecycle Manager (OLM), and support for oc and kubectl.
    • Networking: Full access to Kubernetes CNI, support for third-party SDNs, OVN Kubernetes overlay, Multus, and Kubernetes Network Policies. Includes HAProxy edge routing via the Route API.
    • Storage: Support for all storage plugins supported by {product-title}.
    • Virtualization: Support for Red Hat offerings derived from the kubevirt.io project.
    • Monitoring: Integrated cluster monitoring based on Prometheus.
    • Compatibility: Compatible with {rh-storage}, {quay}, and individual Red Hat Middleware products.
  7. Access OpenShift documentation

    main

    You can view the published OpenShift documentation at https://docs.openshift.com. Depending on your needs, you may be looking for documentation specific to one of the following products:

    • OKD: The community distribution of Kubernetes and OpenShift.
    • OpenShift Online: Managed OpenShift service.
    • OpenShift Container Platform: The core OpenShift product.
    • OpenShift Dedicated: Managed OpenShift clusters for enterprise customers.
  8. What information is collected by Telemetry

    main

    OpenShift Telemetry collects system, sizing, and usage information to assist with product improvement and support.

    System Information

    • Version & Updates: Cluster version, installed update details, update availability, update channels, image repositories, update progress, and update error counts.
    • Identifiers: The unique random identifier generated during installation.
    • Configuration: Node configuration at the cloud infrastructure level, hostnames, IP addresses, Kubernetes pod names, namespaces, and services.
    • Component Status: Installed framework components and their condition/status, information about degraded software, and certificate validity.
    • Operator Events: Events for all namespaces listed as "related objects" for a degraded Operator.
    • Platform Details: The provider platform name and data center location.

    Sizing Information

    • Hardware/Resources: Cluster sizing, machine types, and machine-specific details (CPU cores and RAM usage).
    • Virtualization: Number of running virtual machine instances (in virtual clusters).
    • Storage/Scale: Number of etcd members and the number of objects stored in the etcd cluster.
    • Builds: Number of application builds categorized by build strategy type (except in OpenShift Dedicated environments).

    Usage Information

    • Feature Usage: Information about components, features, and extensions.
    • Preview/Unsupported Usage: Details regarding the use of Technology Previews and unsupported configurations.

    Privacy and Data Security

    Telemetry does not collect identifying information such as usernames or passwords. Red Hat does not intend to collect personal information. For more details, refer to the Red Hat Privacy Statement.

  9. Capabilities included in {product-title}

    main

    In addition to the core Kubernetes features found in {oke}, {product-title} provides an enhanced developer and platform experience including:

    • Developer Tools: Developer Web Console, Developer Application Catalog, Source-to-Image (S2I), and the odo CLI.
    • Serverless & Pipelines: OpenShift Serverless (Knative) and integrated pipelines (Jenkins and Tekton).
    • Service Mesh: OpenShift Service Mesh (Maistra and Kiali).
    • Advanced Monitoring: User Workload Monitoring and Platform Logging.
    • GitOps: Integrated GitOps capabilities via the {gitops-title} Operator.
    • Developer Spaces: Support for {openshift-dev-spaces-productname}.
    • Web Terminal: Integrated web-based terminal functionality.
  10. Benefits of using S2I

    main

    Using S2I provides several advantages over traditional Dockerfile-based builds:

    • Reproducibility: Build environments are encapsulated in versioned container images, ensuring consistent results across continuous integration (CI) pipelines and making it easy to swap runtimes.
    • Flexibility: Any Linux-based build system can be used. Scripts that process source code can be injected into builder images, allowing for easy adaptation of existing images.
    • Speed: S2I encourages representing an application in a single image layer rather than building many incremental layers in a Dockerfile, which optimizes creation and deployment times.
    • Security: Unlike standard Dockerfile builds which often run as root with broad network access, S2I builds can be launched within controlled container environments. When used with OpenShift, administrators can strictly control the privileges available to developers during the build process.
  11. Service Mesh component differences from upstream Istio

    main

    Service Mesh includes several modifications to the standard Istio implementation to optimize it for OpenShift:

    • Security: Replaces BoringSSL with OpenSSL (dynamically linked from the RHEL OS).
    • Resources: All Ingress resources are converted to OpenShift Route resources. A _maistra-version_ label is added to all resources.
    • Observability: Grafana, Tracing (Jaeger), and Kiali are enabled by default and exposed via OpenShift routes.
    • Cleanup: godebug has been removed from templates. The istio-multi ServiceAccount/ClusterRoleBinding and istio-reader ClusterRole have been removed.
    • Limitations: QUIC-based services are not supported. Deployment of TLS certificates via Istio's Secret Discovery Service (SDS) is not currently supported because it relies on a nodeagent using hostPath mounts.