Skip to content

Commit 285a7d1

Browse files
authored
Merge pull request #46421 from Amrita42/Commonterms-install
Added common terms section to the Installing Book
2 parents 5bcce50 + 2baf106 commit 285a7d1

File tree

3 files changed

+70
-11
lines changed

3 files changed

+70
-11
lines changed

installing/index.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ toc::[]
88

99
include::modules/installation-overview.adoc[leveloffset=+1]
1010

11+
include::modules/install-openshift-common-terms.adoc[leveloffset=+2]
12+
1113
include::modules/installation-process.adoc[leveloffset=+2]
1214

1315
include::modules/ipi-verifying-nodes-after-installation.adoc[leveloffset=+2]
Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * installing/index.adoc
4+
5+
:_content-type: REFERENCE
6+
[id="install-openshift-common-terms_{context}"]
7+
= Common terms
8+
9+
This glossary defines common terms that are used in the installation content. These terms help you understand installation effectively.
10+
11+
Bootstrap node::
12+
A temporary machine that runs a minimal Kubernetes configuration to deploy the {product-title} control plane.
13+
14+
Control plane::
15+
A container orchestration layer that exposes the API and interfaces to define, deploy, and manage the lifecycle of containers. Also known as control plane machines.
16+
17+
Compute node::
18+
Nodes that are responsible for executing workloads for cluster users. Also known as worker nodes.
19+
20+
Disconnected installation::
21+
There are situations where parts of a data center might not have access to the internet, even through proxy servers. You can still install the {product-title} in these environments, but you must download the required software and images and make them available to the disconnected environment.
22+
23+
The {product-title} installation program::
24+
A program that provisions the infrastructure and deploys a cluster.
25+
26+
Installer-provisioned infrastructure::
27+
The installation program deploys and configures the infrastructure that the cluster runs on.
28+
29+
Ignition config files::
30+
A file that Ignition uses to configure {op-system-first} during operating system initialization. The installation program generates different Ignition config files to initialize bootstrap, control plane, and worker nodes.
31+
32+
Kubernetes manifests::
33+
Specifications of a Kubernetes API object in a JSON or YAML format. A configuration file can include deployments, config maps, secrets, daemonsets etc.
34+
35+
Kubelet::
36+
A **primary node** agent that runs on each node in the cluster to ensure that containers are running in a pod.
37+
38+
Load balancers::
39+
A load balancer serves as the single point of contact for clients. Load balancers for the API distribute incoming traffic across control plane nodes.
40+
41+
Machine Config Operator::
42+
An Operator that manages and applies configuration and updates of the base operating system and container runtime, including everything between the kernel and kubelet for the nodes in the cluster.
43+
44+
Operators::
45+
The preferred method of packaging, deploying, and managing a Kubernetes application in an {product-title} cluster. An operator takes human operational knowledge and encodes it into software that is easily packaged and shared with customers.
46+
47+
User-provisioned infrastructure::
48+
You can install {product-title} on infrastructure that you provide. You can use the installation program to generate the assets required to provision the cluster infrastructure, create the cluster infrastructure, and then deploy the cluster to the infrastructure that you provided.

modules/installation-overview.adoc

Lines changed: 20 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,28 +5,37 @@
55

66
:_content-type: CONCEPT
77
[id="installation-overview_{context}"]
8-
= {product-title} installation overview
98

10-
The {product-title} installation program offers you flexibility. You can use the installation program to deploy a cluster on infrastructure that the installation program provisions and the cluster maintains or deploy a cluster on infrastructure that you prepare and maintain.
9+
The {product-title} installation program offers you flexibility. You can use the program to:
1110

12-
These two basic types of {product-title} clusters are frequently called installer-provisioned infrastructure clusters and user-provisioned infrastructure clusters.
11+
* Deploy a cluster on provisioned infrastructure and the cluster it maintains.
12+
* Deploy a cluster on infrastructure that you prepare and maintain.
1313
14-
Both types of clusters have the following characteristics:
14+
These two basic types of {product-title} clusters are frequently called:
1515

16-
* Highly available infrastructure with no single points of failure is available by default
17-
* Administrators maintain control over what updates are applied and when
16+
* Installer-provisioned infrastructure clusters.
17+
* User-provisioned infrastructure clusters.
1818
19-
You use the same installation program to deploy both types of clusters. The main assets generated by the installation program are the Ignition config files for the bootstrap, master, and worker machines. With these three configurations and correctly configured infrastructure, you can start an {product-title} cluster.
19+
Both cluster types have the following characteristics:
2020

21-
The {product-title} installation program uses a set of targets and dependencies to manage cluster installation. The installation program has a set of targets that it must achieve, and each target has a set of dependencies. Because each target is only concerned with its own dependencies, the installation program can act to achieve multiple targets in parallel. The ultimate target is a running cluster. By meeting dependencies instead of running commands, the installation program is able to recognize and use existing components instead of running the commands to create them again.
21+
* Highly available infrastructure with no single points of failure is available by default.
22+
* Administrators maintain control over what updates are applied and when.
2223
23-
The following diagram shows a subset of the installation targets and dependencies:
24+
[id="about-the-installation-program"]
25+
== About the installation program
26+
27+
You can use the installation program to deploy both types of clusters. The installation program generates main assets such as Ignition config files for the bootstrap, master, and worker machines. You can start an {product-title} cluster with these three configurations and correctly configured infrastructure.
28+
29+
The {product-title} installation program uses a set of targets and dependencies to manage cluster installations. The installation program has a set of targets that it must achieve, and each target has a set of dependencies. Because each target is only concerned with its own dependencies, the installation program can act to achieve multiple targets in parallel with the ultimate target being a running cluster. The installation program recognizes and uses existing components instead of running commands to create them again because the program meets dependencies.
2430

2531
.{product-title} installation targets and dependencies
2632
image::targets-and-dependencies.png[{product-title} installation targets and dependencies]
2733

28-
After installation, each cluster machine uses {op-system-first} as the operating system. {op-system} is the immutable container host version of {op-system-base-full} and features a {op-system-base} kernel with SELinux enabled by default. It includes the `kubelet`, which is the Kubernetes node agent, and the CRI-O container runtime, which is optimized for Kubernetes.
34+
[id="about-rhcos"]
35+
== About {op-system-first}
36+
37+
Post-installation, each cluster machine uses {op-system-first} as the operating system. {op-system} is the immutable container host version of {op-system-base-full} and features a {op-system-base} kernel with SELinux enabled by default. It includes the `kubelet`, which is the Kubernetes node agent, and the CRI-O container runtime, which is optimized for Kubernetes.
2938

30-
Every control plane machine in an {product-title} {product-version} cluster must use {op-system}, which includes a critical first-boot provisioning tool called Ignition. This tool enables the cluster to configure the machines. Operating system updates are delivered as an Atomic OSTree repository that is embedded in a container image that is rolled out across the cluster by an Operator. Actual operating system changes are made in-place on each machine as an atomic operation by using rpm-ostree. Together, these technologies enable {product-title} to manage the operating system like it manages any other application on the cluster, via in-place upgrades that keep the entire platform up-to-date. These in-place updates can reduce the burden on operations teams.
39+
Every control plane machine in an {product-title} {product-version} cluster must use {op-system}, which includes a critical first-boot provisioning tool called Ignition. This tool enables the cluster to configure the machines. Operating system updates are delivered as an **Atomic OSTree** repository that is embedded in a container image that is deployed across the cluster by an Operator. Actual operating system changes are made in-place on each machine as an atomic operation by using **rpm-ostree**. Together, these technologies enable {product-title} to manage the operating system like it manages any other application on the cluster, by in-place upgrades that keep the entire platform up-to-date. These in-place updates can reduce the burden on operations teams.
3140

3241
If you use {op-system} as the operating system for all cluster machines, the cluster manages all aspects of its components and machines, including the operating system. Because of this, only the installation program and the Machine Config Operator can change machines. The installation program uses Ignition config files to set the exact state of each machine, and the Machine Config Operator completes more changes to the machines, such as the application of new certificates or keys, after installation.

0 commit comments

Comments
 (0)