diff --git a/doc/source/system_configuration/index.rst b/doc/source/system_configuration/index.rst index f4d1439da..48f65c4d8 100644 --- a/doc/source/system_configuration/index.rst +++ b/doc/source/system_configuration/index.rst @@ -1,3 +1,5 @@ +.. _sysconf_main_index: + ==================== System Configuration ==================== @@ -6,139 +8,26 @@ System Configuration StarlingX Kubernetes -------------------- -************************** -System 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. .. toctree:: :maxdepth: 2 - system-configuration-management-overview - -********************** -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 - + kubernetes/index.rst ------------------- StarlingX OpenStack ------------------- -******************************************************* -Configure OpenStack Services Using Helm Chart Overrides -******************************************************* +|prod-os| is installed and managed as an Armada application. + +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:: - :maxdepth: 1 + :maxdepth: 3 - 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 + openstack/index.rst diff --git a/doc/source/system_configuration/application-commands-and-helm-overrides.rst b/doc/source/system_configuration/kubernetes/application-commands-and-helm-overrides.rst similarity index 100% rename from doc/source/system_configuration/application-commands-and-helm-overrides.rst rename to doc/source/system_configuration/kubernetes/application-commands-and-helm-overrides.rst diff --git a/doc/source/system_configuration/applying-a-custom-branding-tarball-to-newly-installed-systems.rst b/doc/source/system_configuration/kubernetes/applying-a-custom-branding-tarball-to-newly-installed-systems.rst similarity index 100% rename from doc/source/system_configuration/applying-a-custom-branding-tarball-to-newly-installed-systems.rst rename to doc/source/system_configuration/kubernetes/applying-a-custom-branding-tarball-to-newly-installed-systems.rst diff --git a/doc/source/system_configuration/applying-a-custom-branding-tarball-to-running-systems.rst b/doc/source/system_configuration/kubernetes/applying-a-custom-branding-tarball-to-running-systems.rst similarity index 100% rename from doc/source/system_configuration/applying-a-custom-branding-tarball-to-running-systems.rst rename to doc/source/system_configuration/kubernetes/applying-a-custom-branding-tarball-to-running-systems.rst diff --git a/doc/source/system_configuration/branding-the-login-banner-during-commissioning.rst b/doc/source/system_configuration/kubernetes/branding-the-login-banner-during-commissioning.rst similarity index 100% rename from doc/source/system_configuration/branding-the-login-banner-during-commissioning.rst rename to doc/source/system_configuration/kubernetes/branding-the-login-banner-during-commissioning.rst diff --git a/doc/source/system_configuration/branding-the-login-banner-on-a-commissioned-system.rst b/doc/source/system_configuration/kubernetes/branding-the-login-banner-on-a-commissioned-system.rst similarity index 100% rename from doc/source/system_configuration/branding-the-login-banner-on-a-commissioned-system.rst rename to doc/source/system_configuration/kubernetes/branding-the-login-banner-on-a-commissioned-system.rst diff --git a/doc/source/system_configuration/changing-the-mtu-of-an-oam-interface-using-horizon.rst b/doc/source/system_configuration/kubernetes/changing-the-mtu-of-an-oam-interface-using-horizon.rst similarity index 91% rename from doc/source/system_configuration/changing-the-mtu-of-an-oam-interface-using-horizon.rst rename to doc/source/system_configuration/kubernetes/changing-the-mtu-of-an-oam-interface-using-horizon.rst index c3325c954..cb9c6a24e 100644 --- a/doc/source/system_configuration/changing-the-mtu-of-an-oam-interface-using-horizon.rst +++ b/doc/source/system_configuration/kubernetes/changing-the-mtu-of-an-oam-interface-using-horizon.rst @@ -23,7 +23,7 @@ locked. This requires a swact during the procedure. #. From the **Edit** menu for the standby controller, select **Lock Host**. - .. figure:: figures/rst1442611298701.png + .. figure:: ../figures/rst1442611298701.png :scale: 100% #. 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**. - .. figure:: figures/psa1420751608971.png + .. figure:: ../figures/psa1420751608971.png :scale: 100% #. Lock the new standby controller. diff --git a/doc/source/system_configuration/changing-the-mtu-of-an-oam-interface-using-the-cli.rst b/doc/source/system_configuration/kubernetes/changing-the-mtu-of-an-oam-interface-using-the-cli.rst similarity index 100% rename from doc/source/system_configuration/changing-the-mtu-of-an-oam-interface-using-the-cli.rst rename to doc/source/system_configuration/kubernetes/changing-the-mtu-of-an-oam-interface-using-the-cli.rst diff --git a/doc/source/system_configuration/changing-the-oam-ip-configuration-using-horizon.rst b/doc/source/system_configuration/kubernetes/changing-the-oam-ip-configuration-using-horizon.rst similarity index 96% rename from doc/source/system_configuration/changing-the-oam-ip-configuration-using-horizon.rst rename to doc/source/system_configuration/kubernetes/changing-the-oam-ip-configuration-using-horizon.rst index 5df5fe6bf..9b76f880c 100644 --- a/doc/source/system_configuration/changing-the-oam-ip-configuration-using-horizon.rst +++ b/doc/source/system_configuration/kubernetes/changing-the-oam-ip-configuration-using-horizon.rst @@ -42,14 +42,14 @@ and ensure that any existing system alarms are cleared. The |OAM| IP page appears, showing the currently defined |OAM| network configuration. - .. figure:: figures/jow1413850481192.png + .. figure:: ../figures/jow1413850481192.png :scale: 100% #. Click **Edit OAM IP**. The Edit OAM IP dialog box appears. - .. figure:: figures/jow1413850497887.png + .. figure:: ../figures/jow1413850497887.png :scale: 100% #. Replace the IP Subnet and/or IP addresses with different ones as required. diff --git a/doc/source/system_configuration/changing-the-oam-ip-configuration-using-the-cli.rst b/doc/source/system_configuration/kubernetes/changing-the-oam-ip-configuration-using-the-cli.rst similarity index 100% rename from doc/source/system_configuration/changing-the-oam-ip-configuration-using-the-cli.rst rename to doc/source/system_configuration/kubernetes/changing-the-oam-ip-configuration-using-the-cli.rst diff --git a/doc/source/system_configuration/changing-the-timezone-configuration.rst b/doc/source/system_configuration/kubernetes/changing-the-timezone-configuration.rst similarity index 100% rename from doc/source/system_configuration/changing-the-timezone-configuration.rst rename to doc/source/system_configuration/kubernetes/changing-the-timezone-configuration.rst diff --git a/doc/source/system_configuration/configuring-ntp-servers-and-services-using-horizon.rst b/doc/source/system_configuration/kubernetes/configuring-ntp-servers-and-services-using-horizon.rst similarity index 98% rename from doc/source/system_configuration/configuring-ntp-servers-and-services-using-horizon.rst rename to doc/source/system_configuration/kubernetes/configuring-ntp-servers-and-services-using-horizon.rst index ae5006889..8b056fb1d 100644 --- a/doc/source/system_configuration/configuring-ntp-servers-and-services-using-horizon.rst +++ b/doc/source/system_configuration/kubernetes/configuring-ntp-servers-and-services-using-horizon.rst @@ -53,7 +53,7 @@ page and ensure that any existing system alarms are cleared. The NTP page appears, showing the currently defined |NTP| servers. - .. figure:: figures/jow1413850406811.png + .. figure:: ../figures/jow1413850406811.png :scale: 100% #. Click **Edit NTP**. diff --git a/doc/source/system_configuration/configuring-ntp-servers-and-services-using-the-cli.rst b/doc/source/system_configuration/kubernetes/configuring-ntp-servers-and-services-using-the-cli.rst similarity index 100% rename from doc/source/system_configuration/configuring-ntp-servers-and-services-using-the-cli.rst rename to doc/source/system_configuration/kubernetes/configuring-ntp-servers-and-services-using-the-cli.rst diff --git a/doc/source/system_configuration/configuring-ptp-service-using-horizon.rst b/doc/source/system_configuration/kubernetes/configuring-ptp-service-using-horizon.rst similarity index 100% rename from doc/source/system_configuration/configuring-ptp-service-using-horizon.rst rename to doc/source/system_configuration/kubernetes/configuring-ptp-service-using-horizon.rst diff --git a/doc/source/system_configuration/configuring-ptp-service-using-the-cli.rst b/doc/source/system_configuration/kubernetes/configuring-ptp-service-using-the-cli.rst similarity index 100% rename from doc/source/system_configuration/configuring-ptp-service-using-the-cli.rst rename to doc/source/system_configuration/kubernetes/configuring-ptp-service-using-the-cli.rst diff --git a/doc/source/system_configuration/console-keyboard-mapping.rst b/doc/source/system_configuration/kubernetes/console-keyboard-mapping.rst similarity index 100% rename from doc/source/system_configuration/console-keyboard-mapping.rst rename to doc/source/system_configuration/kubernetes/console-keyboard-mapping.rst diff --git a/doc/source/system_configuration/converting-a-duplex-system-to-direct-connection.rst b/doc/source/system_configuration/kubernetes/converting-a-duplex-system-to-direct-connection.rst similarity index 100% rename from doc/source/system_configuration/converting-a-duplex-system-to-direct-connection.rst rename to doc/source/system_configuration/kubernetes/converting-a-duplex-system-to-direct-connection.rst diff --git a/doc/source/system_configuration/converting-a-duplex-system-to-switch-based-connection.rst b/doc/source/system_configuration/kubernetes/converting-a-duplex-system-to-switch-based-connection.rst similarity index 100% rename from doc/source/system_configuration/converting-a-duplex-system-to-switch-based-connection.rst rename to doc/source/system_configuration/kubernetes/converting-a-duplex-system-to-switch-based-connection.rst diff --git a/doc/source/system_configuration/creating-a-custom-branding-tarball.rst b/doc/source/system_configuration/kubernetes/creating-a-custom-branding-tarball.rst similarity index 100% rename from doc/source/system_configuration/creating-a-custom-branding-tarball.rst rename to doc/source/system_configuration/kubernetes/creating-a-custom-branding-tarball.rst diff --git a/doc/source/system_configuration/kubernetes/index.rst b/doc/source/system_configuration/kubernetes/index.rst new file mode 100644 index 000000000..911d3b56f --- /dev/null +++ b/doc/source/system_configuration/kubernetes/index.rst @@ -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 diff --git a/doc/source/system_configuration/modifying-oam-firewall-rules.rst b/doc/source/system_configuration/kubernetes/modifying-oam-firewall-rules.rst similarity index 100% rename from doc/source/system_configuration/modifying-oam-firewall-rules.rst rename to doc/source/system_configuration/kubernetes/modifying-oam-firewall-rules.rst diff --git a/doc/source/system_configuration/resynchronizing-a-host-to-the-ntp-server.rst b/doc/source/system_configuration/kubernetes/resynchronizing-a-host-to-the-ntp-server.rst similarity index 100% rename from doc/source/system_configuration/resynchronizing-a-host-to-the-ntp-server.rst rename to doc/source/system_configuration/kubernetes/resynchronizing-a-host-to-the-ntp-server.rst diff --git a/doc/source/system_configuration/specifying-dns-servers-using-horizon.rst b/doc/source/system_configuration/kubernetes/specifying-dns-servers-using-horizon.rst similarity index 92% rename from doc/source/system_configuration/specifying-dns-servers-using-horizon.rst rename to doc/source/system_configuration/kubernetes/specifying-dns-servers-using-horizon.rst index 36e409a96..5e9efa874 100644 --- a/doc/source/system_configuration/specifying-dns-servers-using-horizon.rst +++ b/doc/source/system_configuration/kubernetes/specifying-dns-servers-using-horizon.rst @@ -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 click **Save**. - .. figure:: figures/jow1413850386429.png + .. figure:: ../figures/jow1413850386429.png :scale: 100% \ No newline at end of file diff --git a/doc/source/system_configuration/specifying-dns-servers-using-the-cli.rst b/doc/source/system_configuration/kubernetes/specifying-dns-servers-using-the-cli.rst similarity index 100% rename from doc/source/system_configuration/specifying-dns-servers-using-the-cli.rst rename to doc/source/system_configuration/kubernetes/specifying-dns-servers-using-the-cli.rst diff --git a/doc/source/system_configuration/system-config-helm-package-manager.rst b/doc/source/system_configuration/kubernetes/system-config-helm-package-manager.rst similarity index 100% rename from doc/source/system_configuration/system-config-helm-package-manager.rst rename to doc/source/system_configuration/kubernetes/system-config-helm-package-manager.rst diff --git a/doc/source/system_configuration/system-configuration-starlingx-application-package-manager.rst b/doc/source/system_configuration/kubernetes/system-configuration-starlingx-application-package-manager.rst similarity index 100% rename from doc/source/system_configuration/system-configuration-starlingx-application-package-manager.rst rename to doc/source/system_configuration/kubernetes/system-configuration-starlingx-application-package-manager.rst diff --git a/doc/source/system_configuration/adding-configuration-rpc-response-max-timeout-in-neutron-conf.rst b/doc/source/system_configuration/openstack/adding-configuration-rpc-response-max-timeout-in-neutron-conf.rst similarity index 100% rename from doc/source/system_configuration/adding-configuration-rpc-response-max-timeout-in-neutron-conf.rst rename to doc/source/system_configuration/openstack/adding-configuration-rpc-response-max-timeout-in-neutron-conf.rst diff --git a/doc/source/system_configuration/assigning-a-dedicated-vlan-id-to-a-target-project-network.rst b/doc/source/system_configuration/openstack/assigning-a-dedicated-vlan-id-to-a-target-project-network.rst similarity index 100% rename from doc/source/system_configuration/assigning-a-dedicated-vlan-id-to-a-target-project-network.rst rename to doc/source/system_configuration/openstack/assigning-a-dedicated-vlan-id-to-a-target-project-network.rst diff --git a/doc/source/system_configuration/configuring-a-live-migration-completion-timeout-in-nova.rst b/doc/source/system_configuration/openstack/configuring-a-live-migration-completion-timeout-in-nova.rst similarity index 100% rename from doc/source/system_configuration/configuring-a-live-migration-completion-timeout-in-nova.rst rename to doc/source/system_configuration/openstack/configuring-a-live-migration-completion-timeout-in-nova.rst diff --git a/doc/source/system_configuration/configuring-a-pci-alias-in-nova.rst b/doc/source/system_configuration/openstack/configuring-a-pci-alias-in-nova.rst similarity index 100% rename from doc/source/system_configuration/configuring-a-pci-alias-in-nova.rst rename to doc/source/system_configuration/openstack/configuring-a-pci-alias-in-nova.rst diff --git a/doc/source/system_configuration/configuring-the-rpc-response-timeout-in-cinder.rst b/doc/source/system_configuration/openstack/configuring-the-rpc-response-timeout-in-cinder.rst similarity index 100% rename from doc/source/system_configuration/configuring-the-rpc-response-timeout-in-cinder.rst rename to doc/source/system_configuration/openstack/configuring-the-rpc-response-timeout-in-cinder.rst diff --git a/doc/source/system_configuration/creating-optional-telemetry-services.rst b/doc/source/system_configuration/openstack/creating-optional-telemetry-services.rst similarity index 100% rename from doc/source/system_configuration/creating-optional-telemetry-services.rst rename to doc/source/system_configuration/openstack/creating-optional-telemetry-services.rst diff --git a/doc/source/system_configuration/enabling-the-qos-extension-for-neutron.rst b/doc/source/system_configuration/openstack/enabling-the-qos-extension-for-neutron.rst similarity index 100% rename from doc/source/system_configuration/enabling-the-qos-extension-for-neutron.rst rename to doc/source/system_configuration/openstack/enabling-the-qos-extension-for-neutron.rst diff --git a/doc/source/system_configuration/enabling-the-trunk-extension-for-neutron.rst b/doc/source/system_configuration/openstack/enabling-the-trunk-extension-for-neutron.rst similarity index 100% rename from doc/source/system_configuration/enabling-the-trunk-extension-for-neutron.rst rename to doc/source/system_configuration/openstack/enabling-the-trunk-extension-for-neutron.rst diff --git a/doc/source/system_configuration/openstack/index.rst b/doc/source/system_configuration/openstack/index.rst new file mode 100644 index 000000000..664e72be8 --- /dev/null +++ b/doc/source/system_configuration/openstack/index.rst @@ -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 diff --git a/doc/source/system_configuration/system-configuration-overview.rst b/doc/source/system_configuration/openstack/system-configuration-overview.rst similarity index 100% rename from doc/source/system_configuration/system-configuration-overview.rst rename to doc/source/system_configuration/openstack/system-configuration-overview.rst diff --git a/doc/source/system_configuration/using-helm-overrides-to-enable-internal-dns.rst b/doc/source/system_configuration/openstack/using-helm-overrides-to-enable-internal-dns.rst similarity index 100% rename from doc/source/system_configuration/using-helm-overrides-to-enable-internal-dns.rst rename to doc/source/system_configuration/openstack/using-helm-overrides-to-enable-internal-dns.rst diff --git a/doc/source/system_configuration/system-configuration-management-overview.rst b/doc/source/system_configuration/system-configuration-management-overview.rst deleted file mode 100644 index 79bafda42..000000000 --- a/doc/source/system_configuration/system-configuration-management-overview.rst +++ /dev/null @@ -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 ` \ No newline at end of file