Skip to content

Commit ca2924e

Browse files
author
Amrita
committed
overview page
: This is the commit message #2: index more changes changes more changes topic map xref
1 parent 858b70e commit ca2924e

File tree

2 files changed

+72
-0
lines changed

2 files changed

+72
-0
lines changed

_topic_maps/_topic_map.yml

+2
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,8 @@ Name: Architecture
5959
Dir: architecture
6060
Distros: openshift-enterprise,openshift-origin,openshift-online
6161
Topics:
62+
- Name: Architecture overview
63+
File: index
6264
- Name: Product architecture
6365
File: architecture
6466
- Name: Installation and update

architecture/index.adoc

+70
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
[id="architecture-overview"]
2+
= Architecture overview
3+
include::modules/common-attributes.adoc[]
4+
:context: architecture-overview
5+
6+
toc::[]
7+
8+
{product-title} is a cloud-based Kubernetes container platform.
9+
The foundation of {product-title} is based on Kubernetes and therefore shares the same technology.
10+
To learn more about {product-title} and Kubernetes, see xref:../architecture/architecture.adoc#architecture[product architecture].
11+
12+
[id="about-installation-and-updates"]
13+
== About installation and updates
14+
15+
As a cluster administrator, you can use the {product-title} xref:../architecture/architecture-installation.adoc#architecture-installation[installation program] to install and deploy a cluster by using one of the following methods:
16+
17+
** Installer-provisioned infrastructure
18+
** User-provisioned infrastructure
19+
20+
[id="about-control-planes"]
21+
== About the control plane
22+
23+
The xref:../architecture/control-plane.adoc#control-plane[control plane] manages the worker nodes and the pods in your cluster. You can configure nodes with the use of machine config pools (MCPs).
24+
MCPs are groups of machines, such as control plane components or user workloads, that are based on the resources that they handle.
25+
{product-title} assigns different roles to hosts. These roles define the function of a machine in a cluster.
26+
The cluster contains definitions for the standard control plane and worker role types.
27+
28+
You can use Operators to package, deploy, and manage services on the control plane.
29+
Operators are important components in {product-title} because they provide the following services:
30+
31+
* Perform health checks
32+
* Provide ways to watch applications
33+
* Manage over-the-air updates
34+
* Ensure applications stay in the specified state
35+
36+
[id="about-containerized-applications-for-developers"]
37+
== About containerized applications for developers
38+
39+
As a developer, you can use different tools, methods, and formats to xref:../architecture/understanding-development.adoc#understanding-development[develop your containerized application] based on your unique requirements, for example:
40+
41+
* Use various build-tool, base-image, and registry options to build a simple container application.
42+
* Use supporting components such as OperatorHub and templates to develop your application.
43+
* Package and deploy your application as an Operator.
44+
45+
You can also create a Kubernetes manifest and store it in a Git repository.
46+
Kubernetes works on basic units called pods. A pod is a single instance of a running process in your cluster. Pods can contain one or more containers.
47+
You can create a service by grouping a set of pods and their access policies.
48+
Services provide permanent internal IP addresses and host names for other applications to use as pods are created and destroyed. Kubernetes defines workloads based on the type of your application.
49+
50+
[id="coreos-and-ignition"]
51+
== About {op-system-first} and Ignition
52+
53+
As a cluster administrator, you can perform the following {op-system-first} tasks:
54+
55+
** Learn about the next generation of xref:../architecture/architecture-rhcos.adoc#architecture-rhcos[single-purpose container operating system technology].
56+
** Choose how to configure {op-system-first}
57+
** Choose how to deploy {op-system-first}:
58+
*** Installer-provisioned deployment
59+
*** User-provisioned deployment
60+
61+
The {product-title} installation program creates the Ignition configuration files that you need to deploy your cluster.
62+
{op-system-first} uses Ignition during the initial configuration to perform common disk tasks, such as partitioning, formatting, writing files, and configuring users.
63+
During the first boot, Ignition reads its configuration from the installation media or the location that you specify and applies the configuration to the machines.
64+
65+
You can learn how xref:../architecture/architecture-rhcos.adoc#architecture-rhcos[Ignition works], the process for a {op-system-first} machine in an {product-title} cluster, view Ignition configuration files, and change Ignition configuration after an installation.
66+
67+
[id="about-admission-plug-ins"]
68+
== About admission plug-ins
69+
You can use xref:../architecture/admission-plug-ins.adoc#admission-plug-ins[admission plug-ins] to regulate how {product-title} functions. After a resource request is authenticated and authorized, admission plug-ins intercept the resource request to the master API to validate resource requests and to ensure that scaling policies are adhered to.
70+
Admission plug-ins are used to enforce security policies, resource limitations, or configuration requirements.

0 commit comments

Comments
 (0)