Skip to content

Expand on custom public certificate trust usage

James Reed requested to merge docs-jr-clarify-custom-pub-crt into master

What does this MR do?

This MR seeks to add further clarification when installing custom public SSL certificates.

  1. There is currently an introductory statement of:

    Some environments connect to external resources for various tasks. Omnibus GitLab allows these connections to use HTTPS, and supports connections with self-signed certificates.

    However, we then provide instructions surrounding the context of installing custom public SSL certificates for GitLab itself as a listener, and not necessarily "connecting to external resources". This MR seeks to further expand on these different cases.

  2. An example has been added to the WARNING: alert box regarding splitting custom certificate chains into separate files.

Related issues

  • This originally came about via discussions with a customer where there was some confusion surrounding this part of our documentation, particularly where the specific example steps are limited to the context of "trusting custom public SSL certificates where the certificates are applied to GitLab itself" vs "trusting custom public certificates for external resources GitLab needs to connect to".

Author's checklist

If you are only adding documentation, do not add any of the following labels:

  • ~"feature"
  • ~"frontend"
  • ~"backend"
  • ~"bug"
  • ~"database"

These labels cause the MR to be added to code verification QA issues.

Review checklist

Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.

  • If the content requires it, ensure the information is reviewed by a subject matter expert.
  • Technical writer review items:
    • Ensure docs metadata is present and up-to-date.
    • Ensure the appropriate labels are added to this MR.
    • If relevant to this MR, ensure content topic type principles are in use, including:
      • The headings should be something you'd do a Google search for. Instead of Default behavior, say something like Default behavior when you close an issue.
      • The headings (other than the page title) should be active. Instead of Configuring GDK, say something like Configure GDK.
      • Any task steps should be written as a numbered list.
      • If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
  • Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  • Ensure a release milestone is set.
Edited by James Reed

Merge request reports