Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion installing/installing-gather-logs.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ gather logs from the bootstrap and control plane, or master, machines.

.Prerequisites

* You attempted to install a {product-title} cluster, and installation failed.
* You attempted to install an {product-title} cluster, and installation failed.
* You provided an SSH key to the installation program, and that key is in your
running `ssh-agent` process.

Expand Down
4 changes: 2 additions & 2 deletions installing/installing_aws/installing-aws-customizations.adoc
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
[id="installing-aws-customizations"]
= Installing a cluster on AWS with customizations
include::modules/common-attributes.adoc[]
:context: install-customizations-cloud
:context: installing-aws-customizations

toc::[]

In {product-title} version {product-version}, you can install a customized
cluster on infrastructure that the installation program provisions on
Amazon Web Services (AWS). To customize the installation, you modify
some parameters in the `install-config.yaml` file before you install the cluster.
parameters in the `install-config.yaml` file before you install the cluster.

.Prerequisites

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[id="installing-aws-user-infra"]
= Installing a cluster on AWS using CloudFormation templates
= Installing a cluster on user-provisioned infrastructure in AWS by using CloudFormation templates
include::modules/common-attributes.adoc[]
:context: installing-aws-user-infra

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ toc::[]
In {product-title} version {product-version}, you can install a customized
cluster on infrastructure that the installation program provisions on
Microsoft Azure. To customize the installation, you modify
some parameters in the `install-config.yaml` file before you install the cluster.
parameters in the `install-config.yaml` file before you install the cluster.

.Prerequisites

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ toc::[]
In {product-title} version {product-version}, you can install a customized
cluster on infrastructure that the installation program provisions on
Google Cloud Platform (GCP). To customize the installation, you modify
some parameters in the `install-config.yaml` file before you install the cluster.
parameters in the `install-config.yaml` file before you install the cluster.

.Prerequisites

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ an internal mirror of the installation release content.

[IMPORTANT]
====
While you can install a {product-title} cluster by using mirrored installation
While you can install an {product-title} cluster by using mirrored installation
release content, your cluster still requires internet access to use the AWS APIs.
====

Expand Down
50 changes: 9 additions & 41 deletions modules/architecture-platform-benefits.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,24 +12,16 @@ continues as one of the largest contributors to Kubernetes across a wide range
of technology areas.
////

{product-title} provides enterprise-ready enhancements to Kubernetes, including
the following enhancements:
{product-title} provides enterprise-ready enhancements to Kubernetes, including the following enhancements:

ifdef::openshift-origin,openshift-enterprise[]
* Hybrid cloud deployments. You can deploy {product-title} clusters to variety
of public cloud platforms or in your data center.
* Hybrid cloud deployments. You can deploy {product-title} clusters to variety of public cloud platforms or in your data center.
endif::[]
ifdef::openshift-dedicated[]
* {product-title} clusters are deployed on AWS environments and can be used
as part of a hybrid approach for application management.
* {product-title} clusters are deployed on AWS environments and can be used as part of a hybrid approach for application management.
endif::[]
* Integrated Red Hat technology. Major components in {product-title} come from
Red Hat Enterprise Linux and related Red Hat technologies. {product-title}
benefits from the intense testing and certification initiatives for Red Hat’s
enterprise quality software.
* Open source development model. Development is completed in the open, and the
source code is available from public software repositories. The open
collaboration fosters rapid innovation and development.
* Integrated Red Hat technology. Major components in {product-title} come from Red Hat Enterprise Linux and related Red Hat technologies. {product-title} benefits from the intense testing and certification initiatives for Red Hat’s enterprise quality software.
* Open source development model. Development is completed in the open, and the source code is available from public software repositories. This open collaboration fosters rapid innovation and development.

Although Kubernetes excels at managing your applications, it does not specify
or manage platform-level requirements or deployment processes. Powerful and
Expand All @@ -40,19 +32,16 @@ unique features and benefits of {product-title}.
[id="architecture-custom-os_{context}"]
== Custom operating system

{product-title} uses {op-system-first}, a new container-oriented operating
{product-title} uses {op-system-first}, a container-oriented operating
system that combines some of the best features and functions of the CoreOS and
Red Hat Atomic Host operating systems. {op-system} is specifically designed for
running containerized applications from {product-title} and works with new tools
to provide fast installation, Operator-based management, and simplified upgrades.

{op-system} includes:

* Ignition, which is a firstboot system configuration for initially bringing up and
configuring {product-title} nodes.
* cri-o, a Kubernetes native container runtime implementation that integrates
closely with the operating system to deliver an efficient and optimized
Kubernetes experience.
* Ignition, which {product-title} uses as a firstboot system configuration for initially bringing up and configuring machines.
* CRI-O, a Kubernetes native container runtime implementation that integrates closely with the operating system to deliver an efficient and optimized Kubernetes experience. CRI-O provides facilities for running, stopping, and restarting containers. It fully replaces the Docker Container Engine , which was used in {product-title} 3.
* Kubelet, the primary node agent for Kubernetes that is responsible for
launching and monitoring containers.

Expand Down Expand Up @@ -84,20 +73,13 @@ process, but you must perform more tasks to upgrade the RHEL machines.

Operators are both the fundamental unit of the {product-title} {product-version}
code base and a convenient way to deploy applications and software components
for your applications to use. By using Operators as the platform foundation,
{product-title} replace manual upgrades of operating
systems and control plane applications. {product-title} Operators such as the
for your applications to use. In {product-title}, Operators serve as the platform foundation and remove the need for manual upgrades of operating systems and control plane applications. {product-title} Operators such as the
Cluster Version Operator and Machine Config Operator allow simplified,
cluster-wide management of those critical components.

Operator Lifecycle Manager (OLM) and the OperatorHub provide facilities for
storing and distributing Operators to people developing and deploying applications.

CRI-O Container Engine is the streamlined container engine that is is developed in
tandem with Kubernetes releases and provides facilities for running, stopping,
and restarting containers. It fully replaces the Docker Container Engine in
{product-title} {product-version}.

The Red Hat Quay Container Registry is a Quay.io container registry that serves
most of the container images and Operators to {product-title} clusters.
Quay.io is a public registry version of Red Hat Quay that stores millions of images
Expand Down Expand Up @@ -146,17 +128,3 @@ The following figure illustrates the basic {product-title} lifecycle:

.High level {product-title} overview
image::product-workflow-overview.png[High-level {product-title} flow]

[id="architecture-3-4_{context}"]
== {product-title} 3 and 4
With {product-title} {product-version}, the core story remains unchanged:
{product-title} offers
your developers a set of tools to evolve their applications under operational oversight
and using Kubernetes to provide application infrastructure. The key change to
{product-title} {product-version} is
that the infrastructure and its management are flexible, automated, and self-managing.

A major difference between {product-title} 3 and {product-title} {product-version}
is that {product-title} {product-version} uses Operators
as both the fundamental unit of the product and an option for easily deploying
and managing utilities that your apps use.
4 changes: 2 additions & 2 deletions modules/architecture-platform-introduction.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ thousands of machines that serve millions of clients.

With its foundation in Kubernetes, {product-title} incorporates the same
technology that serves as the engine for massive telecommunications, streaming
video, gaming, banking and other applications. Its implementation in open
video, gaming, banking, and other applications. Its implementation in open
Red Hat technologies lets you extend your containerized applications beyond a
single cloud to on-premise and multi-cloud environments.

Expand All @@ -20,4 +20,4 @@ single cloud to on-premise and multi-cloud environments.
// * Major components of {product-title}
// * Ways of exploring different aspects of {product-title} yourself
// * Available frontdoors (and backdoors) to modify the installation and management of your {product-title} cluster
// * Different types of container application types
// * Different types of container application types
2 changes: 1 addition & 1 deletion modules/cli-installing-cli.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ command-line interface.
[IMPORTANT]
====
If you installed an earlier version of `oc`, you cannot use it to complete all
of the commands in {product-title} {product-version}. You must download and
of the commands in {product-title} {product-version}. Download and
install the new version of `oc`.
====

Expand Down
4 changes: 1 addition & 3 deletions modules/installation-aws-config-yaml.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,5 @@ machines in your cluster.
+
[NOTE]
====
For production {product-title} clusters on which you want to perform installation
debugging or disaster recovery on, you must provide an SSH key that your `ssh-agent`
process uses to the installation program.
For production {product-title} clusters on which you want to perform installation debugging or disaster recovery on, specify an SSH key that your `ssh-agent` process uses.
====
3 changes: 1 addition & 2 deletions modules/installation-aws-limits.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -95,8 +95,7 @@ that are created by cluster usage and deployed workloads.
|VPC Gateway
|20
|20 per account
|Your AWS account uses VPC Gateways for S3 access. Each cluster creates a single
VPC Gateway for S3 access.
|Each cluster creates a single VPC Gateway for S3 access.


|S3 buckets
Expand Down
2 changes: 1 addition & 1 deletion modules/installation-aws-user-infra-bootstrap.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ following command:
+
----
$ ./openshift-install wait-for bootstrap-complete --dir=<installation_directory> \ <1>
--log-level info <2>
--log-level=info <2>
----
<1> For `<installation_directory>`, specify the path to the directory that you
stored the installation files in.
Expand Down
21 changes: 12 additions & 9 deletions modules/installation-aws-user-infra-requirements.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
// * installing/installing_aws_user_infra/installing-aws-user-infra.adoc
// * installing/installing_restricted_networks/installing-restricted-networks-aws.adoc



[id="installation-aws-user-infra-requirements_{context}"]
= Required AWS infrastructure components

Expand Down Expand Up @@ -37,16 +39,16 @@ control plane initializes and you can access the cluster API by using the `oc`
command line interface.
////

You can use the following instance types for the cluster machines:
You can use the following instance types for the cluster machines with the provided CloudFormation templates.

.Valid instance types for machines

[IMPORTANT]
====
If `m4` instance types are not available in your region, such as with
`eu-west-3`, use `m5` types instead.
====

.Instance types for machines
[cols="2a,2a,2a,2a",options="header"]
|===

Expand Down Expand Up @@ -152,13 +154,15 @@ If `m4` instance types are not available in your region, such as with

|===

You might be able to use other instance types that meet the specifications of these instance types.

[id="installation-aws-user-infra-other-infrastructure_{context}"]
== Other infrastructure components

* A VPC
* DNS entries
* Load balancers and listeners
* A Route53 zone
* A public and a private Route53 zone
* Security groups
* IAM roles
* S3 buckets
Expand All @@ -178,8 +182,8 @@ machines.
|VPC
|* `AWS::EC2::VPC`
* `AWS::EC2::VPCEndpoint`
2+|You must provide a public VPC for the cluster to use. The VPC requires an
endpoint that references the route tables for each subnet.
2+|You must provide a public VPC for the cluster to use. The VPC uses an
endpoint that references the route tables for each subnet to improve communication with the registry that is hosted in S3.

|Public subnets
|* `AWS::EC2::Subnet`
Expand All @@ -193,12 +197,11 @@ and associate them with appropriate Ingress rules.
* `AWS::EC2::VPCGatewayAttachment`
* `AWS::EC2::RouteTable`
* `AWS::EC2::Route`
* `PublicSubnetRouteTableAssociation`
* `AWS::EC2::SubnetRouteTableAssociation`
* `AWS::EC2::NatGateway`
* `AWS::EC2::EIP`
2+|You must have a public internet gateway, with public routes, attached to the
VPC. Each public subnet must also be attached to the route and have a NAT
gateway and EIP address.
VPC. In the provided templates, each public subnet has a NAT gateway with an EIP address. These NAT gateways allow cluster resources, like private-subnet instances, to reach the internet and are not required for some restricted network or proxy scenarios.

.7+|Network access control
.7+| * `AWS::EC2::NetworkAcl`
Expand Down Expand Up @@ -306,7 +309,7 @@ within the cluster.

|Internal target group
|`AWS::ElasticLoadBalancingV2::TargetGroup`
|The target group for the Internal load balancer.
|The target group for the internal load balancer.

|===

Expand Down
30 changes: 15 additions & 15 deletions modules/installation-aws-user-infra-rhcos-ami.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -18,48 +18,48 @@ You must use a valid {op-system-first} AMI for your Amazon Web Services
|AWS AMI

|`ap-northeast-1`
|`ami-0c63b39219b8123e5`
|`ami-0426ca3481a088c7b`

|`ap-northeast-2`
|`ami-073cba0913d2250a4`
|`ami-014514ae47679721b`

|`ap-south-1`
|`ami-0270be11430101040`
|`ami-0bd772ba746948d9a`

|`ap-southeast-1`
|`ami-06eb9d35ede4f08a3`
|`ami-0d76ac0ebaac29e40`

|`ap-southeast-2`
|`ami-0d980796ce258b5d5`
|`ami-0391e92574fb09e08`

|`ca-central-1`
|`ami-0f907257d1686e3f7`
|`ami-04419691da69850cf`

|`eu-central-1`
|`ami-02fdd627029c0055b`
|`ami-092b69120ecf915ed`

|`eu-west-1`
|`ami-0d4839574724ed3fa`
|`ami-04370efd78434697b`

|`eu-west-2`
|`ami-053073b95aa285347`
|`ami-00c74e593125e0096`

|`eu-west-3`
|`ami-09deb5deb6567bcd5`
|`ami-058ad17da14ff4d0d`

|`sa-east-1`
|`ami-068a2000546e1889d`
|`ami-03f6b71e93e630dab`

|`us-east-1`
|`ami-046fe691f52a953f9`
|`ami-01e7fdcb66157b224`

|`us-east-2`
|`ami-0649fd5d42859bdfc`
|`ami-0bc59aaa7363b805d`

|`us-west-1`
|`ami-0c1d2b5606111ac8c`
|`ami-0ba912f53c1fdcdf0`

|`us-west-2`
|`ami-00745fcbb14a863ed`
|`ami-08e10b201e19fd5e7`

|===
2 changes: 1 addition & 1 deletion modules/installation-azure-config-yaml.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -86,5 +86,5 @@ If you disable simultaneous multithreading, ensure that your capacity planning a
+
[NOTE]
====
For production {product-title} clusters on which you want to perform installation debugging or disaster recovery on, you must provide an SSH key that your `ssh-agent` process uses to the installation program.
For production {product-title} clusters on which you want to perform installation debugging or disaster recovery on, specify an SSH key that your `ssh-agent` process uses.
====
4 changes: 1 addition & 3 deletions modules/installation-bare-metal-config-yaml.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -120,9 +120,7 @@ endif::restricted[]
+
[NOTE]
====
For production {product-title} clusters on which you want to perform installation
debugging or disaster recovery on, you must provide an SSH key that your `ssh-agent`
process uses to the installation program.
For production {product-title} clusters on which you want to perform installation debugging or disaster recovery on, specify an SSH key that your `ssh-agent` process uses.
====
ifdef::restricted[]
<13> Provide the contents of the certificate file that you used for your mirror
Expand Down
8 changes: 3 additions & 5 deletions modules/installation-configuration-parameters.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
// * installing/installing_openstack/installing-openstack-installer-custom.adoc
// * installing/installing_openstack/installing-openstack-installer-kuryr.adoc

ifeval::["{context}" == "install-customizations-cloud"]
ifeval::["{context}" == "installing-aws-customizations"]
:aws:
endif::[]
ifeval::["{context}" == "installing-aws-network-customizations"]
Expand Down Expand Up @@ -45,7 +45,7 @@ command line. If you customize your cluster, you can modify the

[NOTE]
====
You cannot modify these parameters after installation.
You cannot modify these parameters in the `install-config.yaml` file after installation.
====

.Required parameters
Expand Down Expand Up @@ -115,9 +115,7 @@ container images for {product-title} components.
|The SSH key to use to access your cluster machines.
[NOTE]
====
For production {product-title} clusters on which you want to perform installation
debugging or disaster recovery on, you must provide an SSH key that your `ssh-agent`
process uses to the installation program.
For production {product-title} clusters on which you want to perform installation debugging or disaster recovery on, specify an SSH key that your `ssh-agent` process uses.
====
|A valid, local public SSH key that you added to the `ssh-agent` process.

Expand Down
Loading