Skip to content

Commit c8fffc9

Browse files
committed
[OCPBUGS-23345] Adds step to set Azure resource group for AADWID install
1 parent a911335 commit c8fffc9

5 files changed

+112
-4
lines changed

installing/installing_azure/installing-restricted-networks-azure-installer-provisioned.adoc

Lines changed: 30 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,6 @@ Because the installation media is on the mirror host, you can use that computer
2929
** The VNet contains the mirror registry
3030
** The VNet has firewall rules or a peering connection to access the mirror registry hosted elsewhere
3131
* 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.
32-
* If the cloud identity and access management (IAM) APIs are not accessible in your environment, or if you do not want to store an administrator-level credential secret in the `kube-system` namespace, you can xref:../../installing/installing_azure/installing-azure-customizations.adoc#manually-create-iam_installing-azure-customizations[manually create and maintain long-term credentials].
3332
* If you use customer-managed encryption keys, you xref:../../installing/installing_azure/enabling-user-managed-encryption-azure.adoc#enabling-user-managed-encryption-azure[prepared your Azure environment for encryption].
3433

3534
include::modules/installation-about-restricted-network.adoc[leveloffset=+1]
@@ -61,10 +60,38 @@ include::modules/installation-azure-config-yaml.adoc[leveloffset=+2]
6160

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

64-
include::modules/installation-launching-installer.adoc[leveloffset=+1]
65-
63+
//Installing the OpenShift CLI by downloading the binary: Moved up to precede manual cred (short and long) steps, which require the use of `oc`
6664
include::modules/cli-installing-cli.adoc[leveloffset=+1]
6765

66+
[id="installing-azure-manual-modes_{context}"]
67+
== Alternatives to storing administrator-level secrets in the kube-system project
68+
69+
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:
70+
71+
* To manage long-term cloud credentials manually, follow the procedure in xref:../../installing/installing_azure/installing-restricted-networks-azure-installer-provisioned.adoc#manually-create-iam_installing-restricted-networks-azure-installer-provisioned[Manually creating long-term credentials].
72+
73+
* To implement short-term credentials that are managed outside the cluster for individual components, follow the procedures in xref:../../installing/installing_azure/installing-restricted-networks-azure-installer-provisioned.adoc#installing-azure-with-short-term-creds_installing-restricted-networks-azure-installer-provisioned[Configuring an Azure cluster to use short-term credentials].
74+
75+
//Manually creating long-term credentials
76+
include::modules/manually-create-identity-access-management.adoc[leveloffset=+2]
77+
78+
//Supertask: Configuring an Azure cluster to use short-term credentials
79+
[id="installing-azure-with-short-term-creds_{context}"]
80+
=== Configuring an Azure cluster to use short-term credentials
81+
82+
To install a cluster that uses Azure AD Workload Identity, you must configure the Cloud Credential Operator utility and create the required Azure resources for your cluster.
83+
84+
//Task part 1: Configuring the Cloud Credential Operator utility
85+
include::modules/cco-ccoctl-configuring.adoc[leveloffset=+3]
86+
87+
//Task part 2: Creating the required Azure resources
88+
include::modules/cco-ccoctl-creating-at-once.adoc[leveloffset=+3]
89+
90+
// Additional steps for the Cloud Credential Operator utility (`ccoctl`)
91+
include::modules/cco-ccoctl-install-creating-manifests.adoc[leveloffset=+3]
92+
93+
include::modules/installation-launching-installer.adoc[leveloffset=+1]
94+
6895
include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1]
6996

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

modules/cco-ccoctl-configuring.adoc

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@
3333
// * installing/installing_azure/installing-azure-network-customizations.adoc
3434
// * installing/installing_azure/installing-azure-private.adoc
3535
// * installing/installing_azure/installing-azure-vnet.adoc
36+
// * installing/installing_azure/installing-restricted-networks-azure-installer-provisioned.adoc
3637

3738
//Platforms that must use `ccoctl` and update content
3839
ifeval::["{context}" == "configuring-iam-ibm-cloud"]
@@ -119,6 +120,9 @@ endif::[]
119120
ifeval::["{context}" == "installing-azure-vnet"]
120121
:azure-workload-id:
121122
endif::[]
123+
ifeval::["{context}" == "installing-restricted-networks-azure-installer-provisioned"]
124+
:azure-workload-id:
125+
endif::[]
122126

123127
:_mod-docs-content-type: PROCEDURE
124128
[id="cco-ccoctl-configuring_{context}"]
@@ -424,4 +428,7 @@ ifeval::["{context}" == "installing-azure-private"]
424428
endif::[]
425429
ifeval::["{context}" == "installing-azure-vnet"]
426430
:!azure-workload-id:
431+
endif::[]
432+
ifeval::["{context}" == "installing-restricted-networks-azure-installer-provisioned"]
433+
:!azure-workload-id:
427434
endif::[]

modules/cco-ccoctl-creating-at-once.adoc

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@
3131
// * installing/installing_azure/installing-azure-network-customizations.adoc
3232
// * installing/installing_azure/installing-azure-private.adoc
3333
// * installing/installing_azure/installing-azure-vnet.adoc
34+
// * installing/installing_azure/installing-restricted-networks-azure-installer-provisioned.adoc
3435

3536
//Platforms that must use `ccoctl`
3637
ifeval::["{context}" == "installing-alibaba-default"]
@@ -111,6 +112,9 @@ endif::[]
111112
ifeval::["{context}" == "installing-azure-vnet"]
112113
:azure-workload-id:
113114
endif::[]
115+
ifeval::["{context}" == "installing-restricted-networks-azure-installer-provisioned"]
116+
:azure-workload-id:
117+
endif::[]
114118

115119
:_mod-docs-content-type: PROCEDURE
116120
[id="cco-ccoctl-creating-at-once_{context}"]
@@ -479,4 +483,7 @@ ifeval::["{context}" == "installing-azure-private"]
479483
endif::[]
480484
ifeval::["{context}" == "installing-azure-vnet"]
481485
:!azure-workload-id:
486+
endif::[]
487+
ifeval::["{context}" == "installing-restricted-networks-azure-installer-provisioned"]
488+
:!azure-workload-id:
482489
endif::[]

modules/cco-ccoctl-install-creating-manifests.adoc

Lines changed: 59 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,27 @@
2626
// * installing/installing_azure/installing-azure-network-customizations.adoc
2727
// * installing/installing_azure/installing-azure-private.adoc
2828
// * installing/installing_azure/installing-azure-vnet.adoc
29+
// * installing/installing_azure/installing-restricted-networks-azure-installer-provisioned.adoc
30+
31+
//global Azure install assemblies
32+
ifeval::["{context}" == "installing-azure-customizations"]
33+
:azure-workload-id:
34+
endif::[]
35+
ifeval::["{context}" == "installing-azure-government-region"]
36+
:azure-workload-id:
37+
endif::[]
38+
ifeval::["{context}" == "installing-azure-network-customizations"]
39+
:azure-workload-id:
40+
endif::[]
41+
ifeval::["{context}" == "installing-azure-private"]
42+
:azure-workload-id:
43+
endif::[]
44+
ifeval::["{context}" == "installing-azure-vnet"]
45+
:azure-workload-id:
46+
endif::[]
47+
ifeval::["{context}" == "installing-restricted-networks-azure-installer-provisioned"]
48+
:azure-workload-id:
49+
endif::[]
2950

3051
:_mod-docs-content-type: PROCEDURE
3152
[id="cco-ccoctl-install-creating-manifests_{context}"]
@@ -52,6 +73,23 @@ credentialsMode: Manual
5273
# ...
5374
----
5475

76+
ifdef::azure-workload-id[]
77+
. If you used the `ccoctl` utility to create a new Azure resource group instead of using an existing resource group, modify the `resourceGroupName` parameter in the `install-config.yaml` as shown:
78+
+
79+
.Sample configuration file snippet
80+
[source,yaml]
81+
----
82+
apiVersion: v1
83+
baseDomain: example.com
84+
# ...
85+
platform:
86+
azure:
87+
resourceGroupName: <azure_infra_name> # <1>
88+
# ...
89+
----
90+
<1> This value must match the user-defined name for Azure resources that was specified with the `--name` argument of the `ccoctl azure create-all` command.
91+
endif::azure-workload-id[]
92+
5593
. If you have not previously created installation manifest files, do so by running the following command:
5694
+
5795
[source,terminal]
@@ -71,4 +109,24 @@ $ cp /<path_to_ccoctl_output_dir>/manifests/* ./manifests/
71109
[source,terminal,subs="+quotes"]
72110
----
73111
$ cp -a /<path_to_ccoctl_output_dir>/tls .
74-
----
112+
----
113+
114+
//global Azure install assemblies
115+
ifeval::["{context}" == "installing-azure-customizations"]
116+
:!azure-workload-id:
117+
endif::[]
118+
ifeval::["{context}" == "installing-azure-government-region"]
119+
:!azure-workload-id:
120+
endif::[]
121+
ifeval::["{context}" == "installing-azure-network-customizations"]
122+
:!azure-workload-id:
123+
endif::[]
124+
ifeval::["{context}" == "installing-azure-private"]
125+
:!azure-workload-id:
126+
endif::[]
127+
ifeval::["{context}" == "installing-azure-vnet"]
128+
:!azure-workload-id:
129+
endif::[]
130+
ifeval::["{context}" == "installing-restricted-networks-azure-installer-provisioned"]
131+
:!azure-workload-id:
132+
endif::[]

modules/manually-create-identity-access-management.adoc

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@
2929
// * installing/installing_azure/installing-azure-network-customizations.adoc
3030
// * installing/installing_azure/installing-azure-private.adoc
3131
// * installing/installing_azure/installing-azure-vnet.adoc
32+
// * installing/installing_azure/installing-restricted-networks-azure-installer-provisioned.adoc
3233

3334
//Platforms that must manually create IAM
3435
ifeval::["{context}" == "installing-azure-stack-hub-default"]
@@ -129,6 +130,10 @@ ifeval::["{context}" == "installing-azure-vnet"]
129130
:azure:
130131
:cco-multi-mode:
131132
endif::[]
133+
ifeval::["{context}" == "installing-restricted-networks-azure-installer-provisioned"]
134+
:azure:
135+
:cco-multi-mode:
136+
endif::[]
132137

133138
:_mod-docs-content-type: PROCEDURE
134139
[id="manually-create-iam_{context}"]
@@ -416,4 +421,8 @@ endif::[]
416421
ifeval::["{context}" == "installing-azure-vnet"]
417422
:!azure:
418423
:!cco-multi-mode:
424+
endif::[]
425+
ifeval::["{context}" == "installing-restricted-networks-azure-installer-provisioned"]
426+
:!azure:
427+
:!cco-multi-mode:
419428
endif::[]

0 commit comments

Comments
 (0)