feat: Add Non Admin Restore controller #42

mateusoliveira43 · 2024-04-09T13:41:54Z

Why the changes were made

Non admin users want to restore NonAdminBackups. This PR adds NonAdminRestore CRD along with its controller.

Related to #35

~~Blocked by #16~~
~~Blocked by #54~~
Blocked by #67
Blocked by openshift/oadp-operator#1388

How the changes were made

Get kubebuilder version 3.14.0 from https://github.com/kubernetes-sigs/kubebuilder/releases and run command documented in Architecture 62d5213

Run make manifests

Fix code quality issues

How to test the changes made

TODO

This PR still misses

write restore logic
[check PR size, can be separate] Adding example of configuring DPA with restricted NonAdminRestore fields

oadp-non-admin/README.md

Line 29 in 94c4be9

- create/update DPA and configure non admin feature as needed, setting it to enabled
oadp-non-admin/README.md

Line 50 in 94c4be9

- TODO NonAdminRestore
- show user how to see NonAdminRestore status
- show user how to see NonAdminRestore queue
unit/integration tests for new controller. Some ideas
- [ERROR] try to create NonAdminRestore from Velero Backup
- [ERROR] try to create NonAdminRestore from non existing NonAdminBackup
- [ERROR] try to create NonAdminRestore NonAdminBackup with restricted fields
- [ERROR] try to create NonAdminRestore in non existing namespace
- [SUCCESS] create NonAdminRestore from NonAdminBackup owned by user

openshift-ci · 2024-04-09T13:41:58Z

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

openshift-ci · 2024-04-09T13:42:01Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: mateusoliveira43

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

mateusoliveira43 · 2024-04-29T15:53:55Z

Makefile

@@ -48,6 +48,7 @@ help: ## Display this help.
 .PHONY: manifests
 manifests: controller-gen ## Generate WebhookConfiguration, ClusterRole and CustomResourceDefinition objects.
 	$(CONTROLLER_GEN) rbac:roleName=non-admin-controller-role crd webhook paths="./..." output:crd:artifacts:config=config/crd/bases
+	sed -i 's/Velero backup/NonAdminBackup/' ./config/crd/bases/nac.oadp.openshift.io_nonadminrestores.yaml


for better user experience

mateusoliveira43 · 2024-04-29T15:54:52Z

cmd/main.go

@@ -98,7 +98,8 @@ func main() {
 		TLSOpts: tlsOpts,
 	})

-	if len(constant.OadpNamespace) == 0 {
+	// TODO create get function in common :question:


mateusoliveira43 · 2024-04-29T15:56:43Z

internal/controller/suite_test.go

@@ -73,6 +73,9 @@ var _ = ginkgov2.BeforeSuite(func() {
 	err = nacv1alpha1.AddToScheme(scheme.Scheme)
 	gomega.Expect(err).NotTo(gomega.HaveOccurred())

+	err = nacv1alpha1.AddToScheme(scheme.Scheme)


seems duplication, check if it is needed

mateusoliveira43 · 2024-04-30T15:23:17Z

README.md

+            -p NAME=<NonAdminBackup-name> \
+            | oc create -f -
+        ```
+        <!-- TODO how to track status -->


api/v1alpha1/nonadminrestore_types.go

config/crd/bases/nac.oadp.openshift.io_nonadminbackups.yaml

mpryc · 2024-05-02T12:28:10Z

internal/common/function/function.go

@@ -127,7 +128,7 @@ func GenerateVeleroBackupName(namespace, nabName string) string {
 }

 // UpdateNonAdminPhase updates the phase of a NonAdminBackup object with the provided phase.
-func UpdateNonAdminPhase(ctx context.Context, r client.Client, logger logr.Logger, nab *nacv1alpha1.NonAdminBackup, phase nacv1alpha1.NonAdminBackupPhase) (bool, error) {
+func UpdateNonAdminPhase(ctx context.Context, r client.Client, logger logr.Logger, nab *nacv1alpha1.NonAdminBackup, phase nacv1alpha1.NonAdminPhase) (bool, error) {


This actually should be a separate change, so we don't mix restore with change of types. There is already common condition, but it's ok to move also phases to be similar. https://github.com/migtools/oadp-non-admin/blob/master/api/v1alpha1/nonadmincontroller_types.go#L21

mpryc · 2024-05-02T12:30:16Z

internal/common/function/function.go

@@ -159,7 +160,7 @@ func UpdateNonAdminPhase(ctx context.Context, r client.Client, logger logr.Logge
 // based on the provided parameters. It validates the input parameters and ensures
 // that the condition is set to the desired status only if it differs from the current status.
 // If the condition is already set to the desired status, no update is performed.
-func UpdateNonAdminBackupCondition(ctx context.Context, r client.Client, logger logr.Logger, nab *nacv1alpha1.NonAdminBackup, condition nacv1alpha1.NonAdminCondition, conditionStatus metav1.ConditionStatus, reason string, message string) (bool, error) {
+func UpdateNonAdminBackupCondition(ctx context.Context, r client.Client, logger logr.Logger, nab *nacv1alpha1.NonAdminBackup, condition types.NonAdminCondition, conditionStatus metav1.ConditionStatus, reason string, message string) (bool, error) {


We already have this as common:
https://github.com/migtools/oadp-non-admin/blob/master/api/v1alpha1/nonadmincontroller_types.go#L21

mpryc · 2024-05-02T12:32:33Z

internal/common/function/function.go

@@ -29,12 +29,13 @@ import (
 	velerov1api "github.com/vmware-tanzu/velero/pkg/apis/velero/v1"
 	apimeta "k8s.io/apimachinery/pkg/api/meta"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
-	"k8s.io/apimachinery/pkg/types"
+	apitypes "k8s.io/apimachinery/pkg/types"


how about changing this to:

apimeta apimetav1 apimetatypes

mpryc · 2024-05-02T12:34:28Z

internal/common/types/types.go

@@ -14,17 +14,8 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */

-package v1alpha1


I don't know if that's valuable change. Really mixing the api with implementation types as some of them we have in api/* and now some will be in internal/* so a bit of mix that is harder to read. Definitely not part of the NAR controller, can be seaparate PR.

I see api folder as the entrypoint for kubebuilder to build CRD yamls, stored in config folder. So, there should be only things used to crate those CRDs in this folder

the type here, was not used by any CRD, so I do not think is the right place to it. Moved to internal common folder where we are storing all the things used more than once by files of the project

do you agree ❓

I can do this in separate PR yes

mpryc · 2024-05-02T12:39:08Z

internal/controller/nonadminrestore_controller.go

+	err := r.Get(ctx, types.NamespacedName{Namespace: req.Namespace, Name: nonAdminBackupName}, nonAdminBackup)
+	if err != nil {
+		if errors.IsNotFound(err) {
+			// TODO add this error message to NonAdminRestore status


There is similar implementation in PR for Backup, could be common func:

https://github.com/migtools/oadp-non-admin/pull/56/files#diff-adbb2c0cf906a4dc9b38604d85fb6f353a314513673ea181267a40625f80237bR50-R55

mpryc · 2024-05-02T12:41:08Z

internal/controller/nonadminrestore_controller.go

+// Reconcile is part of the main kubernetes reconciliation loop which aims to
+// move the current state of the NonAdminRestore to the desired state.
+func (r *NonAdminRestoreReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
+	r.Logger = log.FromContext(ctx)


This is bad. We can assign one per worker but not every reconcile. Removed number of items from NAB reconciler, see:
https://github.com/migtools/oadp-non-admin/pull/56/files#diff-98b8a647a66c83f5ee56f93b7530fb37a28301390936ecdb1fdaf38c031453c6R38-R41

api/v1alpha1/nonadminrestore_types.go

Signed-off-by: Mateus Oliveira <msouzaol@redhat.com>

openshift-ci bot added the do-not-merge/work-in-progress label Apr 9, 2024

openshift-ci bot added the approved label Apr 9, 2024

mateusoliveira43 mentioned this pull request Apr 15, 2024

feat: Integrate Non-Admin Controller (NAC) with OADP openshift/oadp-operator#1370

Merged

openshift-merge-robot added the needs-rebase label Apr 24, 2024

mateusoliveira43 force-pushed the feat/restore-controller branch from 7eee636 to 35f7396 Compare April 24, 2024 11:51

openshift-merge-robot removed the needs-rebase label Apr 24, 2024

mateusoliveira43 mentioned this pull request Apr 24, 2024

feat: Add NAC restore controller objects openshift/oadp-operator#1388

Draft

mateusoliveira43 commented Apr 29, 2024

View reviewed changes

mateusoliveira43 force-pushed the feat/restore-controller branch from 0658b04 to 861c8d9 Compare April 30, 2024 15:20

mateusoliveira43 commented Apr 30, 2024

View reviewed changes

README.md

-p NAME=<NonAdminBackup-name> \

| oc create -f -

```



Copy link

Contributor Author

mateusoliveira43 Apr 30, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TODO

mateusoliveira43 commented Apr 30, 2024

View reviewed changes

api/v1alpha1/nonadminrestore_types.go Show resolved Hide resolved

mateusoliveira43 commented Apr 30, 2024

View reviewed changes

config/crd/bases/nac.oadp.openshift.io_nonadminbackups.yaml Show resolved Hide resolved

mpryc reviewed May 2, 2024

View reviewed changes

openshift-merge-robot added the needs-rebase label May 10, 2024

mateusoliveira43 commented May 13, 2024

View reviewed changes

api/v1alpha1/nonadminrestore_types.go Show resolved Hide resolved

mateusoliveira43 added 7 commits May 15, 2024 13:57

feat: Add Non Admin Restore controller

1dac5f6

Signed-off-by: Mateus Oliveira <msouzaol@redhat.com>

fixup! feat: Add Non Admin Restore controller

344be35

Signed-off-by: Mateus Oliveira <msouzaol@redhat.com>

fixup! feat: Add Non Admin Restore controller

3067eb3

Signed-off-by: Mateus Oliveira <msouzaol@redhat.com>

fixup! feat: Add Non Admin Restore controller

cdb9390

Signed-off-by: Mateus Oliveira <msouzaol@redhat.com>

fixup! feat: Add Non Admin Restore controller

e0e01ed

Signed-off-by: Mateus Oliveira <msouzaol@redhat.com>

fixup! feat: Add Non Admin Restore controller

49de8b5

Signed-off-by: Mateus Oliveira <msouzaol@redhat.com>

fixup! feat: Add Non Admin Restore controller

47605cd

Signed-off-by: Mateus Oliveira <msouzaol@redhat.com>

mateusoliveira43 force-pushed the feat/restore-controller branch from 861c8d9 to 47605cd Compare May 15, 2024 17:03

openshift-merge-robot removed the needs-rebase label May 15, 2024

fixup! feat: Add Non Admin Restore controller

ba8553e

Signed-off-by: Mateus Oliveira <msouzaol@redhat.com>

mateusoliveira43 mentioned this pull request May 17, 2024

fix: Update status design with NAR and delete #70

Draft

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Add Non Admin Restore controller #42

feat: Add Non Admin Restore controller #42

mateusoliveira43 commented Apr 9, 2024 •

edited

Loading

openshift-ci bot commented Apr 9, 2024

openshift-ci bot commented Apr 9, 2024

mateusoliveira43 Apr 29, 2024

mateusoliveira43 Apr 29, 2024

mateusoliveira43 Apr 29, 2024

mateusoliveira43 Apr 30, 2024

mpryc May 2, 2024

mpryc May 2, 2024

mpryc May 2, 2024

mpryc May 2, 2024

mateusoliveira43 May 2, 2024

mpryc May 2, 2024

mpryc May 2, 2024

feat: Add Non Admin Restore controller #42

Are you sure you want to change the base?

feat: Add Non Admin Restore controller #42

Conversation

mateusoliveira43 commented Apr 9, 2024 • edited Loading

Why the changes were made

How the changes were made

How to test the changes made

TODO

openshift-ci bot commented Apr 9, 2024

openshift-ci bot commented Apr 9, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mateusoliveira43 commented Apr 9, 2024 •

edited

Loading