From ddc00dd83462dcbe6a0c94edab4db3157e774741 Mon Sep 17 00:00:00 2001 From: MCamp859 Date: Wed, 8 Dec 2021 14:25:15 -0500 Subject: [PATCH] Create archive for old config guides Created archive folder and moved old config guides. Added links to replacement guides in old guides/stubs. Change-Id: I0a911497aacf9b741d41524d11262531c5c17f53 Signed-off-by: MCamp859 --- .../configuration/brand_config.rst | 6 ++ .../configuration/cert_config.rst | 5 ++ .../configuration/figures/k8s_auth_login.png | Bin .../configuration/host_config.rst | 5 ++ .../host_interface_network_config.rst | 4 ++ doc/source/archive/configuration/index.rst | 52 +++++++++++++++ .../configuration/intel_n3000_fpga.rst | 4 ++ .../configuration/k8s_auth_winactivedir.rst | 5 ++ .../configuration/k8s_persistent_vol.rst | 5 ++ .../configuration/k8s_pod_sec_policies.rst | 4 ++ .../configuration/k8s_res_policies.rst | 4 ++ .../configuration/k8s_upgrade.rst | 4 ++ .../configuration/openstack_cinder_config.rst | 5 ++ .../configuration/openstack_ironic_config.rst | 6 ++ .../configuration/openstack_swift_config.rst | 5 ++ .../configuration/system_config.rst | 6 ++ .../configuration/time_sync_config.rst | 5 ++ ...dex-documentation-archive-900988dce206.rst | 21 ++++++ doc/source/cli_ref/system.rst | 2 +- doc/source/configuration/index.rst | 61 +++++------------- .../contributor/doc_contribute_guide.rst | 2 +- doc/source/index.rst | 14 ++-- doc/source/releasenotes/r4_release.rst | 8 +-- 23 files changed, 175 insertions(+), 58 deletions(-) rename doc/source/{ => archive}/configuration/brand_config.rst (72%) rename doc/source/{ => archive}/configuration/cert_config.rst (96%) rename doc/source/{ => archive}/configuration/figures/k8s_auth_login.png (100%) rename doc/source/{ => archive}/configuration/host_config.rst (79%) rename doc/source/{ => archive}/configuration/host_interface_network_config.rst (95%) create mode 100644 doc/source/archive/configuration/index.rst rename doc/source/{ => archive}/configuration/intel_n3000_fpga.rst (96%) rename doc/source/{ => archive}/configuration/k8s_auth_winactivedir.rst (95%) rename doc/source/{ => archive}/configuration/k8s_persistent_vol.rst (78%) rename doc/source/{ => archive}/configuration/k8s_pod_sec_policies.rst (95%) rename doc/source/{ => archive}/configuration/k8s_res_policies.rst (93%) rename doc/source/{ => archive}/configuration/k8s_upgrade.rst (97%) rename doc/source/{ => archive}/configuration/openstack_cinder_config.rst (92%) rename doc/source/{ => archive}/configuration/openstack_ironic_config.rst (76%) rename doc/source/{ => archive}/configuration/openstack_swift_config.rst (75%) rename doc/source/{ => archive}/configuration/system_config.rst (79%) rename doc/source/{ => archive}/configuration/time_sync_config.rst (75%) create mode 100644 doc/source/archive/index-documentation-archive-900988dce206.rst diff --git a/doc/source/configuration/brand_config.rst b/doc/source/archive/configuration/brand_config.rst similarity index 72% rename from doc/source/configuration/brand_config.rst rename to doc/source/archive/configuration/brand_config.rst index b798412ce..4709bcb4f 100644 --- a/doc/source/configuration/brand_config.rst +++ b/doc/source/archive/configuration/brand_config.rst @@ -2,6 +2,12 @@ Branding Configuration ====================== +.. note:: + + This guide was replaced by: + :ref:`Brand the Login Banner During Commissioning ` + + This is a stub page for the topic: Branding Configuration. You can help StarlingX by expanding the content. diff --git a/doc/source/configuration/cert_config.rst b/doc/source/archive/configuration/cert_config.rst similarity index 96% rename from doc/source/configuration/cert_config.rst rename to doc/source/archive/configuration/cert_config.rst index 289b6a13f..48ea16693 100644 --- a/doc/source/configuration/cert_config.rst +++ b/doc/source/archive/configuration/cert_config.rst @@ -2,6 +2,11 @@ Certificate Configuration ========================= +.. note:: + + This guide was replaced by: + :ref:`HTTPS and Certificates Management Overview ` + This guide describes how to enable secure HTTPS access and manage certificates using StarlingX. diff --git a/doc/source/configuration/figures/k8s_auth_login.png b/doc/source/archive/configuration/figures/k8s_auth_login.png similarity index 100% rename from doc/source/configuration/figures/k8s_auth_login.png rename to doc/source/archive/configuration/figures/k8s_auth_login.png diff --git a/doc/source/configuration/host_config.rst b/doc/source/archive/configuration/host_config.rst similarity index 79% rename from doc/source/configuration/host_config.rst rename to doc/source/archive/configuration/host_config.rst index 96d6e488a..a9afa17e5 100644 --- a/doc/source/configuration/host_config.rst +++ b/doc/source/archive/configuration/host_config.rst @@ -2,6 +2,11 @@ Host Configuration ================== +.. note:: + + This guide was replaced by: + :doc:`Node Management Guide ` + This is a stub page for the topic: Host Configuration. You can help StarlingX by expanding the content. diff --git a/doc/source/configuration/host_interface_network_config.rst b/doc/source/archive/configuration/host_interface_network_config.rst similarity index 95% rename from doc/source/configuration/host_interface_network_config.rst rename to doc/source/archive/configuration/host_interface_network_config.rst index 87d7ccb36..80fbd1669 100644 --- a/doc/source/configuration/host_interface_network_config.rst +++ b/doc/source/archive/configuration/host_interface_network_config.rst @@ -2,6 +2,10 @@ Host Interface and Network Configuration ======================================== +.. note:: + + This guide was replaced by: :doc:`Node Management Guide ` + This guide describes the following: .. contents:: diff --git a/doc/source/archive/configuration/index.rst b/doc/source/archive/configuration/index.rst new file mode 100644 index 000000000..82b5e7d82 --- /dev/null +++ b/doc/source/archive/configuration/index.rst @@ -0,0 +1,52 @@ +============= +Configuration +============= + +.. note:: + + These guides are deprecated and no longer maintained. Links to replacement + guides (if applicable) are included within each guide. + + +--------------------- +General Configuration +--------------------- + +.. toctree:: + :maxdepth: 1 + + brand_config + cert_config + host_config + host_interface_network_config + intel_n3000_fpga + system_config + time_sync_config + + + +------------------------ +Kubernetes Configuration +------------------------ + +.. toctree:: + :maxdepth: 1 + + k8s_auth_winactivedir + k8s_persistent_vol + k8s_pod_sec_policies + k8s_res_policies + k8s_upgrade + +----------------------- +OpenStack Configuration +----------------------- + +.. toctree:: + :maxdepth: 1 + + openstack_cinder_config + openstack_ironic_config + openstack_swift_config + + diff --git a/doc/source/configuration/intel_n3000_fpga.rst b/doc/source/archive/configuration/intel_n3000_fpga.rst similarity index 96% rename from doc/source/configuration/intel_n3000_fpga.rst rename to doc/source/archive/configuration/intel_n3000_fpga.rst index f6a07d5ba..8ea31fc9c 100644 --- a/doc/source/configuration/intel_n3000_fpga.rst +++ b/doc/source/archive/configuration/intel_n3000_fpga.rst @@ -2,6 +2,10 @@ Host FPGA Configuration - Intel N3000 ===================================== +.. note:: + + This guide was replaced by: :ref:`N3000 FPGA Overview ` + This guide describes how to configure and integrate an Intel N3000 |FPGA| |PAC| on StarlingX. diff --git a/doc/source/configuration/k8s_auth_winactivedir.rst b/doc/source/archive/configuration/k8s_auth_winactivedir.rst similarity index 95% rename from doc/source/configuration/k8s_auth_winactivedir.rst rename to doc/source/archive/configuration/k8s_auth_winactivedir.rst index e8adf0fe7..2a47982d5 100644 --- a/doc/source/configuration/k8s_auth_winactivedir.rst +++ b/doc/source/archive/configuration/k8s_auth_winactivedir.rst @@ -2,6 +2,11 @@ Authenticate Kubernetes Users with Windows Active Directory Server ================================================================== +.. note:: + + This guide was replaced by: + :ref:`Overview of Windows Active Directory ` + This guide describes how to authenticate users of the Kubernetes API via a remote Windows Active Directory server, using the oidc-auth-apps application. diff --git a/doc/source/configuration/k8s_persistent_vol.rst b/doc/source/archive/configuration/k8s_persistent_vol.rst similarity index 78% rename from doc/source/configuration/k8s_persistent_vol.rst rename to doc/source/archive/configuration/k8s_persistent_vol.rst index eac040aae..7f6bcf08c 100644 --- a/doc/source/configuration/k8s_persistent_vol.rst +++ b/doc/source/archive/configuration/k8s_persistent_vol.rst @@ -2,6 +2,11 @@ Persistent Volume Configuration =============================== +.. note:: + + This guide was replaced by: + :ref:`About Persistent Volume Support ` + This is a stub page for the topic: Configuring Persistent Volume Support. You can help StarlingX by expanding the content. diff --git a/doc/source/configuration/k8s_pod_sec_policies.rst b/doc/source/archive/configuration/k8s_pod_sec_policies.rst similarity index 95% rename from doc/source/configuration/k8s_pod_sec_policies.rst rename to doc/source/archive/configuration/k8s_pod_sec_policies.rst index 516e15c32..046e37f62 100644 --- a/doc/source/configuration/k8s_pod_sec_policies.rst +++ b/doc/source/archive/configuration/k8s_pod_sec_policies.rst @@ -2,6 +2,10 @@ Pod Security Policies ===================== +.. note:: + + This guide was replaced by: :ref:`Pod Security Policies ` + This guide describes how to enable Kubernetes pod security policies. .. contents:: diff --git a/doc/source/configuration/k8s_res_policies.rst b/doc/source/archive/configuration/k8s_res_policies.rst similarity index 93% rename from doc/source/configuration/k8s_res_policies.rst rename to doc/source/archive/configuration/k8s_res_policies.rst index ead399bb5..8debf2b58 100644 --- a/doc/source/configuration/k8s_res_policies.rst +++ b/doc/source/archive/configuration/k8s_res_policies.rst @@ -2,6 +2,10 @@ Resource Policies ================= +.. note:: + + This guide was replaced by: :ref:`Resource Management ` + This guide describes two Kubernetes resource policies, LimitRange and ResourceQuota, which are enabled by default on StarlingX. diff --git a/doc/source/configuration/k8s_upgrade.rst b/doc/source/archive/configuration/k8s_upgrade.rst similarity index 97% rename from doc/source/configuration/k8s_upgrade.rst rename to doc/source/archive/configuration/k8s_upgrade.rst index eb3a0ee26..f30d45a8c 100644 --- a/doc/source/configuration/k8s_upgrade.rst +++ b/doc/source/archive/configuration/k8s_upgrade.rst @@ -2,6 +2,10 @@ Upgrade Kubernetes version ========================== +.. note:: + + This guide was replaced by: :ref:`Manual Kubernetes Version Upgrade ` + This section describes how to upgrade the components on a system running StarlingX from one supported version of Kubernetes (K8s) to another supported version. diff --git a/doc/source/configuration/openstack_cinder_config.rst b/doc/source/archive/configuration/openstack_cinder_config.rst similarity index 92% rename from doc/source/configuration/openstack_cinder_config.rst rename to doc/source/archive/configuration/openstack_cinder_config.rst index b0a170a0a..6abb0c2a4 100644 --- a/doc/source/configuration/openstack_cinder_config.rst +++ b/doc/source/archive/configuration/openstack_cinder_config.rst @@ -2,6 +2,11 @@ OpenStack Cinder File System Configuration ========================================== +.. note:: + + This guide was replaced by: + :ref:`Configure the Optional Image Conversion File System ` + This guide describes an optional file system that can be used by Cinder to convert qcow2 images to raw format. diff --git a/doc/source/configuration/openstack_ironic_config.rst b/doc/source/archive/configuration/openstack_ironic_config.rst similarity index 76% rename from doc/source/configuration/openstack_ironic_config.rst rename to doc/source/archive/configuration/openstack_ironic_config.rst index 9d06cfddc..334a0164f 100644 --- a/doc/source/configuration/openstack_ironic_config.rst +++ b/doc/source/archive/configuration/openstack_ironic_config.rst @@ -2,6 +2,12 @@ OpenStack Ironic Configuration ============================== +.. note:: + + This guide was replaced by: + :ref:`Configure OpenStack Services Using Helm Chart Overrides ` + + This is a stub page for the topic: OpenStack Ironic Configuration and Management. You can help StarlingX by expanding the content. diff --git a/doc/source/configuration/openstack_swift_config.rst b/doc/source/archive/configuration/openstack_swift_config.rst similarity index 75% rename from doc/source/configuration/openstack_swift_config.rst rename to doc/source/archive/configuration/openstack_swift_config.rst index f6bb5e820..f51ce2b45 100644 --- a/doc/source/configuration/openstack_swift_config.rst +++ b/doc/source/archive/configuration/openstack_swift_config.rst @@ -2,6 +2,11 @@ OpenStack Swift Configuration ============================= +.. note:: + + This guide was replaced by: + :ref:`Configure OpenStack Services Using Helm Chart Overrides ` + This is a stub page for the topic: OpenStack Swift Configuration. You can help StarlingX by expanding the content. diff --git a/doc/source/configuration/system_config.rst b/doc/source/archive/configuration/system_config.rst similarity index 79% rename from doc/source/configuration/system_config.rst rename to doc/source/archive/configuration/system_config.rst index 6ef176cf0..d2d1d5b0b 100644 --- a/doc/source/configuration/system_config.rst +++ b/doc/source/archive/configuration/system_config.rst @@ -2,6 +2,12 @@ System Configuration ===================== +.. note:: + + This guide was replaced by: + :ref:`System Configuration Guide ` + + This is a stub page for the topic: System Configuration. You can help StarlingX by expanding the content. diff --git a/doc/source/configuration/time_sync_config.rst b/doc/source/archive/configuration/time_sync_config.rst similarity index 75% rename from doc/source/configuration/time_sync_config.rst rename to doc/source/archive/configuration/time_sync_config.rst index fb873a52a..c41dff343 100644 --- a/doc/source/configuration/time_sync_config.rst +++ b/doc/source/archive/configuration/time_sync_config.rst @@ -2,6 +2,11 @@ Time Synchronization Configuration ================================== +.. note:: + + This guide was replaced by: + :ref:`Configure NTP Servers Using Horizon ` + This is a stub page for the topic: Time Synchronization Configuration. You can help StarlingX by expanding the content. diff --git a/doc/source/archive/index-documentation-archive-900988dce206.rst b/doc/source/archive/index-documentation-archive-900988dce206.rst new file mode 100644 index 000000000..e24b4f1a8 --- /dev/null +++ b/doc/source/archive/index-documentation-archive-900988dce206.rst @@ -0,0 +1,21 @@ +.. _index-documentation-archive-900988dce206: + +===================== +Documentation Archive +===================== + +.. note:: + + These guides are deprecated and no longer maintained. Links to replacement + guides (if applicable) are included within each guide. + + +************* +Configuration +************* + +.. toctree:: + :maxdepth: 2 + + configuration/index + diff --git a/doc/source/cli_ref/system.rst b/doc/source/cli_ref/system.rst index 1771c52c0..d835f3d0b 100644 --- a/doc/source/cli_ref/system.rst +++ b/doc/source/cli_ref/system.rst @@ -985,7 +985,7 @@ Kubernetes version upgrade The following set of commands allow you to upgrade the version of Kubernetes. For more information, see -:doc:`Kubernetes upgrade `. +:ref:`Manual Kubernetes Version Upgrade `. ``kube-host-upgrade`` Perform Kubernetes upgrade for a host. diff --git a/doc/source/configuration/index.rst b/doc/source/configuration/index.rst index 5fb6e1cc7..18f3b2cba 100644 --- a/doc/source/configuration/index.rst +++ b/doc/source/configuration/index.rst @@ -1,45 +1,16 @@ -============= -Configuration -============= - ---------------------- -General Configuration ---------------------- - -.. toctree:: - :maxdepth: 1 - - brand_config - cert_config - host_config - host_interface_network_config - intel_n3000_fpga - docker_proxy_config - system_config - time_sync_config - ------------------------- -Kubernetes Configuration ------------------------- - -.. toctree:: - :maxdepth: 1 - - k8s_auth_winactivedir - k8s_persistent_vol - k8s_pod_sec_policies - k8s_res_policies - k8s_upgrade - ------------------------ -OpenStack Configuration ------------------------ - -.. toctree:: - :maxdepth: 1 - - openstack_cinder_config - openstack_ironic_config - openstack_swift_config - - +============= +Configuration +============= + +.. note:: + + The guides in this folder were moved to + :ref:`Documentation archive `. + + +.. toctree:: + :maxdepth: 1 + :hidden: + + docker_proxy_config + diff --git a/doc/source/contributor/doc_contribute_guide.rst b/doc/source/contributor/doc_contribute_guide.rst index ac9a6eef0..fe4072d12 100644 --- a/doc/source/contributor/doc_contribute_guide.rst +++ b/doc/source/contributor/doc_contribute_guide.rst @@ -84,7 +84,7 @@ Documentation for StarlingX is organized into the following sections: :doc:`/deploy_install_guides/index` Release-specific installation and deployment guides. -:doc:`/configuration/index` +:doc:`/archive/configuration/index` Configuration references for post-installation StarlingX system configuration. :doc:`/operations/index` diff --git a/doc/source/index.rst b/doc/source/index.rst index 91e34a92e..11903dc0b 100755 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -200,20 +200,20 @@ Deprecated guides The guides listed here have been replaced by new guides that provide more details. -************* -Configuration -************* .. toctree:: :maxdepth: 2 + archive/index-documentation-archive-900988dce206 + + +.. toctree:: + :maxdepth: 1 + :hidden: + configuration/index -**************** -Operation guides -**************** - .. toctree:: :maxdepth: 2 diff --git a/doc/source/releasenotes/r4_release.rst b/doc/source/releasenotes/r4_release.rst index e4631fdfe..ccb6c0df8 100644 --- a/doc/source/releasenotes/r4_release.rst +++ b/doc/source/releasenotes/r4_release.rst @@ -44,7 +44,7 @@ associated user guides (if applicable). card's firmware. Guide: :doc:`Host FPGA Configuration for the Intel N3000 FPGA Programmable - Acceleration Card ` + Acceleration Card ` * Kata Containers @@ -61,7 +61,7 @@ associated user guides (if applicable). Kubernetes API. Guide: :doc:`Authenticate Kubernetes Users with Windows Active Directory - Server ` + Server ` * Certificate Manager Integration @@ -69,7 +69,7 @@ associated user guides (if applicable). certificate issuance, monitor certificate expiration dates, and configure an auto-renew process. - Guide: :doc:`Enable secure HTTPS access and manage certificates ` + Guide: :doc:`Enable secure HTTPS access and manage certificates ` * Time-Sensitive Networking (TSN) in Kata Containers @@ -103,7 +103,7 @@ associated user guides (if applicable). StarlingX now has the capability of updating the Kubernetes images installed on the platform. - Guide: :doc:`Upgrade your Kubernetes version ` + Guide: :doc:`Upgrade your Kubernetes version ` * Redfish virtual media support