sigs.k8s.io/cluster-api-provider-azure@v1.14.3/azure/converters/identity.go (about)

     1  /*
     2  Copyright 2020 The Kubernetes Authors.
     3  
     4  Licensed under the Apache License, Version 2.0 (the "License");
     5  you may not use this file except in compliance with the License.
     6  You may obtain a copy of the License at
     7  
     8      http://www.apache.org/licenses/LICENSE-2.0
     9  
    10  Unless required by applicable law or agreed to in writing, software
    11  distributed under the License is distributed on an "AS IS" BASIS,
    12  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13  See the License for the specific language governing permissions and
    14  limitations under the License.
    15  */
    16  
    17  package converters
    18  
    19  import (
    20  	"strings"
    21  
    22  	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/compute/armcompute/v5"
    23  	"github.com/pkg/errors"
    24  	"k8s.io/utils/ptr"
    25  	infrav1 "sigs.k8s.io/cluster-api-provider-azure/api/v1beta1"
    26  	azureutil "sigs.k8s.io/cluster-api-provider-azure/util/azure"
    27  )
    28  
    29  // ErrUserAssignedIdentitiesNotFound is the error thrown when user assigned identities is not passed with the identity type being UserAssigned.
    30  var ErrUserAssignedIdentitiesNotFound = errors.New("the user-assigned identity provider ids must not be null or empty for 'UserAssigned' identity type")
    31  
    32  // VMIdentityToVMSDK converts CAPZ VM identity to Azure SDK identity.
    33  func VMIdentityToVMSDK(identity infrav1.VMIdentity, uami []infrav1.UserAssignedIdentity) (*armcompute.VirtualMachineIdentity, error) {
    34  	if identity == infrav1.VMIdentitySystemAssigned {
    35  		return &armcompute.VirtualMachineIdentity{
    36  			Type: ptr.To(armcompute.ResourceIdentityTypeSystemAssigned),
    37  		}, nil
    38  	}
    39  
    40  	if identity == infrav1.VMIdentityUserAssigned {
    41  		userIdentitiesMap, err := UserAssignedIdentitiesToVMSDK(uami)
    42  		if err != nil {
    43  			return nil, errors.Wrap(err, "failed to assign VM identity")
    44  		}
    45  
    46  		return &armcompute.VirtualMachineIdentity{
    47  			Type:                   ptr.To(armcompute.ResourceIdentityTypeUserAssigned),
    48  			UserAssignedIdentities: userIdentitiesMap,
    49  		}, nil
    50  	}
    51  
    52  	return nil, nil
    53  }
    54  
    55  // UserAssignedIdentitiesToVMSDK converts CAPZ user assigned identities associated with the Virtual Machine to Azure SDK identities
    56  // The user identity dictionary key references will be ARM resource ids in the form:
    57  // '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
    58  func UserAssignedIdentitiesToVMSDK(identities []infrav1.UserAssignedIdentity) (map[string]*armcompute.UserAssignedIdentitiesValue, error) {
    59  	if len(identities) == 0 {
    60  		return nil, ErrUserAssignedIdentitiesNotFound
    61  	}
    62  	userIdentitiesMap := make(map[string]*armcompute.UserAssignedIdentitiesValue, len(identities))
    63  	for _, id := range identities {
    64  		key := sanitized(id.ProviderID)
    65  		userIdentitiesMap[key] = &armcompute.UserAssignedIdentitiesValue{}
    66  	}
    67  
    68  	return userIdentitiesMap, nil
    69  }
    70  
    71  // UserAssignedIdentitiesToVMSSSDK converts CAPZ user-assigned identities associated with the Virtual Machine Scale Set to Azure SDK identities
    72  // Similar to UserAssignedIdentitiesToVMSDK.
    73  func UserAssignedIdentitiesToVMSSSDK(identities []infrav1.UserAssignedIdentity) (map[string]*armcompute.UserAssignedIdentitiesValue, error) {
    74  	if len(identities) == 0 {
    75  		return nil, ErrUserAssignedIdentitiesNotFound
    76  	}
    77  	userIdentitiesMap := make(map[string]*armcompute.UserAssignedIdentitiesValue, len(identities))
    78  	for _, id := range identities {
    79  		key := sanitized(id.ProviderID)
    80  		userIdentitiesMap[key] = &armcompute.UserAssignedIdentitiesValue{}
    81  	}
    82  
    83  	return userIdentitiesMap, nil
    84  }
    85  
    86  // sanitized removes "azure://" prefix from the given id.
    87  func sanitized(id string) string {
    88  	return strings.TrimPrefix(id, azureutil.ProviderIDPrefix)
    89  }