OKD 4.6 Documentation

    To navigate the OKD 4.6 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 .

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

    • Install a cluster on AWS: You have the most installation options when you deploy a cluster on Amazon Web Services (AWS). You can deploy clusters with or custom AWS settings. You can also deploy a cluster on AWS infrastructure that you provisioned yourself. You can modify the provided to meet your needs.

    • Install a cluster on Azure: You can deploy clusters with , custom Azure settings, or in Microsoft Azure. You can also provision OKD into an Azure Virtual Network or use to provision your own infrastructure.

    • Install a cluster on GCP: You can deploy clusters with or custom GCP settings on Google Cloud Platform (GCP). You can also perform a GCP installation where you provision your own infrastructure.

    • : You can install OKD on supported versions of vSphere.

    • Install a cluster on bare metal: If none of the available platform and cloud providers meet your needs, you can install OKD on bare metal.

    • : You can install OKD on bare metal with an installer-provisioned architecture.

    • Create Fedora CoreOS (FCOS) machines on bare metal: You can install FCOS machines using ISO or PXE in a fully live environment and configure them with kernel arguments, Ignition configs, or the command.

    • Install a cluster on Red Hat OpenStack Platform (RHOSP): You can install a cluster on .

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

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

    • : Access installation logs to evaluate issues that occur during OKD 4.6 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.

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

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

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

    • : Create projects from the web console or CLI to organize and share the software you develop.

    • Work with applications: Use the in the OKD web console to easily create and deploy applications. Use the 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.

    • : 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.

    • : Operators are the preferred method for creating on-cluster applications for OKD 4.6. 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.

    • : 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 and objects to exert fine-grained management over applications. Use the Workloads page or CLI to . Learn rolling, recreate, and custom deployment strategies.

    • : 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.

    • Create Operators: Operators are the preferred method for creating on-cluster applications for OKD 4.6. Learn the workflow for building, testing, and deploying Operators. Then create your own Operators based on or Helm, or configure using the Operator SDK.

    Ongoing tasks on your OKD 4.6 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 machines: Manage machines in your cluster on , Azure, or by deploying health checks and .

    • Manage container registries: Each OKD cluster includes a built-in container registry for storing its images. You can also configure a separate registry to use with OKD. The Quay.io web site provides a public container registry that stores OKD containers and Operators.

    • : Add users and groups that have different levels of permissions to use or modify clusters.

    • Manage authentication: Learn how user, group, and API authentication works in OKD. OKD supports multiple identity providers, including , Keystone, , basic authentication, , GitHub, , Google, and .

    • Manage ingress, , and service certificates: OKD creates certificates by default for the Ingress Operator, the API server, and for services needed by complex middleware applications that require encryption. At some point, you might need to change, add, or rotate these certificates.

    • : Networking in OKD is managed by the Cluster Network Operator (CNO). The CNO uses iptables rules in to direct traffic between nodes and pods running on those nodes. The Multus Container Network Interface adds the capability to attach multiple network interfaces to a pod. Using features, you can isolate your pods or permit selected traffic.

    • Manage storage: OKD allows cluster administrators to configure persistent storage using , AWS Elastic Block Store, , iSCSI, , and more. As needed, you can expand persistent volumes, configure , and use CSI to configure and persistent storage.

    • Manage Operators: Lists of Red Hat, ISV, and community Operators can be reviewed by cluster administrators and . Once installed, you can run, , back up or otherwise manage the Operator on your cluster (based on what the Operator is designed to do).

    • Use custom resource definitions (CRDs) to modify the cluster: Cluster features that are implemented with Operators, can be modified with CRDs. Learn to and manage resources from CRDs.

    • : Choose from CPU, memory and other system resources to set quotas.

    • : You can reclaim space by pruning unneeded Operators, groups, deployments, builds, images, registries, and cron jobs.

    • Scale and clusters: Set cluster limits, tune nodes, scale cluster monitoring, and optimize networking, storage, and routes for your environment.

    • Update a cluster: To upgrade your OKD to a later version, use the Cluster Version Operator (CVO). If an update is available from the Container Platform update service, you apply that cluster update from either the web console or the .

    • Understanding the OpenShift Update Service: Learn about installing and managing a local OpenShift Update Service for recommending OKD updates in restricted network environments.

    • : Learn about cluster logging and configure different cluster logging types, such as Elasticsearch, Fluentd, Kibana, and Curator.