-
Bug
-
Resolution: Unresolved
-
Undefined
-
None
-
None
-
False
-
sat-rocket
-
None
-
None
-
None
-
None
Description of problem:
Our documentation for configuring for custom SSL certificates in Satellite constantly uses the generic term certificate without specifying the type of certificate involved, potentially creating a lot of confusion in the reader.
An example taken from the Installing Satellite Server in a connected network environment guide [1]:
section 4.12.2. Deploying a custom SSL certificate to Satellite Server and section 4.12.3. Deploying a custom SSL certificate to hosts actually refer to different types of certificates. The first to the leaf certificate, exposed by Satellite, the second to the CA certificate, used by the hosts to validate the leaf certificate provided by Satellite. This kind of clarification is highly desirable. More info on the terminology here [2].
This improvement would involve several guides including:
- Installing Satellite Server in a connected network environment
- Installing Satellite Server in a disconnected network environment
- Installing Capsule Server
- Administering Red Hat Satellite
- Managing hosts
Target persona:
This would help customers using the documentation get a better understanding of what they're configuring and avoid confusion and mistakes caused by brittle terminology, resulting in a better user experience and reduced number of cases raised to RH support.
[1]: https://docs.redhat.com/en/documentation/red_hat_satellite/6.17/html-single/installing_satellite_server_in_a_connected_network_environment/index#Deploying_a_Custom_SSL_Certificate_to_Server_satellite
[2]: https://cert-manager.io/docs/reference/tls-terminology/#whats-the-difference-between-root-intermediate-and-leaf-certificates