Fix for #89 - Use custom UUID for NAB Object #101

mpryc · 2024-10-14T17:56:48Z

With this change a new UUID is generated to reference parent/child relationship between objects in the Non Admin Controller use cases.

The first consumer of this UUID is a Velero Backup, created when the NonAdminBackup object is reconciled.

The NonAdminBackup object generates the NAC UUID and stores it in its Status. This prevents users from modifying it. The UUID is later used to create the Velero Backup during reconciliation.

While the NAC UUID is currently used as the Velero Backup name, this is not required, as the UUID is also stored as a Velero Backup label, which is used during the reconcile loop. Usage of NAC UUID as Velero Backup name is to easy it's creation.

This PR also includes small changes to fix linting issues of the code, as well reworks the tests to properly take advantage of gingko BeforeEach function.

Why the changes were made

Fixes #89
Fixes #90

mpryc · 2024-10-14T17:57:04Z

@shubham-pampattiwar FYI please review

internal/common/constant/constant.go

internal/common/function/function.go

With this change a new UUID is generated to reference parent/child relationship between objects in the Non Admin Controller use cases. The first consumer of this UUID is a Velero Backup, created when the NonAdminBackup object is reconciled. The NonAdminBackup object generates the NAC UUID and stores it in its Status. This prevents users from modifying it. The UUID is later used to create the Velero Backup during reconciliation. While the NAC UUID is currently used as the Velero Backup name, this is not required, as the UUID is also stored as a Velero Backup label, which is used during the reconcile loop. Usage of NAC UUID as Velero Backup name is to easy it's creation. This PR also includes small changes to fix linting issues of the code, as well reworks the tests to properly take advantage of gingko BeforeEach function. Signed-off-by: Michal Pryc <[email protected]>

Improved function to properly validate NAC Object Labels Dropped length of Annotation Value validation, as it's not limited to 63 or 256 chars. Signed-off-by: Michal Pryc <[email protected]>

api/v1alpha1/nonadminbackup_types.go

internal/common/constant/constant.go

internal/common/function/function.go

Changes to address code review. Signed-off-by: Michal Pryc <[email protected]>

mpryc · 2024-10-16T19:11:02Z

@shubham-pampattiwar @mateusoliveira43 Added commit which I hope answers all comments.

ba85bd5

internal/common/function/function.go

shubham-pampattiwar · 2024-10-17T07:32:09Z

@mpryc ++

Renamed function which lists objects by label in a specific namespace. Signed-off-by: Michal Pryc <[email protected]>

docs/design/Non_Admin_Controller_design.md

api/v1alpha1/nonadminbackup_types.go

internal/controller/nonadminbackup_controller.go

Change to include: - Reworked diagram to include one reconcile entry and multiple states - Labels and annotations uses common function to check for the name and namespace value length - Additional test to cover above scenario. Signed-off-by: Michal Pryc <[email protected]>

internal/common/function/function.go

mateusoliveira43 · 2024-10-22T12:25:10Z

internal/common/function/function.go

-		return ""
+// GenerateNacObjectNameWithUUID generates a unique name based on the provided namespace and object origin name.
+// It includes a UUID suffix. If the name exceeds the maximum length, it truncates nacName first, then namespace.
+func GenerateNacObjectNameWithUUID(namespace, nacName string) string {


this name does not make sense to me. This does not generate NAB/NAR name, it generates Velero backup/restore name, right? GenerateVeleroObjectName makes more sense?

This function generates a UUID to establish a relationship between the NAB or NAR and the corresponding Velero object. However, it should not be assumed that this UUID will be the actual name of the Velero object.

internal/common/function/function.go

mateusoliveira43 · 2024-10-22T13:18:45Z

internal/common/function/function.go

-		return ""
+// GenerateNacObjectNameWithUUID generates a unique name based on the provided namespace and object origin name.
+// It includes a UUID suffix. If the name exceeds the maximum length, it truncates nacName first, then namespace.
+func GenerateNacObjectNameWithUUID(namespace, nacName string) string {


I would change function implementation to make it more readable (did not use the consts you defined, but they can be used here)

func Generate(namespace, name string) string { uuidSuffix := uuid.New().String() remainingLength := validation.DNS1123LabelMaxLength - len(uuidSuffix) - len("--") if len(namespace+name) > remainingLength { if len(namespace) >= remainingLength { return fmt.Sprintf("%s-%s", namespace[:remainingLength], uuidSuffix) } remainingLength := remainingLength - len(namespace) return fmt.Sprintf("%s-%s-%s", name[:remainingLength], namespace, uuidSuffix) } return fmt.Sprintf("%s-%s-%s", namespace, name, uuidSuffix) }

I like your implementation better ! Do you want to include in this PR or as follow-up?

either way is fine

internal/common/function/function.go

internal/common/function/function_test.go

internal/controller/nonadminbackup_controller.go

mateusoliveira43 · 2024-10-22T13:56:32Z

docs/design/Non_Admin_Controller_design.md

@@ -139,17 +139,17 @@ This design intends to enable non-admin users the ability to perform Backup and
      backupSpec: {}
    ```
    - **NAB controller reconciles on this NAB CR:** The NonAdminBackup controller continuously reconciles the NonAdminBackup object's desired state with the actual state in the cluster.
-    - **NAB controller validates the NAB CR and then creates a corresponding Velero Backup CR:** When the NonAdminBackup controller detects a new or modified NonAdminBackup object, it creates or updates a corresponding Velero Backup object within the OADP Namespace using the information provided in the `backupSpec` field of the NonAdminBackup object. The resulting Backup object is named as `nab-<namespace>-<hash>`, where the `<namespace>` is the NonAdminBackup namespace and the `<hash>` is computed from the original NonAdminBackup name. The resulting Backup object is labeled and annotated with the following additional metadata:
+    - **NAB controller validates the NAB CR and then creates a corresponding Velero Backup CR:** When the NonAdminBackup controller detects a new or modified NonAdminBackup object, it creates or updates a corresponding Velero Backup object within the OADP Namespace using the information provided in the `backupSpec` field of the NonAdminBackup object. The resulting Backup object is named as `<namespace>-<name>-<hash>`, where the `<namespace>` is the NonAdminBackup namespace, `<name>` is the NonAdminBackup name and the `<hash>` is the generated UUID (version 4). If the resulting Backup object name is too long the name is adapted to 63 characters limit strpping first characters from name and then from namespace. The resulting Backup object is labeled and annotated with the following additional metadata:


typo strpping ?

mateusoliveira43 · 2024-10-22T14:03:09Z

docs/design/nab_and_nar_status_update.md

+ and status.conditions[Accepted]: **False** ?"};
+questionPhaseStatusSetToCreated{"Is status.phase: **Created**
+ and status.conditions[BackupScheduled]: **True** ?"};
+questionStatusVeleroBackupUUID{"Is status.VeleroBackup.NameUUID existing and valid ?"};


the reconcile loop does not validate UUID, right?

docs/design/nab_and_nar_status_update.md

internal/common/function/function.go

docs/design/nab_and_nar_status_update.md

mateusoliveira43 · 2024-10-22T14:41:41Z

internal/controller/nonadminbackup_controller_test.go

 					},
 					veleroBackup,
 				)).To(gomega.Succeed())
-				veleroBackup.Status.Phase = velerov1.BackupPhaseCompleted
-				// TODO can not call .Status().Update() for veleroBackup object: backups.velero.io "name..." not found error


please do not remove comment. If you want, you can update it, with the reason

// can not call .Status().Update() for veleroBackup object vmware-tanzu/velero#8285

internal/controller/nonadminbackup_controller_test.go

mateusoliveira43 · 2024-10-22T16:10:41Z

internal/controller/nonadminbackup_controller_test.go

-			gomega.Expect(checkTestNonAdminBackupStatus(nonAdminBackup, scenario.ExpectedStatus, nonAdminNamespaceName, oadpNamespaceName)).To(gomega.Succeed())
-
+			gomega.Expect(checkTestNonAdminBackupStatus(nonAdminBackupAfterReconcile, scenario.nonAdminBackupExpectedStatus, oadpNamespace)).To(gomega.Succeed())
+			if scenario.uuidCreatedByReconcile {


this check needs to be moved inside checkTestNonAdminBackupStatus function

first expect in this if here is not valid, no? if namespace name is big, it wont be present in nameUUID

internal/controller/nonadminbackup_controller_test.go

mateusoliveira43

note to self: would have done things a little different, setting UUID (only 36 length) as a NAB and Velero Backup label (less secure to use as label instead of status in NAB, but easier to iterate over). After creating UUID, would do get call in NAB and OADP namespace, to confirm UUID is unique in the cluster (#102), but that would not check things in storage provider.

openshift-ci · 2024-10-22T18:04:31Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: mateusoliveira43, mpryc, shubham-pampattiwar

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,mpryc,shubham-pampattiwar]

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

mpryc

@mateusoliveira43 I think I responded to all of your comments. Please point me the ones which must be fixed before this will get merged, which we want to fix as follow up and which are just nice to have. Also I am not sure why it's approved by you with so many comments added.

mpryc requested a review from mateusoliveira43 October 14, 2024 17:56

openshift-ci bot requested a review from shubham-pampattiwar October 14, 2024 17:56

openshift-ci bot added the approved label Oct 14, 2024

mateusoliveira43 reviewed Oct 14, 2024

View reviewed changes

internal/common/constant/constant.go Show resolved Hide resolved

mateusoliveira43 reviewed Oct 14, 2024

View reviewed changes

internal/common/function/function.go Show resolved Hide resolved

mateusoliveira43 reviewed Oct 14, 2024

View reviewed changes

internal/common/function/function.go Show resolved Hide resolved

mpryc force-pushed the velero_nab_ownership branch from ac7eba1 to b20a4cc Compare October 14, 2024 19:13

mpryc force-pushed the velero_nab_ownership branch from b20a4cc to 2cbd085 Compare October 14, 2024 20:28

mpryc mentioned this pull request Oct 14, 2024

GenerateVeleroBackupName result is not unique #90

Open

Update function to validate NAC Object Labels

97dacc6

Improved function to properly validate NAC Object Labels Dropped length of Annotation Value validation, as it's not limited to 63 or 256 chars. Signed-off-by: Michal Pryc <[email protected]>

shubham-pampattiwar reviewed Oct 15, 2024

View reviewed changes

api/v1alpha1/nonadminbackup_types.go Outdated Show resolved Hide resolved

internal/common/constant/constant.go Show resolved Hide resolved

internal/common/function/function.go Show resolved Hide resolved

shubham-pampattiwar reviewed Oct 16, 2024

View reviewed changes

internal/common/function/function.go Outdated Show resolved Hide resolved

Update custom UUID for NAB Object to reflect Code Review

ba85bd5

Changes to address code review. Signed-off-by: Michal Pryc <[email protected]>

shubham-pampattiwar reviewed Oct 17, 2024

View reviewed changes

internal/common/function/function.go Outdated Show resolved Hide resolved

shubham-pampattiwar previously approved these changes Oct 17, 2024

View reviewed changes

Rename function to ListObjectsByLabel

3cb8cdd

Renamed function which lists objects by label in a specific namespace. Signed-off-by: Michal Pryc <[email protected]>

mpryc dismissed shubham-pampattiwar’s stale review via 3cb8cdd October 17, 2024 08:11

shubham-pampattiwar previously approved these changes Oct 17, 2024

View reviewed changes

mateusoliveira43 reviewed Oct 17, 2024

View reviewed changes

docs/design/Non_Admin_Controller_design.md Outdated Show resolved Hide resolved

mateusoliveira43 reviewed Oct 17, 2024

View reviewed changes

api/v1alpha1/nonadminbackup_types.go Show resolved Hide resolved

mateusoliveira43 reviewed Oct 17, 2024

View reviewed changes

internal/controller/nonadminbackup_controller.go Show resolved Hide resolved

shubham-pampattiwar mentioned this pull request Oct 17, 2024

Check if the VeleroBackup exists for unique name generated using custom UUID and then re-try creation of VeleroBackup #102

Open

mpryc dismissed shubham-pampattiwar’s stale review via 991430a October 21, 2024 20:14

mpryc force-pushed the velero_nab_ownership branch 2 times, most recently from 72fe8c4 to 90893cb Compare October 21, 2024 20:42

mpryc force-pushed the velero_nab_ownership branch from 90893cb to e06454e Compare October 21, 2024 20:44

shubham-pampattiwar approved these changes Oct 22, 2024

View reviewed changes