refactor: mispelled auth method naming

Signed-off-by: Gabriele Fedi <gabriele.fedi@enterprisedb.com>

internal/cnpgi/common/common.go

@@ -105,8 +105,8 @@ func BuildCertificateFilePath(objectStoreName string) string {
 // ContextWithProviderOptions enriches the context with cloud service provider specific options
 // based on the ObjectStore resource
 func ContextWithProviderOptions(ctx context.Context, objectStore apiv1.ObjectStore) context.Context {
-	if objectStore.GetAnnotations()[pluginmetadata.UseDefaultAzureCredentialsAnnotationName] ==
+	if objectStore.GetAnnotations()[pluginmetadata.UseDefaultAzureCredentialAnnotationName] ==
-		pluginmetadata.UseDefaultAzureCredentialsTrueValue {
+		pluginmetadata.UseDefaultAzureCredentialTrueValue {
 		return command.ContextWithDefaultAzureCredentials(ctx, true)
 	}
 

pkg/metadata/labels_annotations.go

@@ -4,12 +4,12 @@ package metadata
 const MetadataNamespace = "barmancloud.cnpg.io"
 
 const (
-	// UseDefaultAzureCredentialsAnnotationName is an annotation that can be set
+	// UseDefaultAzureCredentialAnnotationName is an annotation that can be set
-	// on an ObjectStore resource to enable the use DefaultAzureCredentials
+	// on an ObjectStore resource to enable the authentication to Azure via DefaultAzureCredential.
-	// to authenticate to Azure. This is meant to be used with inheritFromAzureAD enabled.
+	// This is meant to be used with inheritFromAzureAD enabled.
-	UseDefaultAzureCredentialsAnnotationName = MetadataNamespace + "/useDefaultAzureCredentials"
+	UseDefaultAzureCredentialAnnotationName = MetadataNamespace + "/useDefaultAzureCredential"
 
-	// UseDefaultAzureCredentialsTrueValue is the value for the annotation
+	// UseDefaultAzureCredentialTrueValue is the value for the annotation
-	// barmancloud.cnpg.io/useDefaultAzureCredentials to enable the use of DefaultAzureCredentials
+	// barmancloud.cnpg.io/useDefaultAzureCredential to enable the DefaultAzureCredentials auth mechanism.
-	UseDefaultAzureCredentialsTrueValue = "true"
+	UseDefaultAzureCredentialTrueValue = "true"
 )

web/docs/object_stores.md

@@ -233,7 +233,7 @@ Barman Cloud supports the following authentication methods:
 - Storage Account Name + [Access Key](https://learn.microsoft.com/en-us/azure/storage/common/storage-account-keys-manage)
 - Storage Account Name + [SAS Token](https://learn.microsoft.com/en-us/azure/storage/blobs/sas-service-create)
 - [Azure AD Workload Identity](https://azure.github.io/azure-workload-identity/docs/introduction.html)
-- [Azure Default Credentials](https://learn.microsoft.com/en-us/azure/developer/go/sdk/authentication/credential-chains#defaultazurecredential-overview)
+- [DefaultAzureCredential](https://learn.microsoft.com/en-us/azure/developer/go/sdk/authentication/credential-chains#defaultazurecredential-overview)
 
 ### Azure AD Workload Identity
 
@@ -253,10 +253,11 @@ spec:
   [...]
 ```
 
-### Azure Default Credentials
+### DefaultAzureCredential
 
-To authenticate using Azure Default Credentials, set the annotation
+To authenticate using `DefaultAzureCredential`, set the annotation
-`barmancloud.cnpg.io/useDefaultAzureCredentials="true"` on the ObjectStore:
+`barmancloud.cnpg.io/useDefaultAzureCredential="true"` on the ObjectStore in
+conjunction with the `.spec.configuration.inheritFromAzureAD` option:
 
 ```yaml
 apiVersion: barmancloud.cnpg.io/v1
@@ -264,7 +265,7 @@ kind: ObjectStore
 metadata:
   name: azure-store
   annotations:
-    barmancloud.cnpg.io/useDefaultAzureCredentials: "true"
+    barmancloud.cnpg.io/useDefaultAzureCredential: "true"
 spec:
   configuration:
     destinationPath: "<destination path here>"