Skip to content

Commit 5b9baa1

Browse files
OSDOCS-15577:combining AWS assemblies
1 parent 9d20b6f commit 5b9baa1

23 files changed

+47
-195
lines changed

_topic_maps/_topic_map.yml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -208,8 +208,6 @@ Topics:
208208
File: installing-aws-default
209209
- Name: Installing a cluster with customizations
210210
File: installing-aws-customizations
211-
- Name: Installing a cluster with network customizations
212-
File: installing-aws-network-customizations
213211
- Name: Installing a cluster in a disconnected environment
214212
File: installing-restricted-networks-aws-installer-provisioned
215213
- Name: Installing a cluster into an existing VPC

installing/installing_aws/installing-aws-account.adoc

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,5 +39,4 @@ include::modules/installation-aws-regions.adoc[leveloffset=+1]
3939
* Install an {product-title} cluster:
4040
** xref:../../installing/installing_aws/ipi/installing-aws-default.adoc#installing-aws-default[Quickly install a cluster] with default options on installer-provisioned infrastructure
4141
** xref:../../installing/installing_aws/ipi/installing-aws-customizations.adoc#installing-aws-customizations[Install a cluster with cloud customizations on installer-provisioned infrastructure]
42-
** xref:../../installing/installing_aws/ipi/installing-aws-network-customizations.adoc#installing-aws-network-customizations[Install a cluster with network customizations on installer-provisioned infrastructure]
4342
** 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]

installing/installing_aws/ipi/installing-aws-customizations.adoc

Lines changed: 35 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,17 @@
11
:_mod-docs-content-type: ASSEMBLY
22
[id="installing-aws-customizations"]
3-
= Installing a cluster on AWS with customizations
3+
= Installing a cluster on {aws-short} with customizations
44
include::_attributes/common-attributes.adoc[]
55
:context: installing-aws-customizations
66
:platform: AWS
77

88
toc::[]
99

10-
In {product-title} version {product-version}, you can install a customized
11-
cluster on infrastructure that the installation program provisions on
12-
Amazon Web Services (AWS). To customize the installation, you modify
13-
parameters in the `install-config.yaml` file before you install the cluster.
10+
In {product-title} version {product-version}, you can install a cluster on {aws-first} by using installer-provisioned infrastructure with customizations, including network configuration options. In each, you modify parameters in the `install-config.yaml` file before you install the cluster.
11+
12+
By customizing your network configuration, your cluster can coexist with existing IP address allocations in your environment and integrate with existing MTU and VXLAN configurations.
13+
14+
You must set most of the network configuration parameters during installation, and you can modify only `kubeProxy` configuration parameters in a running cluster.
1415

1516
[NOTE]
1617
====
@@ -25,18 +26,20 @@ The scope of the {product-title} installation configurations is intentionally na
2526
+
2627
[IMPORTANT]
2728
====
28-
If you have an AWS profile stored on your computer, it must not use a temporary session token that you generated while using a multi-factor authentication device. The cluster continues to use your current AWS credentials to create AWS resources for the entire life of the cluster, so you must use long-term credentials. To generate appropriate keys, see link:https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html[Managing Access Keys for IAM Users] in the AWS documentation. You can supply the keys when you run the installation program.
29+
If you have an {aws-short} profile stored on your computer, it must not use a temporary session token that you generated while using a multi-factor authentication device. The cluster continues to use your current {aws-short} credentials to create {aws-short} resources for the entire life of the cluster, so you must use long-term credentials. To generate appropriate keys, see link:https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html[Managing Access Keys for IAM Users] in the {aws-short} documentation. You can supply the keys when you run the installation program.
2930
====
3031
* If you use a firewall, you xref:../../../installing/install_config/configuring-firewall.adoc#configuring-firewall[configured it to allow the sites] that your cluster requires access to.
3132

3233
include::modules/installation-aws-marketplace-subscribe.adoc[leveloffset=+1]
3334

35+
include::modules/nw-network-config.adoc[leveloffset=+1]
36+
3437
include::modules/installation-initializing.adoc[leveloffset=+1]
3538

3639
[role="_additional-resources"]
3740
.Additional resources
3841

39-
* xref:../../../installing/installing_aws/installation-config-parameters-aws.adoc#installation-config-parameters-aws[Installation configuration parameters for AWS]
42+
* xref:../../../installing/installing_aws/installation-config-parameters-aws.adoc#installation-config-parameters-aws[Installation configuration parameters for {aws-short}]
4043

4144
include::modules/installation-minimum-resource-requirements.adoc[leveloffset=+2]
4245

@@ -54,7 +57,7 @@ include::modules/installation-aws-config-yaml-customizations.adoc[leveloffset=+2
5457
[role="_additional-resources"]
5558
.Additional resources
5659

57-
* xref:../../../installing/installing_aws/installation-config-parameters-aws.adoc#installation-config-parameters-aws[Installation configuration parameters for AWS]
60+
* xref:../../../installing/installing_aws/installation-config-parameters-aws.adoc#installation-config-parameters-aws[Installation configuration parameters for {aws-short}]
5861

5962
include::modules/installation-configure-proxy.adoc[leveloffset=+2]
6063

@@ -65,14 +68,14 @@ By default, administrator secrets are stored in the `kube-system` project. If yo
6568

6669
* To manage long-term cloud credentials manually, follow the procedure in xref:../../../installing/installing_aws/ipi/installing-aws-customizations.adoc#manually-create-iam_installing-aws-customizations[Manually creating long-term credentials].
6770

68-
* To implement short-term credentials that are managed outside the cluster for individual components, follow the procedures in 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].
71+
* To implement short-term credentials that are managed outside the cluster for individual components, follow the procedures in 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].
6972

7073
//Manually creating long-term credentials
7174
include::modules/manually-create-identity-access-management.adoc[leveloffset=+2]
7275

7376
//Supertask: Configuring an AWS cluster to use short-term credentials
7477
[id="installing-aws-with-short-term-creds_{context}"]
75-
=== Configuring an AWS cluster to use short-term credentials
78+
=== Configuring an {aws-short} cluster to use short-term credentials
7679

7780
To install a cluster that is configured to use the AWS Security Token Service (STS), you must configure the CCO utility and create the required AWS resources for your cluster.
7881

@@ -81,13 +84,13 @@ include::modules/cco-ccoctl-configuring.adoc[leveloffset=+3]
8184

8285
//Task part 2: Creating the required AWS resources
8386
[id="sts-mode-create-aws-resources-ccoctl_{context}"]
84-
==== Creating AWS resources with the Cloud Credential Operator utility
87+
==== Creating {aws-short} resources with the Cloud Credential Operator utility
8588

86-
You have the following options when creating AWS resources:
89+
You have the following options when creating {aws-short} resources:
8790

88-
* You can use the `ccoctl aws create-all` command to create the AWS resources automatically. This is the quickest way to create the resources. See xref:../../../installing/installing_aws/ipi/installing-aws-customizations.adoc#cco-ccoctl-creating-at-once_installing-aws-customizations[Creating AWS resources with a single command].
91+
* You can use the `ccoctl aws create-all` command to create the {aws-short} resources automatically. This is the quickest way to create the resources. See xref:../../../installing/installing_aws/ipi/installing-aws-customizations.adoc#cco-ccoctl-creating-at-once_installing-aws-customizations[Creating {aws-short} resources with a single command].
8992

90-
* If you need to review the JSON files that the `ccoctl` tool creates before modifying AWS resources, or if the process the `ccoctl` tool uses to create AWS resources automatically does not meet the requirements of your organization, you can create the AWS resources individually. See xref:../../../installing/installing_aws/ipi/installing-aws-customizations.adoc#cco-ccoctl-creating-individually_installing-aws-customizations[Creating AWS resources individually].
93+
* If you need to review the JSON files that the `ccoctl` tool creates before modifying AWS resources, or if the process the `ccoctl` tool uses to create AWS resources automatically does not meet the requirements of your organization, you can create the {aws-short} resources individually. See xref:../../../installing/installing_aws/ipi/installing-aws-customizations.adoc#cco-ccoctl-creating-individually_installing-aws-customizations[Creating {aws-short} resources individually].
9194

9295
//Task part 2a: Creating the required AWS resources all at once
9396
include::modules/cco-ccoctl-creating-at-once.adoc[leveloffset=+4]
@@ -98,6 +101,24 @@ include::modules/cco-ccoctl-creating-individually.adoc[leveloffset=+4]
98101
//Task part 3: Incorporating the Cloud Credential Operator utility manifests
99102
include::modules/cco-ccoctl-install-creating-manifests.adoc[leveloffset=+3]
100103

104+
// Network Operator specific configuration
105+
include::modules/nw-operator-cr.adoc[leveloffset=+1]
106+
include::modules/nw-modifying-operator-install-config.adoc[leveloffset=+1]
107+
108+
[NOTE]
109+
====
110+
For more information on using a Network Load Balancer (NLB) on {aws-short}, see xref:../../../networking/ingress_load_balancing/configuring_ingress_cluster_traffic/configuring-ingress-cluster-traffic-aws.adoc#nw-configuring-ingress-cluster-traffic-aws-network-load-balancer_configuring-ingress-cluster-traffic-aws[Configuring Ingress cluster traffic on {aws-short} using a Network Load Balancer].
111+
====
112+
113+
include::modules/nw-aws-nlb-new-cluster.adoc[leveloffset=+1]
114+
115+
include::modules/configuring-hybrid-ovnkubernetes.adoc[leveloffset=+1]
116+
117+
[NOTE]
118+
====
119+
For more information about using Linux and Windows nodes in the same cluster, see xref:../../../windows_containers/understanding-windows-container-workloads.adoc#understanding-windows-container-workloads[Understanding Windows container workloads].
120+
====
121+
101122
include::modules/installation-launching-installer.adoc[leveloffset=+1]
102123

103124
include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1]

installing/installing_aws/preparing-to-install-on-aws.adoc

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,7 @@ You can install a cluster on AWS infrastructure that is provisioned by the {prod
1515

1616
* **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.
1717

18-
* **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].
19-
20-
* **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.
18+
* **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. You can also 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. 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].
2119

2220
* **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.
2321

installing/overview/installing-preparing.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ You can deploy an installer-provisioned infrastructure cluster without specifyin
5858

5959
If you need to perform basic configuration for your installer-provisioned infrastructure cluster, such as the instance type for the cluster machines, you can customize an installation for xref:../../installing/installing_aws/ipi/installing-aws-customizations.adoc#installing-aws-customizations[AWS], xref:../../installing/installing_azure/ipi/installing-azure-customizations.adoc#installing-azure-customizations[Azure], xref:../../installing/installing_gcp/installing-gcp-customizations.adoc#installing-gcp-customizations[GCP], xref:../../installing/installing_nutanix/installing-nutanix-installer-provisioned.adoc#installing-nutanix-installer-provisioned[Nutanix].
6060

61-
For installer-provisioned infrastructure installations, you can use an existing xref:../../installing/installing_aws/ipi/installing-aws-vpc.adoc#installing-aws-vpc[VPC in AWS], xref:../../installing/installing_azure/ipi/installing-azure-vnet.adoc#installing-azure-vnet[vNet in Azure], or xref:../../installing/installing_gcp/installing-gcp-vpc.adoc#installing-gcp-vpc[VPC in GCP]. You can also reuse part of your networking infrastructure so that your cluster in xref:../../installing/installing_aws/ipi/installing-aws-network-customizations.adoc#installing-aws-network-customizations[AWS], xref:../../installing/installing_azure/ipi/installing-azure-network-customizations.adoc#installing-azure-network-customizations[Azure], xref:../../installing/installing_gcp/installing-gcp-network-customizations.adoc#installing-gcp-network-customizations[GCP] can coexist with existing IP address allocations in your environment and integrate with existing MTU and VXLAN configurations. If you have existing accounts and credentials on these clouds, you can re-use them, but you might need to modify the accounts to have the required permissions to install {product-title} clusters on them.
61+
For installer-provisioned infrastructure installations, you can use an existing xref:../../installing/installing_aws/ipi/installing-aws-vpc.adoc#installing-aws-vpc[VPC in AWS], xref:../../installing/installing_azure/ipi/installing-azure-vnet.adoc#installing-azure-vnet[vNet in Azure], or xref:../../installing/installing_gcp/installing-gcp-vpc.adoc#installing-gcp-vpc[VPC in GCP]. You can also reuse part of your networking infrastructure so that your cluster in xref:../../installing/installing_aws/ipi/installing-aws-customizations.adoc#installing-aws-customizations[AWS], xref:../../installing/installing_azure/ipi/installing-azure-network-customizations.adoc#installing-azure-network-customizations[Azure], xref:../../installing/installing_gcp/installing-gcp-network-customizations.adoc#installing-gcp-network-customizations[GCP] can coexist with existing IP address allocations in your environment and integrate with existing MTU and VXLAN configurations. If you have existing accounts and credentials on these clouds, you can re-use them, but you might need to modify the accounts to have the required permissions to install {product-title} clusters on them.
6262

6363

6464
You can use the installer-provisioned infrastructure method to create appropriate machine instances on your hardware for xref:../../installing/installing_vsphere/ipi/installing-vsphere-installer-provisioned.adoc#installing-vsphere-installer-provisioned[vSphere], and xref:../../installing/installing_bare_metal/ipi/ipi-install-overview.adoc#ipi-install-overview[bare metal]. Additionally, for xref:../../installing/installing_vsphere/ipi/installing-vsphere-installer-provisioned-customizations.adoc#installing-vsphere-installer-provisioned-customizations[vSphere], you can also customize additional network parameters during installation.
@@ -173,8 +173,8 @@ ifndef::openshift-origin[]
173173

174174

175175
|Network customization
176-
|xref:../../installing/installing_aws/ipi/installing-aws-network-customizations.adoc#installing-aws-network-customizations[✓]
177-
|xref:../../installing/installing_aws/ipi/installing-aws-network-customizations.adoc#installing-aws-network-customizations[✓]
176+
|xref:../../installing/installing_aws/ipi/installing-aws-customizations.adoc#installing-aws-customizations[✓]
177+
|xref:../../installing/installing_aws/ipi/installing-aws-customizations.adoc#installing-aws-customizations[✓]
178178
|xref:../../installing/installing_azure/ipi/installing-azure-network-customizations.adoc#installing-azure-network-customizations[✓]
179179
|xref:../../installing/installing_azure/ipi/installing-azure-network-customizations.adoc#installing-azure-network-customizations[✓]
180180
|xref:../../installing/installing_azure_stack_hub/ipi/installing-azure-stack-hub-network-customizations.adoc#installing-azure-stack-hub-network-customizations[✓]
@@ -333,7 +333,7 @@ ifdef::openshift-origin[]
333333
|
334334

335335
|Network customization
336-
|xref:../../installing/installing_aws/ipi/installing-aws-network-customizations.adoc#installing-aws-network-customizations[✓]
336+
|xref:../../installing/installing_aws/ipi/installing-aws-customizations.adoc#installing-aws-customizations[✓]
337337
|xref:../../installing/installing_azure/ipi/installing-azure-network-customizations.adoc#installing-azure-network-customizations[✓]
338338
|xref:../../installing/installing_azure_stack_hub/ipi/installing-azure-stack-hub-network-customizations.adoc#installing-azure-stack-hub-network-customizations[✓]
339339
|xref:../../installing/installing_gcp/installing-gcp-network-customizations.adoc#installing-gcp-network-customizations[✓]

modules/cco-ccoctl-configuring.adoc

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@
1111
//
1212
// AWS assemblies:
1313
// * installing/installing_aws/installing-aws-customizations.adoc
14-
// * installing/installing_aws/installing-aws-network-customizations.adoc
1514
// * installing/installing_aws/installing-restricted-networks-aws-installer-provisioned.adoc
1615
// * installing/installing_aws/installing-aws-vpc.adoc
1716
// * installing/installing_aws/installing-aws-private.adoc
@@ -59,9 +58,6 @@ endif::[]
5958
ifeval::["{context}" == "installing-aws-customizations"]
6059
:aws-sts:
6160
endif::[]
62-
ifeval::["{context}" == "installing-aws-network-customizations"]
63-
:aws-sts:
64-
endif::[]
6561
ifeval::["{context}" == "installing-restricted-networks-aws-installer-provisioned"]
6662
:aws-sts:
6763
endif::[]
@@ -279,9 +275,6 @@ endif::[]
279275
ifeval::["{context}" == "installing-aws-customizations"]
280276
:!aws-sts:
281277
endif::[]
282-
ifeval::["{context}" == "installing-aws-network-customizations"]
283-
:!aws-sts:
284-
endif::[]
285278
ifeval::["{context}" == "installing-restricted-networks-aws-installer-provisioned"]
286279
:!aws-sts:
287280
endif::[]

0 commit comments

Comments
 (0)