System Configuration reorg

Organized SysConf Kubernetes and OpenStack content into subdirs and modified
index along lines of Planning layout.

Signed-off-by: Stone <ronald.stone@windriver.com>
Change-Id: Ia17c015b2083a39fcae4ac545fa10cb5445b4cb2
This commit is contained in:
Stone 2021-01-29 07:12:23 -05:00
parent 83e2dcd915
commit ecae991cca
38 changed files with 152 additions and 144 deletions

View File

@ -1,3 +1,5 @@
.. _sysconf_main_index:
==================== ====================
System Configuration System Configuration
==================== ====================
@ -6,139 +8,26 @@ System Configuration
StarlingX Kubernetes StarlingX Kubernetes
-------------------- --------------------
************************** |prod-long| system configuration can be done any time after installation
System Management Overview to change system configuration data specified during system installation,
************************** and to set additional system configuration data.
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
system-configuration-management-overview kubernetes/index.rst
**********************
Timezone Configuration
**********************
.. toctree::
:maxdepth: 2
changing-the-timezone-configuration
************************
DNS Server Configuration
************************
.. toctree::
:maxdepth: 2
specifying-dns-servers-using-horizon
specifying-dns-servers-using-the-cli
************************
NTP Server Configuration
************************
.. toctree::
:maxdepth: 2
configuring-ntp-servers-and-services-using-horizon
configuring-ntp-servers-and-services-using-the-cli
resynchronizing-a-host-to-the-ntp-server
************************
PTP Server Configuration
************************
.. toctree::
:maxdepth: 2
configuring-ptp-service-using-horizon
configuring-ptp-service-using-the-cli
********************
OAM IP Configuration
********************
.. toctree::
:maxdepth: 2
changing-the-oam-ip-configuration-using-horizon
changing-the-oam-ip-configuration-using-the-cli
modifying-oam-firewall-rules
changing-the-mtu-of-an-oam-interface-using-horizon
changing-the-mtu-of-an-oam-interface-using-the-cli
**********************
Application Management
**********************
.. toctree::
:maxdepth: 2
system-config-helm-package-manager
system-configuration-starlingx-application-package-manager
application-commands-and-helm-overrides
****************************************
Direct vs Switch-Based AIO Configuration
****************************************
.. toctree::
:maxdepth: 2
converting-a-duplex-system-to-direct-connection
converting-a-duplex-system-to-switch-based-connection
**************************
Customize Horizon Branding
**************************
.. toctree::
:maxdepth: 2
creating-a-custom-branding-tarball
applying-a-custom-branding-tarball-to-newly-installed-systems
applying-a-custom-branding-tarball-to-running-systems
*******************************
Customize Login Banner Branding
*******************************
.. toctree::
:maxdepth: 2
branding-the-login-banner-during-commissioning
branding-the-login-banner-on-a-commissioned-system
************************
Console Keyboard Mapping
************************
.. toctree::
:maxdepth: 2
console-keyboard-mapping
------------------- -------------------
StarlingX OpenStack StarlingX OpenStack
------------------- -------------------
******************************************************* |prod-os| is installed and managed as an Armada application.
Configure OpenStack Services Using Helm Chart Overrides
******************************************************* Armada Applications are a set of one or more interdependent Application Helm
Charts. In the case of |prod|, there is generally a Helm Chart for every
OpenStack service.
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 3
system-configuration-overview openstack/index.rst
creating-optional-telemetry-services
configuring-a-live-migration-completion-timeout-in-nova
configuring-a-pci-alias-in-nova
configuring-the-rpc-response-timeout-in-cinder
enabling-the-qos-extension-for-neutron
enabling-the-trunk-extension-for-neutron
using-helm-overrides-to-enable-internal-dns
adding-configuration-rpc-response-max-timeout-in-neutron-conf
assigning-a-dedicated-vlan-id-to-a-target-project-network

View File

@ -23,7 +23,7 @@ locked. This requires a swact during the procedure.
#. From the **Edit** menu for the standby controller, select **Lock Host**. #. From the **Edit** menu for the standby controller, select **Lock Host**.
.. figure:: figures/rst1442611298701.png .. figure:: ../figures/rst1442611298701.png
:scale: 100% :scale: 100%
#. Edit the |OAM| interface to change the |MTU| value. #. Edit the |OAM| interface to change the |MTU| value.
@ -42,7 +42,7 @@ locked. This requires a swact during the procedure.
From the **Edit** menu for the active controller, select **Swact Host**. From the **Edit** menu for the active controller, select **Swact Host**.
.. figure:: figures/psa1420751608971.png .. figure:: ../figures/psa1420751608971.png
:scale: 100% :scale: 100%
#. Lock the new standby controller. #. Lock the new standby controller.

View File

@ -42,14 +42,14 @@ and ensure that any existing system alarms are cleared.
The |OAM| IP page appears, showing the currently defined |OAM| network The |OAM| IP page appears, showing the currently defined |OAM| network
configuration. configuration.
.. figure:: figures/jow1413850481192.png .. figure:: ../figures/jow1413850481192.png
:scale: 100% :scale: 100%
#. Click **Edit OAM IP**. #. Click **Edit OAM IP**.
The Edit OAM IP dialog box appears. The Edit OAM IP dialog box appears.
.. figure:: figures/jow1413850497887.png .. figure:: ../figures/jow1413850497887.png
:scale: 100% :scale: 100%
#. Replace the IP Subnet and/or IP addresses with different ones as required. #. Replace the IP Subnet and/or IP addresses with different ones as required.

View File

@ -53,7 +53,7 @@ page and ensure that any existing system alarms are cleared.
The NTP page appears, showing the currently defined |NTP| servers. The NTP page appears, showing the currently defined |NTP| servers.
.. figure:: figures/jow1413850406811.png .. figure:: ../figures/jow1413850406811.png
:scale: 100% :scale: 100%
#. Click **Edit NTP**. #. Click **Edit NTP**.

View File

@ -0,0 +1,110 @@
.. _sysconf_kubernetes_index:
==========
Kubernetes
==========
----------------------
Timezone Configuration
----------------------
.. toctree::
:maxdepth: 2
changing-the-timezone-configuration
------------------------
DNS Server Configuration
------------------------
.. toctree::
:maxdepth: 2
specifying-dns-servers-using-horizon
specifying-dns-servers-using-the-cli
------------------------
NTP Server Configuration
------------------------
.. toctree::
:maxdepth: 2
configuring-ntp-servers-and-services-using-horizon
configuring-ntp-servers-and-services-using-the-cli
resynchronizing-a-host-to-the-ntp-server
------------------------
PTP Server Configuration
------------------------
.. toctree::
:maxdepth: 2
configuring-ptp-service-using-horizon
configuring-ptp-service-using-the-cli
--------------------
OAM IP Configuration
--------------------
.. toctree::
:maxdepth: 2
changing-the-oam-ip-configuration-using-horizon
changing-the-oam-ip-configuration-using-the-cli
modifying-oam-firewall-rules
changing-the-mtu-of-an-oam-interface-using-horizon
changing-the-mtu-of-an-oam-interface-using-the-cli
----------------------
Application Management
----------------------
.. toctree::
:maxdepth: 2
system-config-helm-package-manager
system-configuration-starlingx-application-package-manager
application-commands-and-helm-overrides
----------------------------------------
Direct vs Switch-Based AIO Configuration
----------------------------------------
.. toctree::
:maxdepth: 2
converting-a-duplex-system-to-direct-connection
converting-a-duplex-system-to-switch-based-connection
--------------------------
Customize Horizon Branding
--------------------------
.. toctree::
:maxdepth: 2
creating-a-custom-branding-tarball
applying-a-custom-branding-tarball-to-newly-installed-systems
applying-a-custom-branding-tarball-to-running-systems
-------------------------------
Customize Login Banner Branding
-------------------------------
.. toctree::
:maxdepth: 2
branding-the-login-banner-during-commissioning
branding-the-login-banner-on-a-commissioned-system
------------------------
Console Keyboard Mapping
------------------------
.. toctree::
:maxdepth: 2
console-keyboard-mapping

View File

@ -28,5 +28,5 @@ You can specify up to three DNS servers using the Horizon Web interface.
#. In the Edit DNS dialog box, add or edit the IP addresses, and then #. In the Edit DNS dialog box, add or edit the IP addresses, and then
click **Save**. click **Save**.
.. figure:: figures/jow1413850386429.png .. figure:: ../figures/jow1413850386429.png
:scale: 100% :scale: 100%

View File

@ -0,0 +1,23 @@
.. _sysconf_openstack_index:
===================
StarlingX OpenStack
===================
-------------------------------------------------------
Configure OpenStack Services Using Helm Chart Overrides
-------------------------------------------------------
.. toctree::
:maxdepth: 1
system-configuration-overview
creating-optional-telemetry-services
configuring-a-live-migration-completion-timeout-in-nova
configuring-a-pci-alias-in-nova
configuring-the-rpc-response-timeout-in-cinder
enabling-the-qos-extension-for-neutron
enabling-the-trunk-extension-for-neutron
using-helm-overrides-to-enable-internal-dns
adding-configuration-rpc-response-max-timeout-in-neutron-conf
assigning-a-dedicated-vlan-id-to-a-target-project-network

View File

@ -1,14 +0,0 @@
.. ewz1552673812105
.. _system-configuration-management-overview:
========================================
System Configuration Management Overview
========================================
|prod-long| system configuration can be done any time after installation
to change system configuration data specified during system installation,
and to set additional system configuration data.
.. xbooklink For details on accessing the system,
see |sec-doc|: `Access the System <configuring-local-cli-access>`