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 <maryx.camp@intel.com>
This commit is contained in:
MCamp859 2021-12-08 14:25:15 -05:00
parent 8464f253c2
commit ddc00dd834
23 changed files with 175 additions and 58 deletions

View File

@ -2,6 +2,12 @@
Branding Configuration Branding Configuration
====================== ======================
.. note::
This guide was replaced by:
:ref:`Brand the Login Banner During Commissioning <branding-the-login-banner-during-commissioning>`
This is a stub page for the topic: Branding Configuration. You can help This is a stub page for the topic: Branding Configuration. You can help
StarlingX by expanding the content. StarlingX by expanding the content.

View File

@ -2,6 +2,11 @@
Certificate Configuration Certificate Configuration
========================= =========================
.. note::
This guide was replaced by:
:ref:`HTTPS and Certificates Management Overview <https-access-overview>`
This guide describes how to enable secure HTTPS access and manage certificates This guide describes how to enable secure HTTPS access and manage certificates
using StarlingX. using StarlingX.

View File

Before

Width:  |  Height:  |  Size: 8.0 KiB

After

Width:  |  Height:  |  Size: 8.0 KiB

View File

@ -2,6 +2,11 @@
Host Configuration Host Configuration
================== ==================
.. note::
This guide was replaced by:
:doc:`Node Management Guide </node_management/index>`
This is a stub page for the topic: Host Configuration. You can help StarlingX by This is a stub page for the topic: Host Configuration. You can help StarlingX by
expanding the content. expanding the content.

View File

@ -2,6 +2,10 @@
Host Interface and Network Configuration Host Interface and Network Configuration
======================================== ========================================
.. note::
This guide was replaced by: :doc:`Node Management Guide </node_management/index>`
This guide describes the following: This guide describes the following:
.. contents:: .. contents::

View File

@ -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

View File

@ -2,6 +2,10 @@
Host FPGA Configuration - Intel N3000 Host FPGA Configuration - Intel N3000
===================================== =====================================
.. note::
This guide was replaced by: :ref:`N3000 FPGA Overview <n3000-overview>`
This guide describes how to configure and integrate an Intel N3000 |FPGA| This guide describes how to configure and integrate an Intel N3000 |FPGA|
|PAC| on StarlingX. |PAC| on StarlingX.

View File

@ -2,6 +2,11 @@
Authenticate Kubernetes Users with Windows Active Directory Server Authenticate Kubernetes Users with Windows Active Directory Server
================================================================== ==================================================================
.. note::
This guide was replaced by:
:ref:`Overview of Windows Active Directory <overview-of-windows-active-directory>`
This guide describes how to authenticate users of the Kubernetes API via a This guide describes how to authenticate users of the Kubernetes API via a
remote Windows Active Directory server, using the oidc-auth-apps application. remote Windows Active Directory server, using the oidc-auth-apps application.

View File

@ -2,6 +2,11 @@
Persistent Volume Configuration Persistent Volume Configuration
=============================== ===============================
.. note::
This guide was replaced by:
:ref:`About Persistent Volume Support <about-persistent-volume-support>`
This is a stub page for the topic: Configuring Persistent Volume Support. You This is a stub page for the topic: Configuring Persistent Volume Support. You
can help StarlingX by expanding the content. can help StarlingX by expanding the content.

View File

@ -2,6 +2,10 @@
Pod Security Policies Pod Security Policies
===================== =====================
.. note::
This guide was replaced by: :ref:`Pod Security Policies <pod-security-policies>`
This guide describes how to enable Kubernetes pod security policies. This guide describes how to enable Kubernetes pod security policies.
.. contents:: .. contents::

View File

@ -2,6 +2,10 @@
Resource Policies Resource Policies
================= =================
.. note::
This guide was replaced by: :ref:`Resource Management <resource-management>`
This guide describes two Kubernetes resource policies, LimitRange and This guide describes two Kubernetes resource policies, LimitRange and
ResourceQuota, which are enabled by default on StarlingX. ResourceQuota, which are enabled by default on StarlingX.

View File

@ -2,6 +2,10 @@
Upgrade Kubernetes version Upgrade Kubernetes version
========================== ==========================
.. note::
This guide was replaced by: :ref:`Manual Kubernetes Version Upgrade <manual-kubernetes-components-upgrade>`
This section describes how to upgrade the components on a system running This section describes how to upgrade the components on a system running
StarlingX from one supported version of Kubernetes (K8s) to another supported StarlingX from one supported version of Kubernetes (K8s) to another supported
version. version.

View File

@ -2,6 +2,11 @@
OpenStack Cinder File System Configuration OpenStack Cinder File System Configuration
========================================== ==========================================
.. note::
This guide was replaced by:
:ref:`Configure the Optional Image Conversion File System <configure-an-optional-cinder-file-system>`
This guide describes an optional file system that can be used by Cinder to This guide describes an optional file system that can be used by Cinder to
convert qcow2 images to raw format. convert qcow2 images to raw format.

View File

@ -2,6 +2,12 @@
OpenStack Ironic Configuration OpenStack Ironic Configuration
============================== ==============================
.. note::
This guide was replaced by:
:ref:`Configure OpenStack Services Using Helm Chart Overrides <sysconf_openstack_index>`
This is a stub page for the topic: OpenStack Ironic Configuration and Management. This is a stub page for the topic: OpenStack Ironic Configuration and Management.
You can help StarlingX by expanding the content. You can help StarlingX by expanding the content.

View File

@ -2,6 +2,11 @@
OpenStack Swift Configuration OpenStack Swift Configuration
============================= =============================
.. note::
This guide was replaced by:
:ref:`Configure OpenStack Services Using Helm Chart Overrides <sysconf_openstack_index>`
This is a stub page for the topic: OpenStack Swift Configuration. You can help This is a stub page for the topic: OpenStack Swift Configuration. You can help
StarlingX by expanding the content. StarlingX by expanding the content.

View File

@ -2,6 +2,12 @@
System Configuration System Configuration
===================== =====================
.. note::
This guide was replaced by:
:ref:`System Configuration Guide <sysconf_main_index>`
This is a stub page for the topic: System Configuration. You can help StarlingX This is a stub page for the topic: System Configuration. You can help StarlingX
by expanding the content. by expanding the content.

View File

@ -2,6 +2,11 @@
Time Synchronization Configuration Time Synchronization Configuration
================================== ==================================
.. note::
This guide was replaced by:
:ref:`Configure NTP Servers Using Horizon <configuring-ntp-servers-and-services-using-horizon>`
This is a stub page for the topic: Time Synchronization Configuration. You can This is a stub page for the topic: Time Synchronization Configuration. You can
help StarlingX by expanding the content. help StarlingX by expanding the content.

View File

@ -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

View File

@ -985,7 +985,7 @@ Kubernetes version upgrade
The following set of commands allow you to upgrade the version of Kubernetes. The following set of commands allow you to upgrade the version of Kubernetes.
For more information, see For more information, see
:doc:`Kubernetes upgrade </configuration/k8s_upgrade>`. :ref:`Manual Kubernetes Version Upgrade <manual-kubernetes-components-upgrade>`.
``kube-host-upgrade`` ``kube-host-upgrade``
Perform Kubernetes upgrade for a host. Perform Kubernetes upgrade for a host.

View File

@ -2,44 +2,15 @@
Configuration Configuration
============= =============
--------------------- .. note::
General Configuration
--------------------- The guides in this folder were moved to
:ref:`Documentation archive <index-documentation-archive-900988dce206>`.
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
:hidden:
brand_config
cert_config
host_config
host_interface_network_config
intel_n3000_fpga
docker_proxy_config 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

View File

@ -84,7 +84,7 @@ Documentation for StarlingX is organized into the following sections:
:doc:`/deploy_install_guides/index` :doc:`/deploy_install_guides/index`
Release-specific installation and deployment guides. Release-specific installation and deployment guides.
:doc:`/configuration/index` :doc:`/archive/configuration/index`
Configuration references for post-installation StarlingX system configuration. Configuration references for post-installation StarlingX system configuration.
:doc:`/operations/index` :doc:`/operations/index`

View File

@ -200,20 +200,20 @@ Deprecated guides
The guides listed here have been replaced by new guides that provide more The guides listed here have been replaced by new guides that provide more
details. details.
*************
Configuration
*************
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
archive/index-documentation-archive-900988dce206
.. toctree::
:maxdepth: 1
:hidden:
configuration/index configuration/index
****************
Operation guides
****************
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2

View File

@ -44,7 +44,7 @@ associated user guides (if applicable).
card's firmware. card's firmware.
Guide: :doc:`Host FPGA Configuration for the Intel N3000 FPGA Programmable Guide: :doc:`Host FPGA Configuration for the Intel N3000 FPGA Programmable
Acceleration Card </configuration/intel_n3000_fpga>` Acceleration Card </archive/configuration/intel_n3000_fpga>`
* Kata Containers * Kata Containers
@ -61,7 +61,7 @@ associated user guides (if applicable).
Kubernetes API. Kubernetes API.
Guide: :doc:`Authenticate Kubernetes Users with Windows Active Directory Guide: :doc:`Authenticate Kubernetes Users with Windows Active Directory
Server </configuration/k8s_auth_winactivedir>` Server </archive/configuration/k8s_auth_winactivedir>`
* Certificate Manager Integration * Certificate Manager Integration
@ -69,7 +69,7 @@ associated user guides (if applicable).
certificate issuance, monitor certificate expiration dates, and configure certificate issuance, monitor certificate expiration dates, and configure
an auto-renew process. an auto-renew process.
Guide: :doc:`Enable secure HTTPS access and manage certificates </configuration/cert_config>` Guide: :doc:`Enable secure HTTPS access and manage certificates </archive/configuration/cert_config>`
* Time-Sensitive Networking (TSN) in Kata Containers * 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 StarlingX now has the capability of updating the Kubernetes images
installed on the platform. installed on the platform.
Guide: :doc:`Upgrade your Kubernetes version </configuration/k8s_upgrade>` Guide: :doc:`Upgrade your Kubernetes version </archive/configuration/k8s_upgrade>`
* Redfish virtual media support * Redfish virtual media support