Skip to content

Commit b42c3dc

Browse files
authored
get a self-service troubleshooting doc started (#1840)
* get a self-service troubleshotting doc started * remove trailing lines
1 parent a16b223 commit b42c3dc

File tree

2 files changed

+35
-0
lines changed

2 files changed

+35
-0
lines changed

docs/TROUBLESHOOTING.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ If you need help, first search if there is [already an issue filed](https://issu
1010
1. [Debugging Failed Backups](#debugging-failed-backups)
1111
1. [Debugging Failed Restores](#debugging-failed-restores)
1212
1. [Debugging OpenShift Virtualization backup/restore](virtualization_troubleshooting.md)
13+
1. [Debugging OADP Self Service](self-service_troubleshooting.md)
1314
1. [Deleting Backups](#deleting-backups)
1415
1. [Debugging Data Mover (OADP 1.2 or below)](https://github.com/migtools/volume-snapshot-mover/blob/master/docs/troubleshooting.md)
1516
1. [OpenShift ROSA STS and OADP installation](https://github.com/rh-mobb/documentation/blob/main/content/docs/misc/oadp/rosa-sts/_index.md)

docs/self-service_troubleshooting.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
Based on the [migtools/oadp-non-admin](https://github.com/migtools/oadp-non-admin) repository, OADP's self-service feature is implemented through the **OADP Non Admin Controller (NAC)**.
2+
3+
## Brief Description
4+
5+
The OADP self-service feature enables **non-cluster-administrative users** to perform backup and restore operations within their designated namespaces, while maintaining cluster security and administrative control.
6+
7+
### Key Capabilities:
8+
9+
- **Non-Admin Backup/Restore**: Regular users can create `NonAdminBackup` and `NonAdminRestore` resources to protect and recover their applications without requiring cluster admin privileges.
10+
11+
- **Admin-Controlled Access**: Cluster administrators configure which namespaces non-admin users can backup/restore through the OADP operator's DPA (DataProtectionApplication) configuration.
12+
13+
- **Policy Enforcement**: Admins can enforce company policies by using templated configurations that require specific field values and restrict access to cluster-scoped resources.
14+
15+
- **Automatic Security Restrictions**: The system automatically excludes sensitive cluster-scoped objects (SCCs, ClusterRoles, CRDs, etc.) from non-admin backup/restore operations.
16+
17+
### Workflow:
18+
1. **Admin Setup**: Configure DPA with non-admin feature enabled and set enforcement policies
19+
2. **User Self-Service**: Non-admin users create their own backup/restore operations using `NonAdminBackup` and `NonAdminRestore` CRDs
20+
3. **Controlled Access**: Users can only backup/restore within their permitted namespaces with admin-defined constraints
21+
22+
This feature requires **OADP operator version 1.5+** and provides a secure way to democratize backup/restore operations while maintaining enterprise governance and security controls.
23+
24+
## Troubleshooting
25+
26+
### Common Issues and Solutions
27+
28+
**For more detailed information about non-admin user constraints, see the [OADP Non-Admin README](https://github.com/migtools/oadp-non-admin?tab=readme-ov-file#notes-on-non-admin-permissions-and-enforcements).**
29+
30+
#### Issue: Unable to retrieve backup logs as a non-admin user
31+
32+
**Problem**: As a non-admin user, I cannot access the logs of my backup.
33+
34+
**Solution**: Non-admin users should use a `NonAdminBackupStorageLocation` (NABSL) when creating a `NonAdminBackup` (NAB). Non-admin users do not have permission to access logs directly from the underlying Backup Storage Location for security reasons.

0 commit comments

Comments
 (0)