Skip to content

Commit e77eae0

Browse files
author
Shubha Narayanan
committed
Confiring Azure account improvements
1 parent 6dc45bc commit e77eae0

15 files changed

+79
-117
lines changed

installing/installing_azure/installing-azure-account.adoc

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,19 @@
11
:_mod-docs-content-type: ASSEMBLY
22
[id="installing-azure-account"]
3-
= Configuring an Azure account
3+
= Configuring an {azure-short} account
44
include::_attributes/common-attributes.adoc[]
55
:context: installing-azure-account
66

77
toc::[]
88

9-
Before you can install {product-title}, you must configure a Microsoft Azure account to meet installation requirements.
9+
Before you can install {product-title}, you must configure a {azure-first} account to meet installation requirements.
1010

1111
[IMPORTANT]
1212
====
13-
All Azure resources that are available through public endpoints are subject to
14-
resource name restrictions, and you cannot create resources that use certain
15-
terms. For a list of terms that Azure restricts, see
13+
All {azure-short} resources that are available through public endpoints are subject to
14+
resource name restrictions. For a list of terms that {azure-short} restricts for resource names, see
1615
link:https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-reserved-resource-name[Resolve reserved resource name errors]
17-
in the Azure documentation.
16+
in the {azure-short} documentation.
1817
====
1918

2019
include::modules/installation-azure-limits.adoc[leveloffset=+1]
@@ -26,15 +25,16 @@ include::modules/installation-azure-limits.adoc[leveloffset=+1]
2625
2726
include::modules/installation-azure-network-config.adoc[leveloffset=+1]
2827

29-
include::modules/installation-azure-increasing-limits.adoc[leveloffset=+1]
30-
3128
include::modules/installation-azure-subscription-tenant-id.adoc[leveloffset=+1]
3229

3330
include::modules/installation-azure-identities.adoc[leveloffset=+1]
3431

3532
include::modules/installation-azure-permissions.adoc[leveloffset=+2]
36-
include::modules/minimum-required-permissions-ipi-azure.adoc[leveloffset=+2]
33+
34+
include::modules/minimum-required-permissions-ipi-azure.adoc[leveloffset=+3]
35+
3736
include::modules/installation-using-azure-managed-identities.adoc[leveloffset=+2]
37+
3838
include::modules/installation-creating-azure-service-principal.adoc[leveloffset=+2]
3939

4040
[role="_additional-resources"]

installing/installing_azure/upi/installing-azure-user-infra.adoc

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,8 +53,6 @@ include::modules/installation-azure-network-config.adoc[leveloffset=+2]
5353

5454
You can view Azure's DNS solution by visiting this xref:installation-azure-create-dns-zones_{context}[example for creating DNS zones].
5555

56-
include::modules/installation-azure-increasing-limits.adoc[leveloffset=+2]
57-
5856
include::modules/csr-management.adoc[leveloffset=+2]
5957

6058
include::modules/installation-azure-subscription-tenant-id.adoc[leveloffset=+2]

installing/installing_azure/upi/installing-restricted-networks-azure-user-provisioned.adoc

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,8 +55,6 @@ include::modules/installation-azure-network-config.adoc[leveloffset=+2]
5555

5656
You can view Azure's DNS solution by visiting this xref:installation-azure-create-dns-zones_{context}[example for creating DNS zones].
5757

58-
include::modules/installation-azure-increasing-limits.adoc[leveloffset=+2]
59-
6058
include::modules/csr-management.adoc[leveloffset=+2]
6159

6260
include::modules/installation-azure-permissions.adoc[leveloffset=+2]

modules/installation-azure-identities.adoc

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,12 @@
44

55
:_mod-docs-content-type: CONCEPT
66
[id="installation-azure-identities_{context}"]
7-
= Supported identities to access Azure resources
7+
= Supported identities to access {azure-short} resources
88

9-
An {product-title} cluster requires an Azure identity to create and manage Azure resources. As such, you need one of the following types of identities to complete the installation:
9+
An {product-title} cluster requires an {azure-short} identity to create and manage {azure-short} resources. You need one of the following types of identities to complete the installation:
1010

1111
* A service principal
1212
* A system-assigned managed identity
1313
* A user-assigned managed identity
14+
15+
For more information on Azure identities, see link:https://learn.microsoft.com/en-us/entra/identity/managed-identities-azure-resources/overview#managed-identity-types[Managed identity types].

modules/installation-azure-increasing-limits.adoc

Lines changed: 0 additions & 35 deletions
This file was deleted.

modules/installation-azure-limits.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -206,6 +206,8 @@ Using spot VMs for control plane nodes is not recommended.
206206
endif::ash[]
207207
|===
208208

209+
To increase an account limit, file a support request on the Azure portal. For more information, see link:https://learn.microsoft.com/en-us/azure/deployment-environments/how-to-request-quota-increase[Request a quota limit increase for Azure Deployment Environments resources].
210+
209211
ifeval::["{context}" == "installing-azure-stack-hub-user-infra"]
210212
:!ash:
211213
:!cp: Azure Stack Hub

modules/installation-azure-marketplace.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@
44

55
:_mod-docs-content-type: CONCEPT
66
[id="installation-azure-marketplace_{context}"]
7-
= Supported Azure Marketplace regions
7+
= Supported {azure-short} Marketplace regions
88

9-
Installing a cluster using the Azure Marketplace image is available to customers who purchase the offer in North America and EMEA.
9+
Installing a cluster using the {azure-short} Marketplace image is available to customers who purchase the offer in North America and EMEA.
1010

11-
While the offer must be purchased in North America or EMEA, you can deploy the cluster to any of the Azure public partitions that {product-title} supports.
11+
While the offer must be purchased in North America or EMEA, you can deploy the cluster to any of the {azure-short} public partitions that {product-title} supports.
1212

1313
[NOTE]
1414
====
15-
Deploying a cluster using the Azure Marketplace image is not supported for the Azure Government regions.
15+
Deploying a cluster using the {azure-short} Marketplace image is not supported for the {azure-short} Government regions.
1616
====

modules/installation-azure-network-config.adoc

Lines changed: 11 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -6,37 +6,29 @@
66

77
:_mod-docs-content-type: PROCEDURE
88
[id="installation-azure-network-config_{context}"]
9-
= Configuring a public DNS zone in Azure
9+
= Configuring a public DNS zone in {azure-short}
1010

11-
To install {product-title}, the Microsoft Azure account you use must
11+
To install {product-title}, the {azure-first} account you use must
1212
have a dedicated public hosted DNS zone in your account. This zone must be
1313
authoritative for the domain. This service provides
1414
cluster DNS resolution and name lookup for external connections to the cluster.
1515

1616
.Procedure
1717

1818
. Identify your domain, or subdomain, and registrar. You can transfer an
19-
existing domain and registrar or obtain a new one through Azure or another source.
20-
+
21-
[NOTE]
22-
====
23-
For more information about purchasing domains through Azure, see
24-
link:https://docs.microsoft.com/en-us/azure/app-service/manage-custom-dns-buy-domain[Buy a custom domain name for Azure App Service]
25-
in the Azure documentation.
26-
====
27-
28-
. If you are using an existing domain and registrar, migrate its DNS to Azure. See
19+
existing domain and registrar or obtain a new one through {azure-short} or another source.
20+
21+
** To purchase a new domain through {azure-short}, see link:https://docs.microsoft.com/en-us/azure/app-service/manage-custom-dns-buy-domain[Buy a custom domain name for Azure App Service].
22+
23+
** If you are using an existing domain and registrar, migrate its DNS to {azure-short}. For more information, see
2924
link:https://docs.microsoft.com/en-us/azure/app-service/manage-custom-dns-migrate-domain[Migrate an active DNS name to Azure App Service]
30-
in the Azure documentation.
25+
in the {azure-short} documentation.
3126

32-
. Configure DNS for your domain. Follow the steps in the
33-
link:https://docs.microsoft.com/en-us/azure/dns/dns-delegate-domain-azure-dns[Tutorial: Host your domain in Azure DNS]
34-
in the Azure documentation to create a public hosted zone for your domain or
35-
subdomain, extract the new authoritative name servers, and update the registrar
36-
records for the name servers that your domain uses.
27+
. Configure DNS for your domain, which includes creating a public hosted zone for your domain or subdomain, extracting the new authoritative name servers, and updating the registrar records for the name servers that your domain uses. For more information, see
28+
link:https://docs.microsoft.com/en-us/azure/dns/dns-delegate-domain-azure-dns[Tutorial: Host your domain in Azure DNS].
3729
+
3830
Use an appropriate root domain, such as `openshiftcorp.com`, or subdomain,
3931
such as `clusters.openshiftcorp.com`.
4032

41-
. If you use a subdomain, follow your company's procedures to add its delegation
33+
. If you use a subdomain, follow your organization's procedures to add its delegation
4234
records to the parent domain.

modules/installation-azure-permissions.adoc

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,18 @@
44
// * installing/installing_azure/installing-azure-user-infra.adoc
55
// * installing/installing_azure/installing-restricted-networks-azure-user-provisioned.adoc
66

7+
:_mod-docs-content-type: CONCEPT
78
[id="installation-azure-permissions_{context}"]
8-
= Required Azure roles
9+
= Required {azure-short} roles
910

10-
An {product-title} cluster requires an Azure identity to create and manage Azure resources. Before you create the identity, verify that your environment meets the following requirements:
11+
Before you create the identity, verify that your environment meets the following requirements based on the identity:
1112

1213
* The Azure account that you use to create the identity is assigned the `User Access Administrator` and `Contributor` roles. These roles are required when:
14+
1315
** Creating a service principal or user-assigned managed identity.
16+
1417
** Enabling a system-assigned managed identity on a virtual machine.
18+
1519
* If you are going to use a service principal to complete the installation, verify that the Azure account that you use to create the identity is assigned the `microsoft.directory/servicePrincipals/createAsOwner` permission in Microsoft Entra ID.
1620
17-
To set roles on the Azure portal, see the link:https://docs.microsoft.com/en-us/azure/role-based-access-control/role-assignments-portal[Manage access to Azure resources using RBAC and the Azure portal] in the Azure documentation.
21+
To set roles on the {azure-short} portal, see link:https://docs.microsoft.com/en-us/azure/role-based-access-control/role-assignments-portal[Assign {azure-short} roles using the {azure-short} portal] in the {azure-short} documentation.

modules/installation-azure-preparing-diskencryptionsets.adoc

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -4,42 +4,42 @@
44

55
:_mod-docs-content-type: PROCEDURE
66
[id="preparing-disk-encryption-sets_{context}"]
7-
= Preparing an Azure Disk Encryption Set
8-
The {product-title} installer can use an existing Disk Encryption Set with a user-managed key. To enable this feature, you can create a Disk Encryption Set in Azure and provide the key to the installer.
7+
= Preparing an {azure-short} Disk Encryption Set
8+
The {product-title} installer can use an existing Disk Encryption Set with a user-managed key. To enable this feature, you can create a Disk Encryption Set in {azure-short} and provide the key to the installer.
99

1010
.Procedure
1111

12-
. Set the following environment variables for the Azure resource group by running the following command:
12+
. Set the environment variables for the {azure-short} resource group by running the following command:
1313
+
1414
[source,terminal]
1515
----
1616
$ export RESOURCEGROUP="<resource_group>" \// <1>
1717
LOCATION="<location>" <2>
1818
----
19-
<1> Specifies the name of the Azure resource group where you will create the Disk Encryption Set and encryption key. To avoid losing access to your keys after destroying the cluster, you should create the Disk Encryption Set in a different resource group than the resource group where you install the cluster.
20-
<2> Specifies the Azure location where you will create the resource group.
19+
<1> Specifies the name of the {azure-short} resource group where the Disk Encryption Set and encryption key are to be created. To prevent losing access to your keys when you destroy the cluster, create the Disk Encryption Set in a separate resource group from the one where you install the cluster.
20+
<2> Specifies the {azure-short} location where the resource group is to be created.
2121
+
22-
. Set the following environment variables for the Azure Key Vault and Disk Encryption Set by running the following command:
22+
. Set the environment variables for the {azure-short} Key Vault and Disk Encryption Set by running the following command:
2323
+
2424
[source,terminal]
2525
----
2626
$ export KEYVAULT_NAME="<keyvault_name>" \// <1>
2727
KEYVAULT_KEY_NAME="<keyvault_key_name>" \// <2>
2828
DISK_ENCRYPTION_SET_NAME="<disk_encryption_set_name>" <3>
2929
----
30-
<1> Specifies the name of the Azure Key Vault you will create.
31-
<2> Specifies the name of the encryption key you will create.
32-
<3> Specifies the name of the disk encryption set you will create.
30+
<1> Specifies the name of the {azure-short} Key Vault to be created.
31+
<2> Specifies the name of the encryption key to be created.
32+
<3> Specifies the name of the disk encryption set to be created.
3333
+
34-
. Set the environment variable for the ID of your Azure Service Principal by running the following command:
34+
. Set the environment variable for the ID of your {azure-short} service principal by running the following command:
3535
+
3636
[source,terminal]
3737
----
3838
$ export CLUSTER_SP_ID="<service_principal_id>" <1>
3939
----
40-
<1> Specifies the ID of the service principal you will use for this installation.
40+
<1> Specifies the ID of the service principal to be used for installation.
4141
+
42-
. Enable host-level encryption in Azure by running the following commands:
42+
. Enable host-level encryption in {azure-short} by running the following command:
4343
+
4444
[source,terminal]
4545
----
@@ -56,14 +56,14 @@ $ az feature show --namespace Microsoft.Compute --name EncryptionAtHost
5656
$ az provider register -n Microsoft.Compute
5757
----
5858
+
59-
. Create an Azure Resource Group to hold the disk encryption set and associated resources by running the following command:
59+
. Create an {azure-short} resource group to hold the disk encryption set and associated resources by running the following command:
6060
+
6161
[source,terminal]
6262
----
6363
$ az group create --name $RESOURCEGROUP --location $LOCATION
6464
----
6565
+
66-
. Create an Azure key vault by running the following command:
66+
. Create an {azure-short} Key Vault by running the following command:
6767
+
6868
[source,terminal]
6969
----
@@ -102,7 +102,7 @@ $ az disk-encryption-set create -n $DISK_ENCRYPTION_SET_NAME -l $LOCATION -g \
102102
$RESOURCEGROUP --source-vault $KEYVAULT_ID --key-url $KEYVAULT_KEY_URL
103103
----
104104
+
105-
. Grant the DiskEncryptionSet resource access to the key vault by running the following commands:
105+
. Grant the `DiskEncryptionSet` resource access to the key vault by running the following commands:
106106
+
107107
[source,terminal]
108108
----
@@ -116,7 +116,7 @@ $ az keyvault set-policy -n $KEYVAULT_NAME -g $RESOURCEGROUP --object-id \
116116
$DES_IDENTITY --key-permissions wrapkey unwrapkey get
117117
----
118118
+
119-
. Grant the Azure Service Principal permission to read the DiskEncryptionSet by running the following commands:
119+
. Grant the {azure-short} service principal permission to read the Disk Encryption Set by running the following commands:
120120
+
121121
[source,terminal]
122122
----
@@ -129,4 +129,4 @@ $ DES_RESOURCE_ID=$(az disk-encryption-set show -n $DISK_ENCRYPTION_SET_NAME -g
129129
$ az role assignment create --assignee $CLUSTER_SP_ID --role "<reader_role>" \// <1>
130130
--scope $DES_RESOURCE_ID -o jsonc
131131
----
132-
<1> Specifies an Azure role with read permissions to the disk encryption set. You can use the `Owner` role or a custom role with the necessary permissions.
132+
<1> Specifies an {azure-short} role with read permissions to the disk encryption set. You can use the `Owner` role or a custom role with the necessary permissions.

0 commit comments

Comments
 (0)