Merge pull request #38 from vmware-tanzu/main

Fork Sync: Update from parent repository

changelogs/unreleased/5478-lyndon

@@ -0,0 +1 @@
+Issue fix 5477: create the common way to support S3 compatible object storages that work for both Restic and Kopia; Keep the resticRepoPrefix parameter for compatibility

changelogs/unreleased/5512-lyndon

@@ -0,0 +1 @@
+Fix issue 5505: the pod volume backups/restores except the first one fail under the kopia path if "AZURE_CLOUD_NAME" is specified

pkg/repository/config/azure.go

@@ -18,6 +18,7 @@ package config
 
 import (
 	"context"
+	"fmt"
 	"os"
 	"strings"
 
@@ -211,13 +212,15 @@ func getRequiredValues(getValue func(string) string, keys ...string) error {
 }
 
 // GetAzureStorageDomain gets the Azure storage domain required by a Azure blob connection,
-// if the provided config doean't have the value, get it from system's environment variables
-func GetAzureStorageDomain(config map[string]string) string {
-	if domain, exist := config[storageDomainConfigKey]; exist {
-		return domain
-	} else {
-		return os.Getenv(cloudNameEnvVar)
+// if the provided credential file doesn't have the value, get it from system's environment variables
+func GetAzureStorageDomain(config map[string]string) (string, error) {
+	credentialsFile := selectCredentialsFile(config)
+
+	if err := loadCredentialsIntoEnv(credentialsFile); err != nil {
+		return "", err
 	}
+
+	return getStorageDomainFromCloudName(os.Getenv(cloudNameEnvVar))
 }
 
 func GetAzureCredentials(config map[string]string) (string, string, error) {
@@ -228,3 +231,12 @@ func GetAzureCredentials(config map[string]string) (string, string, error) {
 
 	return config[storageAccountConfigKey], storageAccountKey, nil
 }
+
+func getStorageDomainFromCloudName(cloudName string) (string, error) {
+	env, err := parseAzureEnvironment(cloudName)
+	if err != nil {
+		return "", errors.Wrapf(err, "unable to parse azure env from cloud name %s", cloudName)
+	}
+
+	return fmt.Sprintf("blob.%s", env.StorageEndpointSuffix), nil
+}

pkg/repository/config/azure_test.go

@@ -20,6 +20,7 @@ import (
 	"os"
 	"testing"
 
+	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 )
 
@@ -86,3 +87,48 @@ func TestSelectCredentialsFile(t *testing.T) {
 		})
 	}
 }
+
+func TestGetStorageDomainFromCloudName(t *testing.T) {
+	testCases := []struct {
+		name        string
+		cloudName   string
+		expected    string
+		expectedErr string
+	}{
+		{
+			name:        "get azure env fail",
+			cloudName:   "fake-cloud",
+			expectedErr: "unable to parse azure env from cloud name fake-cloud: autorest/azure: There is no cloud environment matching the name \"FAKE-CLOUD\"",
+		},
+		{
+			name:      "cloud name is empty",
+			cloudName: "",
+			expected:  "blob.core.windows.net",
+		},
+		{
+			name:      "azure public cloud",
+			cloudName: "AzurePublicCloud",
+			expected:  "blob.core.windows.net",
+		},
+		{
+
+			name:      "azure China cloud",
+			cloudName: "AzureChinaCloud",
+			expected:  "blob.core.chinacloudapi.cn",
+		},
+	}
+	for _, tc := range testCases {
+		t.Run(tc.name, func(t *testing.T) {
+			domain, err := getStorageDomainFromCloudName(tc.cloudName)
+
+			require.Equal(t, tc.expected, domain)
+
+			if tc.expectedErr == "" {
+				assert.NoError(t, err)
+			} else {
+				assert.EqualError(t, err, tc.expectedErr)
+				assert.Empty(t, domain)
+			}
+		})
+	}
+}

pkg/repository/config/config.go

@@ -56,7 +56,7 @@ func getRepoPrefix(location *velerov1api.BackupStorageLocation) (string, error)
 		prefix = layout.GetResticDir()
 	}
 
-	backendType := GetBackendType(location.Spec.Provider)
+	backendType := GetBackendType(location.Spec.Provider, location.Spec.Config)
 
 	if repoPrefix := location.Spec.Config["resticRepoPrefix"]; repoPrefix != "" {
 		return repoPrefix, nil
@@ -87,15 +87,25 @@ func getRepoPrefix(location *velerov1api.BackupStorageLocation) (string, error)
 		return fmt.Sprintf("gs:%s:/%s", bucket, prefix), nil
 	}
 
-	return "", errors.New("restic repository prefix (resticRepoPrefix) not specified in backup storage location's config")
+	return "", errors.Errorf("invalid backend type %s, provider %s", backendType, location.Spec.Provider)
 }
 
-func GetBackendType(provider string) BackendType {
+// GetBackendType returns a backend type that is known by Velero.
+// If the provider doesn't indicate a known backend type, but the endpoint is
+// specified, Velero regards it as a S3 compatible object store and return AWSBackend as the type.
+func GetBackendType(provider string, config map[string]string) BackendType {
 	if !strings.Contains(provider, "/") {
 		provider = "velero.io/" + provider
 	}
 
-	return BackendType(provider)
+	bt := BackendType(provider)
+	if IsBackendTypeValid(bt) {
+		return bt
+	} else if config != nil && config["s3Url"] != "" {
+		return AWSBackend
+	} else {
+		return bt
+	}
 }
 
 func IsBackendTypeValid(backendType BackendType) bool {

pkg/repository/config/config_test.go

@@ -48,7 +48,7 @@ func TestGetRepoIdentifier(t *testing.T) {
 				},
 			},
 			repoName:    "repo-1",
-			expectedErr: "restic repository prefix (resticRepoPrefix) not specified in backup storage location's config",
+			expectedErr: "invalid backend type velero.io/unsupported-provider, provider unsupported-provider",
 		},
 		{
 			name: "resticRepoPrefix in BSL config is used if set",
@@ -69,6 +69,25 @@ func TestGetRepoIdentifier(t *testing.T) {
 			repoName: "repo-1",
 			expected: "custom:prefix:/restic/repo-1",
 		},
+		{
+			name: "s3Url in BSL config is used",
+			bsl: &velerov1api.BackupStorageLocation{
+				Spec: velerov1api.BackupStorageLocationSpec{
+					Provider: "custom-repo-identifier",
+					Config: map[string]string{
+						"s3Url": "s3Url",
+					},
+					StorageType: velerov1api.StorageType{
+						ObjectStorage: &velerov1api.ObjectStorageLocation{
+							Bucket: "bucket",
+							Prefix: "prefix",
+						},
+					},
+				},
+			},
+			repoName: "repo-1",
+			expected: "s3:s3Url/bucket/prefix/restic/repo-1",
+		},
 		{
 			name: "s3.amazonaws.com URL format is used if region cannot be determined for AWS BSL",
 			bsl: &velerov1api.BackupStorageLocation{

pkg/repository/provider/unified_repo.go

@@ -344,7 +344,7 @@ func getRepoPassword(secretStore credentials.SecretStore) (string, error) {
 }
 
 func getStorageType(backupLocation *velerov1api.BackupStorageLocation) string {
-	backendType := repoconfig.GetBackendType(backupLocation.Spec.Provider)
+	backendType := repoconfig.GetBackendType(backupLocation.Spec.Provider, backupLocation.Spec.Config)
 
 	switch backendType {
 	case repoconfig.AWSBackend:
@@ -368,7 +368,7 @@ func getStorageCredentials(backupLocation *velerov1api.BackupStorageLocation, cr
 		return map[string]string{}, errors.New("invalid credentials interface")
 	}
 
-	backendType := repoconfig.GetBackendType(backupLocation.Spec.Provider)
+	backendType := repoconfig.GetBackendType(backupLocation.Spec.Provider, backupLocation.Spec.Config)
 	if !repoconfig.IsBackendTypeValid(backendType) {
 		return map[string]string{}, errors.New("invalid storage provider")
 	}
@@ -414,7 +414,7 @@ func getStorageCredentials(backupLocation *velerov1api.BackupStorageLocation, cr
 func getStorageVariables(backupLocation *velerov1api.BackupStorageLocation, repoBackend string, repoName string) (map[string]string, error) {
 	result := make(map[string]string)
 
-	backendType := repoconfig.GetBackendType(backupLocation.Spec.Provider)
+	backendType := repoconfig.GetBackendType(backupLocation.Spec.Provider, backupLocation.Spec.Config)
 	if !repoconfig.IsBackendTypeValid(backendType) {
 		return map[string]string{}, errors.New("invalid storage provider")
 	}
@@ -466,7 +466,12 @@ func getStorageVariables(backupLocation *velerov1api.BackupStorageLocation, repo
 		result[udmrepo.StoreOptionS3DisableTlsVerify] = config["insecureSkipTLSVerify"]
 		result[udmrepo.StoreOptionS3DisableTls] = strconv.FormatBool(disableTls)
 	} else if backendType == repoconfig.AzureBackend {
-		result[udmrepo.StoreOptionAzureDomain] = getAzureStorageDomain(config)
+		domain, err := getAzureStorageDomain(config)
+		if err != nil {
+			return map[string]string{}, errors.Wrapf(err, "error to get azure storage domain")
+		}
+
+		result[udmrepo.StoreOptionAzureDomain] = domain
 	}
 
 	result[udmrepo.StoreOptionOssBucket] = bucket

pkg/repository/provider/unified_repo_test.go

@@ -235,7 +235,7 @@ func TestGetStorageVariables(t *testing.T) {
 		repoName              string
 		repoBackend           string
 		getS3BucketRegion     func(string) (string, error)
-		getAzureStorageDomain func(map[string]string) string
+		getAzureStorageDomain func(map[string]string) (string, error)
 		expected              map[string]string
 		expectedErr           string
 	}{
@@ -366,17 +366,42 @@ func TestGetStorageVariables(t *testing.T) {
 				"skipTLSVerify": "false",
 			},
 		},
+		{
+			name: "azure, getAzureStorageDomain fail",
+			backupLocation: velerov1api.BackupStorageLocation{
+				Spec: velerov1api.BackupStorageLocationSpec{
+					Provider: "velero.io/azure",
+					Config: map[string]string{
+						"bucket": "fake-bucket-config",
+						"prefix": "fake-prefix-config",
+						"region": "fake-region",
+						"fspath": "",
+					},
+					StorageType: velerov1api.StorageType{
+						ObjectStorage: &velerov1api.ObjectStorageLocation{
+							Bucket: "fake-bucket-object-store",
+							Prefix: "fake-prefix-object-store",
+						},
+					},
+				},
+			},
+			getAzureStorageDomain: func(config map[string]string) (string, error) {
+				return "", errors.New("fake error")
+			},
+			repoBackend: "fake-repo-type",
+			expected:    map[string]string{},
+			expectedErr: "error to get azure storage domain: fake error",
+		},
 		{
 			name: "azure, ObjectStorage section exists in BSL",
 			backupLocation: velerov1api.BackupStorageLocation{
 				Spec: velerov1api.BackupStorageLocationSpec{
 					Provider: "velero.io/azure",
 					Config: map[string]string{
-						"bucket":        "fake-bucket-config",
-						"prefix":        "fake-prefix-config",
-						"region":        "fake-region",
-						"fspath":        "",
-						"storageDomain": "fake-domain",
+						"bucket": "fake-bucket-config",
+						"prefix": "fake-prefix-config",
+						"region": "fake-region",
+						"fspath": "",
 					},
 					StorageType: velerov1api.StorageType{
 						ObjectStorage: &velerov1api.ObjectStorageLocation{
@@ -386,8 +411,8 @@ func TestGetStorageVariables(t *testing.T) {
 					},
 				},
 			},
-			getAzureStorageDomain: func(config map[string]string) string {
-				return config["storageDomain"]
+			getAzureStorageDomain: func(config map[string]string) (string, error) {
+				return "fake-domain", nil
 			},
 			repoBackend: "fake-repo-type",
 			expected: map[string]string{
@@ -404,18 +429,17 @@ func TestGetStorageVariables(t *testing.T) {
 				Spec: velerov1api.BackupStorageLocationSpec{
 					Provider: "velero.io/azure",
 					Config: map[string]string{
-						"bucket":        "fake-bucket",
-						"prefix":        "fake-prefix",
-						"region":        "fake-region",
-						"fspath":        "",
-						"storageDomain": "fake-domain",
+						"bucket": "fake-bucket",
+						"prefix": "fake-prefix",
+						"region": "fake-region",
+						"fspath": "",
 					},
 				},
 			},
 			repoName:    "//fake-name//",
 			repoBackend: "fake-repo-type",
-			getAzureStorageDomain: func(config map[string]string) string {
-				return config["storageDomain"]
+			getAzureStorageDomain: func(config map[string]string) (string, error) {
+				return "fake-domain", nil
 			},
 			expected: map[string]string{
 				"bucket":        "fake-bucket",

pkg/restic/common.go

@@ -92,7 +92,7 @@ func CmdEnv(backupLocation *velerov1api.BackupStorageLocation, credentialFileSto
 		config[repoconfig.CredentialsFileKey] = credsFile
 	}
 
-	backendType := repoconfig.GetBackendType(backupLocation.Spec.Provider)
+	backendType := repoconfig.GetBackendType(backupLocation.Spec.Provider, backupLocation.Spec.Config)
 
 	switch backendType {
 	case repoconfig.AWSBackend: