Skip to content

Commit

Permalink
fixup! fix: Update status design with NAR and delete
Browse files Browse the repository at this point in the history
Signed-off-by: Mateus Oliveira <[email protected]>
  • Loading branch information
mateusoliveira43 committed Oct 3, 2024
1 parent 3ee72a0 commit 47eac57
Showing 1 changed file with 7 additions and 8 deletions.
15 changes: 7 additions & 8 deletions docs/design/nab_and_nar_status_update.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Developer Workflow: NonAdminBackup and NonAdminRestore Status Update
# Controller Workflow: NonAdminBackup and NonAdminRestore Status Update

## Overview

Expand Down Expand Up @@ -28,7 +28,6 @@ Those are are the possible values for phase:
| New | *NonAdminBackup/NonAdminRestore* resource was accepted by the NAB/NAR Controller, but it has not yet been validated by the NAB/NAR Controller |
| BackingOff | *NonAdminBackup/NonAdminRestore* resource was invalidated by the NAB/NAR Controller, due to invalid Spec. NAB/NAR Controller will not reconcile the object further, until user updates it |
| Created | *NonAdminBackup/NonAdminRestore* resource was validated by the NAB/NAR Controller and Velero *Backup/restore* was created. The Phase will not have additional information about the *Backup/Restore* run |
| Deleted | TODO |

### Conditions

Expand Down Expand Up @@ -58,8 +57,9 @@ Those are are the possible values for `NonAdminCondition`:
NonAdminBackup/NonAdminRestore `status` contains reference to the related Velero Backup/Restore.

NonAdminBackup `status.veleroBackup` contains `name`, `namespace` and `status`.
`status.veleroBackup.name` represents the name of the `VeleroBackup` object. `status.veleroBackup.namespace` represents the namespace in which the `VeleroBackup` object was created.
`status.veleroBackup.status` field is a copy of the `VeleroBackup` object status.
- `status.veleroBackup.name` represents the name of the `VeleroBackup` object.
- `status.veleroBackup.namespace` represents the namespace in which the `VeleroBackup` object was created.
- `status.veleroBackup.status` field is a copy of the `VeleroBackup` object status.

The format of those fields allows to interact with that Backup using `oc` or `velero` commands as follows:

Expand All @@ -73,14 +73,13 @@ status:
```
```shell
oc describe -n openshift-adp nab-nacproject-c3499c2729730a

velero backup describe -n openshift-adp nab-nacproject-c3499c2729730a
```

Similarly, NonAdminRestore `status.veleroRestore` contains `name`, `namespace` and `status`.
`status.veleroRestore.name` represents the name of the `veleroRestore` object. `status.veleroRestore.namespace` represents the namespace in which the `veleroRestore` object was created.
`status.veleroRestore.status` field is a copy of the `VeleroBackup` object status.
- `status.veleroRestore.name` represents the name of the `veleroRestore` object.
- `status.veleroRestore.namespace` represents the namespace in which the `veleroRestore` object was created.
- `status.veleroRestore.status` field is a copy of the `VeleroBackup` object status.

## Example

Expand Down

0 comments on commit 47eac57

Please sign in to comment.