Skip to content

Commit 58b0d04

Browse files
committed
Added docs for customizing platform components
1 parent e5dcec2 commit 58b0d04

File tree

3 files changed

+63
-0
lines changed

3 files changed

+63
-0
lines changed
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="customizing-platform-components_{context}"]
3+
= Customizing platform components
4+
include::modules/common-attributes.adoc[]
5+
:context: customizing-platform-components
6+
7+
toc::[]
8+
9+
[role="_abstract"]
10+
You can view and customize platform components within {rh-rhacs-first}. {product-title-short} helps you identify vulnerabilities in your user workloads and platform components.
11+
User workloads are the applications and images that you deploy.
12+
Platform components include the underlying infrastructure, Operators, and third-party services that support application development.
13+
Defining these components helps categorize security findings and segments them by area of responsibility.
14+
15+
In previous versions, {product-title-short} automatically identified platform components based on predefined namespaces. Now, you can customize which namespaces {product-title-short} identifies as platform components. Allowing for more granular control over how {product-title-short} categorizes security findings.
16+
17+
include::modules/understanding-platform-components.adoc[leveloffset=+1]
18+
19+
include::modules/modifying-platform-component-definitions.adoc[leveloffset=+1]
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * configuration/customizing-platform-components.adoc
4+
:_mod-docs-content-type: PROCEDURE
5+
[id="modifying-platform-component-definitions_{context}"]
6+
= Modifying platform component definitions
7+
8+
You can define platform components by using namespaces to segment platform security findings from user workloads.
9+
10+
.Prerequisites
11+
* You must have the `Administration` role with `read` permission to view the platform component configuration options.
12+
* You must have the `Administration` role with `write` permission to modify the platform component configuration.
13+
14+
.Procedure
15+
16+
. In the RHACS portal, go to **Platform Configuration** > **System Configuration**.
17+
. On the *System Configuration* view header, click **Edit**.
18+
. Under the **Platform components configuration** section click on the **Red Hat layered products** tab. Components found in Red Hat layered and partner product namespaces are included in the platform definition by default.
19+
.. To modify the Red Hat layered products definition, enter one or more namespaces using regular expressions, separated by a pipe `|` symbol. For more information on the syntax structure, see the link:https://github.com/google/re2/wiki/syntax[RE2 syntax reference].
20+
. Click on the **Custom components** tab.
21+
.. To add a custom platform component, click **Add custom platform component**. You can add more than one.
22+
.. In the new Custom component entry, enter a descriptive **Name**.
23+
.. Enter the **Namespace rules (Regex)** for this custom component. Enter one or more namespaces using regular expressions, separated by a pipe `|` symbol. For more information on the syntax structure, see the link:https://github.com/google/re2/wiki/syntax[RE2 syntax reference].
24+
. Click **Save**.
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * configuration/customizing-platform-components.adoc
4+
:_mod-docs-content-type: CONCEPT
5+
[id="understanding-platform-components_{context}"]
6+
= Understanding platform components
7+
8+
When viewing violations in {product-title-short}, you can view them in the context of user workloads and platform components. This distinction helps you understand the scope of the vulnerabilities.
9+
10+
**User workloads** includes vulnerabilities that affect the workloads and images you deploy in your system. You deploy and manage these workloads.
11+
12+
**Platform** includes vulnerabilities related to the platform itself. For example, these vulnerabilities might be in workloads and images that the {ocp} platform and layered services deploy. {product-title-short} uses regular expression patterns to examine workload namespaces and identify workloads that belong to platform components.
13+
14+
You can view the platform components definition in the {product-title-short} portal by going to **Platform Configuration** > **System Configuration**.
15+
16+
The **Platform components configuration** section lists platform components in the following categories:
17+
18+
* **Core system components**: These components are part of the core {ocp} and Kubernetes namespaces. {product-title-short} includes them in the platform definition by default. You cannot customize these definitions. These definitions might change when you upgrade the system.
19+
* **Red Hat layered products**: Components found in Red Hat layered and partner product namespaces are included in the platform definition by default.
20+
* **Custom components**: You can extend the platform definition by defining namespaces for additional applications and products.

0 commit comments

Comments
 (0)