starlingx/docs
Code Issues Proposed changes
dcd23abd66
docs/doc/source/security/kubernetes/https-access-overview.rst
Ngairangbam Mili 67e324da18 Certificate changes from R8 fixed in master 
Original master review: https://review.opendev.org/c/starlingx/docs/+/894499

Change-Id: Ibf683df7b5d426d17846eec3824dd86ef3ccf0e0
Signed-off-by: Ngairangbam Mili <ngairangbam.mili@windriver.com>
2023-11-03 13:17:37 +00:00

43 KiB
Raw Blame History

HTTPS and Certificates Management Overview

Certificates are required for secure HTTPS access and authentication on platform.

This table lists all the platform certificates, and indicates which certificates are automatically created/renewed by the system versus which certificates must be manually created/renewed by the system administrator.

Platform certificates that are associated with optional platform components are only present if the optional platform component is configured (e.g. ).

Platform certificates that are associated with Distributed Cloud are only present on SystemController systems or Subclouds.

Where:

  • Auto created: the certificate is generated during system deployment or triggered by certain operations.
  • Renewal Status: whether the certificate is renewed automatically by the system when expiry date approaches.

The specific certificates, and details such as expiration date, that are present on a system can be displayed with a local script, sudo show-certs.sh, see utility-script-to-display-certificates.

monitors the installed certificates on the system by raising alarms for expired certificates and certificates that will expire soon, see alarm-expiring-soon-and-expired-certificates-baf5b8f73009.

The following sections provide details on managing these certificates:

  • StarlingX REST API Applications and the Web Administration Server Certificate <starlingx-rest-api-applications-and-the-web-administration-server>
  • Kubernetes Certificates <kubernetes-certificates-f4196d7cae9c>
  • Local Registry Server Certificates <security-install-update-the-docker-registry-certificate>
  • System Trusted CA Certificates <add-a-trusted-ca>

For further information about certificates expiration date or other certificates information, see Display Certificates Installed on a System <utility-script-to-display-certificates>.

In addition, monitors the installed certificates on the system by raising alarms for expire-soon certificates and for expired certificates on the system, see Expiring-Soon and Expired Certificate Alarms <alarm-expiring-soon-and-expired-certificates-baf5b8f73009>.