Skip to content

[RHACS] Added docs for customizing platform components #95029

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: rhacs-docs-main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions _topic_maps/_topic_map.yml
Original file line number Diff line number Diff line change
Expand Up @@ -162,6 +162,8 @@ Topics:
File: reissue-internal-certificates
- Name: Adding security notices
File: add-security-notices
- Name: Customizing platform components
File: customizing-platform-components
- Name: Enabling offline mode
File: enable-offline-mode
- Name: Enabling alert data retention
Expand Down
19 changes: 19 additions & 0 deletions configuration/customizing-platform-components.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
:_mod-docs-content-type: ASSEMBLY
[id="customizing-platform-components_{context}"]
= Customizing platform components
include::modules/common-attributes.adoc[]
:context: customizing-platform-components

toc::[]

[role="_abstract"]
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.
User workloads are the applications and images that you deploy.
Platform components include the underlying infrastructure, Operators, and third-party services that support application development.
Defining these components helps categorize security findings and segments them by area of responsibility.

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.

include::modules/understanding-platform-components.adoc[leveloffset=+1]

include::modules/modifying-platform-component-definitions.adoc[leveloffset=+1]
24 changes: 24 additions & 0 deletions modules/modifying-platform-component-definitions.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
// Module included in the following assemblies:
//
// * configuration/customizing-platform-components.adoc
:_mod-docs-content-type: PROCEDURE
[id="modifying-platform-component-definitions_{context}"]
= Modifying platform component definitions

You can define platform components by using namespaces to segment platform security findings from user workloads.

.Prerequisites
* You must have the `Administration` role with `read` permission to view the platform component configuration options.
* You must have the `Administration` role with `write` permission to modify the platform component configuration.

.Procedure

. In the RHACS portal, go to **Platform Configuration** > **System Configuration**.
. On the *System Configuration* view header, click **Edit**.
. 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.
.. 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].
. Click on the **Custom components** tab.
.. To add a custom platform component, click **Add custom platform component**. You can add more than one.
.. In the new Custom component entry, enter a descriptive **Name**.
.. 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].
. Click **Save**.
20 changes: 20 additions & 0 deletions modules/understanding-platform-components.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
// Module included in the following assemblies:
//
// * configuration/customizing-platform-components.adoc
:_mod-docs-content-type: CONCEPT
[id="understanding-platform-components_{context}"]
= Understanding platform components

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.

**User workloads** includes vulnerabilities that affect the workloads and images you deploy in your system. You deploy and manage these workloads.

**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.

You can view the platform components definition in the {product-title-short} portal by going to **Platform Configuration** > **System Configuration**.

The **Platform components configuration** section lists platform components in the following categories:

* **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.
* **Red Hat layered products**: Components found in Red Hat layered and partner product namespaces are included in the platform definition by default.
* **Custom components**: You can extend the platform definition by defining namespaces for additional applications and products.