OKD 4.8 Documentation

Welcome to the official OKD 4.8 documentation, where you can learn about OKD and start exploring its features.

To navigate the OKD 4.8 documentation, you can use one of the following methods:

  • Use the left navigation bar to browse the documentation.

  • Select the task that interests you from the contents of this Welcome page.

Start with Architecture and Security and compliance.

Cluster installer activities

Explore these OKD installation tasks.

Developer activities

Develop and deploy containerized applications with OKD. OKD is a platform for developing and deploying containerized applications. OKD documentation helps you:

  • Understand OKD development: Learn the different types of containerized applications, from simple containers to advanced Kubernetes deployments and Operators.

  • Work with projects: Create projects from the OKD web console or OpenShift CLI (oc) to organize and share the software you develop.

  • Work with applications: Use the Developer perspective in the OKD web console to create and deploy applications. Use the Topology view to see your applications, monitor status, connect and group components, and modify your code base.

  • Use the developer CLI tool (odo): The odo CLI tool lets developers create single or multi-component applications easily and automates deployment, build, and service route configurations. It abstracts complex Kubernetes and OKD concepts, allowing you to focus on developing your applications.

  • Create CI/CD Pipelines: Pipelines are serverless, cloud-native, continuous integration and continuous deployment systems that run in isolated containers. They use standard Tekton custom resources to automate deployments and are designed for decentralized teams that work on microservices-based architecture.

  • Deploy Helm charts: Helm 3 is a package manager that helps developers define, install, and update application packages on Kubernetes. A Helm chart is a packaging format that describes an application that can be deployed using the Helm CLI.

  • Understand image builds: Choose from different build strategies (Docker, S2I, custom, and pipeline) that can include different kinds of source materials (from places like Git repositories, local binary inputs, and external artifacts). Then, follow examples of build types from basic builds to advanced builds.

  • Create container images: A container image is the most basic building block in OKD (and Kubernetes) applications. Defining image streams lets you gather multiple versions of an image in one place as you continue its development. S2I containers let you insert your source code into a base container that is set up to run code of a particular type, such as Ruby, Node.js, or Python.

  • Create deployments: Use Deployment and DeploymentConfig objects to exert fine-grained management over applications. Manage deployments using the Workloads page or OpenShift CLI (oc). Learn rolling, recreate, and custom deployment strategies.

  • Create templates: Use existing templates or create your own templates that describe how an application is built or deployed. A template can combine images with descriptions, parameters, replicas, exposed ports and other content that defines how an application can be run or built.

  • Understand Operators: Operators are the preferred method for creating on-cluster applications for OKD 4.8. Learn about the Operator Framework and how to deploy applications using installed Operators into your projects.

  • Develop Operators: Operators are the preferred method for creating on-cluster applications for OKD 4.8. Learn the workflow for building, testing, and deploying Operators. Then, create your own Operators based on Ansible or Helm, or configure built-in Prometheus monitoring using the Operator SDK.

  • REST API reference: Learn about OKD application programming interface endpoints.

Cluster administrator activities

Manage machines, provide services to users, and follow monitoring and logging reports. This documentation helps you:

Manage cluster components

Change cluster components

Monitor the cluster