Skip to content
Merged
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
5 changes: 3 additions & 2 deletions configuration/add-custom-certificates.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
:_mod-docs-content-type: ASSEMBLY
[id="add-custom-cert"]
= Adding custom certificates
include::modules/common-attributes.adoc[]
Expand Down Expand Up @@ -25,8 +26,8 @@ include::modules/custom-cert-existing.adoc[leveloffset=+2]
//Updating certificates on an existing installation
include::modules/update-custom-certificate-central.adoc[leveloffset=+2]

//Restart Central
include::modules/restart-central-container.adoc[leveloffset=+3]
//Restarting the Central container
include::modules/restarting-the-central-container.adoc[leveloffset=+3]

[id="configure-sensor-to-trust-cert"]
== Configuring Sensor to trust custom certificates
Expand Down
5 changes: 3 additions & 2 deletions configuration/add-trusted-ca.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
:_mod-docs-content-type: ASSEMBLY
[id="add-trusted-ca"]
= Adding trusted certificate authorities
include::modules/common-attributes.adoc[]
Expand Down Expand Up @@ -33,8 +34,8 @@ After you configure trusted CAs, you must make {product-title} services trust th
* Additionally, if you are also adding certificates for integrating with image registries, you must restart both Central and Scanner.
//TODO: Add link to integrating with image registries

//Restart Central
include::modules/restart-central-container.adoc[leveloffset=+2]
//Restarting the Central container
include::modules/restarting-the-central-container.adoc[leveloffset=+2]

//Restart Scanner
include::modules/restart-scanner-container.adoc[leveloffset=+2]
Expand Down
5 changes: 3 additions & 2 deletions configuration/configure-endpoints.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
:_mod-docs-content-type: ASSEMBLY
[id="configure-endpoints"]
= Configuring endpoints
include::modules/common-attributes.adoc[]
Expand All @@ -18,6 +19,6 @@ include::modules/configure-endpoints-new-install.adoc[leveloffset=+1]

include::modules/configure-endpoints-existing.adoc[leveloffset=+1]

include::modules/restart-central-container.adoc[leveloffset=+2]
include::modules/restarting-the-central-container.adoc[leveloffset=+2]

include::modules/enable-traffic-flow-through-custom-ports.adoc[leveloffset=+1]
include::modules/enable-traffic-flow-through-custom-ports.adoc[leveloffset=+1]
31 changes: 23 additions & 8 deletions configuration/reissue-internal-certificates.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,17 +13,32 @@ You can view the certificate expiration dates by selecting *Platform Configurati

//Add link to role based permissions and resources

//reissue internal certificates for Central
include::modules/reissue-internal-certificates-central.adoc[leveloffset=+1]
//Reissuing internal certificates for Central services
include::modules/reissuing-internal-certificates-for-central-services.adoc[leveloffset=+1]

//Restart Central
include::modules/restart-central-container.adoc[leveloffset=+2]
//Reissuing internal certificates for Central
include::modules/reissuing-internal-certificates-for-central.adoc[leveloffset=+2]

//reissue internal certificates for Scanner
include::modules/reissue-internal-certificates-scanner.adoc[leveloffset=+1]
//Restarting the Central container
include::modules/restarting-the-central-container.adoc[leveloffset=+3]

//Restart Scanner & Scanner DB
include::modules/restart-scanner-and-scannerdb-containers.adoc[leveloffset=+2]
//Reissuing internal certificates for Central DB
include::modules/reissuing-internal-certificates-for-central-db.adoc[leveloffset=+2]

//Restarting the Central DB container
include::modules/restarting-the-central-db-container.adoc[leveloffset=+3]

//Reissuing internal certificates for Scanner
include::modules/reissuing-internal-certificates-for-scanner.adoc[leveloffset=+2]

//Restarting the Scanner and Scanner DB containers
include::modules/restarting-the-scanner-and-scanner-db-containers.adoc[leveloffset=+3]

//Reissuing internal certificates for Scanner V4
include::modules/reissuing-internal-certificates-for-scanner-v4.adoc[leveloffset=+2]

//Restarting the Scanner V4 containers
include::modules/restarting-the-scanner-v4-containers.adoc[leveloffset=+3]

[id="reissue-internal-certificates-secured-clusters_{context}"]
== Reissuing internal certificates for secured clusters
Expand Down
38 changes: 0 additions & 38 deletions modules/reissue-internal-certificates-central.adoc

This file was deleted.

30 changes: 0 additions & 30 deletions modules/reissue-internal-certificates-scanner.adoc

This file was deleted.

25 changes: 25 additions & 0 deletions modules/reissuing-internal-certificates-for-central-db.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
// Module included in the following assemblies:
//
// * configuration/reissue-internal-certificates.adoc

:_mod-docs-content-type: PROCEDURE
[id="reissuing-internal-certificates-for-central-db_{context}"]
= Reissuing internal certificates for Central DB

You can maintain a secure communication between Central DB and other {rh-rhacs-first} components by reissuing the internal certificates.

.Prerequisites

* You have `write` permission for the `Administration` resource.

.Procedure

. In the {product-title-short} portal, click the link in the banner that announces the certificate expiration to download a YAML configuration file, which contains a new secret. The secret includes the certificate and key values.
. To apply the new YAML configuration file to the cluster where you have installed Central DB, run the following command:
+
[source,terminal]
----
$ oc apply -f <secret_file.yaml>
----

. To apply the changes, restart Central DB.
30 changes: 30 additions & 0 deletions modules/reissuing-internal-certificates-for-central-services.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
// Module included in the following assemblies:
//
// * configuration/reissue-internal-certificates.adoc

:_mod-docs-content-type: CONCEPT
[id="reissuing-internal-certificates-for-central-services_{context}"]
= Reissuing internal certificates for Central services

The Central services contain the Central, Central DB, Scanner, and Scanner V4 components.
The Central services use a built-in server certificate for authentication when communicating with other {rh-rhacs-first} services.
This certificate is unique to your Central service installation.
The {product-title-short} portal shows an informational banner when a Central service certificate is about to expire.

[NOTE]
====
The informational banner only appears 15 days before the certificate expiration date.
====

Beginning with {product-title-short} 4.3.4, the Operator automatically rotates the service transport layer security (TLS) certificates for all of the Central components 6 months before they expire.

[IMPORTANT]
====
* The automated rotation of the TLS certificates applies only to Operator-based installations. For all other installation methods, you must manually rotate the TLS certificates.

* The rotation of the TLS certificates within the secrets does not automatically trigger the components to reload them. If the corresponding pods are not restarted at least every 6 months, you must manually restart the pods to load the new certificates before the old ones expire.

ifeval::["{rhacs-version}" < "4.9.0"]
* Certificate authority (CA) certificates are not updated. They are valid for 5 years.
endif::[]
====
25 changes: 25 additions & 0 deletions modules/reissuing-internal-certificates-for-central.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
// Module included in the following assemblies:
//
// * configuration/reissue-internal-certificates.adoc

:_mod-docs-content-type: PROCEDURE
[id="reissuing-internal-certificates-for-central_{context}"]
= Reissuing internal certificates for Central

You can maintain a secure communication between Central and other {rh-rhacs-first} components by reissuing the internal certificates.

.Prerequisites

* You have `write` permission for the `Administration` resource.

.Procedure

. In the {product-title-short} portal, click the link in the banner that announces the certificate expiration to download a YAML configuration file, which contains a new secret. The secret includes the certificate and key values.
. To apply the new YAML configuration file to the cluster where you have installed Central, run the following command:
+
[source,terminal]
----
$ oc apply -f <secret_file.yaml>
----

. To apply the changes, restart Central.
24 changes: 24 additions & 0 deletions modules/reissuing-internal-certificates-for-scanner-v4.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
// Module included in the following assemblies:
//
// * configuration/reissue-internal-certificates.adoc

:_mod-docs-content-type: PROCEDURE
[id="reissuing-internal-certificates-for-scanner-v4_{context}"]
= Reissuing internal certificates for Scanner V4

You can maintain a secure communication between Scanner V4 and other {rh-rhacs-first} components by reissuing the internal certificates.

.Prerequisites

* You have `write` permission for the `Administration` resource.

.Procedure

. Click the link in the banner to download a YAML configuration file, which contains a new {ocp} secret, including the certificate and key values.
. To apply the new YAML configuration file to the cluster where you have installed Scanner V4, run the following command:
+
[source,terminal]
----
$ oc apply -f <secret_file.yaml>
----
. To apply the changes, restart Scanner V4.
24 changes: 24 additions & 0 deletions modules/reissuing-internal-certificates-for-scanner.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
// Module included in the following assemblies:
//
// * configuration/reissue-internal-certificates.adoc

:_mod-docs-content-type: PROCEDURE
[id="reissuing-internal-certificates-for-scanner_{context}"]
= Reissuing internal certificates for Scanner

You can maintain a secure communication between Scanner and other {rh-rhacs-first} components by reissuing the internal certificates.

.Prerequisites

* You have `write` permission for the `Administration` resource.

.Procedure

. Click the link in the banner to download a YAML configuration file, which contains a new {ocp} secret, including the certificate and key values.
. To apply the new YAML configuration file to the cluster where you have installed Scanner, run the following command:
+
[source,terminal]
----
$ oc apply -f <secret_file.yaml>
----
. To apply the changes, restart Scanner.
31 changes: 0 additions & 31 deletions modules/restart-central-container.adoc

This file was deleted.

26 changes: 0 additions & 26 deletions modules/restart-scanner-and-scannerdb-containers.adoc

This file was deleted.

26 changes: 26 additions & 0 deletions modules/restarting-the-central-container.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
// Module included in the following assemblies:
//
// * configuration/add-trusted-ca.adoc
// * configuration/configure-endpoints.adoc
// * configuration/add-custom-certificates.adoc

:_mod-docs-content-type: PROCEDURE
[id="restarting-the-central-container_{context}"]
= Restarting the Central container

[role="_abstract"]
You can restart the Central container by deleting the Central pod.

[IMPORTANT]
====
If you use Kubernetes, enter `kubectl` instead of `oc`.
====

.Procedure

* To delete the Central pod, run the following command:
+
[source,terminal]
----
$ oc -n stackrox delete pod -lapp=central
----
Loading