Skip to content

Commit c3c25c3

Browse files
authored
Merge pull request openshift#55487 from kcarmichael08/policy-categories-3.74
Update documentation to add policy category changes
2 parents 5d2db0a + 58dc9e4 commit c3c25c3

6 files changed

+61
-9
lines changed
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * operating/manage-security-policies.adoc
4+
:_content-type: PROCEDURE
5+
[id="create-policy-categories-using-tab_{context}"]
6+
= Creating policy categories using the Policy categories tab
7+
8+
{product-title-short} version 3.74 provides a new method to create and manage policy categories in {product-title-managed} or in {product-title-short} if you have the PostgreSQL database (Technology Preview) enabled. All policy workflows other than policy creation remain unchanged when using this feature.
9+
10+
You can also configure policy categories by using the `PolicyCategoryService` API object. For more information, navigate to *Help* -> *API reference* in the {product-title-short} portal.
11+
12+
:FeatureName: PostgreSQL support
13+
include::snippets/technology-preview.adoc[]
14+
15+
.Procedure
16+
17+
. On the {product-title-short} portal, navigate to *Platform Configuration* -> *Policy Management*.
18+
. Click the *Policy categories* tab. This tab provides a list of existing categories and allows you to filter the list by category name. You can also click *Show all categories* and select the checkbox to remove default or custom categories from the displayed list.
19+
. Click *Create category*.
20+
. Enter a category name and click *Create*.
21+
Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
// Module included in the following assemblies:
22
//
33
// * operating/manage-security-policies.adoc
4-
:_module-type: PROCEDURE
4+
:_content-type: PROCEDURE
55
[id="create-policy-categories_{context}"]
6-
= Creating policy categories
6+
= Creating policy categories during policy creation
77

88
You can create new policy categories from the system policies view.
99

1010
.Procedure
11-
. On the RHACS portal, navigate to *Platform Configuration* -> *Policies*.
11+
12+
. On the {product-title-short} portal, navigate to *Platform Configuration* -> *Policy Management*.
1213
. From the *Policies* page, select the policy you want to edit.
1314
. Select *Actions* -> *Edit policy*.
14-
. Enter a new category name in the *Categories* field and then click *Create <category>*.
15+
. In the *Policy details* section, enter a new category name in the *Categories* field and then click *Create <category>*.
1516
. Click the *Review policy* section heading.
1617
. Click *Save*.
1718

18-
After you save the configuration, the new category displays on the dashboard if there are any violations for policies in the category.

modules/modify-existing-security-policies.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
// Module included in the following assemblies:
22
//
33
// * operating/manage-security-policies.adoc
4-
:_module-type: PROCEDURE
4+
:_content-type: PROCEDURE
55
[id="modify-existing-security-policies_{context}"]
66
= Modifying existing security policies
77

88
[role="_abstract"]
99
You can edit the policies you have created and the existing default policies provided by {product-title}.
1010

1111
.Procedure
12-
. On the RHACS portal, navigate to *Platform Configuration* -> *Policies*.
12+
. On the {product-title-short} portal, navigate to *Platform Configuration* -> *Policies*.
1313
. From the *Policies* page, select the policy you want to edit.
1414
. Select *Actions* -> *Edit policy*.
1515
. Modify the *Policy details*. You can modify the policy name, severity, categories, description, rationale, and guidance.
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * operating/manage-security-policies.adoc
4+
:_content-type: PROCEDURE
5+
[id="modify-policy-categories-using-tab_{context}"]
6+
= Modifying policy categories using the Policy categories tab
7+
8+
{product-title-short} version 3.74 provides a new method to create and manage policy categories in {product-title-managed} or in {product-title-short} if you have the PostgreSQL database (Technology Preview) enabled. All policy workflows other than policy creation remain unchanged when using this feature. For instructions on using this feature, see the second procedure in the following section.
9+
10+
You can also configure policy categories by using the `PolicyCategoryService` API object. For more information, navigate to *Help* -> *API reference* in the {product-title-short} portal.
11+
12+
:FeatureName: PostgreSQL support
13+
include::snippets/technology-preview.adoc[]
14+
15+
.Procedure
16+
17+
. On the {product-title-short} portal, navigate to *Platform Configuration* -> *Policy Management*.
18+
. Click the *Policy categories* tab. This tab provides a list of existing categories and allows you to filter the list by category name. You can also click *Show all categories* and select the checkbox to remove default or custom categories from the displayed list.
19+
. Click a policy name to edit or delete it. Default policy categories cannot be selected, edited, or deleted.

modules/snippets

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../snippets/

operating/manage-security-policies.adoc

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,18 @@ include::modules/modify-existing-security-policies.adoc[leveloffset=+1]
1717
.Additional resources
1818
* xref:../operating/manage-security-policies.adoc#create-policy-from-system-policies-view_manage-security-policies[Creating a security policy from the system policies view]
1919
20-
include::modules/create-policy-categories.adoc[leveloffset=+1]
20+
[id="create-policy-categories-all"]
21+
== Creating and managing policy categories
22+
23+
You can create and manage policy categories by using the following methods:
24+
25+
* Create a policy category in the *Policy details* section when you create a policy. The category names are stored as strings that are attached to the policy and cannot be copied or deleted.
26+
* Create, copy, or delete a policy category by navigating to *Platform Configuration* -> *Policy Management* and clicking the *Policy categories* tab. The policy categories are stored in the database and can be managed. This option is available only in {product-title-managed} or in {product-title-short} if you have the PostgreSQL database (Technology Preview) enabled.
27+
28+
include::modules/create-policy-categories.adoc[leveloffset=+2]
29+
include::modules/create-policy-categories-using-tab.adoc[leveloffset=+2]
30+
include::modules/modify-policy-categories-using-tab.adoc[leveloffset=+2]
31+
2132
[role="_additional-resources"]
2233
.Additional resources
2334
* xref:../operating/manage-security-policies.adoc#create-policy-from-system-policies-view_manage-security-policies[Creating a security policy from the system policies view]
@@ -29,7 +40,7 @@ In addition to using the default policies, you can also create custom policies i
2940
3041
To build a new policy, you can clone an existing policy or create a new one from scratch.
3142
32-
* You can also create policies based on the filter criteria in the *Risk* view in the RHACS portal.
43+
* You can also create policies based on the filter criteria in the *Risk* view in the {product-title-short} portal.
3344
* You can also use `AND`, `OR`, and `NOT` logical operators for policy criteria to create advanced policies.
3445
3546
include::modules/create-policy-from-system-policies-view.adoc[leveloffset=+2]

0 commit comments

Comments
 (0)