diff --git a/_topic_map.yml b/_topic_map.yml index 897f5597e6..8426846fa7 100644 --- a/_topic_map.yml +++ b/_topic_map.yml @@ -86,11 +86,11 @@ Topics: File: installing-aws-network-customizations - Name: Uninstalling a cluster on AWS File: uninstalling-cluster-aws -- Name: Installing on AWS UPI - Dir: installing_aws_upi +- Name: Installing on user-provisioned AWS + Dir: installing_aws_user_infra Topics: - Name: Installing a cluster on AWS using CloudFormation templates - File: installing-aws-upi + File: installing-aws-user-infra - Name: Installing on bare metal Dir: installing_bare_metal Topics: diff --git a/installing/installing_aws/installing-aws-network-customizations.adoc b/installing/installing_aws/installing-aws-network-customizations.adoc index 8d6d5728a0..28be6016cf 100644 --- a/installing/installing_aws/installing-aws-network-customizations.adoc +++ b/installing/installing_aws/installing-aws-network-customizations.adoc @@ -25,8 +25,6 @@ to host the cluster. include::modules/installation-overview.adoc[leveloffset=+1] -include::modules/installation-clouds.adoc[leveloffset=+1] - include::modules/installation-provide-credentials.adoc[leveloffset=+1] include::modules/installation-obtaining-installer.adoc[leveloffset=+1] diff --git a/installing/installing_aws_upi/installing-aws-upi.adoc b/installing/installing_aws_user_infra/installing-aws-user-infra.adoc similarity index 82% rename from installing/installing_aws_upi/installing-aws-upi.adoc rename to installing/installing_aws_user_infra/installing-aws-user-infra.adoc index 165c2148d0..19bbf4f49e 100644 --- a/installing/installing_aws_upi/installing-aws-upi.adoc +++ b/installing/installing_aws_user_infra/installing-aws-user-infra.adoc @@ -1,7 +1,7 @@ -[id="installing-aws-upi"] +[id="installing-aws-user-infra"] = Installing a cluster on AWS using CloudFormation templates include::modules/common-attributes.adoc[] -:context: installing-aws-upi +:context: installing-aws-user-infra toc::[] @@ -20,7 +20,7 @@ to host the cluster. include::modules/installation-overview.adoc[leveloffset=+1] -include::modules/installation-aws-upi-requirements.adoc[leveloffset=+1] +include::modules/installation-aws-user-infra-requirements.adoc[leveloffset=+1] include::modules/installation-aws-permissions.adoc[leveloffset=+2] @@ -28,7 +28,7 @@ include::modules/installation-obtaining-installer.adoc[leveloffset=+1] include::modules/installation-provide-credentials.adoc[leveloffset=+1] -include::modules/installation-generate-aws-upi.adoc[leveloffset=+1] +include::modules/installation-generate-aws-user-infra.adoc[leveloffset=+1] include::modules/installation-extracting-infraid.adoc[leveloffset=+1] @@ -44,7 +44,7 @@ include::modules/installation-creating-aws-security.adoc[leveloffset=+1] include::modules/installation-cloudformation-security.adoc[leveloffset=+2] -include::modules/installation-aws-upi-rhcos-ami.adoc[leveloffset=+1] +include::modules/installation-aws-user-infra-rhcos-ami.adoc[leveloffset=+1] include::modules/installation-creating-aws-bootstrap.adoc[leveloffset=+1] @@ -54,10 +54,10 @@ include::modules/installation-creating-aws-control-plane.adoc[leveloffset=+1] include::modules/installation-cloudformation-control-plane.adoc[leveloffset=+2] -include::modules/installation-aws-upi-bootstrap.adoc[leveloffset=+1] +include::modules/installation-aws-user-infra-bootstrap.adoc[leveloffset=+1] //// -[id="installing-workers-aws-upi"] +[id="installing-workers-aws-user-infra"] == Creating worker nodes You can either manually create worker nodes or use a MachineSet to create worker @@ -77,4 +77,4 @@ include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1] include::modules/installation-approve-csrs.adoc[leveloffset=+1] -include::modules/installation-aws-upi-installation.adoc[leveloffset=+1] \ No newline at end of file +include::modules/installation-aws-user-infra-installation.adoc[leveloffset=+1] diff --git a/installing/installing_bare_metal/installing-bare-metal.adoc b/installing/installing_bare_metal/installing-bare-metal.adoc index 62aefa14a2..4ba12a8d8d 100644 --- a/installing/installing_bare_metal/installing-bare-metal.adoc +++ b/installing/installing_bare_metal/installing-bare-metal.adoc @@ -10,13 +10,13 @@ bare metal infrastructure that you provision. include::modules/installation-overview.adoc[leveloffset=+1] -include::modules/installation-requirements-upi.adoc[leveloffset=+1] +include::modules/installation-requirements-user-infra.adoc[leveloffset=+1] -include::modules/installation-infrastructure-upi.adoc[leveloffset=+1] +include::modules/installation-infrastructure-user-infra.adoc[leveloffset=+1] -include::modules/installation-network-upi.adoc[leveloffset=+2] +include::modules/installation-network-user-infra.adoc[leveloffset=+2] -include::modules/installation-dns-upi.adoc[leveloffset=+2] +include::modules/installation-dns-user-infra.adoc[leveloffset=+2] include::modules/installation-obtaining-installer.adoc[leveloffset=+1] @@ -28,7 +28,7 @@ include::modules/installation-bare-metal-config-yaml.adoc[leveloffset=+2] include::modules/installation-generate-ignition-configs.adoc[leveloffset=+1] -include::modules/installation-upi-machines-iso.adoc[leveloffset=+1] +include::modules/installation-user-infra-machines-iso.adoc[leveloffset=+1] include::modules/installation-installing-bare-metal.adoc[leveloffset=+1] @@ -40,7 +40,7 @@ include::modules/installation-operators-config.adoc[leveloffset=+1] include::modules/installation-registry-storage-non-production.adoc[leveloffset=+2] -include::modules/installation-complete-upi.adoc[leveloffset=+1] +include::modules/installation-complete-user-infra.adoc[leveloffset=+1] .Next steps diff --git a/installing/installing_vsphere/installing-vsphere.adoc b/installing/installing_vsphere/installing-vsphere.adoc index a4197b0466..9464c19842 100644 --- a/installing/installing_vsphere/installing-vsphere.adoc +++ b/installing/installing_vsphere/installing-vsphere.adoc @@ -10,13 +10,13 @@ vSphere infrastructure that you provision. include::modules/installation-overview.adoc[leveloffset=+1] -include::modules/installation-requirements-upi.adoc[leveloffset=+1] +include::modules/installation-requirements-user-infra.adoc[leveloffset=+1] -include::modules/installation-infrastructure-upi.adoc[leveloffset=+1] +include::modules/installation-infrastructure-user-infra.adoc[leveloffset=+1] -include::modules/installation-network-upi.adoc[leveloffset=+2] +include::modules/installation-network-user-infra.adoc[leveloffset=+2] -include::modules/installation-dns-upi.adoc[leveloffset=+2] +include::modules/installation-dns-user-infra.adoc[leveloffset=+2] include::modules/installation-obtaining-installer.adoc[leveloffset=+1] @@ -40,7 +40,7 @@ include::modules/installation-operators-config.adoc[leveloffset=+1] include::modules/installation-registry-storage-non-production.adoc[leveloffset=+2] -include::modules/installation-complete-upi.adoc[leveloffset=+1] +include::modules/installation-complete-user-infra.adoc[leveloffset=+1] diff --git a/machine_management/adding-rhel-compute.adoc b/machine_management/adding-rhel-compute.adoc index e162656ba8..c6250d9784 100644 --- a/machine_management/adding-rhel-compute.adoc +++ b/machine_management/adding-rhel-compute.adoc @@ -6,7 +6,7 @@ include::modules/common-attributes.adoc[] toc::[] In {product-title}, you can add Red Hat Enterprise Linux (RHEL) compute, or -worker, machines to a user provisioned infrastructure cluster. You can use RHEL +worker, machines to a user-provisioned infrastructure cluster. You can use RHEL as the operating system on only compute machines. include::modules/rhel-compute-overview.adoc[leveloffset=+1] diff --git a/modules/installation-approve-csrs.adoc b/modules/installation-approve-csrs.adoc index ad17302d5f..069a14c318 100644 --- a/modules/installation-approve-csrs.adoc +++ b/modules/installation-approve-csrs.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * installing/installing_aws_upi/installing-aws-upi.adoc +// * installing/installing_aws_user_infra/installing-aws-user-infra.adoc // * installing/installing_bare_metal/installing-bare-metal.adoc // * installing/installing_vsphere/installing-vsphere.adoc // * machine_management/adding-rhel-compute.adoc diff --git a/modules/installation-aws-upi-bootstrap.adoc b/modules/installation-aws-user-infra-bootstrap.adoc similarity index 82% rename from modules/installation-aws-upi-bootstrap.adoc rename to modules/installation-aws-user-infra-bootstrap.adoc index 9f04c4de45..b2fac9d2b9 100644 --- a/modules/installation-aws-upi-bootstrap.adoc +++ b/modules/installation-aws-user-infra-bootstrap.adoc @@ -1,9 +1,9 @@ // Module included in the following assemblies: // -// * installing/installing_aws_upi/installing-aws-upi.adoc +// * installing/installing_aws_user_infra/installing-aws-user-infra.adoc -[id="installation-aws-upi-bootstrap_{context}"] -= Initializing the bootstrap node on AWS UPI +[id="installation-aws-user-infra-bootstrap-{context}"] += Initializing the bootstrap node on AWS with user-provisioned infrastructure After you create all of the required infrastructure in Amazon Web Services (AWS), you can install the cluster. diff --git a/modules/installation-aws-upi-installation.adoc b/modules/installation-aws-user-infra-installation.adoc similarity index 81% rename from modules/installation-aws-upi-installation.adoc rename to modules/installation-aws-user-infra-installation.adoc index f3a9ed7da4..83a45da733 100644 --- a/modules/installation-aws-upi-installation.adoc +++ b/modules/installation-aws-user-infra-installation.adoc @@ -1,9 +1,9 @@ // Module included in the following assemblies: // -// * installing/installing_aws_upi/installing-aws-upi.adoc +// * installing/installing_aws_user_infra/installing-aws-user-infra.adoc -[id="installation-aws-upi-installation_{context}"] -= Completing an AWS UPI installation +[id="installation-aws-user-infra-installation-{context}"] += Completing an AWS installation on user-provisioned infrastructure After you start the {product-title} installation on Amazon Web Service (AWS) user-provisioned infrastructure, remove the bootstrap node, reconcile the default diff --git a/modules/installation-aws-upi-requirements.adoc b/modules/installation-aws-user-infra-requirements.adoc similarity index 95% rename from modules/installation-aws-upi-requirements.adoc rename to modules/installation-aws-user-infra-requirements.adoc index f2950d9238..b9f0aafab5 100644 --- a/modules/installation-aws-upi-requirements.adoc +++ b/modules/installation-aws-user-infra-requirements.adoc @@ -1,9 +1,9 @@ // Module included in the following assemblies: // -// * installing/installing_aws_upi/installing-aws-upi.adoc +// * installing/installing_aws_user_infra/installing-aws-user-infra.adoc -[id="installation-aws-upi-requirements_{context}"] -= Required AWS UPI infrastructure components +[id="installation-aws-user-infra-requirements-{context}"] += Required AWS infrastructure components To install {product-title} on user-provisioned infrastructure in Amazon Web Services (AWS), you must manually create both the machines and their @@ -14,7 +14,7 @@ you can manually create the components, or you can reuse existing infrastructure that meets the cluster requirements. Review the CloudFormation templates for more details about how the components interrelate. -[id="installation-aws-upi-cluster-machines_{context}"] +[id="installation-aws-user-infra-cluster-machines-{context}"] == Cluster machines You need `AWS::EC2::Instance` objects for the following machines: @@ -141,7 +141,7 @@ You can use the following instance types for the cluster machines: |=== -[id="installation-aws-upi-other-infrastructure_{context}"] +[id="installation-aws-user-infra-other-infrastructure-{context}"] == Other infrastructure components * A VPC @@ -227,7 +227,8 @@ for them. .Required DNS and load balancing components Your DNS and load balancer configuration needs to use a public hosted zone and -can use a private hosted zone similar to the IPI installation method. You must +can use a private hosted zone similar to the one that the installer uses if it +provisions the cluster's infrastructure. You must create a DNS entry that resolves to your load balancer. An entry for `api..` must point to the external load balancer, and an entry for `api-int..` must point to the internal load diff --git a/modules/installation-aws-upi-rhcos-ami.adoc b/modules/installation-aws-user-infra-rhcos-ami.adoc similarity index 83% rename from modules/installation-aws-upi-rhcos-ami.adoc rename to modules/installation-aws-user-infra-rhcos-ami.adoc index db417cff1a..6644e44bf2 100644 --- a/modules/installation-aws-upi-rhcos-ami.adoc +++ b/modules/installation-aws-user-infra-rhcos-ami.adoc @@ -1,9 +1,9 @@ // Module included in the following assemblies: // -// * installing/installing_aws_upi/installing-aws-upi.adoc +// * installing/installing_aws_user_infra/installing-aws-user-infra.adoc -[id="installation-aws-upi-rhcos-ami_{context}"] -= {op-system} AMIs for the AWS UPI infrastructure +[id="installation-aws-user-infra-rhcos-ami-{context}"] += {op-system} AMIs for the AWS infrastructure You must use a valid {op-system-first} AMI for your Amazon Web Services (AWS) zone for your {product-title} nodes. diff --git a/modules/installation-cloudformation-bootstrap.adoc b/modules/installation-cloudformation-bootstrap.adoc index 164d3fea7b..21aa26c7fd 100644 --- a/modules/installation-cloudformation-bootstrap.adoc +++ b/modules/installation-cloudformation-bootstrap.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * installing/installing_aws_upi/installing-aws-upi.adoc +// * installing/installing_aws_user_infra/installing-aws-user-infra.adoc [id="installation-cloudformation-bootstrap_{context}"] = CloudFormation template for the bootstrap machine @@ -11,7 +11,7 @@ machine that you need for your {product-title} cluster. [source,yaml] ---- AWSTemplateFormatVersion: 2010-09-09 -Description: Template for Openshift Cluster UPI Bootstrap (EC2 Instance, Security Groups and IAM) +Description: Template for OpenShift Cluster Bootstrap (EC2 Instance, Security Groups and IAM) Parameters: InfrastructureName: diff --git a/modules/installation-cloudformation-control-plane.adoc b/modules/installation-cloudformation-control-plane.adoc index 9dbaa78001..f7d4120fc9 100644 --- a/modules/installation-cloudformation-control-plane.adoc +++ b/modules/installation-cloudformation-control-plane.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * installing/installing_aws_upi/installing-aws-upi.adoc +// * installing/installing_aws_user_infra/installing-aws-user-infra.adoc [id="installation-cloudformation-control-plane_{context}"] = CloudFormation template for control plane machines @@ -11,7 +11,7 @@ machines that you need for your {product-title} cluster. [source,yaml] ---- AWSTemplateFormatVersion: 2010-09-09 -Description: Template for Openshift Cluster UPI Node Launch (EC2 master instances) +Description: Template for OpenShift Cluster Node Launch (EC2 master instances) Parameters: InfrastructureName: diff --git a/modules/installation-cloudformation-dns.adoc b/modules/installation-cloudformation-dns.adoc index ac52ef4036..71068590ff 100644 --- a/modules/installation-cloudformation-dns.adoc +++ b/modules/installation-cloudformation-dns.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * installing/installing_aws_upi/installing-aws-upi.adoc +// * installing/installing_aws_user_infra/installing-aws-user-infra.adoc [id="installation-cloudformation-dns_{context}"] = CloudFormation template for the network and load balancers @@ -12,7 +12,7 @@ objects and load balancers that you need for your {product-title} cluster. [source,yaml] ---- AWSTemplateFormatVersion: 2010-09-09 -Description: Template for Openshift Cluster UPI Network Elements (Route53 & LBs) +Description: Template for OpenShift Cluster Network Elements (Route53 & LBs) Parameters: ClusterName: diff --git a/modules/installation-cloudformation-security.adoc b/modules/installation-cloudformation-security.adoc index 12b9957efd..6b71431ac4 100644 --- a/modules/installation-cloudformation-security.adoc +++ b/modules/installation-cloudformation-security.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * installing/installing_aws_upi/installing-aws-upi.adoc +// * installing/installing_aws_user_infra/installing-aws-user-infra.adoc [id="installation-cloudformation-security_{context}"] = CloudFormation template for security objects @@ -11,7 +11,7 @@ that you need for your {product-title} cluster. [source,yaml] ---- AWSTemplateFormatVersion: 2010-09-09 -Description: Template for Openshift Cluster UPI Security Elements (Security Groups & IAM) +Description: Template for OpenShift Cluster Security Elements (Security Groups & IAM) Parameters: InfrastructureName: diff --git a/modules/installation-cloudformation-vpc.adoc b/modules/installation-cloudformation-vpc.adoc index 1e50563ae3..cb8106507d 100644 --- a/modules/installation-cloudformation-vpc.adoc +++ b/modules/installation-cloudformation-vpc.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * installing/installing_aws_upi/installing-aws-upi.adoc +// * installing/installing_aws_user_infra/installing-aws-user-infra.adoc [id="installation-cloudformation-vpc_{context}"] = CloudFormation template for the VPC diff --git a/modules/installation-cloudformation-worker.adoc b/modules/installation-cloudformation-worker.adoc index c5b63bc56b..29297de73e 100644 --- a/modules/installation-cloudformation-worker.adoc +++ b/modules/installation-cloudformation-worker.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * installing/installing_aws_upi/installing-aws-upi.adoc +// * installing/installing_aws_user_infra/installing-aws-user-infra.adoc [id="installation-cloudformation-worker_{context}"] = CloudFormation template for worker machines @@ -11,7 +11,7 @@ that you need for your {product-title} cluster. [source,yaml] ---- AWSTemplateFormatVersion: 2010-09-09 -Description: Template for Openshift Cluster UPI Node Launch (EC2 worker instance) +Description: Template for OpenShift Cluster Node Launch (EC2 worker instance) Parameters: InfrastructureName: diff --git a/modules/installation-clouds.adoc b/modules/installation-clouds.adoc deleted file mode 100644 index 69f0c93c97..0000000000 --- a/modules/installation-clouds.adoc +++ /dev/null @@ -1,75 +0,0 @@ -// Module included in the following assemblies: -// -// * installing/installing_aws/installing-aws-default.adoc -// * installing/installing_aws/installing-aws-customizations.adoc - -[id="cloud-installations_{context}"] -= {product-title} clusters on Installer Provisioned Infrastructure - -[IMPORTANT] -==== -In version {product-version}, you can install {product-title} on only Amazon -Web Services (AWS). -==== - -You can install either a standard cluster or a customized cluster. With a -standard cluster, you provide minimum details that are required to install the -cluster. With a customized cluster, you can specify more details about the -platform, such as the number of machines that the control plane uses, the type -of virtual machine that the cluster deploys, or the CIDR range for the -Kubernetes service network. - -[IMPORTANT] -==== -It is possible to modify Kubernetes and the Ignition Configs that control -the underlying {op-system-first} operating system during installation. However, -no validation is available to confirm the suitability of any modifications that -you make to these objects. If you modify these objects, you might render -your cluster non-functional. Because of this risk, modifying Kubernetes and -Ignition Configs is not supported. -==== - -When you install {product-title} cluster with Installer Provisioned Infrastructure (IPI), you download the -installer from link:https://cloud.openshift.com/clusters/install[the OpenShift start page]. This site manages: - -* REST API for accounts -* Registry tokens, which are the pull secrets that you use to obtain the required -components -* Cluster registration, which associates the cluster identity to your Red Hat -account to facilitate the gathering of usage metrics - -In {product-title} 4, the installation program is a Go binary that performs a -series of file transformations on a set of assets. When you use Installer -Provisioned Infrastructure, -you delegate the infrastructure bootstrapping and provisioning to the installation program -instead of doing it yourself. Because you do not use the installation program to upgrade or -update your cluster, if you do not highly customize your cluster, you run the -installer only once. - -You use three sets of files during installation: an installation configuration -file, Kubernetes manifests, and Ignition configurations for your machine types. - -The installation configuration file is transformed into Kubernetes manifests, and -then the manifests are wrapped into Ignition configurations. The installation program uses -these Ignition configurations to create the cluster. - -The install configuration files are all pruned when you run the installation program , -so be sure to back up all configuration files that you want to use again. - -[IMPORTANT] -==== -You cannot modify the parameters that you set during installation, but you can -modify many cluster attributes after installation. -==== - -//// -There are individual commands to perform the different actions in cluster creation -if you want to try to make customizations, but you can run openshift-install -create cluster to get the default cluster done quick. - -$ openshift-install --help -$ openshift-install create install-config -$ openshift-install create manifests -$ openshift-install create ignition-configs -$ openshift-install create cluster -//// diff --git a/modules/installation-complete-upi.adoc b/modules/installation-complete-user-infra.adoc similarity index 92% rename from modules/installation-complete-upi.adoc rename to modules/installation-complete-user-infra.adoc index b909f5c3b2..dbe795a47f 100644 --- a/modules/installation-complete-upi.adoc +++ b/modules/installation-complete-user-infra.adoc @@ -2,11 +2,11 @@ // // * installing/installing_bare_metal/installing-bare-metal.adoc -[id="installation-complete-upi_{context}"] -= Completing the UPI installation +[id="installation-complete-user-infra-{context}"] += Completing installation on user-provisioned infrastructure -After you complete the Operator configuration, you can complete the user provisioned -infrastructure (UPI) installation. +After you complete the Operator configuration, you can finish installing the +cluster on infrastructure that you provide. .Prerequisites diff --git a/modules/installation-creating-aws-bootstrap.adoc b/modules/installation-creating-aws-bootstrap.adoc index b5ce0782bf..4fedc35e1f 100644 --- a/modules/installation-creating-aws-bootstrap.adoc +++ b/modules/installation-creating-aws-bootstrap.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * installing/installing_aws_upi/installing-aws-user-infra.adoc +// * installing/installing_aws_user_infra/installing-aws-user-infra.adoc [id="installation-creating-aws-bootstrap_{context}"] = Creating the bootstrap node in AWS diff --git a/modules/installation-creating-aws-control-plane.adoc b/modules/installation-creating-aws-control-plane.adoc index a325125a65..6493c37dcf 100644 --- a/modules/installation-creating-aws-control-plane.adoc +++ b/modules/installation-creating-aws-control-plane.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * installing/installing_aws_upi/installing-aws-upi.adoc +// * installing/installing_aws_user_infra/installing-aws-user-infra.adoc [id="installation-creating-aws-control-plane_{context}"] = Creating the control plane machines in AWS diff --git a/modules/installation-creating-aws-dns.adoc b/modules/installation-creating-aws-dns.adoc index 4f589e7d8f..eac85a04b4 100644 --- a/modules/installation-creating-aws-dns.adoc +++ b/modules/installation-creating-aws-dns.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * installing/installing_aws_upi/installing-aws-upi.adoc +// * installing/installing_aws_user_infra/installing-aws-user-infra.adoc [id="installation-creating-aws-dns_{context}"] = Creating networking and load balancing components in AWS diff --git a/modules/installation-creating-aws-security.adoc b/modules/installation-creating-aws-security.adoc index 9a2c92e811..c0970f274f 100644 --- a/modules/installation-creating-aws-security.adoc +++ b/modules/installation-creating-aws-security.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * installing/installing_aws_upi/installing-aws-upi.adoc +// * installing/installing_aws_user_infra/installing-aws-user-infra.adoc [id="installation-creating-aws-security_{context}"] = Creating security group and roles in AWS diff --git a/modules/installation-creating-aws-vpc.adoc b/modules/installation-creating-aws-vpc.adoc index 12f496ada5..5acc1077bb 100644 --- a/modules/installation-creating-aws-vpc.adoc +++ b/modules/installation-creating-aws-vpc.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * installing/installing_aws_upi/installing-aws-upi.adoc +// * installing/installing_aws_user_infra/installing-aws-user-infra.adoc [id="installation-creating-aws-vpc_{context}"] = Creating a VPC in AWS diff --git a/modules/installation-creating-aws-worker.adoc b/modules/installation-creating-aws-worker.adoc index e8a035cebc..8250873496 100644 --- a/modules/installation-creating-aws-worker.adoc +++ b/modules/installation-creating-aws-worker.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * installing/installing_aws_upi/installing-aws-upi.adoc +// * installing/installing_aws_user_infra/installing-aws-user-infra.adoc [id="installation-creating-aws-worker_{context}"] = Creating the worker nodes in AWS diff --git a/modules/installation-creating-upi-worker-machineset.adoc b/modules/installation-creating-worker-machineset.adoc similarity index 95% rename from modules/installation-creating-upi-worker-machineset.adoc rename to modules/installation-creating-worker-machineset.adoc index 270e647918..54bd8f1478 100644 --- a/modules/installation-creating-upi-worker-machineset.adoc +++ b/modules/installation-creating-worker-machineset.adoc @@ -2,16 +2,16 @@ // // * none -[id="installation-creating-aws-worker-machineset_{context}"] +[id="installation-creating-worker-machineset_{context}"] = Creating worker nodes that the cluster manages After your cluster initializes, you can create workers that are controlled by -a MachineSet in your Amazon Web Services (AWS) user provisioned Infrastructure (UPI) +a MachineSet in your Amazon Web Services (AWS) user-provisioned Infrastructure cluster. .Prerequisites -* Install a UPI cluster on AWS +* Install a cluster on AWS using infrastructer that you provisioned. .Procedure diff --git a/modules/installation-dhcp-user-infra.adoc b/modules/installation-dhcp-user-infra.adoc new file mode 100644 index 0000000000..f2f9c41de0 --- /dev/null +++ b/modules/installation-dhcp-user-infra.adoc @@ -0,0 +1,19 @@ +// Module included in the following assemblies: +// +// * installing/installing_bare_metal/installing-bare-metal.adoc +// * installing/installing_vsphere/installing-vsphere.adoc + +[id="installation-dhcp-user-infra-{context}"] += Networking requirements for user-provisioned infrastructure + +All the {op-system-first} machines require network in `initramfs` during boot +to fetch Ignition config from the Machine Config Server. + +During the initial boot, the machines require a DHCP server in order to +establish a network connection to download their Ignition config files. + +It is recommended to use the DHCP server to manage the machines for the cluster +long-term. Ensure that the DHCP server is configured to provide persistent IP +addresses and host names to the cluster machines. + +//After the initial boot, the machines can be configured to use static IP addresses. \ No newline at end of file diff --git a/modules/installation-dns-upi.adoc b/modules/installation-dns-user-infra.adoc similarity index 90% rename from modules/installation-dns-upi.adoc rename to modules/installation-dns-user-infra.adoc index 3b9bf3489a..9eed3af259 100644 --- a/modules/installation-dns-upi.adoc +++ b/modules/installation-dns-user-infra.adoc @@ -3,11 +3,11 @@ // * installing/installing_bare_metal/installing-bare-metal.adoc // * installing/installing_vsphere/installing-vsphere.adoc -[id="installation-dns-upi_{context}"] -= UPI DNS requirements +[id="installation-dns-user-infra-{context}"] += User-provisioned DNS requirements -The following DNS records are required for a user provisioned infrastructure -(UPI) {product-title} cluster. In each record, `` is the cluster +The following DNS records are required for a {product-title} cluster that uses +user-provisioned infrastructure. In each record, `` is the cluster name and `` is the cluster base domain that you specify in the `install-config.yaml` file. diff --git a/modules/installation-generate-aws-upi.adoc b/modules/installation-generate-aws-user-infra.adoc similarity index 91% rename from modules/installation-generate-aws-upi.adoc rename to modules/installation-generate-aws-user-infra.adoc index 8abdfb211f..1efe24ac77 100644 --- a/modules/installation-generate-aws-upi.adoc +++ b/modules/installation-generate-aws-user-infra.adoc @@ -1,12 +1,12 @@ // Module included in the following assemblies: // -// * installing/installing_aws_upi/installing-aws-upi.adoc +// * installing/installing_aws_user_infra/installing-aws-user-infra.adoc -[id="installation-generate-aws-upi_{context}"] -= Creating the installation files for AWS UPI +[id="installation-generate-aws-user-infra-{context}"] += Creating the installation files for AWS -To install {product-title} on Amazon Web Services (AWS) using user provisioned -infrastructure (UPI), you must generate the files that the installation +To install {product-title} on Amazon Web Services (AWS) using user-provisioned +infrastructure, you must generate the files that the installation program needs to deploy your cluster and modify them so that the cluster creates only the machines that it will use. You generate and customize the `install_config.yaml` file, Kubernetes manifests, and Ignition config files. @@ -75,7 +75,7 @@ you can safely ignore this warning. $ rm -f openshift/99_openshift-cluster-api_master-machines-*.yaml ---- -ifeval::["{context}" == "installing-aws-upi"] +ifeval::["{context}" == "installing-aws-user-infra"] . Remove the Kubernetes manifest files that define the worker machines: + ---- diff --git a/modules/installation-infrastructure-upi.adoc b/modules/installation-infrastructure-user-infra.adoc similarity index 57% rename from modules/installation-infrastructure-upi.adoc rename to modules/installation-infrastructure-user-infra.adoc index 3761bd1909..2f532fd737 100644 --- a/modules/installation-infrastructure-upi.adoc +++ b/modules/installation-infrastructure-user-infra.adoc @@ -3,11 +3,11 @@ // * installing/installing_bare_metal/installing-bare-metal.adoc // * installing/installing_vsphere/installing-vsphere.adoc -[id="installation-infrastructure-upi_{context}"] -= Creating the UPI infrastructure +[id="installation-infrastructure-user-infra-{context}"] += Creating the user-provisioned infrastructure -Before you deploy a user provisioned infrastructure (UPI) {product-title} -cluster, you must create supporting infrastructure. +Before you deploy a {product-title} cluster that uses user-provisioned +infrastructure, you must create the underlying infrastructure. .Procedure diff --git a/modules/installation-initializing-manual.adoc b/modules/installation-initializing-manual.adoc index 04b37a5896..f70c9d6e3a 100644 --- a/modules/installation-initializing-manual.adoc +++ b/modules/installation-initializing-manual.adoc @@ -6,8 +6,8 @@ [id="installation-initializing-manual_{context}"] = Manually creating the installation configuration file -For some User Provisioned Infrastructure (UPI) installations of {product-title}, -you must manually generate your installation configuration file. +For some installations of {product-title} that use user-provisioned +infrastructure, you must manually generate your installation configuration file. .Prerequisites diff --git a/modules/installation-network-upi.adoc b/modules/installation-network-user-infra.adoc similarity index 91% rename from modules/installation-network-upi.adoc rename to modules/installation-network-user-infra.adoc index 0fa43d8303..2267c60551 100644 --- a/modules/installation-network-upi.adoc +++ b/modules/installation-network-user-infra.adoc @@ -3,8 +3,8 @@ // * installing/installing_bare_metal/installing-bare-metal.adoc // * installing/installing_vsphere/installing-vsphere.adoc -[id="installation-network-upi_{context}"] -= UPI networking requirements +[id="installation-network-user-infra_{context}"] += Networking requirements for user-provisioned infrastructure All the {op-system-first} machines require network in `initramfs` during boot to fetch Ignition config from the Machine Config Server. @@ -48,8 +48,8 @@ the Cluster Version Operator on port `9099`. [discrete] == Network topology requirements -User provisioned infrastructure (UPI) clusters have the following network -topology requirements. +The infrastructure that you provision for your cluster must meet the following +network topology requirements. [NOTE] ==== diff --git a/modules/installation-options.adoc b/modules/installation-options.adoc index 1446e44fb1..3bda75b500 100644 --- a/modules/installation-options.adoc +++ b/modules/installation-options.adoc @@ -6,12 +6,13 @@ [id="installation-options_{context}"] = Installation and update +// this is going to get deprecated when we merge the new arch guide In {product-title} {product-version}, you can install only clusters that use -Installer Provisioned Infrastructure in Amazon Web Services (AWS). +installer-provisioned infrastructure in Amazon Web Services (AWS). These clusters use {op-system-first} nodes as the operating system. Future versions of {product-title} will support -clusters that use both Installer Provisioned Infrastructure -and User Provisioned Infrastructure on more cloud providers and on bare metal. +clusters that use both installer-provisioned infrastructure +and user-provisioned infrastructure on more cloud providers and on bare metal. With all cluster types, you must use {op-system} as the operating system for control plane machines. //// @@ -21,7 +22,7 @@ infrastructure option to install your cluster on existing Red Hat Enterprise Linux (RHEL) hosts. //// -Using Installer Provisioned Infrastructure offers full-stack automation to: +Using installer-provisioned infrastructure offers full-stack automation to: * Manage compute * Manage operating system ({op-system}) diff --git a/modules/installation-overview.adoc b/modules/installation-overview.adoc index 919d0af5f4..094952fca7 100644 --- a/modules/installation-overview.adoc +++ b/modules/installation-overview.adoc @@ -22,9 +22,9 @@ for platform containers and provide telemetry data to Red Hat. You cannot specify a proxy server for {product-title}. ==== -These two basic types of {product-title} clusters are -Installer Provisioned Infrastructure (IPI) clusters -and User Provisioned Infrastructure (UPI) clusters. +These two basic types of {product-title} clusters are frequently called +installer-provisioned infrastructure clusters and user-provisioned +infrastructure clusters. 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 @@ -34,11 +34,11 @@ configured infrastructure, you can start an {product-title} cluster. [id="available-platforms_{context}"] == Available platforms -In {product-title} {product-version}, you can complete IPI installations on -only Amazon Web Services (AWS). +In {product-title} {product-version}, you can install a cluser that uses +installer-provisioned infrastructure on only Amazon Web Services (AWS). -In {product-title} {product-version}, you can complete UPI installations on the -following platforms: +In {product-title} {product-version}, you can install a cluser that uses +user-provisioned infrastructure on the following platforms: * AWS * vSphere @@ -61,15 +61,15 @@ In {product-title} 4, the installation program is a Go binary file that performs series of file transformations on a set of assets. The way you interact with the installation program differs depending on your installation type. -* When you use IPI, you delegate the infrastructure bootstrapping and provisioning -to the installation program +* For clusters with installer-provisioned infrastructure, you delegate the +infrastructure bootstrapping and provisioning to the installation program instead of doing it yourself. Because you do not use the installation program to upgrade or update your cluster, if you do not customize your cluster, you run the installer only once. If you customize your cluster, you run the installation program to generate the required configuration files and then run it again to deploy your cluster. -* When you use UPI, you must +* If you provision and manage the infrastructure for your cluster, you must provide all of the cluster infrastructure and resources, including the bootstrap node. You must run the installation program to generate the required configuration files and then run the installation program again to deploy a cluster @@ -103,16 +103,17 @@ modify many cluster attributes after installation. ==== [discrete] -=== IPI cluster installation process +=== The installation process with installer-provisioned infrastructure [IMPORTANT] ==== -In version {product-version}, you can perform an -Installer Provisioned Infrastructure (IPI) install {product-title} on only +In version {product-version}, you can install a {product-title} cluser that +uses installer-provisioned infrastructure on only Amazon Web Services (AWS). ==== -The default installation type is IPI on AWS. By default, the installation +The default installation type uses installer-provisioned infrastructure +on AWS. By default, the installation program acts as an installation wizard, prompting you for values that it cannot determine on its own and providing reasonable default values for the remaining parameters. You can also customize the installation @@ -131,21 +132,21 @@ having to provision and maintain the cluster infrastructure. In all other environments, you use the installation program to generate the assets that you require to provision your cluster infrastructure. -With IPI clusters, {product-title} manages all aspects of +With installer-provisioned infrastructure clusters, {product-title} manages all aspects of the cluster, including the operating system itself. Each machine boots with a configuration that references resources hosted in the cluster that it joins. This configuration allows the cluster to manage itself as updates are applied. [discrete] -=== UPI cluster installation process +=== The installation process with user-provisioned infrastructure You can also install {product-title} on infrastructure that you provide. You use the installation program to generate the assets that you require to provision the cluster infrastructure, create the cluster infrastructure, and then deploy the cluster to the infrastructure that you provided. -With UPI clusters, you must manage and maintain the cluster resources yourself, -including: +If you do not use infrastructure that the installer provisioned, you must manage +and maintain the cluster resources yourself, including: * The control plane and compute machines that make up the cluster * Load balancers @@ -160,15 +161,18 @@ initial configuration. This machine provides the required information. It boots by using an Ignition config file that describes how to create the cluster. This temporary machine is a temporary control plane that launches the rest of the cluster and then is -destroyed. Both UPI and IPI clusters use the bootstrap process to initialize the -cluster, but for UPI clusters, you must complete many of the steps manually. +destroyed. All clusters use the bootstrap process to initialize the +cluster, but if you provision the infrastructure for your cluster, you must +complete many of the steps manually. Bootstrapping a cluster involves the following steps: . The bootstrap machine boots and starts hosting the remote resources required -for the master machines to boot. (Requires manual intervention for UPI) +for the master machines to boot. (Requires manual intervention if you provision + the infrastructure) . The master machines fetch the remote resources from the bootstrap machine -and finish booting. (Requires manual intervention for UPI) +and finish booting. (Requires manual intervention if you provision the + infrastructure) . The master machines use the bootstrap node to form an etcd cluster. . The bootstrap node starts a temporary Kubernetes control plane using the new etcd cluster. @@ -179,7 +183,7 @@ control plane. . The bootstrap node injects {product-title} components into the production control plane. . The installation program shuts down the bootstrap node. -(Requires manual intervention for UPI) +(Requires manual intervention if you provision the infrastructure) The result of this bootstrapping process is a fully running {product-title} cluster. The cluster then downloads and configures remaining components diff --git a/modules/installation-requirements-upi.adoc b/modules/installation-requirements-user-infra.adoc similarity index 88% rename from modules/installation-requirements-upi.adoc rename to modules/installation-requirements-user-infra.adoc index 76c9dc47f9..37b2fb8cea 100644 --- a/modules/installation-requirements-upi.adoc +++ b/modules/installation-requirements-user-infra.adoc @@ -3,10 +3,10 @@ // * installing/installing_bare_metal/installing-bare-metal.adoc // * installing/installing_vsphere/installing-vsphere.adoc -[id="installation-requirements-upi_{context}"] -= UPI machine requirements +[id="installation-requirements-user-infra-{context}"] += Machine requirements for cluster with user-provisioned infrastructure -With a user provisioned infrastructure (UPI) installation, you must deploy all +For a cluster that contains user-provisioned infrastructure, you must deploy all of the required machines. [id="machine-requirements_{context}"] diff --git a/modules/installation-upi-machines-iso.adoc b/modules/installation-user-infra-machines-iso.adoc similarity index 93% rename from modules/installation-upi-machines-iso.adoc rename to modules/installation-user-infra-machines-iso.adoc index 403975b8e1..6210dad1ee 100644 --- a/modules/installation-upi-machines-iso.adoc +++ b/modules/installation-user-infra-machines-iso.adoc @@ -2,11 +2,11 @@ // // * installing/installing_bare_metal/installing-bare-metal.adoc -[id="installation-upi-machines-iso_{context}"] +[id=" installation-user-infra-machines-iso-{context}"] = Creating {op-system-first} machines using an ISO image -Before you install a user provisioned infrastructure (UPI) cluster on bare -metal, you must create {op-system} machines for it to use. You can use an +Before you install a cluster on bare metal infrastructure that you provision, +you must create {op-system} machines for it to use. You can use an ISO image to create the machines. .Prerequisites diff --git a/modules/installation-vsphere-machines.adoc b/modules/installation-vsphere-machines.adoc index 2432c98278..16895f9f0a 100644 --- a/modules/installation-vsphere-machines.adoc +++ b/modules/installation-vsphere-machines.adoc @@ -5,8 +5,8 @@ [id="installation-vsphere-machines_{context}"] = Creating {op-system-first} machines in vSphere -Before you install a user provisioned infrastructure (UPI) cluster on vSphere, -you need to create {op-system} machines for it to use. +Before you install a cluster that contains user-provisioned infrastructure on +vSphere, you need to create {op-system} machines on vSphere hosts for it to use. .Prerequisites diff --git a/modules/rhel-compute-overview.adoc b/modules/rhel-compute-overview.adoc index 6baf49b071..9ba81612cb 100644 --- a/modules/rhel-compute-overview.adoc +++ b/modules/rhel-compute-overview.adoc @@ -8,11 +8,12 @@ In {product-title} {product-version}, you have the option of using Red Hat Enterprise Linux (RHEL) machines as compute, or worker, machines in your -cluster if you use a user provisioned infrastructure (UPI) installation. You +cluster if you use a user-provisioned infrastructure installation. You must use {op-system-first} machines for the control plane, or master, machines in your cluster. -As with all UPI installations, if you choose to use RHEL compute machines in +As with all installations that use user-provisioned infrastructure, if you +choose to use RHEL compute machines in your cluster, you take responsibility for all operating system life cycle management and maintenance, including performing system updates, applying patches, and completing all other required tasks.