Skip to content
Open
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
19 changes: 9 additions & 10 deletions installing/installing_aws/installing-aws-account.adoc
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
:_mod-docs-content-type: ASSEMBLY
[id="installing-aws-account"]
= Configuring an AWS account
include::_attributes/common-attributes.adoc[]
= Configuring an AWS account

:context: installing-aws-account

toc::[]

Before you can install {product-title}, you must configure an
Amazon Web Services (AWS) account.
[role="_abstract"]
Before you can install {product-title}, you must configure an {aws-first} account.

include::modules/installation-aws-route53.adoc[leveloffset=+1]

Expand Down Expand Up @@ -35,10 +36,8 @@ include::modules/installation-aws-marketplace.adoc[leveloffset=+1]

include::modules/installation-aws-regions.adoc[leveloffset=+1]

== Next steps

* Install an {product-title} cluster:
** xref:../../installing/installing_aws/ipi/installing-aws-default.adoc#installing-aws-default[Quickly install a cluster] with default options on installer-provisioned infrastructure
** xref:../../installing/installing_aws/ipi/installing-aws-customizations.adoc#installing-aws-customizations[Install a cluster with cloud customizations on installer-provisioned infrastructure]
** xref:../../installing/installing_aws/ipi/installing-aws-network-customizations.adoc#installing-aws-network-customizations[Install a cluster with network customizations on installer-provisioned infrastructure]
** xref:../../installing/installing_aws/upi/installing-aws-user-infra.adoc#installing-aws-user-infra[Installing a cluster on user-provisioned infrastructure in AWS by using CloudFormation templates]
[role="_additional-resources"]
.Additional resources
* xref:../../installing/installing_aws/ipi/installing-aws-default.adoc#installing-aws-default[Quickly install a cluster]
* xref:../../installing/installing_aws/ipi/installing-aws-customizations.adoc#installing-aws-customizations[Install a cluster with cloud customizations on installer-provisioned infrastructure]
* xref:../../installing/installing_aws/upi/installing-aws-user-infra.adoc#installing-aws-user-infra[Installing a cluster on user-provisioned infrastructure in AWS by using CloudFormation templates]
13 changes: 8 additions & 5 deletions installing/installing_aws/installing-aws-three-node.adoc
Original file line number Diff line number Diff line change
@@ -1,22 +1,25 @@
:_mod-docs-content-type: ASSEMBLY
[id="installing-aws-three-node"]
= Installing a three-node cluster on AWS
include::_attributes/common-attributes.adoc[]
[id="installing-aws-three-node"]
= Installing a three-node cluster on {aws-short}
:context: installing-aws-three-node

toc::[]

In {product-title} version {product-version}, you can install a three-node cluster on Amazon Web Services (AWS). A three-node cluster consists of three control plane machines, which also act as compute machines. This type of cluster provides a smaller, more resource efficient cluster, for cluster administrators and developers to use for testing, development, and production.
[role="_abstract"]
In {product-title} version {product-version}, you can install a three-node cluster on {aws-first}. A three-node cluster consists of three control plane machines, which also act as compute machines.

This type of cluster provides a smaller, more resource efficient cluster, for cluster administrators and developers to use for testing, development, and production.

You can install a three-node cluster using either installer-provisioned or user-provisioned infrastructure.

[NOTE]
====
Deploying a three-node cluster using an AWS Marketplace image is not supported.
Deploying a three-node cluster using an {aws-short} Marketplace image is not supported.
====

include::modules/installation-three-node-cluster-cloud-provider.adoc[leveloffset=+1]

== Next steps
== Additional resources
* xref:../../installing/installing_aws/ipi/installing-aws-customizations.adoc#installing-aws-customizations[Installing a cluster on AWS with customizations]
* xref:../../installing/installing_aws/upi/installing-aws-user-infra.adoc#installing-aws-user-infra[Installing a cluster on user-provisioned infrastructure in AWS by using CloudFormation templates]
11 changes: 8 additions & 3 deletions installing/installing_aws/ipi/ipi-aws-preparing-to-install.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,16 @@ include::_attributes/common-attributes.adoc[]

toc::[]

You prepare to install an {product-title} cluster on AWS by completing the following steps:
[role="_abstract"]
To install an {product-title} cluster on {aws-first}, you must verify your internet connectivity, download the installation program, install the {oc-first}, and generate an SSH key pair.

If required, you also need to manually create long-term credentials for {aws-short} or configure an {aws-short} cluster to use short-term credentials with Amazon Web Services Security Token Service ({aws-short} STS).

The following list outlines in detail the steps to prepare to install an {product-title} cluster on {aws-short}:

* Verifying internet connectivity for your cluster.

* xref:../../../installing/installing_aws/installing-aws-account.adoc#installing-aws-account[Configuring an AWS account].
* xref:../../../installing/installing_aws/installing-aws-account.adoc#installing-aws-account[Configuring an aws-short} account].

* Downloading the installation program.
+
Expand All @@ -26,7 +31,7 @@ If you are installing in a disconnected environment, install `oc` to the mirror
====
* Generating an SSH key pair. You can use this key pair to authenticate into the {product-title} cluster's nodes after it is deployed.

* If the cloud identity and access management (IAM) APIs are not accessible in your environment, or if you do not want to store an administrator-level credential secret in the `kube-system` namespace, xref:../../../installing/installing_aws/ipi/installing-aws-customizations.adoc#manually-create-iam_installing-aws-customizations[manually creating long-term credentials for AWS] or xref:../../../installing/installing_aws/ipi/installing-aws-customizations.adoc#installing-aws-with-short-term-creds_installing-aws-customizations[configuring an AWS cluster to use short-term credentials] with Amazon Web Services Security Token Service (AWS STS).
* If the cloud identity and access management (IAM) APIs are not accessible in your environment, or if you do not want to store an administrator-level credential secret in the `kube-system` namespace, xref:../../../installing/installing_aws/ipi/installing-aws-customizations.adoc#manually-create-iam_installing-aws-customizations[manually creating long-term credentials for {aws-short}] or xref:../../../installing/installing_aws/ipi/installing-aws-customizations.adoc#installing-aws-with-short-term-creds_installing-aws-customizations[configuring an {aws-short} cluster to use short-term credentials] with ({aws-short} STS).

include::modules/cluster-entitlements.adoc[leveloffset=+1]

Expand Down
49 changes: 19 additions & 30 deletions installing/installing_aws/preparing-to-install-on-aws.adoc
Original file line number Diff line number Diff line change
@@ -1,47 +1,36 @@
:_mod-docs-content-type: ASSEMBLY
[id="preparing-to-install-on-aws"]
[id="installing-methods-aws"]
= Installation methods
include::_attributes/common-attributes.adoc[]
:context: preparing-to-install-on-aws

toc::[]

You can install {product-title} on Amazon Web Services (AWS) using installer-provisioned or user-provisioned infrastructure. The default installation type uses installer-provisioned infrastructure, where the installation program provisions the underlying infrastructure for the cluster. You can also install {product-title} on infrastructure that you provision. If you do not use infrastructure that the installation program provisions, you must manage and maintain the cluster resources yourself. You can also install {product-title} on a single node, which is a specialized installation method that is ideal for edge computing environments.
[role="_abstract"]
You can install {product-title} on {aws-full} using installer-provisioned, user-provisioned infrastructure, or on a single node, depending on the needs of your use case.

[id="choosing-an-method-to-install-ocp-on-aws-installer-provisioned"]
== Installing a cluster on installer-provisioned infrastructure
The default installation type uses installer-provisioned infrastructure, where the installation program provisions the underlying infrastructure for the cluster.

You can install a cluster on AWS infrastructure that is provisioned by the {product-title} installation program, by using one of the following methods:
You can also install {product-title} on infrastructure that you provision. If you do not use infrastructure that the installation program provisions, you must manage and maintain the cluster resources yourself.

* **xref:../../installing/installing_aws/ipi/installing-aws-default.adoc#installing-aws-default[Installing a cluster quickly on AWS]**: You can install {product-title} on AWS infrastructure that is provisioned by the {product-title} installation program. You can install a cluster quickly by using the default configuration options.
You can also install {product-title} on a single node, which is a specialized installation method that is ideal for edge computing environments.

* **xref:../../installing/installing_aws/ipi/installing-aws-customizations.adoc#installing-aws-customizations[Installing a customized cluster on AWS]**: You can install a customized cluster on AWS infrastructure that the installation program provisions. The installation program allows for some customization to be applied at the installation stage. Many other customization options are available xref:../../post_installation_configuration/cluster-tasks.adoc#post-install-cluster-tasks[post-installation].
include::modules/installing-aws-ipi.adoc[leveloffset=+1]

* **xref:../../installing/installing_aws/ipi/installing-aws-network-customizations.adoc#installing-aws-network-customizations[Installing a cluster on AWS with network customizations]**: You can customize your {product-title} network configuration during installation, so that your cluster can coexist with your existing IP address allocations and adhere to your network requirements.
include::modules/installing-aws-upi.adoc[leveloffset=+1]

* **xref:../../installing/installing_aws/ipi/installing-restricted-networks-aws-installer-provisioned.adoc#installing-restricted-networks-aws-installer-provisioned[Installing a cluster on AWS in a restricted network]**: You can install {product-title} on AWS on installer-provisioned infrastructure by using an internal mirror of the installation release content. You can use this method to install a cluster that does not require an active internet connection to obtain the software components.

* **xref:../../installing/installing_aws/ipi/installing-aws-vpc.adoc#installing-aws-vpc[Installing a cluster on an existing Virtual Private Cloud]**: You can install {product-title} on an existing AWS Virtual Private Cloud (VPC). You can use this installation method if you have constraints set by the guidelines of your company, such as limits when creating new accounts or infrastructure.

* **xref:../../installing/installing_aws/ipi/installing-aws-private.adoc#installing-aws-private[Installing a private cluster on an existing VPC]**: You can install a private cluster on an existing AWS VPC. You can use this method to deploy {product-title} on an internal network that is not visible to the internet.

* **xref:../../installing/installing_aws/ipi/installing-aws-government-region.adoc#installing-aws-government-region[Installing a cluster on AWS into a government or secret region]**: {product-title} can be deployed into AWS regions that are specifically designed for US government agencies at the federal, state, and local level, as well as contractors, educational institutions, and other US customers that must run sensitive workloads in the cloud.

[id="choosing-an-method-to-install-ocp-on-aws-user-provisioned"]
== Installing a cluster on user-provisioned infrastructure

You can install a cluster on AWS infrastructure that you provision, by using one of the following methods:

* **xref:../../installing/installing_aws/upi/installing-aws-user-infra.adoc#installing-aws-user-infra[Installing a cluster on AWS infrastructure that you provide]**: You can install {product-title} on AWS infrastructure that you provide. You can use the provided CloudFormation templates to create stacks of AWS resources that represent each of the components required for an {product-title} installation.

* **xref:../../installing/installing_aws/upi/installing-restricted-networks-aws.adoc#installing-restricted-networks-aws[Installing a cluster on AWS in a restricted network with user-provisioned infrastructure]**: You can install {product-title} on AWS infrastructure that you provide by using an internal mirror of the installation release content. You can use this method to install a cluster that does not require an active internet connection to obtain the software components. You can also use this installation method to ensure that your clusters only use container images that satisfy your organizational controls on external content. While you can install {product-title} by using the mirrored content, your cluster still requires internet access to use the AWS APIs.

[id="choosing-an-method-to-install-ocp-on-aws-single-node"]
== Installing a cluster on a single node

Installing {product-title} on a single node alleviates some of the requirements for high availability and large scale clusters. However, you must address the xref:../../installing/installing_sno/install-sno-preparing-to-install-sno.adoc#install-sno-requirements-for-installing-on-a-single-node_install-sno-preparing[requirements for installing on a single node], and the xref:../../installing/installing_sno/install-sno-installing-sno.adoc#additional-requirements-for-installing-sno-on-a-cloud-provider_install-sno-installing-sno-with-the-assisted-installer[additional requirements for installing {sno} on a cloud provider]. After addressing the requirements for single node installation, use the xref:../../installing/installing_aws/ipi/installing-aws-customizations.adoc#installing-aws-customizations[Installing a customized cluster on AWS] procedure to install the cluster. The xref:../../installing/installing_sno/install-sno-installing-sno.adoc#install-sno-installing-sno-manually[installing single-node OpenShift manually] section contains an exemplary `install-config.yaml` file when installing an {product-title} cluster on a single node.
include::modules/installing-aws-single-node.adoc[leveloffset=+1]

[role="_additional-resources"]
[id="preparing-to-install-on-aws-additional-resources"]
[id="installing-methods-aws-ipi-additional-resources"]
== Additional resources
* xref:../../installing/installing_aws/ipi/installing-aws-default.adoc#installing-aws-default[Installing a cluster quickly on AWS]
* xref:../../installing/installing_aws/ipi/installing-aws-customizations.adoc#installing-aws-customizations[Installing a customized cluster on AWS]
* xref:../../post_installation_configuration/cluster-tasks.adoc#post-install-cluster-tasks[Post-installation]
* xref:../../installing/installing_aws/ipi/installing-restricted-networks-aws-installer-provisioned.adoc#installing-restricted-networks-aws-installer-provisioned[Installing a cluster on AWS in a restricted network]
* xref:../../installing/installing_aws/ipi/installing-aws-vpc.adoc#installing-aws-vpc[Installing a cluster on an existing Virtual Private Cloud]
* xref:../../installing/installing_aws/ipi/installing-aws-private.adoc#installing-aws-private[Installing a private cluster on an existing VPC]
* xref:../../installing/installing_aws/ipi/installing-aws-specialized-region.adoc#installing-aws-specialized-region[Installing a cluster on AWS into a government or secret region]
* xref:../../installing/installing_aws/upi/installing-aws-user-infra.adoc#installing-aws-user-infra[Installing a cluster on AWS infrastructure that you provide]
* xref:../../installing/installing_aws/upi/installing-restricted-networks-aws.adoc#installing-restricted-networks-aws[Installing a cluster on AWS in a restricted network with user-provisioned infrastructure]
* xref:../../architecture/architecture-installation.adoc#installation-process_architecture-installation[Installation process]
11 changes: 6 additions & 5 deletions installing/installing_aws/uninstalling-cluster-aws.adoc
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
:_mod-docs-content-type: ASSEMBLY
[id="uninstalling-cluster-aws"]
= Uninstalling a cluster on AWS
include::_attributes/common-attributes.adoc[]
[id="uninstalling-cluster-aws"]
= Uninstalling a cluster on {aws-short}
:context: uninstall-cluster-aws

toc::[]

You can remove a cluster that you deployed to Amazon Web Services (AWS).
[role="_abstract"]
You can remove a cluster that you deployed to {aws-first}.

include::modules/installation-uninstall-clouds.adoc[leveloffset=+1]

Expand All @@ -16,9 +17,9 @@ include::modules/installation-aws-delete-cluster.adoc[leveloffset=+1]

[role="_additional-resources"]
[id="installing-localzone-additional-resources"]
.Additional resources
== Additional resources

* See link:https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacks.html[Working with stacks] in the AWS documentation for more information about AWS CloudFormation stacks.
* link:https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacks.html[Working with stacks]
* link:https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#opt-in-local-zone[Opt into AWS Local Zones]
* link:https://aws.amazon.com/about-aws/global-infrastructure/localzones/locations[AWS Local Zones available locations]
* link:https://aws.amazon.com/about-aws/global-infrastructure/localzones/features[AWS Local Zones features]
Loading