Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[azclient] Refactor AuthProvider multi-tenant token credential #8596

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

zarvd
Copy link
Contributor

@zarvd zarvd commented Mar 12, 2025

What type of PR is this?

/kind cleanup

What this PR does / why we need it:

Refactor the AuthProvider to remove the MultiTenantCredential, as the ComputeCredential would work the same and provide the client options while using the auxiliary token provider.

Which issue(s) this PR fixes:

Fixes #

Special notes for your reviewer:

Does this PR introduce a user-facing change?

NONE

Additional documentation e.g., KEPs (Kubernetes Enhancement Proposals), usage docs, etc.:


@k8s-ci-robot k8s-ci-robot added release-note-none Denotes a PR that doesn't merit a release note. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. labels Mar 12, 2025
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: zarvd
Once this PR has been reviewed and has the lgtm label, please assign andyzhangx for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Mar 12, 2025
@k8s-ci-robot
Copy link
Contributor

Hi @zarvd. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@k8s-ci-robot k8s-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Mar 12, 2025
@zarvd zarvd changed the title Refactor AuthProvider multi-tenant token credential [azclient] Refactor AuthProvider multi-tenant token credential Mar 12, 2025
credOptions := &azidentity.ClientCertificateCredentialOptions{
ClientOptions: *clientOption,
AdditionallyAllowedTenants: []string{armConfig.NetworkResourceTenantID},
SendCertificateChain: true,
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@MartinForReal Kindly note that I have also add the missing option here. please take a look, thanks.

MultiTenantCredential: multiTenantCredential,
CloudConfig: clientOption.Cloud,
ComputeCredential: computeCredential,
AdditionalComputeClientOptions: additionalComputeClientOptions,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there any reference to this field?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will be used in L418 in https://github.com/zarvd/cloud-provider-azure/blob/b24b7a4a34c24199494a18b1859db89584558594/pkg/provider/azure.go#L401-L427.

Compared to the existing one

if az.ComputeClientFactory == nil {
var cred azcore.TokenCredential
if az.AuthProvider.IsMultiTenantModeEnabled() {
// It uses Service Principal as the multi-tenant credential.
// TODO: refactor `IsMultiTenantModeEnabled` to make it more clear.
multiTenantCred := az.AuthProvider.GetMultiTenantIdentity()
networkTenantCred := az.AuthProvider.GetNetworkAzIdentity()
az.NetworkClientFactory, err = azclient.NewClientFactory(&azclient.ClientFactoryConfig{
SubscriptionID: az.NetworkResourceSubscriptionID,
}, &az.ARMClientConfig, clientOps.Cloud, networkTenantCred)
if err != nil {
return err
}
cred = multiTenantCred
} else {
cred = az.AuthProvider.GetAzIdentity()
}
var opts []func(option *arm.ClientOptions)
if az.AzureAuthConfig.AuxiliaryTokenProvider != nil && az.AzureAuthConfig.UseManagedIdentityExtension {
klog.InfoS("Using auxiliary token provider for ARM network credential")
// Multi-tenant mode with auxiliary token provider.
// It uses Managed Identity as the primary credential and auxiliary token provider as the auxiliary credential.
opts = append(opts, func(option *arm.ClientOptions) {
option.PerRetryPolicies = append(option.PerRetryPolicies, armauth.NewAuxiliaryAuthPolicy(
[]azcore.TokenCredential{az.AuthProvider.GetNetworkAzIdentity()},
az.AuthProvider.DefaultTokenScope(),
))
})
az.NetworkClientFactory, err = azclient.NewClientFactory(&azclient.ClientFactoryConfig{
SubscriptionID: az.NetworkResourceSubscriptionID,
}, &az.ARMClientConfig, clientOps.Cloud, az.AuthProvider.GetNetworkAzIdentity())
if err != nil {
return err
}
}
az.ComputeClientFactory, err = azclient.NewClientFactory(&azclient.ClientFactoryConfig{
SubscriptionID: az.SubscriptionID,
}, &az.ARMClientConfig, clientOps.Cloud, cred, opts...)
if err != nil {
return err
}
if az.NetworkClientFactory == nil {
az.NetworkClientFactory = az.ComputeClientFactory
}
}

}
}

// ClientCertificateCredential is used for client certificate
if computeCredential == nil && len(config.AADClientCertPath) > 0 {
credOptions := &azidentity.ClientCertificateCredentialOptions{
ClientOptions: *clientOption,
SendCertificateChain: true,
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please take a closer look; it's moved to the else branch in L213.

@MartinForReal
Copy link
Contributor

/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Mar 12, 2025
@zarvd zarvd force-pushed the refactor/azclient/auth-provider-multi-tenant branch from 8235f84 to 878ec67 Compare March 12, 2025 09:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. release-note-none Denotes a PR that doesn't merit a release note. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants