Skip to content

Commit 201606f

Browse files
committed
corrections
Signed-off-by: Shruti Deshpande <shdeshpa@redhat.com>
1 parent 65a3f6e commit 201606f

16 files changed

+43
-59
lines changed

backup_and_restore/application_backup_and_restore/oadp-self-service/oadp-self-service-admin-use-cases.adoc

-3
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,6 @@ include::modules/oadp-self-service-approving-nabsl.adoc[leveloffset=+1]
2424

2525
include::modules/oadp-self-service-rejecting-nabsl.adoc[leveloffset=+1]
2626

27-
28-
As a cluster administrator, you can also enforce policies in the `DataProtectionApplication` (DPA) spec template. The spec enforcement applies to Self-Service CRs such as the `NonAdminBackup`, `NonAdminRestore`, and `NonAdminBackupStorageLocation`.
29-
3027
include::modules/oadp-self-service-admin-spec-enforcement.adoc[leveloffset=+1]
3128

3229
include::modules/oadp-self-service-admin-spec-enforce-nabsl.adoc[leveloffset=+1]

backup_and_restore/application_backup_and_restore/oadp-self-service/oadp-self-service.adoc

+3-3
Original file line numberDiff line numberDiff line change
@@ -16,16 +16,16 @@ include::modules/oadp-self-service-how-it-works.adoc[leveloffset=+1]
1616

1717
include::modules/oadp-self-service-prerequisites.adoc[leveloffset=+1]
1818

19+
include::modules/oadp-self-service-namespace-permissions.adoc[leveloffset=+1]
20+
1921
include::modules/oadp-self-service-unsupported-features.adoc[leveloffset=+1]
2022

21-
include::modules/oadp-self-service-namespace-permissions.adoc[leveloffset=+1]
23+
include::modules/oadp-self-service-phases.adoc[leveloffset=+1]
2224

2325
include::modules/oadp-self-service-admin-enabling.adoc[leveloffset=+1]
2426

2527
include::modules/oadp-self-service-admin-disabling.adoc[leveloffset=+1]
2628

27-
include::modules/oadp-self-service-phases.adoc[leveloffset=+1]
28-
2929
include::modules/oadp-self-service-creating-nab.adoc[leveloffset=+1]
3030

3131
include::modules/oadp-self-service-creating-nar.adoc[leveloffset=+1]

images/oadp-self-service.svg

+14-33
Loading

modules/oadp-self-service-about-nabsl.adoc

+3-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,9 @@
66
[id="oadp-self-service-about-nabsl_{context}"]
77
= About `NonAdminBackupStorageLocation` CR
88

9-
A `NonAdminBackupStorageLocation` (NABSL) is a custom resource that a non-admin user can create to store the backup data. To ensure that the NABSL CR is created and used securely, there are cluster administrator controls in place. The cluster administrator manages the NABSL CR to conform to company policies, compliance requirements, and so on.
9+
A `NonAdminBackupStorageLocation` (NABSL) is a custom resource that a non-admin user can create to store the backup data.
10+
11+
To ensure that the NABSL CR is created and used securely, there are cluster administrator controls in place. The cluster administrator manages the NABSL CR to conform to company policies, compliance requirements, and so on.
1012

1113
You can create a NABSL CR by using one of the following workflows:
1214

modules/oadp-self-service-admin-disabling.adoc

+1-3
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,11 @@ You can use the `spec.nonAdmin.enable` section of the `DataProtectionApplication
1111
.Prerequisites
1212

1313
* You are logged in to the cluster with administrator privileges.
14-
* You have installed the {oadp-short} Operator in the non-admin user namespace.
15-
* You have configured the DPA according to your requirement.
1614
* You have enabled {oadp-short} Self-Service in the DPA.
1715
1816
.Procedure
1917

20-
. To disable Self-Service in the non-admin namespace, edit the DPA and set the `nonAdmin.enable` field to `false` as shown in the following example.
18+
. To disable Self-Service, edit the DPA and set the `nonAdmin.enable` field to `false` as shown in the following example.
2119
+
2220
.Example `DataProtectionApplication`
2321
[source,yaml]

modules/oadp-self-service-admin-enabling.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ You must be a cluster administrator to enable the {oadp-short} Self-Service feat
1212

1313
* You are logged in to the cluster with administrator privileges.
1414
* You have installed the {oadp-short} Operator.
15-
* You have configured the `DataProtectionApplication` according to your requirement.
15+
* You have configured the DPA CR.
1616
1717
.Procedure
1818

modules/oadp-self-service-admin-spec-enforcement.adoc

+2
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66
[id="oadp-self-service-admin-spec-enforcement_{context}"]
77
= {oadp-short} Self-Service administrator DPA spec enforcement
88

9+
As a cluster administrator, you can also enforce policies in the `DataProtectionApplication` (DPA) spec template. The spec enforcement applies to Self-Service CRs such as the `NonAdminBackup`, `NonAdminRestore`, and `NonAdminBackupStorageLocation`.
10+
911
To ensure secure backup and restore, {oadp-short} Self-Service automatically excludes the following resources from being backed up or restored:
1012

1113
* Security Context Constraints (SCCs)

modules/oadp-self-service-approving-nabsl.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
:_mod-docs-content-type: PROCEDURE
66
[id="oadp-self-service-approving-nabsl_{context}"]
7-
= Approving `NonAdminBackupStorageLocation` request
7+
= Approving a `NonAdminBackupStorageLocation` request
88

99
As a cluster administrator, to approve a `NonAdminBackupStorageLocation` (NABSL) CR request, you can edit the `NonAdminBackupStorageLocationRequest` CR and set the `approvalDecision` to `"approve"`.
1010

modules/oadp-self-service-components.adoc

+5-5
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@
88

99
The {oadp-short} Self-Service feature has the following new custom resources (CRs) to enable the backup and restore operations for a non-admin user:
1010

11-
* `NonAdminController` (NAC): Used to control and orchestrate the Self-Service operations.
12-
* `NonAdminBackup` (NAB): Used to manage namespace-scoped backup operations.
13-
* `NonAdminRestore` (NAR): Used to manage namespace-scoped restore operations.
14-
* `NonAdminBackupStorageLocation` (NABSL): Used to define user specific backup storage locations.
15-
* `NonAdminDownloadRequest` (NADR) - Used to manage namespace-scoped download request operations.
11+
* `NonAdminController` (NAC): Controls and orchestrates the Self-Service operations.
12+
* `NonAdminBackup` (NAB): Manages namespace-scoped backup operations.
13+
* `NonAdminRestore` (NAR): Manages namespace-scoped restore operations.
14+
* `NonAdminBackupStorageLocation` (NABSL): Defines user specific backup storage location.
15+
* `NonAdminDownloadRequest` (NADR) : Manages namespace-scoped download request operations.

modules/oadp-self-service-creating-nab.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ When you create a NAB CR:
1717
Following are some important points to take note of, when you create a NAB CR:
1818

1919
* The `NonAdminBackup` CR creates the `Velero` backup object in a secure way so that other non-admin users cannot access the CR.
20-
* As a non-admin user, you cannot specify the namespace to back up. The namespace from which the NAB CR is created, is the namespace that will be backed up.
20+
* As a non-admin user, you can only specify your authorized namespace in the NAB CR. You get an error when you specify a namespace you are not authorized to use.
2121
2222
.Prerequisites
2323

modules/oadp-self-service-creating-nar.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ spec:
3232
backupName: test-nab # <2>
3333
----
3434
1. Specify a name for the NAR CR. In this example, the name of the NAR CR is `test-nar`.
35-
2. Specify the `NonAdminBackup` CR you to restore from. In this example, the NAB is `test-nab`.
35+
2. Specify the NAB CR you want to restore from. In this example, the NAB CR is `test-nab`.
3636
3737
. To create the NAR CR, run the following command:
3838
+

modules/oadp-self-service-enabling-nabsl-approval.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ The `NonAdminBackupStorageLocation` (NABSL) administrator approval workflow is a
1616
1717
.Procedure
1818

19-
. To enable the NABSL administrator approval workflow, edit the DPA and:
19+
* To enable the NABSL administrator approval workflow, edit the DPA and:
2020
.. Add the `requireApprovalForBSL` field as shown in the example.
2121
.. Set the `requireApprovalForBSL` field to `true`.
2222
+

modules/oadp-self-service-overview.adoc

+5-3
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@
66
[id="oadp-self-service-overview_{context}"]
77
= {oadp-short} Self-Service overview
88

9-
In the earlier versions of {oadp-full}, you needed to have cluster-wide administrator privileges to perform {oadp-short} operations such as backing up and restoring an application, creating a backup storage location, and so on.
9+
In the earlier versions of {oadp-full}, you needed cluster-wide administrator privileges to perform {oadp-short} operations such as backing up and restoring an application, creating a backup storage location, and so on.
1010

11-
With {oadp-short} 1.5.0 onward, you do not need to have cluster-wide administrator privileges to perform the backup and restore operations. {oadp-short} Self-Service introduces a significant change to backup and restore operations in {product-title}.
11+
With {oadp-short} 1.5.0 onward, you do not need cluster-wide administrator privileges to perform the backup and restore operations.
1212

1313
The {oadp-short} Self-Service feature provides secure self-service data protection capabilities for users without administrator privileges, while maintaining proper access controls.
1414

@@ -31,7 +31,9 @@ Note that, {oadp-short} Self-service does not support cross-cluster restore.
3131
3232
= What namespace-scoped backup and restore means
3333

34-
The {oadp-short} Self-Service feature ensures that non-admin users can only operate within their authorized namespace and permissions. For example, if you do not have access to a namespace, as a non-admin user, you cannot back up that namespace.
34+
The {oadp-short} Self-Service feature ensures that non-admin users can only operate within their authorized namespace. For example, if you do not have access to a namespace, as a non-admin user, you cannot back up that namespace.
35+
36+
This also means that a non-admin user cannot access backup and restore data of other users.
3537

3638
The cluster administrator enforces the access control through custom resources that securely manage the backup and restore operations.
3739

modules/oadp-self-service-phases.adoc

+3-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,9 @@
66
[id="oadp-self-service-phases_{context}"]
77
= {oadp-short} Self-Service backup and restore phases
88

9-
When you create a `NonAdminBackup` (NAB) or a `NonAdminRestore` (NAR) CR, you can check the CR status in the `status.phase` field of these CRs. The `status.phase` field is a summary of the lifecycle of the CRs. The lifecycle phases can only move forward. That means, when a phase changes, it cannot go back to the earlier value. The `NonAdminController` (NAC) validates the CRs and sends the status back to the NAB and NAR CRs.
9+
When you create a `NonAdminBackup` (NAB) or a `NonAdminRestore` (NAR) CR, you can check the CR status in the `status.phase` field of these CRs. The `status.phase` field is a summary of the lifecycle of the CRs.
10+
11+
The lifecycle phases can only move forward. This means, when a phase changes, it cannot go back to the earlier value. The `NonAdminController` (NAC) validates the CRs and sends the status back to the NAB and NAR CRs.
1012

1113
.Phases
1214
|===

modules/oadp-self-service-rejecting-nabsl.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
:_mod-docs-content-type: PROCEDURE
66
[id="oadp-self-service-rejecting-nabsl_{context}"]
7-
= Rejecting `NonAdminBackupStorageLocation` request
7+
= Rejecting a `NonAdminBackupStorageLocation` request
88

99
As a cluster administrator, to reject a `NonAdminBackupStorageLocation` (NABSL) CR request, you can edit the `NonAdminBackupStorageLocationRequest` CR and set the `approvalDecision` to `"reject"`.
1010

modules/oadp-self-service-unsupported-features.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
[id="oadp-self-service-unsupported-features_{context}"]
77
= {oadp-short} Self-Service unsupported features
88

9-
Following features are not supported by {oadp-short} Self-Service:
9+
The following features are not supported by {oadp-short} Self-Service:
1010

1111
* Cross cluster backup and restore, or migrations are not supported. These {oadp-short} operations are supported for the cluster administrator.
1212
* A non-admin user cannot create a `VolumeSnapshotLocation` (VSL) CR. The cluster administrator creates and configures the VSL in the `DataProtectionApplication` (DPA) for a non-admin user.

0 commit comments

Comments
 (0)