Skip to content

Commit f079e90

Browse files
committed
Update OKD documentation
Change summary: * _topic_map: include odo in openshift-origin distro * _topic_map: include Helm in openshift-origin * _topic_map: include Monitoring in openshift-origin * modules/whats-new-features: update links to OLM and OperatorHub * _topic_map: show Installation and Update for OKD * installing/install_config/installing-customizing: hide FIPS section for OKD * odc-creating-applications-using-developer-perspective: hide Serverless operator for OKD * _topic_map: enable Release notes for OKD * migration/migrating_3_4/planning-migration-3-to-4: hide Service Mesh reference for OKD * Show FCOS in OKD documentation * Use op-system-base and op-system-base-full to set OS base name * modules/cli-installing-cli: use mirror.openshift.com to download oc on OKD * cli_reference/openshift_cli/getting-started-cli: don't show "Installing the CLI by using an RPM" for OKD * Hide RHEL workers from OKD docs * _topic_map: hide IBM Z install for OKD
1 parent f10578e commit f079e90

File tree

12 files changed

+56
-29
lines changed

12 files changed

+56
-29
lines changed

_topic_map.yml

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ Topics:
6161
---
6262
Name: Release notes
6363
Dir: release_notes
64-
Distros: openshift-enterprise,openshift-webscale
64+
Distros: openshift-enterprise,openshift-webscale,openshift-origin
6565
Topics:
6666
- Name: OpenShift Container Platform 4.4 release notes
6767
File: ocp-4-4-release-notes
@@ -75,16 +75,19 @@ Topics:
7575
- Name: Product architecture
7676
File: architecture
7777
- Name: Installation and update
78-
Distros: openshift-enterprise,openshift-webscale
78+
Distros: openshift-enterprise,openshift-webscale,openshift-origin
7979
File: architecture-installation
8080
- Name: The control plane
8181
File: control-plane
8282
Distros: openshift-enterprise,openshift-webscale,openshift-origin,openshift-dedicated,openshift-online
8383
- Name: Understanding OpenShift development
8484
File: understanding-development
85+
- Name: Fedora CoreOS
86+
File: architecture-rhcos
87+
Distros: openshift-origin
8588
- Name: Red Hat Enterprise Linux CoreOS
8689
File: architecture-rhcos
87-
Distros: openshift-enterprise,openshift-webscale,openshift-origin
90+
Distros: openshift-enterprise,openshift-webscale
8891
---
8992
Name: Administering a cluster
9093
Dir: administering_a_cluster
@@ -186,6 +189,7 @@ Topics:
186189
File: ipi-install-troubleshooting
187190
- Name: Installing on IBM Z
188191
Dir: installing_ibm_z
192+
Distros: openshift-enterprise,openshift-webscale
189193
Topics:
190194
- Name: Installing a cluster on IBM Z
191195
File: installing-ibm-z
@@ -246,6 +250,7 @@ Topics:
246250
File: updating-cluster-cli
247251
- Name: Updating a cluster that includes RHEL compute machines
248252
File: updating-cluster-rhel-compute
253+
Distros: openshift-enterprise,openshift-webscale
249254
#- Name: Updating a disconnected cluster
250255
# File: updating-disconnected-cluster
251256
# - Name: Troubleshooting an update
@@ -882,8 +887,10 @@ Topics:
882887
File: creating-infrastructure-machinesets
883888
- Name: Adding a RHEL compute machine
884889
File: adding-rhel-compute
890+
Distros: openshift-enterprise,openshift-webscale
885891
- Name: Adding more RHEL compute machines
886892
File: more-rhel-compute
893+
Distros: openshift-enterprise,openshift-webscale
887894
- Name: Deploying machine health checks
888895
File: deploying-machine-health-checks
889896
---
@@ -1088,7 +1095,7 @@ Topics:
10881095
---
10891096
Name: Monitoring
10901097
Dir: monitoring
1091-
Distros: openshift-enterprise,openshift-webscale
1098+
Distros: openshift-enterprise,openshift-webscale,openshift-origin
10921099
Topics:
10931100
- Name: Cluster monitoring
10941101
Dir: cluster_monitoring
@@ -1271,7 +1278,7 @@ Topics:
12711278
File: usage-oc-kubectl
12721279
- Name: OpenShift Do developer CLI (odo)
12731280
Dir: openshift_developer_cli
1274-
Distros: openshift-enterprise,openshift-webscale,openshift-online,openshift-dedicated,openshift-online
1281+
Distros: openshift-enterprise,openshift-webscale,openshift-origin,openshift-dedicated,openshift-online
12751282
Topics:
12761283
- Name: Understanding odo
12771284
File: understanding-odo
@@ -1308,7 +1315,7 @@ Topics:
13081315
File: odo-release-notes
13091316
- Name: Helm CLI
13101317
Dir: helm_cli
1311-
Distros: openshift-enterprise,openshift-webscale
1318+
Distros: openshift-enterprise,openshift-webscale,openshift-origin
13121319
Topics:
13131320
- Name: Getting started with Helm on OpenShift Container Platform
13141321
File: getting-started-with-helm-on-openshift-container-platform

applications/application_life_cycle_management/odc-creating-applications-using-developer-perspective.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ image::odc_add_view.png[Add View]
1616
* *YAML*: Use the editor to add YAML or JSON definitions to create and modify resources.
1717
* *Database*: See the *Developer Catalog* to select the required database service and add it to your application.
1818

19-
ifdef::openshift-enterprise,openshift-webscale,openshift-origin[]
19+
ifdef::openshift-enterprise,openshift-webscale[]
2020
[NOTE]
2121
====
2222
The serverless sections in the above options are displayed only if the xref:../../serverless/installing_serverless/installing-openshift-serverless.adoc#installing-openshift-serverless[*Serverless Operator*] is installed in your cluster. OpenShift Serverless is a Technology Preview feature.
@@ -30,7 +30,7 @@ To create applications using the *Developer* perspective ensure that:
3030
* You are in the xref:../../web_console/odc-about-developer-perspective.adoc#odc-about-developer-perspective[*Developer* perspective].
3131
* You have the appropriate xref:../../authentication/using-rbac.adoc#default-roles_using-rbac[roles and permissions] in a project to create applications and other workloads in {product-title}.
3232

33-
ifdef::openshift-enterprise,openshift-webscale,openshift-origin[]
33+
ifdef::openshift-enterprise,openshift-webscale[]
3434

3535
To create serverless applications, in addition to the above, ensure that:
3636

architecture/understanding-development.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -72,19 +72,19 @@ The following diagram displays the process of building and pushing an image:
7272
.Create a simple containerized application and push it to a registry
7373
image::create-push-app.png[Creating and pushing a containerized application]
7474

75-
If you use a computer that runs Red Hat Enterprise Linux (RHEL) as the operating
75+
If you use a computer that runs {op-system-base-full} as the operating
7676
system, the process of creating a containerized application requires the
7777
following steps:
7878

79-
. Install container build tools: RHEL contains a set of tools that includes
79+
. Install container build tools: {op-system-base} contains a set of tools that includes
8080
podman, buildah, and skopeo that you use to build and manage containers.
8181
. Create a Dockerfile to combine base image and software: Information about
8282
building your container goes into a file that is named `Dockerfile`. In that
8383
file, you identify the base image you build from, the software packages you
8484
install, and the software you copy into the container. You also identify
8585
parameter values like network ports that you expose outside the container and
8686
volumes that you mount inside the container. Put your Dockerfile and the
87-
software you want to containerized in a directory on your RHEL system.
87+
software you want to containerized in a directory on your {op-system-base} system.
8888
. Run buildah or docker build: Run the `buildah build-using-dockerfile` or
8989
the `docker build` command to pull you chosen base image to the local system and
9090
creates a container image that is stored locally. You can also build container
@@ -110,7 +110,7 @@ endif::openshift-origin,openshift-enterprise,openshift-webscale[]
110110
=== Container build tool options
111111

112112
While the Docker Container Engine and `docker` command are popular tools
113-
to work with containers, with RHEL and many other Linux systems, you can
113+
to work with containers, with {op-system-base} and many other Linux systems, you can
114114
instead choose a different set of container tools that includes podman, skopeo,
115115
and buildah. You can still use Docker Container Engine tools to create
116116
containers that will run in {product-title} and any other container platform.

cli_reference/openshift_cli/getting-started-cli.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,10 @@ You can install the OpenShift CLI (`oc`) either by downloading the binary or by
1515
// Installing the CLI by downloading the binary
1616
include::modules/cli-installing-cli.adoc[leveloffset=+2]
1717

18+
ifndef::openshift-origin[]
1819
// Installing the CLI by using an RPM
1920
include::modules/cli-installing-cli-rpm.adoc[leveloffset=+2]
21+
endif::[]
2022

2123
// Logging in to the CLI
2224
include::modules/cli-logging-in.adoc[leveloffset=+1]

installing/install_config/installing-customizing.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,9 @@ include::modules/installation-special-config-encrypt-disk-tpm2.adoc[leveloffset=
2727
include::modules/installation-special-config-encrypt-disk-tang.adoc[leveloffset=+2]
2828
include::modules/installation-special-config-crony.adoc[leveloffset=+1]
2929

30-
30+
ifndef::openshift-origin[]
3131
== Additional resources
3232

3333
See xref:../../installing/installing-fips.adoc#installing-fips[Support for FIPS cryptography]
3434
for information on FIPS support.
35+
endif::[]

migration/migrating_3_4/planning-migration-3-to-4.adoc

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@ It is not possible to upgrade your existing {product-title} 3 cluster to {produc
1818

1919
[id="migration-comparing-ocp-3-4"]
2020
== Comparing {product-title} 3 and {product-title} 4
21+
With {product-title} 3, administrators individually deployed {op-system-base-full} hosts, and then installed {product-title} on top of these hosts to form a cluster. Administrators were responsible for properly configuring these hosts and performing updates.
2122

22-
With {product-title} 3, administrators individually deployed Red Hat Enterprise Linux (RHEL) hosts, and then installed {product-title} on top of these hosts to form a cluster. Administrators were responsible for properly configuring these hosts and performing updates.
2323

2424
{product-title} 4 represents a significant change in the way that {product-title} clusters are deployed and managed. {product-title} 4 includes new technologies and functionality, such as Operators, MachineSets, and {op-system-first}, which are core to the operation of the cluster. This technology shift enables clusters to self-manage some functions previously performed by administrators. This also ensures platform stability and consistency, and simplifies installation and scaling.
2525

@@ -31,7 +31,7 @@ For more information, see xref:../../architecture/architecture.adoc#architecture
3131
[discrete]
3232
==== Immutable infrastructure
3333

34-
{product-title} 4 uses {op-system-first}, which is designed to run containerized applications, and provides efficient installation, Operator-based management, and simplified upgrades. {op-system} is an immutable container host, rather than a customizable operating system like RHEL. {op-system} enables {product-title} 4 to manage and automate the deployment of the underlying container host. {op-system} is a part of {product-title}, which means that everything runs inside a container and is deployed using {product-title}.
34+
{product-title} 4 uses {op-system-first}, which is designed to run containerized applications, and provides efficient installation, Operator-based management, and simplified upgrades. {op-system} is an immutable container host, rather than a customizable operating system like {op-system-base}. {op-system} enables {product-title} 4 to manage and automate the deployment of the underlying container host. {op-system} is a part of {product-title}, which means that everything runs inside a container and is deployed using {product-title}.
3535

3636
In {product-title} 4, control plane nodes must run {op-system}, ensuring that full-stack automation is maintained for the control plane. This makes rolling out updates and upgrades a much easier process than in {product-title} 3.
3737

@@ -50,13 +50,15 @@ For more information, see xref:../../operators/olm-what-operators-are.adoc#olm-w
5050
[discrete]
5151
==== Installation process
5252

53-
To install {product-title} 3.11, you prepared your Red Hat Enterprise Linux (RHEL) hosts, set all of the configuration values your cluster needed, and then ran an Ansible playbook to install and set up your cluster.
53+
To install {product-title} 3.11, you prepared your {op-system-base-full} hosts, set all of the configuration values your cluster needed, and then ran an Ansible playbook to install and set up your cluster.
5454

5555
In {product-title} 4.4, you use the OpenShift installation program to create a minimum set of resources required for a cluster. Once the cluster is running, you use Operators to further configure your cluster and to install new services. After first boot, {op-system-first} systems are managed by the Machine Config Operator (MCO) that runs in the {product-title} cluster.
5656

5757
For more information, see xref:../../architecture/architecture-installation.adoc#installation-process_architecture-installation[Installation process].
5858

59+
ifndef::openshift-origin[]
5960
If you want to add RHEL worker machines to your {product-title} 4.4 cluster, you use an Ansible playbook to join the RHEL worker machines after the cluster is running. For more information, see xref:../../machine_management/adding-rhel-compute.adoc#adding-rhel-compute[Adding RHEL compute machines to an {product-title} cluster].
61+
endif::[]
6062

6163
[discrete]
6264
==== Infrastructure options
@@ -144,7 +146,9 @@ For more information, see xref:../../networking/configuring-networkpolicy.adoc#n
144146

145147
In {product-title} 3.11, you could use IPsec to encrypt traffic between hosts. {product-title} 4.4 does not support IPsec. It is recommended to use Red Hat OpenShift Service Mesh to enable mutual TLS between services.
146148

149+
ifndef::openshift-origin[]
147150
For more information, see xref:../../service_mesh/service_mesh_arch/understanding-ossm.adoc#understanding-ossm[Understanding Red Hat OpenShift Service Mesh].
151+
endif::[]
148152

149153
[id="migration-preparing-logging"]
150154
=== Logging considerations

modules/cli-installing-cli-rpm.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
[id="cli-installing-cli-rpm_{context}"]
66
= Installing the CLI by using an RPM
77

8-
For Red Hat Enterprise Linux (RHEL), you can install the OpenShift CLI (`oc`) as an RPM if you have an active {product-title} subscription on your Red Hat account.
8+
For {op-system-base-full}, you can install the OpenShift CLI (`oc`) as an RPM if you have an active {product-title} subscription on your Red Hat account.
99

1010
.Prerequisites
1111

modules/cli-installing-cli.adoc

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,9 +39,14 @@ install the new version of `oc`.
3939
====
4040

4141
.Procedure
42-
42+
ifdef::openshift-origin[]
43+
. Navigate to https://mirror.openshift.com/pub/openshift-v4/clients/oc/latest/ and choose the folder for your operating system
44+
. Download `oc.tar.gz`
45+
endif::[]
46+
ifndef::openshift-origin[]
4347
. From the link:https://cloud.redhat.com/openshift/install[Infrastructure Provider] page on the {cloud-redhat-com} site, navigate to the page for your installation type and
4448
click *Download Command-line Tools*.
49+
endif::[]
4550
. Click the folder for your operating system and architecture and click the
4651
compressed file.
4752
+

modules/common-attributes.adoc

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,14 @@
99
:prewrap!:
1010
:op-system-first: Red Hat Enterprise Linux CoreOS (RHCOS)
1111
:op-system: RHCOS
12+
:op-system-base: RHEL
13+
:op-system-base-full: Red Hat Enterprise Linux (RHEL)
14+
ifdef::openshift-origin[]
15+
:op-system-first: Fedora CoreOS (FCOS)
16+
:op-system: FCOS
17+
:op-system-base: Fedora
18+
:op-system-base-full: Fedora
19+
endif::[]
1220
:asb-name: OpenShift Ansible Broker
1321
:tsb-name: Template Service Broker
1422
:kebab: image:kebab.png[title="Options menu"]

modules/installation-overview.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ The following diagram shows a subset of the installation targets and dependencie
2626
.{product-title} installation targets and dependencies
2727
image::targets-and-dependencies.png[{product-title} installation targets and dependencies]
2828

29-
After installation, each cluster machine uses {op-system-first} as the operating system. {op-system} is the immutable container host version of Red Hat Enterprise Linux (RHEL) and features a RHEL 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.
29+
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.
3030

3131
Every control plane machine in an {product-title} {product-version} cluster must
3232
use {op-system}, which includes a critical first-boot provisioning tool called

modules/rhcos-about.adoc

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,14 @@
88
{op-system-first} represents the next generation of single-purpose
99
container operating system technology. Created by the same development teams
1010
that created Red Hat Enterprise Linux Atomic Host and CoreOS Container Linux,
11-
{op-system} combines the quality standards of Red Hat Enterprise Linux (RHEL)
11+
{op-system} combines the quality standards of {op-system-base-full}
1212
with the automated, remote upgrade features from Container Linux.
1313

1414
{op-system} is supported only as a component of {product-title}
1515
{product-version} for all {product-title} machines. {op-system} is the only
1616
supported operating system for {product-title} control plane, or master,
1717
machines. While {op-system} is the default operating system for all cluster
18-
machines, you can create compute machines, which are also known as worker machines, that use RHEL as their
18+
machines, you can create compute machines, which are also known as worker machines, that use {op-system-base} as their
1919
operating system. There are two general ways {op-system} is deployed in
2020
{product-title} {product-version}:
2121

@@ -34,15 +34,15 @@ files to provision your machines.
3434

3535
The following list describes key features of the {op-system} operating system:
3636

37-
* **Based on RHEL**: The underlying operating system consists primarily of RHEL components.
38-
The same quality, security, and control measures that support RHEL also support
37+
* **Based on {op-system-base}**: The underlying operating system consists primarily of {op-system-base} components.
38+
The same quality, security, and control measures that support {op-system-base} also support
3939
{op-system}. For example, {op-system} software is in
40-
RPM packages, and each {op-system} system starts up with a RHEL kernel and a set
40+
RPM packages, and each {op-system} system starts up with a {op-system-base} kernel and a set
4141
of services that are managed by the systemd init system.
4242

43-
* **Controlled immutability**: Although it contains RHEL components, {op-system}
43+
* **Controlled immutability**: Although it contains {op-system-base} components, {op-system}
4444
is designed to be managed
45-
more tightly than a default RHEL installation. Management is
45+
more tightly than a default {op-system-base} installation. Management is
4646
performed remotely from the {product-title} cluster. When you set up your
4747
{op-system} machines, you can modify only a few system settings. This controlled
4848
immutability allows {product-title} to

modules/whats-new-features.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ This release adds improvements related to the following components and concepts.
1313
[id="ocp-operators"]
1414
== Operators
1515

16-
xref:../applications/operators/olm-what-operators-are.adoc#olm-what-operators-are[Operators]
16+
xref:../operators/olm-what-operators-are.adoc#olm-what-operators-are[Operators]
1717
are pieces of software that ease the operational complexity of running another
1818
piece of software. They act like an extension of the software vendor’s
1919
engineering team, watching over a Kubernetes environment (such as
@@ -35,7 +35,7 @@ access to Operators running on their cluster:
3535
* Supports role-based access control (RBAC) for certain teams to use certain Operators
3636

3737
See
38-
xref:../applications/operators/olm-understanding-olm.adoc#olm-understanding-olm[Understanding the Operator Lifecycle Manager (OLM)] for more information.
38+
xref:../operators/understanding_olm/olm-understanding-olm.adoc#olm-understanding-olm[Understanding the Operator Lifecycle Manager (OLM)] for more information.
3939

4040
[id="ocp-installation-and-upgrade"]
4141
== Installation and upgrade
@@ -113,7 +113,7 @@ from Red Hat products, Red Hat partners, and the community.
113113
|===
114114

115115
See
116-
xref:../applications/operators/olm-understanding-operatorhub.adoc#olm-understanding-operatorhub[Understanding the OperatorHub] for more information.
116+
xref:../operators/olm-understanding-operatorhub.adoc#olm-understanding-operatorhub[Understanding the OperatorHub] for more information.
117117

118118
[id="ocp-storage"]
119119
== Storage

0 commit comments

Comments
 (0)