From 859e0754e95538df3997dcbb9e054224a46be153 Mon Sep 17 00:00:00 2001 From: Ron Stone Date: Fri, 29 Jul 2022 14:04:38 -0400 Subject: [PATCH] Openstack installation updates See launchpad for details. Review updates Resolve merge conflicts. Address additional review comments. Closes Bug: 1981827 Signed-off-by: Ron Stone Change-Id: Icd14460ef47c5d1008a503a66fd8844d21bfa0a3 --- .../index-install-e083ca818006.rst | 22 +++++++--- .../index-install-r6-8966076f0e81.rst | 12 +++++- .../index-install-r6-os-adc44604968c.rst | 1 - .../r6_release/openstack/install.rst | 40 ++++++++++++++++++- .../r7_release/openstack/install.rst | 4 +- 5 files changed, 66 insertions(+), 13 deletions(-) diff --git a/doc/source/deploy_install_guides/index-install-e083ca818006.rst b/doc/source/deploy_install_guides/index-install-e083ca818006.rst index bd04b378a..518074a27 100644 --- a/doc/source/deploy_install_guides/index-install-e083ca818006.rst +++ b/doc/source/deploy_install_guides/index-install-e083ca818006.rst @@ -8,11 +8,20 @@ Installation and deployment guides for StarlingX are release-specific. Each guide provides instruction on a specific StarlingX configuration (e.g. All-in-one Simplex). +---------------- +Upcoming release +---------------- + +The next release will be R8.0. Use the documentation for the R7.0 +installation listed below. + ------------------------- -Upcoming release (latest) +Current release (latest) ------------------------- -StarlingX R8.0 is under development. +StarlingX R7.0 is the most recent supported release of StarlingX. + +Use the R7.0 Installation Guides to install R7.0. .. toctree:: :maxdepth: 1 @@ -24,15 +33,16 @@ StarlingX R8.0 is under development. Supported release ----------------- -StarlingX R7.0 is the most recent supported release of StarlingX. - -Use the R7.0 Installation Guides to install R7.0. .. toctree:: :maxdepth: 1 r7_release/index-install-r7-8966076f0e81 +-------------- +Older releases +-------------- + Use the R6.0 Installation Guides to install R6.0. @@ -47,7 +57,7 @@ Archived releases ----------------- To view the archived installation guides, see `Installation guides for R5.0 and -older releases `_. +older releases `_. diff --git a/doc/source/deploy_install_guides/r6_release/index-install-r6-8966076f0e81.rst b/doc/source/deploy_install_guides/r6_release/index-install-r6-8966076f0e81.rst index 46e1d80c8..85867fd34 100644 --- a/doc/source/deploy_install_guides/r6_release/index-install-r6-8966076f0e81.rst +++ b/doc/source/deploy_install_guides/r6_release/index-install-r6-8966076f0e81.rst @@ -127,6 +127,15 @@ Access Kubernetes kubernetes_access +--------------------------- +Install StarlingX OpenStack +--------------------------- + +.. toctree:: + :maxdepth: 1 + + openstack/index-install-r6-os-adc44604968c + -------------------------- Access StarlingX OpenStack -------------------------- @@ -134,5 +143,4 @@ Access StarlingX OpenStack .. toctree:: :maxdepth: 1 - openstack/index-install-r6-os-adc44604968c - + openstack/access diff --git a/doc/source/deploy_install_guides/r6_release/openstack/index-install-r6-os-adc44604968c.rst b/doc/source/deploy_install_guides/r6_release/openstack/index-install-r6-os-adc44604968c.rst index 1f7c5f501..64f4199f2 100644 --- a/doc/source/deploy_install_guides/r6_release/openstack/index-install-r6-os-adc44604968c.rst +++ b/doc/source/deploy_install_guides/r6_release/openstack/index-install-r6-os-adc44604968c.rst @@ -14,7 +14,6 @@ StarlingX is independent of deployment configuration. :maxdepth: 2 install - access uninstall_delete -------------- diff --git a/doc/source/deploy_install_guides/r6_release/openstack/install.rst b/doc/source/deploy_install_guides/r6_release/openstack/install.rst index 015478d15..dde41825c 100644 --- a/doc/source/deploy_install_guides/r6_release/openstack/install.rst +++ b/doc/source/deploy_install_guides/r6_release/openstack/install.rst @@ -48,7 +48,7 @@ Install application manifest and helm-charts After you select a release, helm charts are located in ``centos/outputs/helm-charts``. #. Load the |prefix|-openstack application's package into StarlingX. The tarball - package contains |prefix|-openstack's FluxCD manifest and + package contains |prefix|-openstack's manifest and |prefix|-openstack's set of helm charts. For example: .. parsed-literal:: @@ -57,12 +57,48 @@ Install application manifest and helm-charts This will: - * Load the FluxCD manifest and helm charts. + * Load the manifest and helm charts. * Internally manage helm chart override values for each chart. * Automatically generate system helm chart overrides for each chart based on the current state of the underlying StarlingX Kubernetes platform and the recommended StarlingX configuration of OpenStack services. + +#. OPTIONAL: In order to enable secure HTTPS connectivity for OpenStack REST + APIs and OpenStack Horizon, install an HTTPS Certificate for OpenStack. + + #. Obtain an Intermediate or Root CA-signed certificate and key from a + trusted Intermediate or Root CA. The OpenStack certificate should be + created with a wildcard SAN, e.g. + + .. code-block:: + + X509v3 extensions: + X509v3 Subject Alternative Name: + DNS:*.my-wro.my-company.com + + #. Put the PEM encoded versions of the openstack certificate and key in a + single file (e.g. ``openstack-cert-key.pem``), and put the certificate of + the Root CA in a separate file (e.g. ``openstack-ca-cert.pem``), and copy + the files to the controller host. + + #. Install/update this certificate as the OpenStack REST API / Horizon + certificate: + + .. code-block:: + + ~(keystone_admin)]$ system certificate-install -m ssl_ca openstack-ca-cert.pem + ~(keystone_admin)]$ system certificate-install -m openstack_ca openstack-ca-cert.pem + ~(keystone_admin)]$ system certificate-install -m openstack openstack-cert-key.pem + + The above command will make the appropriate overrides to the OpenStack + Helm Charts to enable HTTPS on the OpenStack Services REST API + endpoints. + +#. OPTIONAL: Configure the domain name. + + For details, see :ref:`update-the-domain-name`. + #. Apply the |prefix|-openstack application in order to bring StarlingX OpenStack into service. If your environment is preconfigured with a proxy server, then make sure HTTPS proxy is set before applying |prefix|-openstack. diff --git a/doc/source/deploy_install_guides/r7_release/openstack/install.rst b/doc/source/deploy_install_guides/r7_release/openstack/install.rst index 2cfc62e96..d061adb7d 100644 --- a/doc/source/deploy_install_guides/r7_release/openstack/install.rst +++ b/doc/source/deploy_install_guides/r7_release/openstack/install.rst @@ -48,7 +48,7 @@ Install application manifest and helm-charts After you select a release, helm charts are located in ``centos/outputs/helm-charts``. #. Load the |prefix|-openstack application's package into StarlingX. The tarball - package contains |prefix|-openstack's FluxCD manifest and + package contains |prefix|-openstack's manifest and |prefix|-openstack's set of helm charts. For example: .. parsed-literal:: @@ -57,7 +57,7 @@ Install application manifest and helm-charts This will: - * Load the FluxCD manifest and helm charts. + * Load the manifest and helm charts. * Internally manage helm chart override values for each chart. * Automatically generate system helm chart overrides for each chart based on the current state of the underlying StarlingX Kubernetes platform and the