Skip to content

CQA WLC-1: OpenShift Overviews and Editions #114761

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mburke5678 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

CQA WLC-1: OpenShift Overviews and Editions #114761

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions modules/kubernetes-architecture.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
// Module included in the following assemblies:
//
// * getting_started/kubernetes-overview.adoc

@mburke5678 mburke5678 Jul 7, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Created a new module for text that came after an include. See kubernetes-overview.adoc, line 30

:_mod-docs-content-type: CONCEPT
[id="kubernetes-architecture_{context}"]
= Kubernetes architecture

[role="_abstract"]
You can run Kubernetes containers across various machines and environments.

A cluster is a single computational unit consisting of multiple nodes in a cloud environment. A Kubernetes cluster includes a control plane and compute nodes.

The control plane node controls and maintains the state of a cluster. You can run the Kubernetes application by using compute nodes. You can use the Kubernetes namespace to differentiate cluster resources in a cluster. Namespace scoping is applicable for resource objects, such as deployments, services, and pods. You cannot use namespace for cluster-wide resource objects such as storage classes, nodes, and persistent volumes.

.Architecture of Kubernetes
image::247_OpenShift_Kubernetes_Overview-2.png[]

3 changes: 3 additions & 0 deletions modules/kubernetes-components.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@
[id="kubernetes-components_{context}"]
= Kubernetes components

[role="_abstract"]
To effectively manage and maintain a Kubernetes cluster, you must understand its core infrastructure and control plane components. This reference details the function of each component and how they interact to run your workloads.

.Kubernetes components
[cols="1,2",options="header"]
|===
Expand Down
3 changes: 3 additions & 0 deletions modules/kubernetes-conceptual-guidelines.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@
[id="kubernetes-conceptual-guidelines_{context}"]
= Kubernetes conceptual guidelines

[role="_abstract"]
To more effectively deploy and scale applications, you should understand how Kubernetes aligns with {product-title}.

Before getting started with the {product-title}, consider these conceptual guidelines of Kubernetes:

* Start with one or more worker nodes to run the container workloads.
Expand Down
5 changes: 4 additions & 1 deletion modules/kubernetes-resources.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,10 @@
[id="kubernetes-resources_{context}"]
= Kubernetes resources

A custom resource is an extension of the Kubernetes API. You can customize Kubernetes clusters by using custom resources. Operators are software extensions which manage applications and their components with the help of custom resources. Kubernetes uses a declarative model when you want a fixed desired result while dealing with cluster resources. By using Operators, Kubernetes defines its states in a declarative way. You can modify the Kubernetes cluster resources by using imperative commands.
[role="_abstract"]
To extend and automate your Kubernetes cluster capabilities, you can use custom resources and Operators.

A custom resource is an extension of the Kubernetes API. Operators are software extensions which manage applications and their components with the help of custom resources. Kubernetes uses a declarative model when you want a fixed desired result while dealing with cluster resources. By using Operators, Kubernetes defines its states in a declarative way. You can modify the Kubernetes cluster resources by using imperative commands.
An Operator acts as a control loop which continuously compares the desired state of resources with the actual state of resources and puts actions in place to bring reality in line with the desired state.

.Kubernetes cluster overview
Expand Down
335 changes: 335 additions & 0 deletions modules/oke_similarities_and_differences.adoc
View file
Open in desktop

Large diffs are not rendered by default.

13 changes: 7 additions & 6 deletions modules/openshift-use-cases.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,20 @@

:_mod-docs-content-type: CONCEPT
[id="openshift-use-cases_{context}"]
== Use cases
= {product-title} use cases

Red Hat OpenShift is widely adopted across industries to support various use cases, enabling organizations to modernize applications, optimize infrastructure, and enhance operational efficiency.
[role="_abstract"]
Your organization can use {product-title} to modernize applications, optimize infrastructure, and enhance operational efficiency.

{product-title} is widely adopted across industries to support various use cases, including the following cases:

OpenShift virtualization::

* Provides a unified platform for managing virtual machines (VMs) and containers in parallel, which streamlines operations and reduces complexity.
* Provides a robust infrastructure to scale VM workloads efficiently.
* Provides enhanced security features to protect VM environments, ensuring compliance and data integrity.
+
For detailed implementation guidelines and a sample architecture, refer to the link:https://access.redhat.com/articles/7067871[OpenShift Virtualization - Reference Implementation Guide]. This document offers best practices for deploying OpenShift as a hosting solution for virtualization workloads, designed for environments transitioning from platforms such as VMware Cloud Foundation, VMware vSphere Foundation, Red Hat Virtualization, and OpenStack to OpenShift Virtualization.
For detailed implementation guidelines and a sample architecture, refer to the "OpenShift Virtualization - Reference Implementation Guide" in the _Additional resources_ section. This document offers best practices for deploying OpenShift as a hosting solution for virtualization workloads, designed for environments transitioning from platforms such as VMware Cloud Foundation, VMware vSphere Foundation, Red Hat Virtualization, and OpenStack to OpenShift Virtualization.

Application modernization including artificial intelligence and machine learning (AI/ML) operations::

Expand Down Expand Up @@ -52,6 +55,4 @@ Enterprise SaaS delivery::
* Facilitates multi-tenant SaaS application deployment with consistent operations.
* Includes features like Hosted Control Planes, cluster-as-a-service, and fleet-level management with Advanced Cluster Management (ACM) and Advanced Cluster Security (ACS).

To explore more use cases, see link:https://www.redhat.com/en/technologies/cloud-computing/openshift#use-cases[Use cases].

For additional recommended solutions tailored to various use cases, see link:https://www.solutionpatterns.io/patterns/[Solution Patterns from Red Hat].
For additional recommended solutions tailored to various use cases, see "Explore Solution Patterns" in the _Additional resources_ section.
5 changes: 4 additions & 1 deletion modules/understanding-openshift.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,10 @@
[id="understanding-openshift_{context}"]
= Understanding {product-title}

{product-title} is a Kubernetes environment for managing the lifecycle of container-based applications and their dependencies on various computing platforms, such as bare metal, virtualized, on-premise, and in cloud. {product-title} deploys, configures and manages containers. {product-title} offers usability, stability, and customization of its components.
[role="_abstract"]
You can use {product-title} to deploy, configure, and manage the lifecycle of container-based applications.

{product-title} is a Kubernetes environment for managing containers and their dependencies on various computing platforms, such as bare metal, virtualized, on-premise, and in cloud. {product-title} offers usability, stability, and customization of its components.

{product-title} utilises a number of computing resources, known as nodes. A node has a lightweight, secure operating system based on {op-system-base-full}, known as {op-system-first}.

Expand Down
21 changes: 21 additions & 0 deletions snippets/troubleshooting-windows-containers-includes.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
// Text snippet included in the following modules:
//
// * modules/troubleshooting-windows-container-workload-issues.adoc
// * modules/windows-containers-troubleshooting.adoc

:_mod-docs-content-type: SNIPPET

What if I have text here?

include::modules/wmco-does-not-install.adoc[leveloffset=+1]

include::modules/investigating-why-windows-machine-compute-node.adoc[leveloffset=+1]

include::modules/accessing-windows-node.adoc[leveloffset=+1]
include::modules/accessing-windows-node-using-ssh.adoc[leveloffset=+2]
include::modules/accessing-windows-node-using-rdp.adoc[leveloffset=+2]

include::modules/collecting-kube-node-logs-windows.adoc[leveloffset=+1]
include::modules/collecting-windows-application-event-logs.adoc[leveloffset=+1]
include::modules/collecting-containerd-logs-windows.adoc[leveloffset=+1]

12 changes: 6 additions & 6 deletions welcome/kubernetes-overview.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,10 @@ include::_attributes/common-attributes.adoc[]

toc::[]

Kubernetes is an open source container orchestration tool developed by Google. You can run and manage container-based workloads by using Kubernetes. The most common Kubernetes use case is to deploy an array of interconnected microservices, building an application in a cloud native way. You can create Kubernetes clusters that can span hosts across on-premise, public, private, or hybrid clouds.
[role="_abstract"]
You can run and manage container-based workloads by using Kubernetes, an open source container orchestration tool developed by Google.

The most common Kubernetes use case is to deploy an array of interconnected microservices, building an application in a cloud native way. You can create Kubernetes clusters that can span hosts across on-premise, public, private, or hybrid clouds.

Traditionally, applications were deployed on top of a single operating system. With virtualization, you can split the physical host into several virtual hosts. Working on virtual instances on shared resources is not optimal for efficiency and scalability. Because a virtual machine (VM) consumes as many resources as a physical machine, providing resources to a VM such as CPU, RAM, and storage can be expensive. Also, you might see your application degrading in performance due to virtual instance usage on shared resources.

Expand All @@ -27,9 +30,6 @@ include::modules/kubernetes-components.adoc[leveloffset=+1]

include::modules/kubernetes-resources.adoc[leveloffset=+1]

.Architecture of Kubernetes
image::247_OpenShift_Kubernetes_Overview-2.png[]

A cluster is a single computational unit consisting of multiple nodes in a cloud environment. A Kubernetes cluster includes a control plane and worker nodes. You can run Kubernetes containers across various machines and environments. The control plane node controls and maintains the state of a cluster. You can run the Kubernetes application by using worker nodes. You can use the Kubernetes namespace to differentiate cluster resources in a cluster. Namespace scoping is applicable for resource objects, such as deployment, service, and pods. You cannot use namespace for cluster-wide resource objects such as storage class, nodes, and persistent volumes.
include::modules/kubernetes-architecture.adoc[leveloffset=+1]

@mburke5678 mburke5678 Jul 7, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Moved the text into the kubernetes-architecture.adoc module.


include::modules/kubernetes-conceptual-guidelines.adoc[leveloffset=+1]
include::modules/kubernetes-conceptual-guidelines.adoc[leveloffset=+1]
74 changes: 31 additions & 43 deletions welcome/learn_more_about_openshift.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,13 @@ include::_attributes/common-attributes.adoc[]

toc::[]

Use the following sections to find content to help you learn about and better understand {product-title} functions:
[role="_abstract"]
To better use {product-title}, you should first learn about and better understand how {product-title} functions.

[id="support"]
== Learning and support
You can use the following sections to find content to help you learn about {product-title}.

Learning and support::
+
[options="header",cols="2*",width="%autowidth.stretch"]
|===
| Learn about {product-title} |Optional additional resources
Expand All @@ -29,9 +31,8 @@ Use the following sections to find content to help you learn about and better un

|===

[id="architecture"]
== Architecture

Architecture::
+
[options="header",cols="2*",width="%autowidth.stretch"]
|===
| Learn about {product-title} |Optional additional resources
Expand All @@ -50,10 +51,9 @@ Use the following sections to find content to help you learn about and better un

|===

[id="installation"]
== Installation
Installation::
Explore the following {product-title} installation tasks:

+
[options="header",cols="2*",width="%autowidth.stretch"]
|===
| Learn about installation on {product-title} |Optional additional resources
Expand All @@ -66,9 +66,8 @@ Explore the following {product-title} installation tasks:

|===

[id="other-cluster-installer-tasks"]
== Other cluster installer tasks

Other cluster installer tasks::
+
[options="header",cols="2*",width="%autowidth.stretch"]
|===
| Learn about other installer tasks on {product-title} |Optional additional resources
Expand All @@ -82,8 +81,8 @@ Explore the following {product-title} installation tasks:
|===


=== Install a cluster in a restricted network

Install a cluster in a restricted network::
+
[options="header",cols="2*",width="%autowidth.stretch"]
|===
|Learn about installing in a restricted network |Optional additional resources
Expand All @@ -101,9 +100,8 @@ a| If your cluster uses user-provisioned infrastructure, and the cluster does no

|===


=== Install a cluster in an existing network

Install a cluster in an existing network::
+
[options="header",cols="2*",width="%autowidth.stretch"]
|===
|Learn about installing in a restricted network |Optional additional resources
Expand All @@ -117,9 +115,8 @@ on Microsoft Azure, you can install a cluster.

|===

[id="cluster-administrator"]
== Cluster administrator

Cluster administration::
+
[options="header",cols="2*",width="%autowidth.stretch"]
|===
|Learn about {product-title} cluster activities |Optional additional resources
Expand All @@ -134,12 +131,8 @@ a|* xref:../machine_management/index.adoc#machine-api-overview_overview-of-machi

|===

[id="managing-changing-cluster-components"]
=== Managing and changing cluster components


==== Managing cluster components

Managing cluster components::
+
[options="header",cols="2*",width="%autowidth.stretch"]
|===
|Learn about managing cluster components |Optional additional resources
Expand Down Expand Up @@ -176,8 +169,8 @@ a|* xref:../networking/networking_operators/cluster-network-operator.adoc#nw-clu
|===


==== Changing cluster components

Changing cluster components::
+
[options="header",cols="2*",width="%autowidth.stretch"]
|===
|Learn more about changing cluster components |Optional additional resources
Expand All @@ -202,9 +195,8 @@ a|* xref:../operators/understanding/crds/crd-extending-api-with-crds.adoc#crd-cr

|===

[id="observe-cluster"]
== Observe a cluster

Observe a cluster::
+
[options="header",cols="2*",width="%autowidth.stretch"]
|===
|Learn about {product-title} |Optional additional resources
Expand All @@ -225,9 +217,8 @@ a|* xref:../support/remote_health_monitoring/about-remote-health-monitoring.adoc

|===

[id="storage-activities"]
== Storage activities

Storage activities::
+
[options="header",cols="2*",width="%autowidth.stretch"]
|===
|Learn about {product-title} |Optional additional resources
Expand All @@ -238,9 +229,8 @@ a| * xref:../storage/understanding-persistent-storage.adoc#understanding-persist

|===

[id="application_site_reliability_engineer"]
== Application Site Reliability Engineer (App SRE)

Application Site Reliability Engineer (App SRE)::
+
[options="header",cols="2*",width="%autowidth.stretch"]
|===
|Learn about {product-title} |Optional additional resources
Expand All @@ -253,10 +243,9 @@ a| * xref:../storage/understanding-persistent-storage.adoc#understanding-persist

|===

[id="Developer"]
== Developer
Developing applications::
{product-title} is a platform for developing and deploying containerized applications. Read the following {product-title} documentation, so that you can better understand {product-title} functions:

+
[options="header",cols="2*",width="%autowidth.stretch"]
|===
|Learn about application development in {product-title} |Optional additional resources
Expand Down Expand Up @@ -286,9 +275,8 @@ a|* xref:../nodes/scheduling/nodes-scheduler-taints-tolerations.adoc#nodes-sched
* xref:../machine_management/creating-infrastructure-machinesets.adoc#creating-infrastructure-machinesets[Creating infrastructure machine sets]
|===

[id="self-managed-hcp"]
== {hcp-capital}

{hcp-capital}::
+
[options="header",cols="2*",width="%autowidth.stretch"]
|===
|Learn about {hcp} |Optional additional resources
Expand Down
16 changes: 11 additions & 5 deletions welcome/ocp-overview.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,17 @@
:_mod-docs-content-type: ASSEMBLY
[id="ocp-overview"]
= Introduction to OpenShift Container Platform

= Introduction to {product-title}
include::_attributes/common-attributes.adoc[]
:context: ocp-overview

toc::[]

{product-title} is a cloud-based Kubernetes container platform. The foundation of {product-title} is based on Kubernetes and therefore shares the same technology. It is designed to allow applications and the data centers that support them to expand from just a few machines and applications to thousands of machines that serve millions of clients.
[role="_abstract"]
With {product-title}, you can expand your application environment from just a few machines and applications to thousands of machines that serve millions of clients.

{product-title} is a cloud-based Kubernetes container platform. The foundation of {product-title} is based on Kubernetes and therefore shares the same technology.

{product-title} enables you to do the following:
Using {product-title}, you can perform the following tasks:

* Provide developers and IT organizations with cloud application platforms that can be used for deploying applications on secure and scalable resources.

Expand All @@ -27,7 +30,10 @@ include::modules/understanding-openshift.adoc[leveloffset=+1]
include::modules/openshift-use-cases.adoc[leveloffset=+1]

[role="_additional-resources"]
.Additional resources
[id="additional-resources_{context}"]
== Additional resources

* xref:../installing/installing_sno/install-sno-preparing-to-install-sno.adoc#preparing-to-install-sno[Preparing to install on a single node]
* link:https://access.redhat.com/articles/7067871[OpenShift Virtualization - Reference Implementation Guide (Red{nbsp}Hat Knowledgebase)]
* link:https://www.solutionpatterns.io/patterns/[Explore Solution Patterns (Solution Patterns from Red Hat documentation)]

Loading