-
Task
-
Resolution: Done
-
Critical
-
None
-
False
-
-
False
-
-
- Who is your target persona?
C-Suite IT, Automation Architect, Enterprise Architect Leader
- What stage of the user journey are you targeting?
Configuration and Maintenance
- Why is this content important?
This content is crucial for users who need to manage and maintain the security and functionality of their Red Hat Advanced Cluster Security for Kubernetes (RHACS) installation. Specifically, it addresses the reissuing of internal certificates for various RHACS components, ensuring secure communication and preventing potential service disruptions due to certificate expiration.
- What high level steps does the user need to take to accomplish the goal?
1. Understand the importance of certificate expiration notifications in the RHACS portal.
2. Identify the specific RHACS component requiring certificate reissuance (Central, Central DB, Scanner, Scanner V4).
3. Gain `write` permission for the `Administration` resource.
4. Download a YAML configuration file containing a new secret with certificate and key values from the RHACS portal.
5. Apply the new YAML configuration file to the cluster using the `oc apply -f <secret_file.yaml>` command.
6. Restart the relevant RHACS component (Central, Central DB, Scanner, Scanner V4, or Scanner V4 containers) to apply the changes.
- What is the general sentiment of users towards this goal?
Users express frustration and concern regarding certificate expiration and its potential impact on service continuity. They seek clear, comprehensive guidance on managing certificate reissuance for various RHACS components.
- What pain points are the user likely to encounter when accomplishing this goal?
Users may struggle with understanding the implications of certificate expiration, identifying the correct component requiring reissuance, and executing the necessary steps to apply new certificates without disrupting service.
- What other feedback do users have around this goal?
Users have requested more detailed and consolidated documentation on certificate reissuance for various RHACS components. They also seek clarification on the differences between Operator-based and non-Operator-based installations regarding certificate management.
- Are there any additional opportunities you can also implement for the user when documenting this goal?
Yes, consider including a high-level overview of the RHACS certificate management process, highlighting the differences between Operator-based and non-Operator-based installations. Additionally, provide troubleshooting tips and best practices for certificate reissuance to minimize service disruptions. Also, discuss the interoperability of Central and Scanner components, as well as their dependencies.
- People:
SME: Agil Antony (agantony@redhat.com)
QE: Not specified in the provided context
Release Note: Yes
- Documentation Outline:
1. Module Title (Concept): Reissuing Internal Certificates in RHACS
- Overview of content required: This section will provide a high-level introduction to the importance of certificate reissuance in RHACS, the implications of certificate expiration, and the differences between Operator-based and non-Operator-based installations. It will also discuss the interoperability of Central and Scanner components.
2. Module Title (Concept): Certificate Expiration Notifications
- Overview of content required: This section will explain how to interpret and act on certificate expiration notifications in the RHACS portal.
3. Module Title (Procedure): Reissuing Internal Certificates for Central Services
- Prerequisites: User must have `write` permission for the `Administration` resource.
- Outline of steps:
1. Download the YAML configuration file from the RHACS portal.
2. Apply the new YAML configuration file using `oc apply -f <secret_file.yaml>`.
3. Restart the Central container.
4. Module Title (Procedure): Reissuing Internal Certificates for Central DB
- Prerequisites: User must have `write` permission for the `Administration` resource.
- Outline of steps:
1. Download the YAML configuration file from the RHACS portal.
2. Apply the new YAML configuration file using `oc apply -f <secret_file.yaml>`.
3. Restart the Central DB container.
5. Module Title (Procedure): Reissuing Internal Certificates for Scanner
- Prerequisites: User must have `write` permission for the `Administration` resource.
- Outline of steps:
1. Download the YAML configuration file from the RHACS portal.
2. Apply the new YAML configuration file using `oc apply -f <secret_file.yaml>`.
3. Restart the Scanner.
6. Module Title (Procedure): Reissuing Internal Certificates for Scanner V4
- Prerequisites: User must have `write` permission for the `Administration` resource.
- Outline of steps:
1. Download the YAML configuration file from the RHACS portal.
2. Apply the new YAML configuration file using `oc apply -f <secret_file.yaml>`.
3. Restart the Scanner V4 containers.
7. Module Title (Reference): Certificate Reissuance Troubleshooting
- Outline of parameters/options/data to be included: Common issues and solutions related to certificate reissuance in RHACS.
8. Module Title (Concept): Central and Scanner Interoperability
- Overview of content required: This section will discuss the relationship between Central and Scanner components, their dependencies, and how to manage certificates for both components together.
- is triggered by
-
ROX-28969 Docs: Improve Clarity and Completeness of "Reissuing Internal Certificates"
-
- Closed
-