weiguoqiang/cert-manager
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

update AzureDNS auth API comments

Browse Source 
Signed-off-by: Tim Ramlot <42113979+inteon@users.noreply.github.com>
This commit is contained in:
Tim Ramlot 2024-01-10 17:41:27 +01:00
parent 99d5732e29
commit 67f8a03cae
No known key found for this signature in database
GPG Key ID: 47428728E0C2878D
4 changed files with 31 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
deploy/crds/crd-challenges.yaml
View File

@ -171,10 +171,10 @@ spec:
- subscriptionID
properties:
clientID:
description: if both this and ClientSecret are left unset MSI will be used
description: 'Auth: Azure Service Principal: The ClientID of the Azure Service Principal used to authenticate with Azure DNS. If set, ClientSecret and TenantID must also be set.'
type: string
clientSecretSecretRef:
description: if both this and ClientID are left unset MSI will be used
description: 'Auth: Azure Service Principal: A reference to a Secret containing the password associated with the Service Principal. If set, ClientID and TenantID must also be set.'
type: object
required:
- name
@ -197,14 +197,14 @@ spec:
description: name of the DNS zone that should be used
type: string
managedIdentity:
description: managed identity configuration, can not be used at the same time as clientID, clientSecretSecretRef or tenantID
description: 'Auth: Azure Workload Identity or Azure Managed Service Identity: Settings to enable Azure Workload Identity or Azure Managed Service Identity If set, ClientID, ClientSecret and TenantID must not be set.'
type: object
properties:
clientID:
description: client ID of the managed identity, can not be used at the same time as resourceID
type: string
resourceID:
description: resource ID of the managed identity, can not be used at the same time as clientID
description: resource ID of the managed identity, can not be used at the same time as clientID Cannot be used for Azure Managed Service Identity
type: string
resourceGroupName:
description: resource group the DNS zone is located in
@ -213,7 +213,7 @@ spec:
description: ID of the Azure subscription
type: string
tenantID:
description: when specifying ClientID and ClientSecret then this field is also needed
description: 'Auth: Azure Service Principal: The TenantID of the Azure Service Principal used to authenticate with Azure DNS. If set, ClientID and ClientSecret must also be set.'
type: string
cloudDNS:
description: Use the Google Cloud DNS API to manage DNS01 challenge records.

10
deploy/crds/crd-clusterissuers.yaml
View File

@ -210,10 +210,10 @@ spec:
- subscriptionID
properties:
clientID:
description: if both this and ClientSecret are left unset MSI will be used
description: 'Auth: Azure Service Principal: The ClientID of the Azure Service Principal used to authenticate with Azure DNS. If set, ClientSecret and TenantID must also be set.'
type: string
clientSecretSecretRef:
description: if both this and ClientID are left unset MSI will be used
description: 'Auth: Azure Service Principal: A reference to a Secret containing the password associated with the Service Principal. If set, ClientID and TenantID must also be set.'
type: object
required:
- name
@ -236,14 +236,14 @@ spec:
description: name of the DNS zone that should be used
type: string
managedIdentity:
description: managed identity configuration, can not be used at the same time as clientID, clientSecretSecretRef or tenantID
description: 'Auth: Azure Workload Identity or Azure Managed Service Identity: Settings to enable Azure Workload Identity or Azure Managed Service Identity If set, ClientID, ClientSecret and TenantID must not be set.'
type: object
properties:
clientID:
description: client ID of the managed identity, can not be used at the same time as resourceID
type: string
resourceID:
description: resource ID of the managed identity, can not be used at the same time as clientID
description: resource ID of the managed identity, can not be used at the same time as clientID Cannot be used for Azure Managed Service Identity
type: string
resourceGroupName:
description: resource group the DNS zone is located in
@ -252,7 +252,7 @@ spec:
description: ID of the Azure subscription
type: string
tenantID:
description: when specifying ClientID and ClientSecret then this field is also needed
description: 'Auth: Azure Service Principal: The TenantID of the Azure Service Principal used to authenticate with Azure DNS. If set, ClientID and ClientSecret must also be set.'
type: string
cloudDNS:
description: Use the Google Cloud DNS API to manage DNS01 challenge records.

10
deploy/crds/crd-issuers.yaml
View File

@ -210,10 +210,10 @@ spec:
- subscriptionID
properties:
clientID:
description: if both this and ClientSecret are left unset MSI will be used
description: 'Auth: Azure Service Principal: The ClientID of the Azure Service Principal used to authenticate with Azure DNS. If set, ClientSecret and TenantID must also be set.'
type: string
clientSecretSecretRef:
description: if both this and ClientID are left unset MSI will be used
description: 'Auth: Azure Service Principal: A reference to a Secret containing the password associated with the Service Principal. If set, ClientID and TenantID must also be set.'
type: object
required:
- name
@ -236,14 +236,14 @@ spec:
description: name of the DNS zone that should be used
type: string
managedIdentity:
description: managed identity configuration, can not be used at the same time as clientID, clientSecretSecretRef or tenantID
description: 'Auth: Azure Workload Identity or Azure Managed Service Identity: Settings to enable Azure Workload Identity or Azure Managed Service Identity If set, ClientID, ClientSecret and TenantID must not be set.'
type: object
properties:
clientID:
description: client ID of the managed identity, can not be used at the same time as resourceID
type: string
resourceID:
description: resource ID of the managed identity, can not be used at the same time as clientID
description: resource ID of the managed identity, can not be used at the same time as clientID Cannot be used for Azure Managed Service Identity
type: string
resourceGroupName:
description: resource group the DNS zone is located in
@ -252,7 +252,7 @@ spec:
description: ID of the Azure subscription
type: string
tenantID:
description: when specifying ClientID and ClientSecret then this field is also needed
description: 'Auth: Azure Service Principal: The TenantID of the Azure Service Principal used to authenticate with Azure DNS. If set, ClientID and ClientSecret must also be set.'
type: string
cloudDNS:
description: Use the Google Cloud DNS API to manage DNS01 challenge records.

20
pkg/apis/acme/v1/types_issuer.go
View File

@ -518,18 +518,24 @@ type ACMEIssuerDNS01ProviderRoute53 struct {
// ACMEIssuerDNS01ProviderAzureDNS is a structure containing the
// configuration for Azure DNS
type ACMEIssuerDNS01ProviderAzureDNS struct {
// if both this and ClientSecret are left unset MSI will be used
// Auth: Azure Service Principal:
// The ClientID of the Azure Service Principal used to authenticate with Azure DNS.
// If set, ClientSecret and TenantID must also be set.
// +optional
ClientID string `json:"clientID,omitempty"`
// if both this and ClientID are left unset MSI will be used
// Auth: Azure Service Principal:
// A reference to a Secret containing the password associated with the Service Principal.
// If set, ClientID and TenantID must also be set.
// +optional
ClientSecret *cmmeta.SecretKeySelector `json:"clientSecretSecretRef,omitempty"`
// ID of the Azure subscription
SubscriptionID string `json:"subscriptionID"`
// when specifying ClientID and ClientSecret then this field is also needed
// Auth: Azure Service Principal:
// The TenantID of the Azure Service Principal used to authenticate with Azure DNS.
// If set, ClientID and ClientSecret must also be set.
// +optional
TenantID string `json:"tenantID,omitempty"`
@ -544,17 +550,23 @@ type ACMEIssuerDNS01ProviderAzureDNS struct {
// +optional
Environment AzureDNSEnvironment `json:"environment,omitempty"`
// managed identity configuration, can not be used at the same time as clientID, clientSecretSecretRef or tenantID
// Auth: Azure Workload Identity or Azure Managed Service Identity:
// Settings to enable Azure Workload Identity or Azure Managed Service Identity
// If set, ClientID, ClientSecret and TenantID must not be set.
// +optional
ManagedIdentity *AzureManagedIdentity `json:"managedIdentity,omitempty"`
}
// AzureManagedIdentity contains the configuration for Azure Workload Identity or Azure Managed Service Identity
// If the AZURE_FEDERATED_TOKEN_FILE environment variable is set, the Azure Workload Identity will be used.
// Otherwise, we fall-back to using Azure Managed Service Identity.
type AzureManagedIdentity struct {
// client ID of the managed identity, can not be used at the same time as resourceID
// +optional
ClientID string `json:"clientID,omitempty"`
// resource ID of the managed identity, can not be used at the same time as clientID
// Cannot be used for Azure Managed Service Identity
// +optional
ResourceID string `json:"resourceID,omitempty"`
}