Bug 1550409 - [DOCS] Add more information about custom CA certificates
Summary: [DOCS] Add more information about custom CA certificates
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: OpenShift Container Platform
Classification: Red Hat
Component: Documentation
Version: 3.6.0
Hardware: All
OS: Linux
medium
medium
Target Milestone: ---
: ---
Assignee: Michael Burke
QA Contact: Gaoyun Pei
Vikram Goyal
URL:
Whiteboard: 3.10-release-plan
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2018-03-01 08:31 UTC by Suresh
Modified: 2023-09-15 00:06 UTC (History)
6 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2018-05-07 14:54:44 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)

Description Suresh 2018-03-01 08:31:13 UTC
Document URL: 
https://docs.openshift.com/container-platform/3.6/install_config/redeploying_certificates.html#redeploying-new-custom-ca

Section Number and Name: 
Redeploying a New or Custom OpenShift Container Platform CA

Describe the issue: 

To use custom CA, we have specified below information in the documentation:

<snip>

To redeploy a newly generated or custom CA:

    If you want to use a custom CA, set the following variable in your inventory file:


openshift_master_ca_certificate={'certfile': '</path/to/ca.crt>', 'keyfile': '</path/to/ca.key>'}

</snip>

However, we haven't specified about certificate bundles. We should add a line stating the 'certfile' could be a certificate bundle and also provide the command to create a certificate bundle. 

If the CA certificate is issued by an intermediate CA, in that case bundle must contain the intermediate and root certificates for the CA we use in order to validate child certificates. 


Suggestions for improvement: 

This should look like:

<snip>

To redeploy a newly generated or custom CA:

    If you want to use a custom CA, set the following variable in your inventory file:


openshift_master_ca_certificate={'certfile': '</path/to/ca.crt>', 'keyfile': '</path/to/ca.key>'}


If the CA certificate is issued by an intermediate CA, in that case bundle must contain the intermediate and root certificates for the CA we use in order to validate child certificates. 

</snip>


Additional information: 

For more information, refer the below bugzilla which has more details about this:

https://bugzilla.redhat.com/show_bug.cgi?id=1530312#c8

Document URL: 

Section Number and Name: 

Describe the issue: 

Suggestions for improvement: 

Additional information:

Comment 1 Michael Burke 2018-04-04 17:50:40 UTC
@Suresh Please take a look:
https://github.com/openshift/openshift-docs/pull/8597

Comment 2 Gaoyun Pei 2018-04-11 04:46:40 UTC
PR lgtm, move it to verified.

Comment 4 Red Hat Bugzilla 2023-09-15 00:06:43 UTC
The needinfo request[s] on this closed bug have been removed as they have been unresolved for 500 days


Note You need to log in before you can comment on or make changes to this bug.