Skip to content

Commit

Permalink
fixup! fix: Add contribution documenation to project
Browse files Browse the repository at this point in the history
Signed-off-by: Mateus Oliveira <[email protected]>
  • Loading branch information
mateusoliveira43 committed Mar 26, 2024
1 parent 31a59d0 commit 8d85862
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 1 deletion.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ This open source controller adds the non admin feature to [OADP operator](https:
- Access to a OpenShift cluster
- [OADP operator](https://github.com/openshift/oadp-operator) installed in the cluster

> **TODO:** Today, OADP operator must be installed in `openshift-adp` namespace, because of this limitation https://github.com/migtools/oadp-non-admin/blob/master/internal/controller/nonadminbackup_controller.go#L51
### Using NAC

To use NAC functionality:
Expand Down
4 changes: 3 additions & 1 deletion docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,14 +31,16 @@ OADP_NAMESPACE=<OADP_operator_installation_namespace>
DEV_IMG=<NAC_image>
```

> **TODO:** If `OADP_NAMESPACE` is set to a value different than `openshift-adp`, you also need to change the value here https://github.com/migtools/oadp-non-admin/blob/master/internal/controller/nonadminbackup_controller.go#L51
To create a non admin user to test NAC, check [non admin user documentation](non_admin_user.md).

To uninstall the previously installed OADP operator in your cluster, run
```sh
make undeploy-dev
```

> **NOTE:** make sure there are no running instances of CRDs. Finalizers in those objects can fail `undeploy-dev` command.
> **NOTE:** Make sure there are no running instances of CRDs. Finalizers in those objects can fail `undeploy-dev` command.
## Code quality and standardization

Expand Down

0 comments on commit 8d85862

Please sign in to comment.