Welcome to the official OKD 4.7 documentation, where you can find information to help you learn about OKD and start exploring its features.

To navigate the OKD 4.7 documentation, you can either

  • Use the left navigation bar to browse the documentation or

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

You can start with Architecture and Security and compliance.

Cluster installer activities

As someone setting out to install an OKD 4.7 cluster, this documentation helps you:

  • Install a cluster on oVirt: You can deploy clusters on oVirt with a quick install or an install with customizations.

  • Install a cluster in a restricted network: If your cluster that uses user-provisioned infrastructure on AWS, GCP, vSphere, or bare metal does not have full access to the internet, you can mirror the OKD installation images and install a cluster in a restricted network.

  • Install a cluster in an existing network: If you use an existing Virtual Private Cloud (VPC) in AWS or GCP or an existing VNet on Azure, you can install a cluster.

  • Install a private cluster: If your cluster does not require external internet access, you can install a private cluster on AWS, Azure, or GCP. Internet access is still required to access the cloud APIs and installation media.

  • Check installation logs: Access installation logs to evaluate issues that occur during OKD 4.7 installation.

  • Access OKD: Use credentials output at the end of the installation process to log in to the OKD cluster from the command line or web console.

  • Install Red Hat OpenShift Container Storage: You can install Red Hat OpenShift Container Storage as an Operator to provide highly integrated and simplified persistent storage management for containers.

Developer activities

Ultimately, OKD is a platform for developing and deploying containerized applications. As an application developer, OKD documentation helps you:

Use the Topology view to visually interact with 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 developers to focus on developing their 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 Operators: Operators are the preferred method for creating on-cluster applications for OKD 4.7. Learn about the Operator Framework and how to deploy applications using installed Operators into your projects.

  • 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. Use the Workloads page or oc CLI to manage deployments. 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.

  • Develop Operators: Operators are the preferred method for creating on-cluster applications for OKD 4.7. 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: Lists OKD application programming interface endpoints.

Cluster administrator activities

Ongoing tasks on your OKD 4.7 cluster include various activities for managing machines, providing services to users, and following monitoring and logging features that watch over the cluster. As a cluster administrator, this documentation helps you:

Manage cluster components

Change cluster components

Monitor the cluster