Skip to content

Commit 4e6cacb

Browse files
author
Agil Antony
committed
ROX30868 Removing discrete headings
1 parent bc10c0b commit 4e6cacb

19 files changed

+170
-184
lines changed

integration/integrate-with-image-vulnerability-scanners.adoc

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,7 @@ toc::[]
99
[role="_abstract"]
1010
{rh-rhacs-first} integrates with vulnerability scanners to enable you to import your container images and watch them for vulnerabilities.
1111

12-
[discrete]
13-
== Supported container image registries
12+
Supported container image registries::
1413

1514
Red{nbsp}Hat supports the following container image registries:
1615

@@ -27,13 +26,11 @@ Red{nbsp}Hat supports the following container image registries:
2726
2827
This enhanced support gives you greater flexibility and choice in managing your container images in your preferred registry.
2928

30-
[discrete]
31-
== Supported Scanners
29+
Supported Scanners::
3230

3331
You can set up {product-title-short} to obtain image vulnerability data from the following commercial container image vulnerability scanners:
3432

35-
[discrete]
36-
=== Scanners included in {product-title-short}
33+
Scanners included in {product-title-short}::
3734

3835
* Scanner V4: Beginning with {product-title-short} version 4.4, a new scanner is introduced that is built on link:https://github.com/quay/claircore[ClairCore], which also powers the link:https://github.com/quay/clair[Clair] scanner. Scanner V4 supports scanning of language and OS-specific image components. You do not have to create an integration to use this scanner, but you must enable it during or after installation. For version 4.4, if you enable this scanner, you must also enable the StackRox Scanner. For more information about Scanner V4, including links to the installation documentation, see xref:../operating/examine-images-for-vulnerabilities.adoc#about-scanner-v4_examine-images-for-vulnerabilities[About {product-title-short} Scanner V4].
3936
* StackRox Scanner: This scanner is the default scanner in {product-title-short}. It originates from a fork of the Clair v2 open source scanner.
@@ -43,8 +40,7 @@ You can set up {product-title-short} to obtain image vulnerability data from the
4340
Even if you have Scanner V4 enabled, at this time, the StackRox Scanner must still be enabled to provide scanning of RHCOS nodes and platform vulnerabilities such as {osp}, Kubernetes, and Istio. Support for that functionality in Scanner V4 is planned for a future release. Do not disable the StackRox Scanner.
4441
====
4542
46-
[discrete]
47-
=== Alternative scanners
43+
Alternative scanners::
4844

4945
* link:https://github.com/quay/clair[Clair]: As of version 4.4, you can enable Scanner V4 in {product-title-short} to provide functionality provided by ClairCore, which also powers the Clair V4 scanner. However, you can configure Clair V4 as the scanner by configuring an integration.
5046
* link:https://cloud.google.com/container-registry/docs/container-analysis[Google Container Analysis]

modules/acs-architecture-overview.adoc

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,7 @@ You install {product-title-short} as a set of containers in your {ocp} or Kubern
2020
2121
In addition to these primary services, {product-title-short} also interacts with other external components to enhance your clusters' security.
2222

23-
[discrete]
2423
[id="installation-differences-architecture_{context}"]
25-
== Installation differences
24+
Installation differences::
2625

27-
When you install {product-title-short} on {ocp} by using the Operator, {product-title-short} installs a lightweight version of Scanner on every secured cluster. The lightweight Scanner enables the scanning of images in the integrated OpenShift image registry. When you install {product-title-short} on {ocp} or Kubernetes by using the Helm install method with the _default_ values, the lightweight version of Scanner is not installed. To install the lightweight Scanner on the secured cluster by using Helm, you must set the `scanner.disable=false` parameter. You cannot install the lightweight Scanner by using the `roxctl` installation method.
26+
When you install {product-title-short} on {ocp} by using the Operator, {product-title-short} installs a lightweight version of Scanner on every secured cluster. The lightweight Scanner enables the scanning of images in the integrated OpenShift image registry. When you install {product-title-short} on {ocp} or Kubernetes by using the Helm install method with the _default_ values, the lightweight version of Scanner is not installed. To install the lightweight Scanner on the secured cluster by using Helm, you must set the `scanner.disable=false` parameter. You cannot install the lightweight Scanner by using the `roxctl` installation method.

modules/common-search-queries.adoc

Lines changed: 11 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,7 @@
77

88
Here are some common search queries you can run with {product-title}.
99

10-
[discrete]
11-
== Finding deployments that are affected by a specific CVE
10+
Finding deployments that are affected by a specific CVE::
1211

1312
|===
1413
| Query | Example
@@ -17,8 +16,7 @@ Here are some common search queries you can run with {product-title}.
1716
| `CVE:CVE-2018-11776`
1817
|===
1918

20-
[discrete]
21-
== Finding privileged running deployments
19+
Finding privileged running deployments::
2220

2321
|===
2422
| Query | Example
@@ -27,8 +25,7 @@ Here are some common search queries you can run with {product-title}.
2725
| `Privileged:true`
2826
|===
2927

30-
[discrete]
31-
== Finding deployments that have external network exposure
28+
Finding deployments that have external network exposure::
3229

3330
|===
3431
| Query | Example
@@ -37,8 +34,7 @@ Here are some common search queries you can run with {product-title}.
3734
| `Exposure Level:External`
3835
|===
3936

40-
[discrete]
41-
== Finding deployments that are running specific processes
37+
Finding deployments that are running specific processes::
4238

4339
|===
4440
| Query | Example
@@ -47,8 +43,7 @@ Here are some common search queries you can run with {product-title}.
4743
| `Process Name:bash`
4844
|===
4945

50-
[discrete]
51-
== Finding deployments that have serious but fixable vulnerabilities
46+
Finding deployments that have serious but fixable vulnerabilities::
5247

5348
|===
5449
| Query | Example
@@ -57,8 +52,7 @@ Here are some common search queries you can run with {product-title}.
5752
| `CVSS:>=6` `Fixable:.*`
5853
|===
5954

60-
[discrete]
61-
== Finding deployments that use passwords exposed through environment variables
55+
Finding deployments that use passwords exposed through environment variables::
6256

6357
|===
6458
| Query | Example
@@ -67,8 +61,7 @@ Here are some common search queries you can run with {product-title}.
6761
| `Environment Key:r/.\*pass.*`
6862
|===
6963

70-
[discrete]
71-
== Finding running deployments that have particular software components in them
64+
Finding running deployments that have particular software components in them::
7265

7366
|===
7467
| Query | Example
@@ -77,14 +70,12 @@ Here are some common search queries you can run with {product-title}.
7770
| `Component:libgpg-error` or `Component:sudo`
7871
|===
7972

80-
[discrete]
81-
== Finding users or groups
73+
Finding users or groups::
8274

8375
Use Kubernetes link:https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/[Labels and Selectors], and link:https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/[Annotations] to attach metadata to your deployments.
8476
You can then query based on the applied annotations and labels to identify individuals or groups.
8577

86-
[discrete]
87-
=== Finding who owns a particular deployment
78+
Finding who owns a particular deployment::
8879

8980
|===
9081
| Query | Example
@@ -93,8 +84,7 @@ You can then query based on the applied annotations and labels to identify indiv
9384
| `Deployment:app-server` `Label:team=backend`
9485
|===
9586

96-
[discrete]
97-
=== Finding who is deploying images from public registries
87+
Finding who is deploying images from public registries::
9888

9989
|===
10090
| Query | Example
@@ -103,8 +93,7 @@ You can then query based on the applied annotations and labels to identify indiv
10393
| `Image Registry:docker.io` `Label:team=backend`
10494
|===
10595

106-
[discrete]
107-
=== Finding who is deploying into the default namespace
96+
Finding who is deploying into the default namespace::
10897

10998
|===
11099
| Query | Example

modules/configuration-details-tab.adoc

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,7 @@
88

99
The *Configuration details* tab displays information about the scan schedule information such as the essential parameters, cluster status, associated profiles, and email delivery destinations.
1010

11-
[discrete]
12-
== Parameters section
11+
Parameters section::
1312

1413
The *Parameters* section organizes information into the following groups:
1514

@@ -19,24 +18,21 @@ The *Parameters* section organizes information into the following groups:
1918
* *Last scanned*: The timestamp of the last compliance scan performed.
2019
* *Last updated*: The last date and time that the compliance scan data was modified.
2120
22-
[discrete]
23-
== Clusters section
21+
Clusters section::
2422

2523
The *Clusters* section organizes information into the following groups:
2624

2725
* *Cluster*: Lists the one or more clusters associated with a compliance scan.
2826
* *Operator status*: Indicates the current health or operational status of the Operator.
2927
30-
[discrete]
31-
== Profiles section
28+
Profiles section::
3229

3330
The *Profiles* section lists the one or more profiles associated with a compliance scan.
3431

35-
[discrete]
36-
== Delivery destinations section
32+
Delivery destinations section::
3733

3834
The *Delivery destinations* section organizes information into the following groups:
3935

4036
* *Email notifier*: Specifies the email notification system or tool set up to distribute reports or alerts.
4137
* *Distribution list*: Lists the recipients who should receive the notifications or reports.
42-
* *Email template*: Specifies the email format used for the notifications. You can use the default or customize the email subject and body as needed.
38+
* *Email template*: Specifies the email format used for the notifications. You can use the default or customize the email subject and body as needed.

modules/create-policy-from-system-policies-view.adoc

Lines changed: 8 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,12 @@ You can create new security policies from the system policies view.
1010
.Procedure
1111
. In the {product-title-short} portal, go to *Platform Configuration* -> *Policy Management*.
1212
. Click *Create policy*.
13-
. Configure the policy definition information in the following sections:
13+
. Configure the policy definition information in the f[ollowing sections:
1414

1515
// future enhancement: split these into separate modules and call them from the assembly. Add a procedure title to each module.
1616

17-
[discrete]
1817
[id="policy-details_{context}"]
19-
== Enter policy details
18+
Enter policy details::
2019

2120
Enter the following details about your policy in the *Policy details* section.
2221

@@ -31,9 +30,8 @@ Enter the following details about your policy in the *Policy details* section.
3130
.. Click the *Add technique* to add techniques for the selected tactic. You can specify multiple techniques for a tactic.
3231
. Click *Next*.
3332

34-
[discrete]
3533
[id="policy-lifecycle_{context}"]
36-
== Configure the policy lifecycle
34+
Configure the policy lifecycle::
3735

3836
In the *Lifecycle* section, complete the following steps:
3937

@@ -48,9 +46,8 @@ You can select more than one stage from the following choices:
4846
* *Audit logs*: {product-title-short} triggers policy violations when event sources match Kubernetes audit log records.
4947
. Click *Next*.
5048

51-
[discrete]
5249
[id="policy-rules_{context}"]
53-
== Configure the policy rules and criteria
50+
Configure the policy rules and criteria::
5451

5552
To configure a policy rule:
5653

@@ -75,9 +72,8 @@ See "Policy criteria" in the "Additional resources" section for more information
7572
. To combine multiple values for an attribute, click the *Add* icon.
7673
. Click *Next*.
7774

78-
[discrete]
7975
[id="policy-scope_{context}"]
80-
== Configure the policy scope
76+
Configure the policy scope::
8177

8278
Create scopes to restrict or exclude your policy from entities, such as cluster or namespaces, within your environment.
8379

@@ -98,9 +94,8 @@ It does not have any effect if you use this policy to check running deployments
9894
====
9995
. Click *Next*.
10096

101-
[discrete]
10297
[id="policy-actions_{context}"]
103-
== Configure policy actions
98+
Configure policy actions::
10499

105100
Configure the activation state, enforcement, and notifiers for the policy.
106101

@@ -130,9 +125,8 @@ You must have previously configured the notification before it is visible and av
130125
====
131126
. Click *Next*.
132127

133-
[discrete]
134128
[id="policy-review_{context}"]
135-
== Review the policy and preview violations
129+
Review the policy and preview violations::
136130

137131
Review the policy settings you have configured.
138132

@@ -144,4 +138,4 @@ Review the policy settings you have configured.
144138
Runtime violations are not available in this preview because they are generated in response to future events.
145139
====
146140
Before you save the policy, verify that the violations seem accurate.
147-
. Click *Save*.
141+
. Click *Save*.

modules/default-requirements-central-services.adoc

Lines changed: 6 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,7 @@ However, you can use another storage type if you do not have SSDs available.
4343
For security reasons, you should deploy Central in a cluster with limited administrative access.
4444
====
4545

46-
[discrete]
47-
== CPU, memory, and storage requirements
46+
CPU, memory, and storage requirements::
4847

4948
The following table lists the minimum CPU and memory values required to install and run Central.
5049

@@ -84,8 +83,7 @@ Scanner is responsible for scanning images, nodes, and the platform for vulnerab
8483

8584
Beginning with version 4.4, {product-title-short} includes two image vulnerability scanners: StackRox Scanner and Scanner V4. StackRox Scanner is planned to be removed in a future release, but is still required at this time to perform node and platform scanning. Scanner V4 is the preferred image scanner because it provides additional features over the StackRox Scanner, such as expanded language and operating system support and data from additional vulnerability sources.
8685

87-
[discrete]
88-
== CPU, memory, and storage requirements
86+
CPU, memory, and storage requirements::
8987

9088
The following table lists the minimum CPU and memory values required to install and run Scanner. The requirements in this table are based on the default of 3 replicas.
9189

@@ -121,11 +119,9 @@ The StackRox Scanner requires Scanner DB (PostgreSQL 15) to store data. This dat
121119

122120
Scanner V4 is the preferred image scanner because it provides additional features over the StackRox Scanner, such as expanded language and operating system support and data from additional vulnerability sources.
123121

124-
[discrete]
125-
== CPU, memory, and storage requirements
122+
CPU, memory, and storage requirements::
126123

127-
[discrete]
128-
=== Scanner V4 Indexer
124+
Scanner V4 Indexer::
129125

130126
The requirements in this table are based on the default of 3 replicas.
131127

@@ -141,8 +137,7 @@ The requirements in this table are based on the default of 3 replicas.
141137
| 9 GiB
142138
|===
143139

144-
[discrete]
145-
=== Scanner V4 Matcher
140+
Scanner V4 Matcher::
146141

147142
The requirements in this table are based on the default of 2 replicas.
148143

@@ -158,8 +153,7 @@ The requirements in this table are based on the default of 2 replicas.
158153
| 4 GiB
159154
|===
160155

161-
[discrete]
162-
=== Scanner V4 DB
156+
Scanner V4 DB::
163157

164158
Scanner V4 requires Scanner V4 DB (PostgreSQL 15) to store data. For Scanner V4 DB, a PVC is required to ensure optimal performance. The following table lists the minimum CPU, memory, and storage values required to install and run Scanner V4 DB.
165159

modules/default-requirements-external-db.adoc

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -18,28 +18,24 @@ When you use an external database, note the following guidance:
1818

1919
If you select an external database, your database instance and the user connecting to it must meet the requirements listed in the following sections.
2020

21-
[discrete]
22-
== Database type and version
21+
Database type and version::
2322
The database must be a PostgreSQL-compatible database that supports PostgreSQL 13 or later.
2423

25-
[discrete]
26-
== User permissions
24+
User permissions::
2725
The user account that Central uses to connect to the database must be a `superuser` account with connection rights to the database and the following permissions:
2826

2927
* `Usage` and `Create` permissions on the schema.
3028
* `Select`, `Insert`, `Update`, and `Delete` permissions on all tables in the schema.
3129
* `Usage` permissions on all sequences in the schema.
3230
* The ability to create and delete databases as a `superuser`.
3331
34-
[discrete]
35-
== Connection string
32+
Connection string::
3633
Central connects to the external database by using a connection string, which must be in `keyword=value` format. The connection string should specify details such as the host, port, database name, user, and SSL/TLS mode. For example, `host=<host> port=5432 database=stackrox user=stackrox sslmode=verify-ca`.
3734

3835
[NOTE]
3936
====
4037
Connections through *PgBouncer* are not supported.
4138
====
4239

43-
[discrete]
44-
== CA certificates
40+
CA certificates::
4541
If your external database uses a certificate issued by a private or untrusted Certificate Authority (CA), you might need to specify the CA certificate so that Central trusts the database certificate. You can add this by using a TLS block in the Central custom resource configuration.

0 commit comments

Comments
 (0)