Skip to content

Commit 13cb6ff

Browse files
authored
Merge pull request #74783 from openshift/revert-74484-OSDOCS-10082
Revert "OSDOCS#10082 Reworking AWS topic map/TOC"
2 parents 910f6f1 + 202dc34 commit 13cb6ff

File tree

59 files changed

+489
-449
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

59 files changed

+489
-449
lines changed

_topic_maps/_topic_map.yml

Lines changed: 32 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -155,51 +155,43 @@ Topics:
155155
Dir: installing_aws
156156
Distros: openshift-origin,openshift-enterprise
157157
Topics:
158-
- Name: Preparing to install
158+
- Name: Preparing to install on AWS
159159
File: preparing-to-install-on-aws
160160
- Name: Configuring an AWS account
161161
File: installing-aws-account
162-
- Name: Installer-provisioned infrastructure
163-
Dir: ipi
164-
Distros: openshift-origin,openshift-enterprise
165-
Topics:
166-
- Name: Installing a cluster
167-
File: installing-aws-default
168-
- Name: Installing a cluster with customizations
169-
File: installing-aws-customizations
170-
- Name: Installing a cluster with network customizations
171-
File: installing-aws-network-customizations
172-
- Name: Installing a cluster in a restricted network
173-
File: installing-restricted-networks-aws-installer-provisioned
174-
- Name: Installing a cluster into an existing VPC
175-
File: installing-aws-vpc
176-
- Name: Installing a private cluster
177-
File: installing-aws-private
178-
- Name: Installing a cluster into a government region
179-
File: installing-aws-government-region
180-
- Name: Installing a cluster into a Secret or Top Secret Region
181-
File: installing-aws-secret-region
182-
- Name: Installing a cluster into a China region
183-
File: installing-aws-china
184-
- Name: Installing a cluster with compute nodes on Local Zones
185-
File: installing-aws-localzone
186-
- Name: Installing a cluster with compute nodes on Wavelength Zones
187-
File: installing-aws-wavelength-zone
188-
- Name: Installing a cluster with compute nodes on Outposts
189-
File: installing-aws-outposts
190-
- Name: User-provisioned infrastructure
191-
Dir: upi
192-
Distros: openshift-origin,openshift-enterprise
193-
Topics:
194-
- Name: Installing a cluster using CloudFormation templates
195-
File: installing-aws-user-infra
196-
- Name: Installing a cluster in a restricted network with user-provisioned infrastructure
197-
File: installing-restricted-networks-aws
198-
- Name: Installing a three-node cluster
162+
- Name: Installing a cluster quickly on AWS
163+
File: installing-aws-default
164+
- Name: Installing a cluster on AWS with customizations
165+
File: installing-aws-customizations
166+
- Name: Installing a cluster on AWS with network customizations
167+
File: installing-aws-network-customizations
168+
- Name: Installing a cluster on AWS in a restricted network
169+
File: installing-restricted-networks-aws-installer-provisioned
170+
- Name: Installing a cluster on AWS into an existing VPC
171+
File: installing-aws-vpc
172+
- Name: Installing a private cluster on AWS
173+
File: installing-aws-private
174+
- Name: Installing a cluster on AWS into a government region
175+
File: installing-aws-government-region
176+
- Name: Installing a cluster on AWS into a Secret or Top Secret Region
177+
File: installing-aws-secret-region
178+
- Name: Installing a cluster on AWS into a China region
179+
File: installing-aws-china
180+
- Name: Installing a cluster on AWS using CloudFormation templates
181+
File: installing-aws-user-infra
182+
- Name: Installing a cluster on AWS in a restricted network with user-provisioned infrastructure
183+
File: installing-restricted-networks-aws
184+
- Name: Installing a cluster on AWS with compute nodes on AWS Local Zones
185+
File: installing-aws-localzone
186+
- Name: Installing a cluster on AWS with compute nodes on AWS Wavelength Zones
187+
File: installing-aws-wavelength-zone
188+
- Name: Installing a cluster on AWS with compute nodes on AWS Outposts
189+
File: installing-aws-outposts
190+
- Name: Installing a three-node cluster on AWS
199191
File: installing-aws-three-node
200-
- Name: Uninstalling a cluster
192+
- Name: Uninstalling a cluster on AWS
201193
File: uninstalling-cluster-aws
202-
- Name: Installation configuration parameters
194+
- Name: Installation configuration parameters for AWS
203195
File: installation-config-parameters-aws
204196
- Name: Installing on Azure
205197
Dir: installing_azure
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
[id="manually-creating-iam-aws"]
3+
= Manually creating IAM for AWS
4+
include::_attributes/common-attributes.adoc[]
5+
:context: manually-creating-iam-aws
6+
7+
//TO-DO: this should be one file for AWS, Azure, and GCP with conditions for specifics.
8+
9+
toc::[]
10+
11+
In environments where the cloud identity and access management (IAM) APIs are not reachable, or the administrator prefers not to store an administrator-level credential secret in the cluster `kube-system` namespace, you can put the Cloud Credential Operator (CCO) into manual mode before you install the cluster.
12+
13+
include::modules/alternatives-to-storing-admin-secrets-in-kube-system.adoc[leveloffset=+1]
14+
15+
[role="_additional-resources"]
16+
.Additional resources
17+
18+
// AWS only. Condition out if combining topic for AWS/Azure/GCP.
19+
* To learn how to use the CCO utility (`ccoctl`) to configure the CCO to use the AWS STS, see xref:../../authentication/managing_cloud_provider_credentials/cco-mode-sts.adoc#cco-mode-sts[Using manual mode with STS].
20+
21+
// Not supported in Azure. Condition out if combining topic for AWS/Azure/GCP.
22+
* To learn how to rotate or remove the administrator-level credential secret after installing {product-title}, see xref:../../post_installation_configuration/cluster-tasks.adoc#post-install-rotate-remove-cloud-creds[Rotating or removing cloud provider credentials].
23+
24+
* For a detailed description of all available CCO credential modes and their supported platforms, see xref:../../authentication/managing_cloud_provider_credentials/about-cloud-credential-operator.adoc#about-cloud-credential-operator[About the Cloud Credential Operator].
25+
26+
include::modules/manually-create-identity-access-management.adoc[leveloffset=+1]
27+
28+
[role="_additional-resources"]
29+
.Additional resources
30+
* xref:../../updating/preparing_for_updates/preparing-manual-creds-update.adoc#preparing-manual-creds-update[Preparing to update a cluster with manually maintained credentials]
31+
32+
include::modules/mint-mode.adoc[leveloffset=+1]
33+
34+
include::modules/mint-mode-with-removal-of-admin-credential.adoc[leveloffset=+1]
35+
36+
[id="manually-creating-iam-aws-next-steps"]
37+
== Next steps
38+
39+
* Install an {product-title} cluster:
40+
** xref:../../installing/installing_aws/installing-aws-default.adoc#installing-aws-default[Installing a cluster quickly on AWS] with default options on installer-provisioned infrastructure
41+
** xref:../../installing/installing_aws/installing-aws-customizations.adoc#installing-aws-customizations[Install a cluster with cloud customizations on installer-provisioned infrastructure]
42+
** xref:../../installing/installing_aws/installing-aws-network-customizations.adoc#installing-aws-network-customizations[Install a cluster with network customizations on installer-provisioned infrastructure]
43+
** xref:../../installing/installing_aws/installing-aws-user-infra.adoc#installing-aws-user-infra[Installing a cluster on user-provisioned infrastructure in AWS by using CloudFormation templates]

authentication/managing_cloud_provider_credentials/cco-mode-manual.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ An AWS, global Azure, or GCP cluster that uses manual mode might be configured t
2727
== Additional resources
2828

2929
* xref:../../installing/installing_alibaba/manually-creating-alibaba-ram.adoc#manually-creating-alibaba-ram[Manually creating RAM resources for Alibaba Cloud]
30-
* xref:../../installing/installing_aws/ipi/installing-aws-customizations.adoc#manually-create-iam_installing-aws-customizations[Manually creating long-term credentials for AWS]
30+
* xref:../../installing/installing_aws/installing-aws-customizations.adoc#manually-create-iam_installing-aws-customizations[Manually creating long-term credentials for AWS]
3131
* xref:../../installing/installing_azure/installing-azure-customizations.adoc#manually-create-iam_installing-azure-customizations[Manually creating long-term credentials for Azure]
3232
* xref:../../installing/installing_gcp/installing-gcp-customizations.adoc#manually-create-iam_installing-gcp-customizations[Manually creating long-term credentials for GCP]
3333
* xref:../../installing/installing_ibm_cloud_public/configuring-iam-ibm-cloud.adoc#configuring-iam-ibm-cloud[Configuring IAM for {ibm-cloud-name}]

authentication/managing_cloud_provider_credentials/cco-mode-passthrough.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ When using the CCO in passthrough mode, ensure that the credential you provide m
2323
=== Amazon Web Services (AWS) permissions
2424
The credential you provide for passthrough mode in AWS must have all the requested permissions for all `CredentialsRequest` CRs that are required by the version of {product-title} you are running or installing.
2525

26-
To locate the `CredentialsRequest` CRs that are required, see xref:../../installing/installing_aws/ipi/installing-aws-customizations.adoc#manually-create-iam_installing-aws-customizations[Manually creating long-term credentials for AWS].
26+
To locate the `CredentialsRequest` CRs that are required, see xref:../../installing/installing_aws/installing-aws-customizations.adoc#manually-create-iam_installing-aws-customizations[Manually creating long-term credentials for AWS].
2727

2828
[id="passthrough-mode-permissions-azure"]
2929
=== Microsoft Azure permissions
@@ -81,7 +81,7 @@ include::modules/admin-credentials-root-secret-formats.adoc[leveloffset=+1]
8181

8282
[id="passthrough-mode-maintenance"]
8383
== Passthrough mode credential maintenance
84-
If `CredentialsRequest` CRs change over time as the cluster is upgraded, you must manually update the passthrough mode credential to meet the requirements. To avoid credentials issues during an upgrade, check the `CredentialsRequest` CRs in the release image for the new version of {product-title} before upgrading. To locate the `CredentialsRequest` CRs that are required for your cloud provider, see _Manually creating long-term credentials_ for xref:../../installing/installing_aws/ipi/installing-aws-customizations.adoc#manually-create-iam_installing-aws-customizations[AWS], xref:../../installing/installing_azure/installing-azure-customizations.adoc#manually-create-iam_installing-azure-customizations[Azure], or xref:../../installing/installing_gcp/installing-gcp-customizations.adoc#manually-create-iam_installing-gcp-customizations[GCP].
84+
If `CredentialsRequest` CRs change over time as the cluster is upgraded, you must manually update the passthrough mode credential to meet the requirements. To avoid credentials issues during an upgrade, check the `CredentialsRequest` CRs in the release image for the new version of {product-title} before upgrading. To locate the `CredentialsRequest` CRs that are required for your cloud provider, see _Manually creating long-term credentials_ for xref:../../installing/installing_aws/installing-aws-customizations.adoc#manually-create-iam_installing-aws-customizations[AWS], xref:../../installing/installing_azure/installing-azure-customizations.adoc#manually-create-iam_installing-azure-customizations[Azure], or xref:../../installing/installing_gcp/installing-gcp-customizations.adoc#manually-create-iam_installing-gcp-customizations[GCP].
8585

8686
//Rotating cloud provider credentials manually
8787
include::modules/manually-rotating-cloud-creds.adoc[leveloffset=+2]
@@ -96,11 +96,11 @@ When using passthrough mode, each component has the same permissions used by all
9696

9797
After installation, you can reduce the permissions on your credential to only those that are required to run the cluster, as defined by the `CredentialsRequest` CRs in the release image for the version of {product-title} that you are using.
9898

99-
To locate the `CredentialsRequest` CRs that are required for AWS, Azure, or GCP and learn how to change the permissions the CCO uses, see _Manually creating long-term credentials_ for xref:../../installing/installing_aws/ipi/installing-aws-customizations.adoc#manually-create-iam_installing-aws-customizations[AWS], xref:../../installing/installing_azure/installing-azure-customizations.adoc#manually-create-iam_installing-azure-customizations[Azure], or xref:../../installing/installing_gcp/installing-gcp-customizations.adoc#manually-create-iam_installing-gcp-customizations[GCP].
99+
To locate the `CredentialsRequest` CRs that are required for AWS, Azure, or GCP and learn how to change the permissions the CCO uses, see _Manually creating long-term credentials_ for xref:../../installing/installing_aws/installing-aws-customizations.adoc#manually-create-iam_installing-aws-customizations[AWS], xref:../../installing/installing_azure/installing-azure-customizations.adoc#manually-create-iam_installing-azure-customizations[Azure], or xref:../../installing/installing_gcp/installing-gcp-customizations.adoc#manually-create-iam_installing-gcp-customizations[GCP].
100100

101101
[role="_additional-resources"]
102102
== Additional resources
103103

104-
* xref:../../installing/installing_aws/ipi/installing-aws-customizations.adoc#manually-create-iam_installing-aws-customizations[Manually creating long-term credentials for AWS]
104+
* xref:../../installing/installing_aws/installing-aws-customizations.adoc#manually-create-iam_installing-aws-customizations[Manually creating long-term credentials for AWS]
105105
* xref:../../installing/installing_azure/installing-azure-customizations.adoc#manually-create-iam_installing-azure-customizations[Manually creating long-term credentials for Azure]
106106
* xref:../../installing/installing_gcp/installing-gcp-customizations.adoc#manually-create-iam_installing-gcp-customizations[Manually creating long-term credentials for GCP]

authentication/managing_cloud_provider_credentials/cco-short-term-creds.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ In manual mode with STS, the individual {product-title} cluster components use t
3939

4040
[role="_additional-resources"]
4141
.Additional resources
42-
* 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]
42+
* xref:../../installing/installing_aws/installing-aws-customizations.adoc#installing-aws-with-short-term-creds_installing-aws-customizations[Configuring an AWS cluster to use short-term credentials]
4343

4444
//AWS Security Token Service authentication process
4545
include::modules/cco-short-term-creds-auth-flow-aws.adoc[leveloffset=+2]
@@ -104,7 +104,7 @@ include::modules/cco-short-term-creds-azure-olm.adoc[leveloffset=+2]
104104
[id="additional-resources_{context}"]
105105
== Additional resources
106106

107-
* 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]
107+
* xref:../../installing/installing_aws/installing-aws-customizations.adoc#installing-aws-with-short-term-creds_installing-aws-customizations[Configuring an AWS cluster to use short-term credentials]
108108
* xref:../../installing/installing_gcp/installing-gcp-customizations.adoc#installing-gcp-with-short-term-creds_installing-gcp-customizations[Configuring a GCP cluster to use short-term credentials]
109109
* xref:../../installing/installing_azure/installing-azure-customizations.adoc#installing-azure-with-short-term-creds_installing-azure-customizations[Configuring a global Microsoft Azure cluster to use short-term credentials]
110110
* xref:../../updating/preparing_for_updates/preparing-manual-creds-update.adoc#preparing-manual-creds-update[Preparing to update a cluster with manually maintained credentials]

contributing_to_docs/doc_guidelines.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ Example:
141141
----
142142
// Text snippet included in the following assemblies:
143143
//
144-
// * installing/installing_aws/ipi/installing-aws-default.adoc
144+
// * installing/installing_aws/installing-aws-default.adoc
145145
// * installing/installing_azure/installing-azure-default.adoc
146146
// * installing/installing_gcp/installing-gcp-default.adoc
147147

installing/cluster-capabilities.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ include::snippets/capabilities-table.adoc[]
1919

2020
[role="_additional-resources"]
2121
.Additional resources
22-
* xref:../installing/installing_aws/ipi/installing-aws-customizations.adoc#installing-aws-customizations[Installing a cluster on AWS with customizations]
22+
* xref:../installing/installing_aws/installing-aws-customizations.adoc#installing-aws-customizations[Installing a cluster on AWS with customizations]
2323
* xref:../installing/installing_gcp/installing-gcp-customizations.adoc#installing-gcp-customizations[Installing a cluster on GCP with customizations]
2424
2525
include::modules/explanation-of-capabilities.adoc[leveloffset=+1]

installing/disconnected_install/installing-mirroring-installation-images.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ include::modules/olm-mirroring-catalog-post.adoc[leveloffset=+2]
145145

146146
* Install a cluster on infrastructure that you provision in your restricted network, such as on
147147
xref:../../installing/installing_vsphere/upi/installing-restricted-networks-vsphere.adoc#installing-restricted-networks-vsphere[VMware vSphere],
148-
xref:../../installing/installing_bare_metal/installing-restricted-networks-bare-metal.adoc#installing-restricted-networks-bare-metal[bare metal], or xref:../../installing/installing_aws/upi/installing-restricted-networks-aws.adoc#installing-restricted-networks-aws[Amazon Web Services].
148+
xref:../../installing/installing_bare_metal/installing-restricted-networks-bare-metal.adoc#installing-restricted-networks-bare-metal[bare metal], or xref:../../installing/installing_aws/installing-restricted-networks-aws.adoc#installing-restricted-networks-aws[Amazon Web Services].
149149

150150
[role="_additional-resources"]
151151
[id="restricted-networks-additional-resources"]

installing/installing-fips.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ To install a cluster in FIPS mode, follow the instructions to install a customiz
8686
To enable FIPS mode for your cluster, you must run the installation program from a {op-system-base} computer configured to operate in FIPS mode. For more information about configuring FIPS mode on RHEL, see link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/9/html/security_hardening/assembly_installing-the-system-in-fips-mode_security-hardening[Installing the system in FIPS mode].
8787
====
8888

89-
* xref:../installing/installing_aws/ipi/installing-aws-customizations.adoc#installing-aws-customizations[Amazon Web Services]
89+
* xref:../installing/installing_aws/installing-aws-customizations.adoc#installing-aws-customizations[Amazon Web Services]
9090
* xref:../installing/installing_alibaba/installing-alibaba-customizations.adoc#installing-alibaba-customizations[Alibaba Cloud]
9191
* xref:../installing/installing_azure/installing-azure-customizations.adoc#installing-azure-customizations[Microsoft Azure]
9292
* xref:../installing/installing_bare_metal/installing-bare-metal.adoc#installing-bare-metal[Bare metal]

0 commit comments

Comments
 (0)