Skip to content

Commit deca39a

Browse files
committed
OSDOCS-13798 Modifying azure identity params with new default behavior
1 parent cd1eda2 commit deca39a

File tree

2 files changed

+101
-0
lines changed

2 files changed

+101
-0
lines changed

modules/installation-configuration-parameters.adoc

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1462,6 +1462,30 @@ within link:https://azure.microsoft.com/en-us/global-infrastructure/regions[a re
14621462
|The version number of the image SKU. If you use `compute.platform.azure.osImage.publisher`, this field is required.
14631463
|String. The version of the image to use.
14641464

1465+
|compute:
1466+
platform:
1467+
azure:
1468+
identity:
1469+
type:
1470+
|The type of identity used for compute virtual machines.
1471+
The `UserAssigned` identity is a standalone Azure resource provided by the user and assigned to compute virtual machines.
1472+
If you specify `identity.type` as `UserAssigned`, but do not provide a user-assigned identity, the installation program creates the identity.
1473+
If you provide a user-assigned identity, the Azure account that you use to create the identity must have either the "User Access Administrator" or "RBAC Access Admin" roles.
1474+
|`UserAssigned` or `None`. If you do not specify a value, the installation program generates a user-assigned identity.
1475+
1476+
|compute:
1477+
platform:
1478+
azure:
1479+
identity:
1480+
userAssignedIdentities:
1481+
- name:
1482+
resourceGroup:
1483+
subscription:
1484+
|A group of parameters that specify the name of the user-assigned identity, and the resource group and subscription that contain the identity. All three values must be provided to specify a user-assigned identity.
1485+
Only one user-assigned identity can be supplied.
1486+
Supplying more than one user-assigned identity is an experimental feature, which may be enabled with the `MachineAPIMigration` feature gate.
1487+
|Array of strings.
1488+
14651489
|compute:
14661490
platform:
14671491
azure:
@@ -1540,6 +1564,30 @@ within link:https://azure.microsoft.com/en-us/global-infrastructure/regions[a re
15401564
|Enables the encryption of the virtual machine guest state for compute nodes. This parameter can only be used if you use Confidential VMs.
15411565
|`VMGuestStateOnly` is the only supported value.
15421566

1567+
|controlPlane:
1568+
platform:
1569+
azure:
1570+
identity:
1571+
type:
1572+
|The type of identity used for control plane virtual machines.
1573+
The `UserAssigned` identity is a standalone Azure resource provided by the user and assigned to control plane virtual machines.
1574+
If you specify `identity.type` as `UserAssigned`, but do not provide a user-assigned identity, the installation program creates the identity.
1575+
If you provide a user-assigned identity, the Azure account that you use to create the identity must have either the "User Access Administrator" or "RBAC Access Admin" roles.
1576+
|`UserAssigned` or `None`. If you do not specify a value, the installation program generates a user-assigned identity.
1577+
1578+
|controlPlane:
1579+
platform:
1580+
azure:
1581+
identity:
1582+
userAssignedIdentities:
1583+
- name:
1584+
resourceGroup:
1585+
subscription:
1586+
|A group of parameters that specify the name of the user-assigned identity, and the resource group and subscription that contain the identity. All three values must be provided to specify a user-assigned identity.
1587+
Only one user-assigned identity can be supplied.
1588+
Supplying more than one user-assigned identity is an experimental feature, which may be enabled with the `MachineAPIMigration` feature gate.
1589+
|Array of strings.
1590+
15431591
|controlPlane:
15441592
platform:
15451593
azure:
@@ -1659,6 +1707,30 @@ within link:https://azure.microsoft.com/en-us/global-infrastructure/regions[a re
16591707
|Enables the vTPM feature on all nodes if you are using trusted launch.
16601708
|`Enabled` or `Disabled`. The default is `Disabled`.
16611709

1710+
|platform:
1711+
azure:
1712+
defaultMachinePlatform:
1713+
identity:
1714+
type:
1715+
|The type of identity used for all virtual machines.
1716+
The `UserAssigned` identity is a standalone Azure resource provided by the user and assigned to all virtual machines.
1717+
If you specify `identity.type` as `UserAssigned`, but do not provide a user-assigned identity, the installation program creates the identity.
1718+
If you provide a user-assigned identity, the Azure account that you use to create the identity must have either the "User Access Administrator" or "RBAC Access Admin" roles.
1719+
|`UserAssigned` or `None`. If you do not specify a value, the installation program generates a user-assigned identity.
1720+
1721+
|platform:
1722+
azure:
1723+
defaultMachinePlatform:
1724+
identity:
1725+
userAssignedIdentities:
1726+
- name:
1727+
resourceGroup:
1728+
subscription:
1729+
|A group of parameters that specify the name of the user-assigned identity, and the resource group and subscription that contain the identity. All three values must be provided to specify a user-assigned identity.
1730+
Only one user-assigned identity can be supplied.
1731+
Supplying more than one user-assigned identity is an experimental feature, which may be enabled with the `MachineAPIMigration` feature gate.
1732+
|Array of strings.
1733+
16621734
|platform:
16631735
azure:
16641736
defaultMachinePlatform:

modules/minimum-required-permissions-ipi-azure.adoc

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ The following options are available to you:
1212

1313
* You can assign the identity the `Contributor` and `User Access Administrator` roles, which grant all of the required permissions.
1414
+
15+
If you set `identity.type` to `None` in the `install-config.yaml` file, you do not need to assign the `User Access Administrator` role to the service principal.
16+
+
1517
For more information about assigning roles, see the Azure documentation for link:https://docs.microsoft.com/en-us/azure/role-based-access-control/role-assignments-portal[managing access to Azure resources using the Azure portal].
1618
1719
* If the security policies of your organization require a more restrictive set of permissions, you can create a link:https://learn.microsoft.com/en-us/azure/role-based-access-control/custom-roles[custom role] with the necessary permissions.
@@ -27,6 +29,26 @@ The following permissions are required for creating an {product-title} cluster o
2729
* `Microsoft.Authorization/roleAssignments/write`
2830
====
2931
32+
[IMPORTANT]
33+
====
34+
The following permissions are not required if you set `identity.type` to `None` in the `install-config.yaml` file:
35+
36+
* `Microsoft.Authorization/roleAssignments/read`
37+
* `Microsoft.Authorization/roleAssignments/write`
38+
* `Microsoft.ManagedIdentity/userAssignedIdentities/assign/action`
39+
* `Microsoft.ManagedIdentity/userAssignedIdentities/read`
40+
* `Microsoft.ManagedIdentity/userAssignedIdentities/write`
41+
* `Microsoft.Authorization/roleAssignments/delete`
42+
43+
The following permissions are not required if you set `identity.type` to `UserAssigned` in the `install-config.yaml` file and provide a user-assigned identity:
44+
45+
* `Microsoft.Authorization/roleAssignments/read`
46+
* `Microsoft.Authorization/roleAssignments/write`
47+
* `Microsoft.ManagedIdentity/userAssignedIdentities/write`
48+
* `Microsoft.Authorization/roleAssignments/delete`
49+
50+
====
51+
3052
.Required permissions for creating compute resources
3153
[%collapsible]
3254
====
@@ -134,6 +156,13 @@ The following permissions are not required to create the private {product-title}
134156
* `Microsoft.Resources/subscriptions/resourcegroups/write`
135157
====
136158
159+
.Optional permissions for attaching an existing user-assigned identity to a node
160+
[%collapsible]
161+
====
162+
* `Microsoft.ManagedIdentity/userAssignedIdentities/assign/action`
163+
* `Microsoft.ManagedIdentity/userAssignedIdentities/read`
164+
====
165+
137166
.Required permissions for creating resource tags
138167
[%collapsible]
139168
====

0 commit comments

Comments
 (0)