Skip to content

Commit 02280ec

Browse files
committed
Update structure of policy docs
1 parent 7bf255e commit 02280ec

File tree

7 files changed

+124
-13
lines changed

7 files changed

+124
-13
lines changed

_topic_maps/_topic_map.yml

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -220,10 +220,16 @@ Topics:
220220
Topics:
221221
- Name: About security policies
222222
File: about-security-policies
223-
- Name: Custom security policies
224-
File: custom-security-policies
223+
- Name: Understanding security policies
224+
File: understanding-security-policies
225225
- Name: Default security policies
226226
File: default-security-policies
227+
- Name: Understanding policy violations
228+
File: understanding-policy-violations
229+
- Name: Understanding policy enforcement
230+
File: understanding-policy-enforcement
231+
- Name: Creating and modifying custom security policies
232+
File: custom-security-policies
227233
- Name: Managing network policies
228234
File: manage-network-policies
229235
- Name: Build-time network policy tools

operating/manage_security_policies/about-security-policies.adoc

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,26 @@ include::modules/common-attributes.adoc[]
77
toc::[]
88

99
[role="_abstract"]
10-
{product-title} provides out-of-the-box _default_ security policies that you can use to prevent high-risk service deployments in your environment and respond to runtime security incidents. You can also create _custom_ multi-factor policies for your container environment.
10+
{product-title-short}provides security for your Kubernetes environments by providing out-of-the-box security policies and giving you the ability to customize your own multi-factor policies for your container environment. Configuring these policies enables you to automatically prevent high-risk service deployments in your environment and respond to runtime security incidents.
11+
12+
You can use policies to alert you or work with your system to stop it from performing an action, such as a deployment, when {product-title-short} scans your environment and discovers policy violations.
13+
14+
15+
Default policies
16+
17+
The default policies included in {product-title-short} provide broad coverage to identify security issues and ensure that you follow best development practices in your environment. These default policies include policies to
18+
19+
Custom policies
20+
Policy categories
21+
Best practices
22+
23+
24+
25+
26+
27+
28+
1129

12-
//Policy categories
13-
include::modules/con-policy-categories.adoc[leveloffset=+1]
14-
include::modules/create-policy-categories-using-tab.adoc[leveloffset=+2]
15-
include::modules/modify-policy-categories-using-tab.adoc[leveloffset=+2]
1630

1731
//Future section:
1832
//Best practices

operating/manage_security_policies/custom-security-policies.adoc

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
:_mod-docs-content-type: ASSEMBLY
22
[id="custom-security-policies"]
3-
= Custom security policies
3+
= Creating and modifying custom security policies
44
include::modules/common-attributes.adoc[]
55
:context: custom-security-policies
66

@@ -19,13 +19,18 @@ See the following sections for more information.
1919

2020
include::modules/create-policy-from-system-policies-view.adoc[leveloffset=+1]
2121

22-
include::modules/add-logical-conditions-policy-criteria.adoc[leveloffset=+2]
23-
2422
include::modules/create-policy-from-risk-view.adoc[leveloffset=+1]
2523

26-
[role="_additional-resources"]
27-
.Additional resources
28-
* xref:../../operating/search-filter.adoc#use-local-page-filtering_search-filter[Using local page filtering]
24+
. Create policy details (MODULE)
25+
. Select the lifecycle stage (MODULE)
26+
. Configure rules, or policy criteria (MODULE)
27+
ADD: modules/add-logical-conditions-policy-criteria.adoc[leveloffset=+2]
28+
. Configure policy behavior (MODULE)
29+
* Scope
30+
* Actions
31+
** Enforcement
32+
** Notifiers
33+
. Review and save (MODULE)
2934

3035
//Modifying existing security policies
3136
include::modules/modify-existing-security-policies.adoc[leveloffset=+1]
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
[id="managing-policies-as-code"]
3+
= Managing policies as code
4+
include::modules/common-attributes.adoc[]
5+
:context: managing-policies-as-code
6+
7+
toc::[]
8+
9+
[role="_abstract"]
10+
You can create and manage policies as code by saving policies as Kubernetes custom resources (CRs) and applying them to clusters by using a Kubernetes-native continuous delivery (CD) tool such as Argo CD.
11+
12+
include::modules/policy-as-code-about.adoc[leveloffset=+1]
13+
include::modules/policy-as-code-drift.adoc[leveloffset=+2]
14+
include::modules/policy-as-code-create-portal.adoc[leveloffset=+2]
15+
include::modules/policy-as-code-create-cr.adoc[leveloffset=+2]
16+
include::modules/policy-as-code-disable.adoc[leveloffset=+2]
17+
18+
//in progress: modules/policy-as-code-workflow-example.adoc
19+
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
[id="understanding-policy-violations"]
3+
= Understanding policy violations
4+
include::modules/common-attributes.adoc[]
5+
:context: understanding-policy-violations
6+
7+
toc::[]
8+
9+
[role="_abstract"]
10+
11+
Active Violations
12+
Blocked operations by Admission Controller
13+
Deployments attempts
14+
Blocked API calls
15+
Resolved Violations
16+
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
[id="understanding-security-policies"]
3+
= Understanding security policy structure
4+
include::modules/common-attributes.adoc[]
5+
:context: understanding-security-policies
6+
7+
toc::[]
8+
9+
[role="_abstract"]
10+
11+
Policy details
12+
13+
include::modules/con-policy-categories.adoc[leveloffset=+1]
14+
15+
16+
Policy Lifecycle
17+
18+
* build phase policies
19+
* deploy phase policies
20+
* runtime policies
21+
22+
Policy Rules
23+
24+
Policy Behavior
25+
26+
Policy Scoping
27+
28+
Policy Enforcement
29+
30+
build time enforcement
31+
deploy time enforcement
32+
Soft enforcement using the admission controller
33+
Hard enforcement by Sensor
34+
runtime enforcement
35+
36+
37+
Policy Notifiers
38+
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
[id="understanding-policy-enforcement"]
3+
= Understanding policy enforcement
4+
include::modules/common-attributes.adoc[]
5+
:context: understanding-policy-enforcement
6+
7+
toc::[]
8+
9+
[role="_abstract"]
10+
11+
12+
include::modules/policy-enforcement-about.adoc[leveloffset=+1]
13+
include::modules/policy-enforcement-deploy.adoc[leveloffset=+2]

0 commit comments

Comments
 (0)