Merge pull request #9939 from adam-jian-zhang/resource_policy_for_restore

add resourcePolicy on restore CRD
This commit is contained in:
Adam Zhang
2026-06-25 16:14:51 +08:00
committed by GitHub
10 changed files with 781 additions and 63 deletions
@@ -0,0 +1 @@
Fix issue #9935, add resource policy on restore CRD
@@ -404,6 +404,33 @@ spec:
- name
type: object
x-kubernetes-map-type: atomic
resourcePolicy:
description: |-
ResourcePolicy specifies the reference to a ConfigMap containing resource
filter policies for this restore. The ConfigMap can contain a
namespacedFilterPolicies section that specifies per-namespace resource type
filters, label selectors, and resource name patterns, and a
clusterScopedFilterPolicy section for per-kind filtering of cluster-scoped
resources. The ConfigMap format is the same as for BackupSpec.ResourcePolicy.
nullable: true
properties:
apiGroup:
description: |-
APIGroup is the group for the resource being referenced.
If APIGroup is not specified, the specified Kind must be in the core API group.
For any other third-party types, APIGroup is required.
type: string
kind:
description: Kind is the type of resource being referenced
type: string
name:
description: Name is the name of resource being referenced
type: string
required:
- kind
- name
type: object
x-kubernetes-map-type: atomic
restorePVs:
description: |-
RestorePVs specifies whether to restore all included
File diff suppressed because one or more lines are too long
+73 -6
View File
@@ -303,6 +303,30 @@ func (p *Policies) Validate() error {
return nil
}
func (p *Policies) ValidateForRestore() error {
if p.version != currentSupportDataVersion {
return fmt.Errorf("incompatible version number %s with supported version %s", p.version, currentSupportDataVersion)
}
if len(p.volumePolicies) > 0 {
return fmt.Errorf("volumePolicies are not supported for restore")
}
if p.GetIncludeExcludePolicy() != nil {
return fmt.Errorf("includeExcludePolicy is not supported for restore")
}
if err := p.validateClusterScopedFilterPolicy(); err != nil {
return errors.WithStack(err)
}
if err := p.validateNamespacedFilterPolicies(); err != nil {
return errors.WithStack(err)
}
return nil
}
func (p *Policies) GetIncludeExcludePolicy() *IncludeExcludePolicy {
return p.includeExcludePolicy
}
@@ -331,20 +355,20 @@ func GetResourcePoliciesFromBackup(
if err != nil {
logger.Errorf("Fail to get ResourcePolicies %s ConfigMap with error %s.",
backup.Namespace+"/"+backup.Spec.ResourcePolicy.Name, err.Error())
return nil, fmt.Errorf("fail to get ResourcePolicies %s ConfigMap with error %s",
backup.Namespace+"/"+backup.Spec.ResourcePolicy.Name, err.Error())
return nil, fmt.Errorf("fail to get ResourcePolicies %s ConfigMap: %w",
backup.Namespace+"/"+backup.Spec.ResourcePolicy.Name, err)
}
resourcePolicies, err = getResourcePoliciesFromConfig(policiesConfigMap)
if err != nil {
logger.Errorf("Fail to read ResourcePolicies from ConfigMap %s with error %s.",
backup.Namespace+"/"+backup.Name, err.Error())
return nil, fmt.Errorf("fail to read the ResourcePolicies from ConfigMap %s with error %s",
backup.Namespace+"/"+backup.Name, err.Error())
return nil, fmt.Errorf("fail to read the ResourcePolicies from ConfigMap %s: %w",
backup.Namespace+"/"+backup.Name, err)
} else if err = resourcePolicies.Validate(); err != nil {
logger.Errorf("Fail to validate ResourcePolicies in ConfigMap %s with error %s.",
backup.Namespace+"/"+backup.Name, err.Error())
return nil, fmt.Errorf("fail to validate ResourcePolicies in ConfigMap %s with error %s",
backup.Namespace+"/"+backup.Name, err.Error())
return nil, fmt.Errorf("fail to validate ResourcePolicies in ConfigMap %s: %w",
backup.Namespace+"/"+backup.Name, err)
}
}
@@ -425,6 +449,49 @@ func GetResourcePoliciesFromBackupWithGlobal(
return backupPolicies, nil
}
// GetResourcePoliciesFromRestore retrieves the resource policies from the ConfigMap referenced in the Restore spec.
func GetResourcePoliciesFromRestore(
ctx context.Context,
restore *velerov1api.Restore,
client crclient.Client,
logger logrus.FieldLogger,
) (resourcePolicies *Policies, err error) {
if restore.Spec.ResourcePolicy != nil {
if !strings.EqualFold(restore.Spec.ResourcePolicy.Kind, ConfigmapRefType) {
return nil, fmt.Errorf("invalid ResourcePolicy kind %q, only %q is supported",
restore.Spec.ResourcePolicy.Kind, ConfigmapRefType)
}
policiesConfigMap := &corev1api.ConfigMap{}
err = client.Get(
ctx,
crclient.ObjectKey{
Namespace: restore.Namespace,
Name: restore.Spec.ResourcePolicy.Name,
},
policiesConfigMap,
)
if err != nil {
logger.Errorf("Fail to get ResourcePolicies %s ConfigMap with error %s.",
restore.Namespace+"/"+restore.Spec.ResourcePolicy.Name, err.Error())
return nil, fmt.Errorf("fail to get ResourcePolicies %s ConfigMap: %w",
restore.Namespace+"/"+restore.Spec.ResourcePolicy.Name, err)
}
resourcePolicies, err = getResourcePoliciesFromConfig(policiesConfigMap)
if err != nil {
logger.Errorf("Fail to read ResourcePolicies from ConfigMap %s with error %s.",
restore.Namespace+"/"+restore.Spec.ResourcePolicy.Name, err.Error())
return nil, fmt.Errorf("fail to read the ResourcePolicies from ConfigMap %s: %w",
restore.Namespace+"/"+restore.Spec.ResourcePolicy.Name, err)
} else if err = resourcePolicies.ValidateForRestore(); err != nil {
logger.Errorf("Fail to validate ResourcePolicies in ConfigMap %s with error %s.",
restore.Namespace+"/"+restore.Spec.ResourcePolicy.Name, err.Error())
return nil, fmt.Errorf("fail to validate ResourcePolicies in ConfigMap %s: %w",
restore.Namespace+"/"+restore.Spec.ResourcePolicy.Name, err)
}
}
return resourcePolicies, nil
}
func getResourcePoliciesFromConfig(cm *corev1api.ConfigMap) (*Policies, error) {
if cm == nil {
return nil, fmt.Errorf("could not parse config from nil configmap")
@@ -16,6 +16,7 @@ limitations under the License.
package resourcepolicies
import (
"context"
"testing"
"github.com/sirupsen/logrus"
@@ -24,6 +25,8 @@ import (
corev1api "k8s.io/api/core/v1"
"k8s.io/apimachinery/pkg/api/resource"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/client-go/kubernetes/scheme"
"sigs.k8s.io/controller-runtime/pkg/client/fake"
velerov1api "github.com/vmware-tanzu/velero/pkg/apis/velero/v1"
velerotest "github.com/vmware-tanzu/velero/pkg/test"
@@ -209,6 +212,18 @@ volumePolicies:
pvcAccessModes: ReadWriteOnce
action:
type: skip
`,
wantErr: true,
},
{
name: "error format of pvcAccessModes (list with non-string)",
yamlData: `version: v1
volumePolicies:
- conditions:
pvcAccessModes:
- 123
action:
type: skip
`,
wantErr: true,
},
@@ -407,14 +422,20 @@ func TestGetResourceMatchedAction(t *testing.T) {
}
func TestGetResourcePoliciesFromConfig(t *testing.T) {
// Create a test ConfigMap
cm := &corev1api.ConfigMap{
ObjectMeta: metav1.ObjectMeta{
Name: "test-configmap",
Namespace: "test-namespace",
},
Data: map[string]string{
"test-data": `version: v1
testCases := []struct {
name string
cm *corev1api.ConfigMap
expectedErr string
}{
{
name: "valid configmap",
cm: &corev1api.ConfigMap{
ObjectMeta: metav1.ObjectMeta{
Name: "test-configmap",
Namespace: "test-namespace",
},
Data: map[string]string{
"test-data": `version: v1
volumePolicies:
- conditions:
capacity: '0,10Gi'
@@ -435,63 +456,457 @@ volumePolicies:
action:
type: skip
`,
},
},
expectedErr: "",
},
{
name: "nil configmap",
cm: nil,
expectedErr: "could not parse config from nil configmap",
},
{
name: "empty data configmap",
cm: &corev1api.ConfigMap{
ObjectMeta: metav1.ObjectMeta{
Name: "test-configmap",
Namespace: "test-namespace",
},
Data: map[string]string{},
},
expectedErr: "illegal resource policies test-namespace/test-configmap configmap",
},
{
name: "multiple data configmap",
cm: &corev1api.ConfigMap{
ObjectMeta: metav1.ObjectMeta{
Name: "test-configmap",
Namespace: "test-namespace",
},
Data: map[string]string{
"data1": "value1",
"data2": "value2",
},
},
expectedErr: "illegal resource policies test-namespace/test-configmap configmap",
},
{
name: "invalid yaml data",
cm: &corev1api.ConfigMap{
ObjectMeta: metav1.ObjectMeta{
Name: "test-configmap",
Namespace: "test-namespace",
},
Data: map[string]string{
"test-data": `version: v1
volumePolicies:
- conditions:
capacity: '0,10Gi'
csi:
driver: disks.csi.driver
action:
type: skip
invalid-key: value
`,
},
},
expectedErr: "failed to decode yaml data into resource policies",
},
{
name: "build policy error",
cm: &corev1api.ConfigMap{
ObjectMeta: metav1.ObjectMeta{
Name: "test-configmap",
Namespace: "test-namespace",
},
Data: map[string]string{
"test-data": `version: v1
volumePolicies:
- conditions:
capacity: 'invalid-capacity'
csi:
driver: disks.csi.driver
action:
type: skip
`,
},
},
expectedErr: "wrong format of Capacity invalid-capacity",
},
}
// Call the function and check for errors
resPolicies, err := getResourcePoliciesFromConfig(cm)
require.NoError(t, err)
for _, tc := range testCases {
t.Run(tc.name, func(t *testing.T) {
resPolicies, err := getResourcePoliciesFromConfig(tc.cm)
if tc.expectedErr == "" {
require.NoError(t, err)
assert.Equal(t, "v1", resPolicies.version)
assert.Len(t, resPolicies.volumePolicies, 3)
} else {
require.ErrorContains(t, err, tc.expectedErr)
assert.Nil(t, resPolicies)
}
})
}
}
// Check that the returned resourcePolicies object contains the expected data
assert.Equal(t, "v1", resPolicies.version)
assert.Len(t, resPolicies.volumePolicies, 3)
policies := ResourcePolicies{
Version: "v1",
VolumePolicies: []VolumePolicy{
{
Conditions: map[string]any{
"capacity": "0,10Gi",
"csi": map[string]any{
"driver": "disks.csi.driver",
},
},
Action: Action{
Type: Skip,
},
},
{
Conditions: map[string]any{
"csi": map[string]any{
"driver": "files.csi.driver",
"volumeAttributes": map[string]string{"protocol": "nfs"},
},
},
Action: Action{
Type: Skip,
},
},
{
Conditions: map[string]any{
"pvcLabels": map[string]string{
"environment": "production",
},
},
Action: Action{
Type: Skip,
},
},
func TestGetResourcePoliciesFromBackup(t *testing.T) {
validCM := &corev1api.ConfigMap{
ObjectMeta: metav1.ObjectMeta{
Name: "test-configmap",
Namespace: "test-namespace",
},
Data: map[string]string{
"test-data": `version: v1
volumePolicies:
- conditions:
capacity: '0,10Gi'
csi:
driver: disks.csi.driver
action:
type: skip
`,
},
}
p := &Policies{}
err = p.BuildPolicy(&policies)
if err != nil {
t.Fatalf("failed to build policy: %v", err)
invalidActionCM := &corev1api.ConfigMap{
ObjectMeta: metav1.ObjectMeta{
Name: "invalid-action-configmap",
Namespace: "test-namespace",
},
Data: map[string]string{
"test-data": `version: v1
volumePolicies:
- conditions:
capacity: '0,10Gi'
csi:
driver: disks.csi.driver
action:
type: invalid-action
`,
},
}
assert.Equal(t, p, resPolicies)
invalidVersionCM := &corev1api.ConfigMap{
ObjectMeta: metav1.ObjectMeta{
Name: "invalid-version-configmap",
Namespace: "test-namespace",
},
Data: map[string]string{
"test-data": `version: v2
volumePolicies:
- conditions:
capacity: '0,10Gi'
csi:
driver: disks.csi.driver
action:
type: skip
`,
},
}
emptyCM := &corev1api.ConfigMap{
ObjectMeta: metav1.ObjectMeta{
Name: "empty-configmap",
Namespace: "test-namespace",
},
}
client := fake.NewClientBuilder().WithScheme(scheme.Scheme).WithObjects(validCM, invalidActionCM, invalidVersionCM, emptyCM).Build()
logger := logrus.New()
testCases := []struct {
name string
backup velerov1api.Backup
expectedErr string
}{
{
name: "valid configmap",
backup: velerov1api.Backup{
ObjectMeta: metav1.ObjectMeta{
Namespace: "test-namespace",
Name: "test-backup",
},
Spec: velerov1api.BackupSpec{
ResourcePolicy: &corev1api.TypedLocalObjectReference{
Kind: ConfigmapRefType,
Name: "test-configmap",
},
},
},
expectedErr: "",
},
{
name: "invalid kind",
backup: velerov1api.Backup{
ObjectMeta: metav1.ObjectMeta{
Namespace: "test-namespace",
Name: "test-backup",
},
Spec: velerov1api.BackupSpec{
ResourcePolicy: &corev1api.TypedLocalObjectReference{
Kind: "Secret",
Name: "test-configmap",
},
},
},
expectedErr: "",
},
{
name: "configmap not found",
backup: velerov1api.Backup{
ObjectMeta: metav1.ObjectMeta{
Namespace: "test-namespace",
Name: "test-backup",
},
Spec: velerov1api.BackupSpec{
ResourcePolicy: &corev1api.TypedLocalObjectReference{
Kind: ConfigmapRefType,
Name: "non-existent-configmap",
},
},
},
expectedErr: "fail to get ResourcePolicies test-namespace/non-existent-configmap ConfigMap",
},
{
name: "invalid action configmap",
backup: velerov1api.Backup{
ObjectMeta: metav1.ObjectMeta{
Namespace: "test-namespace",
Name: "test-backup",
},
Spec: velerov1api.BackupSpec{
ResourcePolicy: &corev1api.TypedLocalObjectReference{
Kind: ConfigmapRefType,
Name: "invalid-action-configmap",
},
},
},
expectedErr: "fail to validate ResourcePolicies in ConfigMap test-namespace/test-backup",
},
{
name: "invalid version configmap",
backup: velerov1api.Backup{
ObjectMeta: metav1.ObjectMeta{
Namespace: "test-namespace",
Name: "test-backup",
},
Spec: velerov1api.BackupSpec{
ResourcePolicy: &corev1api.TypedLocalObjectReference{
Kind: ConfigmapRefType,
Name: "invalid-version-configmap",
},
},
},
expectedErr: "fail to validate ResourcePolicies in ConfigMap test-namespace/test-backup",
},
{
name: "empty configmap",
backup: velerov1api.Backup{
ObjectMeta: metav1.ObjectMeta{
Namespace: "test-namespace",
Name: "test-backup",
},
Spec: velerov1api.BackupSpec{
ResourcePolicy: &corev1api.TypedLocalObjectReference{
Kind: ConfigmapRefType,
Name: "empty-configmap",
},
},
},
expectedErr: "fail to read the ResourcePolicies from ConfigMap test-namespace/test-backup",
},
}
for _, tc := range testCases {
t.Run(tc.name, func(t *testing.T) {
resPolicies, err := GetResourcePoliciesFromBackup(tc.backup, client, logger)
if tc.expectedErr == "" {
require.NoError(t, err)
if tc.backup.Spec.ResourcePolicy != nil && tc.backup.Spec.ResourcePolicy.Kind == ConfigmapRefType {
assert.NotNil(t, resPolicies)
} else {
assert.Nil(t, resPolicies)
}
} else {
require.ErrorContains(t, err, tc.expectedErr)
assert.Nil(t, resPolicies)
}
})
}
}
func TestGetResourcePoliciesFromRestore(t *testing.T) {
validCM := &corev1api.ConfigMap{
ObjectMeta: metav1.ObjectMeta{
Name: "test-configmap",
Namespace: "test-namespace",
},
Data: map[string]string{
"test-data": `version: v1
namespacedFilterPolicies:
- namespaces: ["default"]
resourceFilters:
- kinds: ["Pod"]
`,
},
}
invalidNfpCM := &corev1api.ConfigMap{
ObjectMeta: metav1.ObjectMeta{
Name: "invalid-action-configmap",
Namespace: "test-namespace",
},
Data: map[string]string{
"test-data": `version: v1
namespacedFilterPolicies:
- namespaces: []
resourceFilters:
- kinds: ["Pod"]
`,
},
}
invalidVersionCM := &corev1api.ConfigMap{
ObjectMeta: metav1.ObjectMeta{
Name: "invalid-version-configmap",
Namespace: "test-namespace",
},
Data: map[string]string{
"test-data": `version: v2
namespacedFilterPolicies:
- namespaces: ["default"]
resourceFilters:
- kinds: ["Pod"]
`,
},
}
emptyCM := &corev1api.ConfigMap{
ObjectMeta: metav1.ObjectMeta{
Name: "empty-configmap",
Namespace: "test-namespace",
},
}
client := fake.NewClientBuilder().WithScheme(scheme.Scheme).WithObjects(validCM, invalidNfpCM, invalidVersionCM, emptyCM).Build()
logger := logrus.New()
testCases := []struct {
name string
restore *velerov1api.Restore
expectedErr string
}{
{
name: "valid configmap",
restore: &velerov1api.Restore{
ObjectMeta: metav1.ObjectMeta{
Namespace: "test-namespace",
Name: "test-restore",
},
Spec: velerov1api.RestoreSpec{
ResourcePolicy: &corev1api.TypedLocalObjectReference{
Kind: ConfigmapRefType,
Name: "test-configmap",
},
},
},
expectedErr: "",
},
{
name: "invalid kind",
restore: &velerov1api.Restore{
ObjectMeta: metav1.ObjectMeta{
Namespace: "test-namespace",
Name: "test-restore",
},
Spec: velerov1api.RestoreSpec{
ResourcePolicy: &corev1api.TypedLocalObjectReference{
Kind: "Secret",
Name: "test-configmap",
},
},
},
expectedErr: "invalid ResourcePolicy kind \"Secret\", only \"configmap\" is supported",
},
{
name: "configmap not found",
restore: &velerov1api.Restore{
ObjectMeta: metav1.ObjectMeta{
Namespace: "test-namespace",
Name: "test-restore",
},
Spec: velerov1api.RestoreSpec{
ResourcePolicy: &corev1api.TypedLocalObjectReference{
Kind: ConfigmapRefType,
Name: "non-existent-configmap",
},
},
},
expectedErr: "fail to get ResourcePolicies test-namespace/non-existent-configmap ConfigMap",
},
{
name: "invalid action configmap",
restore: &velerov1api.Restore{
ObjectMeta: metav1.ObjectMeta{
Namespace: "test-namespace",
Name: "test-restore",
},
Spec: velerov1api.RestoreSpec{
ResourcePolicy: &corev1api.TypedLocalObjectReference{
Kind: ConfigmapRefType,
Name: "invalid-action-configmap",
},
},
},
expectedErr: "fail to validate ResourcePolicies in ConfigMap test-namespace/invalid-action-configmap",
},
{
name: "invalid version configmap",
restore: &velerov1api.Restore{
ObjectMeta: metav1.ObjectMeta{
Namespace: "test-namespace",
Name: "test-restore",
},
Spec: velerov1api.RestoreSpec{
ResourcePolicy: &corev1api.TypedLocalObjectReference{
Kind: ConfigmapRefType,
Name: "invalid-version-configmap",
},
},
},
expectedErr: "fail to validate ResourcePolicies in ConfigMap test-namespace/invalid-version-configmap",
},
{
name: "empty configmap",
restore: &velerov1api.Restore{
ObjectMeta: metav1.ObjectMeta{
Namespace: "test-namespace",
Name: "test-restore",
},
Spec: velerov1api.RestoreSpec{
ResourcePolicy: &corev1api.TypedLocalObjectReference{
Kind: ConfigmapRefType,
Name: "empty-configmap",
},
},
},
expectedErr: "fail to read the ResourcePolicies from ConfigMap test-namespace/empty-configmap",
},
}
for _, tc := range testCases {
t.Run(tc.name, func(t *testing.T) {
resPolicies, err := GetResourcePoliciesFromRestore(context.Background(), tc.restore, client, logger)
if tc.expectedErr == "" {
require.NoError(t, err)
assert.NotNil(t, resPolicies)
} else {
require.ErrorContains(t, err, tc.expectedErr)
assert.Nil(t, resPolicies)
}
})
}
}
func TestGetMatchAction(t *testing.T) {
@@ -1788,6 +2203,17 @@ namespacedFilterPolicies:
wantErr: true,
errMsg: "invalid glob pattern",
},
{
name: "invalid - bad glob pattern in excludedNames",
yamlData: `version: v1
namespacedFilterPolicies:
- namespaces: ["test"]
resourceFilters:
- kinds: ["Pod"]
excludedNames: ["[invalid"]`,
wantErr: true,
errMsg: "invalid glob pattern",
},
{
name: "invalid - duplicate namespace pattern",
yamlData: `version: v1
@@ -1801,6 +2227,16 @@ namespacedFilterPolicies:
wantErr: true,
errMsg: "duplicate namespace pattern",
},
{
name: "invalid - bad namespace pattern",
yamlData: `version: v1
namespacedFilterPolicies:
- namespaces: ["prod**uction"]
resourceFilters:
- kinds: ["Pod"]`,
wantErr: true,
errMsg: "wildcard pattern contains consecutive asterisks",
},
}
for _, tc := range testCases {
@@ -1857,6 +2293,50 @@ namespacedFilterPolicies:
assert.Equal(t, map[string]string{"app": "web"}, rf.LabelSelector)
}
func TestClusterScopedFilterPoliciesAccessor(t *testing.T) {
yamlData := `version: v1
clusterScopedFilterPolicy:
resourceFilters:
- kinds: ["ClusterRole"]
names: ["my-app-*"]`
resPolicies, err := unmarshalResourcePolicies(&yamlData)
require.NoError(t, err)
policies := &Policies{}
err = policies.BuildPolicy(resPolicies)
require.NoError(t, err)
csfPolicy := policies.GetClusterScopedFilterPolicy()
require.NotNil(t, csfPolicy)
assert.Len(t, csfPolicy.ResourceFilters, 1)
rf := csfPolicy.ResourceFilters[0]
assert.Equal(t, []string{"ClusterRole"}, rf.Kinds)
assert.Equal(t, []string{"my-app-*"}, rf.Names)
}
func TestIncludeExcludePolicyAccessor(t *testing.T) {
yamlData := `version: v1
includeExcludePolicy:
includedClusterScopedResources:
- ClusterRole
excludedClusterScopedResources:
- ClusterRoleBinding`
resPolicies, err := unmarshalResourcePolicies(&yamlData)
require.NoError(t, err)
policies := &Policies{}
err = policies.BuildPolicy(resPolicies)
require.NoError(t, err)
iePolicy := policies.GetIncludeExcludePolicy()
require.NotNil(t, iePolicy)
assert.Equal(t, []string{"ClusterRole"}, iePolicy.IncludedClusterScopedResources)
assert.Equal(t, []string{"ClusterRoleBinding"}, iePolicy.ExcludedClusterScopedResources)
}
func TestFirstMatchSemantics(t *testing.T) {
yamlData := `version: v1
namespacedFilterPolicies:
@@ -568,3 +568,85 @@ func TestValidate(t *testing.T) {
})
}
}
func TestValidateForRestore(t *testing.T) {
testCases := []struct {
name string
res *ResourcePolicies
wantErr bool
}{
{
name: "valid restore policies",
res: &ResourcePolicies{
Version: "v1",
ClusterScopedFilterPolicy: &ClusterScopedFilterPolicy{
ResourceFilters: []ResourceFilter{
{
Kinds: []string{"ClusterRole"},
},
},
},
NamespacedFilterPolicies: []NamespacedFilterPolicy{
{
Namespaces: []string{"default"},
ResourceFilters: []ResourceFilter{
{
Kinds: []string{"Pod"},
},
},
},
},
},
wantErr: false,
},
{
name: "unsupported volumePolicies for restore",
res: &ResourcePolicies{
Version: "v1",
VolumePolicies: []VolumePolicy{
{
Action: Action{Type: "skip"},
Conditions: map[string]any{
"capacity": "10Gi",
},
},
},
},
wantErr: true,
},
{
name: "unsupported includeExcludePolicy for restore",
res: &ResourcePolicies{
Version: "v1",
IncludeExcludePolicy: &IncludeExcludePolicy{
IncludedClusterScopedResources: []string{"persistentvolumes"},
},
},
wantErr: true,
},
{
name: "wrong version",
res: &ResourcePolicies{
Version: "v2",
},
wantErr: true,
},
}
for _, tc := range testCases {
t.Run(tc.name, func(t *testing.T) {
policies := &Policies{}
err1 := policies.BuildPolicy(tc.res)
err2 := policies.ValidateForRestore()
if tc.wantErr {
if err1 == nil && err2 == nil {
t.Fatalf("Expected error %v, but not get error", tc.wantErr)
}
} else {
if err1 != nil || err2 != nil {
t.Fatalf("Expected error %v, but got error %v %v", tc.wantErr, err1, err2)
}
}
})
}
}
+10
View File
@@ -125,6 +125,16 @@ type RestoreSpec struct {
// +nullable
ResourceModifier *corev1api.TypedLocalObjectReference `json:"resourceModifier,omitempty"`
// ResourcePolicy specifies the reference to a ConfigMap containing resource
// filter policies for this restore. The ConfigMap can contain a
// namespacedFilterPolicies section that specifies per-namespace resource type
// filters, label selectors, and resource name patterns, and a
// clusterScopedFilterPolicy section for per-kind filtering of cluster-scoped
// resources. The ConfigMap format is the same as for BackupSpec.ResourcePolicy.
// +optional
// +nullable
ResourcePolicy *corev1api.TypedLocalObjectReference `json:"resourcePolicy,omitempty"`
// UploaderConfig specifies the configuration for the restore.
// +optional
// +nullable
@@ -1415,6 +1415,11 @@ func (in *RestoreSpec) DeepCopyInto(out *RestoreSpec) {
*out = new(corev1.TypedLocalObjectReference)
(*in).DeepCopyInto(*out)
}
if in.ResourcePolicy != nil {
in, out := &in.ResourcePolicy, &out.ResourcePolicy
*out = new(corev1.TypedLocalObjectReference)
(*in).DeepCopyInto(*out)
}
if in.UploaderConfig != nil {
in, out := &in.UploaderConfig, &out.UploaderConfig
*out = new(UploaderConfigForRestore)
+10
View File
@@ -19,6 +19,7 @@ package builder
import (
"time"
corev1api "k8s.io/api/core/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
velerov1api "github.com/vmware-tanzu/velero/pkg/apis/velero/v1"
@@ -171,3 +172,12 @@ func (b *RestoreBuilder) ItemOperationTimeout(timeout time.Duration) *RestoreBui
b.object.Spec.ItemOperationTimeout.Duration = timeout
return b
}
// ResourcePoliciesConfigmap sets the Restore's resource policies configmap.
func (b *RestoreBuilder) ResourcePoliciesConfigmap(name string) *RestoreBuilder {
b.object.Spec.ResourcePolicy = &corev1api.TypedLocalObjectReference{
Kind: "configmap",
Name: name,
}
return b
}
+36
View File
@@ -0,0 +1,36 @@
/*
Copyright The Velero Contributors.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package builder
import (
"testing"
"github.com/stretchr/testify/assert"
)
func TestRestoreBuilder_ResourcePoliciesConfigmap(t *testing.T) {
restore := ForRestore("velero", "my-restore").
ResourcePoliciesConfigmap("my-policy-cm").
Result()
assert.Equal(t, "velero", restore.Namespace)
assert.Equal(t, "my-restore", restore.Name)
assert.NotNil(t, restore.Spec.ResourcePolicy)
assert.Equal(t, "configmap", restore.Spec.ResourcePolicy.Kind)
assert.Equal(t, "my-policy-cm", restore.Spec.ResourcePolicy.Name)
assert.Equal(t, (*string)(nil), restore.Spec.ResourcePolicy.APIGroup)
}