starlingx/docs
Code Issues Proposed changes

Updated Limitation for IPv6 addresses (r8, dsr8)

Browse Source 
Updated the title in the rest file
Shorten filename. Link with very long file name is broken in some URL contexts
such as local builds This change corrects it in local testing but needs
further verification from other contributors.

Linked to: https://review.opendev.org/c/starlingx/docs/+/891913
Change-Id: I3ad7ac655ef46190efa0f4bb88345195333d4030
Signed-off-by: Juanita Balaraj <juanita.balaraj@windriver.com>
This commit is contained in:
Juanita Balaraj 2023-08-30 19:45:25 +00:00 committed by Ron Stone
parent 634a2a24ee
commit 98f8b72701
5 changed files with 20 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
doc/source/security/kubernetes/configure-docker-registry-certificate-after-installation-c519edbfe90a.rst
View File

@ -4,9 +4,6 @@
Configure Docker Registry Certificate
=====================================
.. rubric:: |context|
The local Docker registry provides secure HTTPS access using the registry API.
.. rubric:: |context|
@ -104,4 +101,8 @@ Update the following fields:
The Docker registry certificate installation is now complete, and Cert-Manager
will handle the lifecycle management of the certificate.
.. include:: /_includes/cert-mgmt-ipv6-address-limitation-1a4504370674.rest
---------------------------------------------------------------------------
Limitations for using IPv6 addresses related to management and OAM networks
---------------------------------------------------------------------------
.. include:: /shared/_includes/cert-mgmt-ipv6-address-limitation-1a4504370674.rest

17
doc/source/security/kubernetes/configure-rest-api-applications-and-web-administration-server-certificates-after-installation-6816457ab95f.rst → doc/source/security/kubernetes/configure-rest-api-apps-and-web-admin-server-certs-after-inst-6816457ab95f.rst
View File

@ -39,13 +39,13 @@ Update the following fields:
If you plan to use the container-based remote CLIs, due to a limitation in
the Python2 SSL certificate validation, the certificate used for the
'system-restapi-gui-certificate' certificate must either have:
``system-restapi-gui-certificate`` certificate must either have:
1. CN=IPADDRESS and SANs=IPADDRESS
- CN=IPADDRESS and SANs=IPADDRESS
or
1. CN=FQDN and SANs=FQDN
- CN=FQDN and SANs=FQDN
where IPADDRESS and FQDN are for the |OAM| Floating IP Address.
@ -93,9 +93,9 @@ Update the following fields:
.. code-block::
~(keystone_admin)]$ kubectl get certificate system-restapi-gui-certificate –n deployment
~(keystone_admin)]$ kubectl get certificate system-restapi-gui-certificate -n deployment
If configuration was successful, the certificate’s Ready status will be
If configuration was successful, the certificate's Ready status will be
``True``.
.. rubric:: |result|
@ -103,4 +103,9 @@ Update the following fields:
The REST and Web Server certificate installation is now complete, and
Cert-Manager will handle the lifecycle management of the certificate.
.. include:: /_includes/cert-mgmt-ipv6-address-limitation-1a4504370674.rest
---------------------------------------------------------------------------
Limitations for using IPv6 addresses related to management and OAM networks
---------------------------------------------------------------------------
.. include:: /shared/_includes/cert-mgmt-ipv6-address-limitation-1a4504370674.rest

5
doc/source/security/kubernetes/https-access-overview.rst
View File

@ -113,7 +113,7 @@ show-certs.sh`, see :ref:`utility-script-to-display-certificates`.
expired certificates and certificates that will expire soon, see
:ref:`alarm-expiring-soon-and-expired-certificates-baf5b8f73009`.
The following sections provide details on managing these certificates.
The following sections provide details on managing these certificates:
- :ref:`StarlingX REST API Applications and the Web Administration Server Certificate <starlingx-rest-api-applications-and-the-web-administration-server>`
@ -129,4 +129,5 @@ information, see :ref:`Display Certificates Installed on a System <utility-scrip
In addition, |prod| monitors the installed certificates on the system by raising
alarms for expire-soon certificates and for expired certificates on the system,
see :ref:`Expiring-Soon and Expired Certificate Alarms
<alarm-expiring-soon-and-expired-certificates-baf5b8f73009>`.
<alarm-expiring-soon-and-expired-certificates-baf5b8f73009>`.

2
doc/source/security/kubernetes/index-security-kub-81153c1254c3.rst
View File

@ -118,7 +118,7 @@ HTTPS Certificate Management
etcd-certificates-c1fc943e4a9c
kubernetes-certificates-f4196d7cae9c
starlingx-rest-api-applications-and-the-web-admin-server-cert-9196c5794834
configure-rest-api-applications-and-web-administration-server-certificates-after-installation-6816457ab95f
configure-rest-api-apps-and-web-admin-server-certs-after-inst-6816457ab95f
configure-docker-registry-certificate-after-installation-c519edbfe90a
oidc-client-dex-server-certificates-dc174462d51a
migrate-platform-certificates-to-use-cert-manager-c0b1727e4e5d

3
doc/source/_includes/cert-mgmt-ipv6-address-limitation-1a4504370674.rest → doc/source/shared/_includes/cert-mgmt-ipv6-address-limitation-1a4504370674.rest
View File

@ -1,6 +1,3 @@
---------------------------------------------------------------------------
Limitations for using IPv6 addresses related to management and OAM networks
---------------------------------------------------------------------------
Cert-manager accepts only short-hand IPv6 addresses.