OADP-5158: Do not allow restic config use in OADP 1.5+; Deprecate restic for file system backups #1235

mateusoliveira43 · 2023-11-22T13:11:07Z

Description

This PR removes logic of using old restic field (it should use nodeAgent field instead) from 1.5+ code. But it does not remove old restic field from DPA (which should only be removed when DPA version is updated), for a safe upgrade and better user experience for the users.

Also, log a Deprecation Warning when using restic in NodeAgent config.

How to test

OADP 1.5

run make deploy-olm and test that

DPA is Reconciled false if old restic field (spec.configuration.restic) is present
OADP manager pod has 1 warning log and OADP namespace has 1 warning event if DPA spec.configuration.nodeAgent.uploaderType is set to restic

Simulate a upgrade

Simulate a upgrade from OADP 1.4 to 1.5 (this PR branch), by

running make catalog-test-upgrade
installing OADP 1.4
creating a DPA with old restic field (wait until it is reconciled true)
and update to OADP 1.5

More info

Update should finish successfully and DPA should:

be reconciled false, with the error message that restic field is not allowed
restic fields should be still in DPA

Makefile

openshift-ci-robot · 2025-01-02T18:49:44Z

@mateusoliveira43: This pull request references OADP-5158 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the bug to target the "4.19.0" version, but no target version was set.

In response to this:

Description

This PR removes logic of using old restic field (it should use nodeAgent field instead) from 1.5+ code. But it does not remove old restic field from DPA (which should only be removed when DPA version is updated), for a safe upgrade and better user experience for the users.

Also, log a Deprecation Warning when using restic in NodeAgent config.

How to test

Simulate a upgrade from OADP 1.4 to 1.5 (this PR branch), by

running make catalog-test-upgrade

installing OADP 1.4

creating a DPA with old restic field (wait until it is reconciled true)

and update to OADP 1.5

More info

Update should finish successfully and DPA should:

be reconciled false, with the error message that restic field is not allowed

restic fields should be still in DPA

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 openshift-eng/jira-lifecycle-plugin repository.

openshift-ci-robot · 2025-01-02T19:36:15Z

@mateusoliveira43: This pull request references OADP-5158 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the bug to target the "4.19.0" version, but no target version was set.

In response to this:

Description

This PR removes logic of using old restic field (it should use nodeAgent field instead) from 1.5+ code. But it does not remove old restic field from DPA (which should only be removed when DPA version is updated), for a safe upgrade and better user experience for the users.

Also, log a Deprecation Warning when using restic in NodeAgent config.

How to test

OADP 1.5

run make deploy-olm and test that

DPA is Reconciled false if old restic field (spec.configuration.restic) is present

OADP manager pod has 1 warning log and OADP namespace has 1 warning event if DPA spec.configuration.nodeAgent.uploaderType is set to restic

Simulate a upgrade

Simulate a upgrade from OADP 1.4 to 1.5 (this PR branch), by

running make catalog-test-upgrade

installing OADP 1.4

creating a DPA with old restic field (wait until it is reconciled true)

and update to OADP 1.5

More info

Update should finish successfully and DPA should:

be reconciled false, with the error message that restic field is not allowed

restic fields should be still in DPA

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 openshift-eng/jira-lifecycle-plugin repository.

shubham-pampattiwar · 2025-01-23T19:14:27Z

api/v1alpha1/dataprotectionapplication_types.go

-	// restic is for backwards compatibility and is replaced by the nodeAgent
-	// restic will be removed in the future
-	// +kubebuilder:deprecatedversion:warning=1.3
+	// (do not use warning) restic field is for backwards compatibility and


s/field/spec at both places

not sold on this. Changing to spec would not pass sense that restic is an CR instead of part of DPA spec?

🤷 I like field. alternatively spec field.

or better yet..

Suggested change

// (do not use warning) restic field is for backwards compatibility and

// (do not use warning) restic config is for backwards compatibility and

internal/controller/nodeagent.go

shubham-pampattiwar · 2025-01-23T19:29:17Z

internal/controller/validator.go

 	// check for VSM/Volsync DataMover (OADP 1.2 or below) syntax
 	if r.dpa.Spec.Features != nil && r.dpa.Spec.Features.DataMover != nil {
 		return false, errors.New("Delete vsm from spec.configuration.velero.defaultPlugins and dataMover object from spec.features. Use Velero Built-in Data Mover instead")
 	}

+	// check for ResticConfig (OADP 1.4 or below) syntax
+	if r.dpa.Spec.Configuration.Restic != nil {
+		return false, errors.New("Delete restic object from spec.configuration, use spec.configuration.nodeAgent instead")


s/object/spec

not sold on this. Changing to spec would not pass sense that restic is an CR instead of part of DPA spec?

shubham-pampattiwar · 2025-01-23T19:47:57Z

internal/controller/validator.go

@@ -16,6 +17,8 @@ import (
 	"github.com/openshift/oadp-operator/pkg/credentials"
 )

+var wasRestic bool


Should we explicitly set this as false ? (I think default is false but still)

If we do, it would fail https://revive.run/r#var-declaration linter that was recently merged https://github.com/vmware-tanzu/velero/pull/8636/files#diff-9917ddc9f1c3304218f7269265b746d997c5c0615478177b5fceecd33ef47cb5
specifically because we are declaring "zeroLiteral"

var zeroLiteral = map[string]bool{ "false": true, // bool // runes `'\x00'`: true, `'\000'`: true, // strings `""`: true, "``": true, // numerics "0": true, "0.": true, "0.0": true, "0i": true, }

im ok with it either way.

Signed-off-by: Mateus Oliveira <[email protected]>

openshift-ci-robot · 2025-03-06T18:44:26Z

@mateusoliveira43: This pull request references OADP-5158 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the bug to target the "4.19.0" version, but no target version was set.

In response to this:

Description

This PR removes logic of using old restic field (it should use nodeAgent field instead) from 1.5+ code. But it does not remove old restic field from DPA (which should only be removed when DPA version is updated), for a safe upgrade and better user experience for the users.

Also, log a Deprecation Warning when using restic in NodeAgent config.

How to test

OADP 1.5

run make deploy-olm and test that

DPA is Reconciled false if old restic field (spec.configuration.restic) is present

OADP manager pod has 1 warning log and OADP namespace has 1 warning event if DPA spec.configuration.nodeAgent.uploaderType is set to restic

Simulate a upgrade

Simulate a upgrade from OADP 1.4 to 1.5 (this PR branch), by

running make catalog-test-upgrade

installing OADP 1.4

creating a DPA with old restic field (wait until it is reconciled true)

and update to OADP 1.5

More info

Update should finish successfully and DPA should:

be reconciled false, with the error message that restic field is not allowed

restic fields should be still in DPA

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 openshift-eng/jira-lifecycle-plugin repository.

Signed-off-by: Mateus Oliveira <[email protected]>

weshayutin · 2025-03-06T21:25:18Z

toying around adding and removing the config.restic.enabled true/false and clearing the whole thing.
LGTM. I think we can save upgrade testing for QE

status:
  conditions:
    - lastTransitionTime: '2025-03-06T21:21:17Z'
      message: 'Delete restic object from spec.configuration, use spec.configuration.nodeAgent instead'
      reason: Error
      status: 'False'
      type: Reconciled

weshayutin

/LGTM

openshift-ci · 2025-03-06T21:27:34Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: mateusoliveira43, weshayutin

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

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [mateusoliveira43]

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

openshift-ci · 2025-03-07T00:45:35Z

@mateusoliveira43: The following tests failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name	Commit	Details	Required	Rerun command
ci/prow/4.12-operator-e2e-aws	`1587d2c`	link	true	`/test 4.12-operator-e2e-aws`
ci/prow/4.12-operator-unit-test	`1587d2c`	link	true	`/test 4.12-operator-unit-test`
ci/prow/4.14-operator-e2e-azure	`1587d2c`	link	true	`/test 4.14-operator-e2e-azure`
ci/prow/4.12-operator-e2e-azure	`1587d2c`	link	true	`/test 4.12-operator-e2e-azure`
ci/prow/4.12-e2e-test-azure	`8299442`	link	true	`/test 4.12-e2e-test-azure`
ci/prow/4.15-e2e-test-aws	`cbd019d`	link	true	`/test 4.15-e2e-test-aws`
ci/prow/4.17-e2e-test-aws	`cbd019d`	link	true	`/test 4.17-e2e-test-aws`

Full PR test history. Your PR dashboard.

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. I understand the commands that are listed here.

openshift-ci-robot · 2025-03-07T01:02:27Z

/retest-required

Remaining retests: 0 against base HEAD da7cbd2 and 2 for PR HEAD 18b3018 in total

openshift-ci bot requested review from eemcmullan and shubham-pampattiwar November 22, 2023 13:13

kaovilai reviewed Nov 27, 2023

View reviewed changes

Makefile Outdated Show resolved Hide resolved

mateusoliveira43 force-pushed the fix/remove-restic-config-master branch from 1587d2c to 7f9b1e9 Compare November 30, 2023 16:22