Skip to content

Commit 81c40f0

Browse files
jeana-redhatjeana-redhat
authored
Merge pull request #65120 from jeana-redhat/OSDOCS-7881-ccoctl-install-uniformity
[OSDOCS-7881]: Unify `ccoctl` install step order across providers
2 parents f5e04ae + 0a2b3a9 commit 81c40f0

16 files changed

+453
-477
lines changed

‎installing/installing_aws/installing-aws-china.adoc

Lines changed: 34 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -40,39 +40,6 @@ include::modules/installation-aws-upload-custom-rhcos-ami.adoc[leveloffset=+1]
4040

4141
include::modules/installation-obtaining-installer.adoc[leveloffset=+1]
4242

43-
//Installing the OpenShift CLI by downloading the binary: Moved up to precede `ccoctl` steps, which require the use of `oc`
44-
include::modules/cli-installing-cli.adoc[leveloffset=+1]
45-
46-
//Supertask: Configuring an AWS cluster to use short-term credentials
47-
[id="installing-aws-with-short-term-creds_{context}"]
48-
== Optional: Configuring an AWS cluster to use short-term credentials
49-
50-
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.
51-
52-
[NOTE]
53-
====
54-
To use the AWS STS, you must configure the Cloud Credential Operator (CCO) to run in manual mode. As part of the installation process, you set `credentialsMode` parameter to `Manual` after creating the `install-config.yaml` installation configuration file.
55-
====
56-
57-
//Task part 1: Configuring the Cloud Credential Operator utility
58-
include::modules/cco-ccoctl-configuring.adoc[leveloffset=+2]
59-
60-
//Task part 2: Creating the required AWS resources
61-
[id="sts-mode-create-aws-resources-ccoctl_{context}"]
62-
=== Creating AWS resources with the Cloud Credential Operator utility
63-
64-
You have the following options when creating AWS resources:
65-
66-
* 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/installing-aws-china.adoc#cco-ccoctl-creating-at-once_installing-aws-china-region[Creating AWS resources with a single command].
67-
68-
* 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/installing-aws-china.adoc#cco-ccoctl-creating-individually_installing-aws-china-region[Creating AWS resources individually].
69-
70-
//Task part 2a: Creating the required AWS resources all at once
71-
include::modules/cco-ccoctl-creating-at-once.adoc[leveloffset=+3]
72-
73-
//Task part 2b: Creating the required AWS resources individually
74-
include::modules/cco-ccoctl-creating-individually.adoc[leveloffset=+3]
75-
7643
include::modules/installation-initializing-manual.adoc[leveloffset=+1]
7744

7845
[role="_additional-resources"]
@@ -94,21 +61,49 @@ include::modules/installation-configure-proxy.adoc[leveloffset=+2]
9461

9562
include::modules/installation-applying-aws-security-groups.adoc[leveloffset=+2]
9663

64+
//Installing the OpenShift CLI by downloading the binary: Moved up to precede `ccoctl` steps, which require the use of `oc`
65+
include::modules/cli-installing-cli.adoc[leveloffset=+1]
66+
9767
[id="installing-aws-manual-modes_{context}"]
9868
== Alternatives to storing administrator-level secrets in the kube-system project
9969

10070
By default, administrator secrets are stored in the `kube-system` project. If you configured the `credentialsMode` parameter in the `install-config.yaml` file to `Manual`, you must use one of the following alternatives:
10171

102-
* If you configured the CCO utility (`ccoctl`) to implement short-term credentials for individual components, follow the procedure in xref:../../installing/installing_aws/installing-aws-china.adoc#cco-ccoctl-install-creating-manifests_installing-aws-china-region[Incorporating the Cloud Credential Operator utility manifests].
103-
104-
* If you will manage cloud credentials manually, follow the procedure in xref:../../installing/installing_aws/installing-aws-china.adoc#manually-create-iam_installing-aws-china-region[Manually creating long-term credentials].
72+
* To manage long-term cloud credentials manually, follow the procedure in xref:../../installing/installing_aws/installing-aws-china.adoc#manually-create-iam_installing-aws-china-region[Manually creating long-term credentials].
10573

106-
// Additional steps for the Cloud Credential Operator utility (`ccoctl`)
107-
include::modules/cco-ccoctl-install-creating-manifests.adoc[leveloffset=+2]
74+
* To implement short-term credentials that are managed outside the cluster for individual components, follow the procedures in xref:../../installing/installing_aws/installing-aws-china.adoc#installing-aws-with-short-term-creds_installing-aws-china-region[Configuring an AWS cluster to use short-term credentials].
10875

109-
//Manually creating IAM
76+
//Manually creating long-term credentials
11077
include::modules/manually-create-identity-access-management.adoc[leveloffset=+2]
11178

79+
//Supertask: Configuring an AWS cluster to use short-term credentials
80+
[id="installing-aws-with-short-term-creds_{context}"]
81+
=== Configuring an AWS cluster to use short-term credentials
82+
83+
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.
84+
85+
//Task part 1: Configuring the Cloud Credential Operator utility
86+
include::modules/cco-ccoctl-configuring.adoc[leveloffset=+3]
87+
88+
//Task part 2: Creating the required AWS resources
89+
[id="sts-mode-create-aws-resources-ccoctl_{context}"]
90+
==== Creating AWS resources with the Cloud Credential Operator utility
91+
92+
You have the following options when creating AWS resources:
93+
94+
* 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/installing-aws-china.adoc#cco-ccoctl-creating-at-once_installing-aws-china-region[Creating AWS resources with a single command].
95+
96+
* 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/installing-aws-china.adoc#cco-ccoctl-creating-individually_installing-aws-china-region[Creating AWS resources individually].
97+
98+
//Task part 2a: Creating the required AWS resources all at once
99+
include::modules/cco-ccoctl-creating-at-once.adoc[leveloffset=+4]
100+
101+
//Task part 2b: Creating the required AWS resources individually
102+
include::modules/cco-ccoctl-creating-individually.adoc[leveloffset=+4]
103+
104+
//Task part 3: Incorporating the Cloud Credential Operator utility manifests
105+
include::modules/cco-ccoctl-install-creating-manifests.adoc[leveloffset=+3]
106+
112107
include::modules/installation-launching-installer.adoc[leveloffset=+1]
113108

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

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

Lines changed: 34 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -37,39 +37,6 @@ include::modules/installation-aws-marketplace-subscribe.adoc[leveloffset=+1]
3737

3838
include::modules/installation-obtaining-installer.adoc[leveloffset=+1]
3939

40-
//Installing the OpenShift CLI by downloading the binary: Moved up to precede `ccoctl` steps, which require the use of `oc`
41-
include::modules/cli-installing-cli.adoc[leveloffset=+1]
42-
43-
//Supertask: Configuring an AWS cluster to use short-term credentials
44-
[id="installing-aws-with-short-term-creds_{context}"]
45-
== Optional: Configuring an AWS cluster to use short-term credentials
46-
47-
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.
48-
49-
[NOTE]
50-
====
51-
To use the AWS STS, you must configure the Cloud Credential Operator (CCO) to run in manual mode. As part of the installation process, you set `credentialsMode` parameter to `Manual` after creating the `install-config.yaml` installation configuration file.
52-
====
53-
54-
//Task part 1: Configuring the Cloud Credential Operator utility
55-
include::modules/cco-ccoctl-configuring.adoc[leveloffset=+2]
56-
57-
//Task part 2: Creating the required AWS resources
58-
[id="sts-mode-create-aws-resources-ccoctl_{context}"]
59-
=== Creating AWS resources with the Cloud Credential Operator utility
60-
61-
You have the following options when creating AWS resources:
62-
63-
* 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/installing-aws-customizations.adoc#cco-ccoctl-creating-at-once_installing-aws-customizations[Creating AWS resources with a single command].
64-
65-
* 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/installing-aws-customizations.adoc#cco-ccoctl-creating-individually_installing-aws-customizations[Creating AWS resources individually].
66-
67-
//Task part 2a: Creating the required AWS resources all at once
68-
include::modules/cco-ccoctl-creating-at-once.adoc[leveloffset=+3]
69-
70-
//Task part 2b: Creating the required AWS resources individually
71-
include::modules/cco-ccoctl-creating-individually.adoc[leveloffset=+3]
72-
7340
include::modules/installation-initializing.adoc[leveloffset=+1]
7441

7542
[role="_additional-resources"]
@@ -91,21 +58,49 @@ include::modules/installation-aws-config-yaml.adoc[leveloffset=+2]
9158

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

61+
//Installing the OpenShift CLI by downloading the binary: Moved up to precede `ccoctl` steps, which require the use of `oc`
62+
include::modules/cli-installing-cli.adoc[leveloffset=+1]
63+
9464
[id="installing-aws-manual-modes_{context}"]
9565
== Alternatives to storing administrator-level secrets in the kube-system project
9666

9767
By default, administrator secrets are stored in the `kube-system` project. If you configured the `credentialsMode` parameter in the `install-config.yaml` file to `Manual`, you must use one of the following alternatives:
9868

99-
* If you configured the CCO utility (`ccoctl`) to implement short-term credentials for individual components, follow the procedure in xref:../../installing/installing_aws/installing-aws-customizations.adoc#cco-ccoctl-install-creating-manifests_installing-aws-customizations[Incorporating the Cloud Credential Operator utility manifests].
69+
* To manage long-term cloud credentials manually, follow the procedure in xref:../../installing/installing_aws/installing-aws-customizations.adoc#manually-create-iam_installing-aws-customizations[Manually creating long-term credentials].
10070

101-
* If you will manage cloud credentials manually, follow the procedure in xref:../../installing/installing_aws/installing-aws-customizations.adoc#manually-create-iam_installing-aws-customizations[Manually creating long-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/installing-aws-customizations.adoc#installing-aws-with-short-term-creds_installing-aws-customizations[Configuring an AWS cluster to use short-term credentials].
10272

103-
// Additional steps for the Cloud Credential Operator utility (`ccoctl`)
104-
include::modules/cco-ccoctl-install-creating-manifests.adoc[leveloffset=+2]
105-
106-
//Manually creating IAM
73+
//Manually creating long-term credentials
10774
include::modules/manually-create-identity-access-management.adoc[leveloffset=+2]
10875

76+
//Supertask: Configuring an AWS cluster to use short-term credentials
77+
[id="installing-aws-with-short-term-creds_{context}"]
78+
=== Configuring an AWS cluster to use short-term credentials
79+
80+
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.
81+
82+
//Task part 1: Configuring the Cloud Credential Operator utility
83+
include::modules/cco-ccoctl-configuring.adoc[leveloffset=+3]
84+
85+
//Task part 2: Creating the required AWS resources
86+
[id="sts-mode-create-aws-resources-ccoctl_{context}"]
87+
==== Creating AWS resources with the Cloud Credential Operator utility
88+
89+
You have the following options when creating AWS resources:
90+
91+
* 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/installing-aws-customizations.adoc#cco-ccoctl-creating-at-once_installing-aws-customizations[Creating AWS resources with a single command].
92+
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 resources individually. See xref:../../installing/installing_aws/installing-aws-customizations.adoc#cco-ccoctl-creating-individually_installing-aws-customizations[Creating AWS resources individually].
94+
95+
//Task part 2a: Creating the required AWS resources all at once
96+
include::modules/cco-ccoctl-creating-at-once.adoc[leveloffset=+4]
97+
98+
//Task part 2b: Creating the required AWS resources individually
99+
include::modules/cco-ccoctl-creating-individually.adoc[leveloffset=+4]
100+
101+
//Task part 3: Incorporating the Cloud Credential Operator utility manifests
102+
include::modules/cco-ccoctl-install-creating-manifests.adoc[leveloffset=+3]
103+
109104
include::modules/installation-launching-installer.adoc[leveloffset=+1]
110105

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

‎installing/installing_aws/installing-aws-government-region.adoc

Lines changed: 34 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -41,39 +41,6 @@ include::modules/installation-aws-marketplace-subscribe.adoc[leveloffset=+1]
4141

4242
include::modules/installation-obtaining-installer.adoc[leveloffset=+1]
4343

44-
//Installing the OpenShift CLI by downloading the binary: Moved up to precede `ccoctl` steps, which require the use of `oc`
45-
include::modules/cli-installing-cli.adoc[leveloffset=+1]
46-
47-
//Supertask: Configuring an AWS cluster to use short-term credentials
48-
[id="installing-aws-with-short-term-creds_{context}"]
49-
== Optional: Configuring an AWS cluster to use short-term credentials
50-
51-
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.
52-
53-
[NOTE]
54-
====
55-
To use the AWS STS, you must configure the Cloud Credential Operator (CCO) to run in manual mode. As part of the installation process, you set `credentialsMode` parameter to `Manual` after creating the `install-config.yaml` installation configuration file.
56-
====
57-
58-
//Task part 1: Configuring the Cloud Credential Operator utility
59-
include::modules/cco-ccoctl-configuring.adoc[leveloffset=+2]
60-
61-
//Task part 2: Creating the required AWS resources
62-
[id="sts-mode-create-aws-resources-ccoctl_{context}"]
63-
=== Creating AWS resources with the Cloud Credential Operator utility
64-
65-
You have the following options when creating AWS resources:
66-
67-
* 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/installing-aws-government-region.adoc#cco-ccoctl-creating-at-once_installing-aws-government-region[Creating AWS resources with a single command].
68-
69-
* 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/installing-aws-government-region.adoc#cco-ccoctl-creating-individually_installing-aws-government-region[Creating AWS resources individually].
70-
71-
//Task part 2a: Creating the required AWS resources all at once
72-
include::modules/cco-ccoctl-creating-at-once.adoc[leveloffset=+3]
73-
74-
//Task part 2b: Creating the required AWS resources individually
75-
include::modules/cco-ccoctl-creating-individually.adoc[leveloffset=+3]
76-
7744
include::modules/installation-initializing-manual.adoc[leveloffset=+1]
7845

7946
[role="_additional-resources"]
@@ -95,21 +62,49 @@ include::modules/installation-configure-proxy.adoc[leveloffset=+2]
9562

9663
include::modules/installation-applying-aws-security-groups.adoc[leveloffset=+2]
9764

65+
//Installing the OpenShift CLI by downloading the binary: Moved up to precede `ccoctl` steps, which require the use of `oc`
66+
include::modules/cli-installing-cli.adoc[leveloffset=+1]
67+
9868
[id="installing-aws-manual-modes_{context}"]
9969
== Alternatives to storing administrator-level secrets in the kube-system project
10070

10171
By default, administrator secrets are stored in the `kube-system` project. If you configured the `credentialsMode` parameter in the `install-config.yaml` file to `Manual`, you must use one of the following alternatives:
10272

103-
* If you configured the CCO utility (`ccoctl`) to implement short-term credentials for individual components, follow the procedure in xref:../../installing/installing_aws/installing-aws-government-region.adoc#cco-ccoctl-install-creating-manifests_installing-aws-government-region[Incorporating the Cloud Credential Operator utility manifests].
104-
105-
* If you will manage cloud credentials manually, follow the procedure in xref:../../installing/installing_aws/installing-aws-government-region.adoc#manually-create-iam_installing-aws-government-region[Manually creating long-term credentials].
73+
* To manage long-term cloud credentials manually, follow the procedure in xref:../../installing/installing_aws/installing-aws-government-region.adoc#manually-create-iam_installing-aws-government-region[Manually creating long-term credentials].
10674

107-
// Additional steps for the Cloud Credential Operator utility (`ccoctl`)
108-
include::modules/cco-ccoctl-install-creating-manifests.adoc[leveloffset=+2]
75+
* To implement short-term credentials that are managed outside the cluster for individual components, follow the procedures in xref:../../installing/installing_aws/installing-aws-government-region.adoc#installing-aws-with-short-term-creds_installing-aws-government-region[Incorporating the Cloud Credential Operator utility manifests].
10976

110-
//Manually creating IAM
77+
//Manually creating long-term credentials
11178
include::modules/manually-create-identity-access-management.adoc[leveloffset=+2]
11279

80+
//Supertask: Configuring an AWS cluster to use short-term credentials
81+
[id="installing-aws-with-short-term-creds_{context}"]
82+
=== Configuring an AWS cluster to use short-term credentials
83+
84+
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.
85+
86+
//Task part 1: Configuring the Cloud Credential Operator utility
87+
include::modules/cco-ccoctl-configuring.adoc[leveloffset=+3]
88+
89+
//Task part 2: Creating the required AWS resources
90+
[id="sts-mode-create-aws-resources-ccoctl_{context}"]
91+
==== Creating AWS resources with the Cloud Credential Operator utility
92+
93+
You have the following options when creating AWS resources:
94+
95+
* 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/installing-aws-government-region.adoc#cco-ccoctl-creating-at-once_installing-aws-government-region[Creating AWS resources with a single command].
96+
97+
* 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/installing-aws-government-region.adoc#cco-ccoctl-creating-individually_installing-aws-government-region[Creating AWS resources individually].
98+
99+
//Task part 2a: Creating the required AWS resources all at once
100+
include::modules/cco-ccoctl-creating-at-once.adoc[leveloffset=+4]
101+
102+
//Task part 2b: Creating the required AWS resources individually
103+
include::modules/cco-ccoctl-creating-individually.adoc[leveloffset=+4]
104+
105+
//Task part 3: Incorporating the Cloud Credential Operator utility manifests
106+
include::modules/cco-ccoctl-install-creating-manifests.adoc[leveloffset=+3]
107+
113108
include::modules/installation-launching-installer.adoc[leveloffset=+1]
114109

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

0 commit comments

Comments
 (0)