diff --git a/doc/source/_includes/toc-contents.rest b/doc/source/_includes/toc-contents.rest new file mode 100644 index 000000000..b8a56e005 --- /dev/null +++ b/doc/source/_includes/toc-contents.rest @@ -0,0 +1,3 @@ +.. ======== +.. Contents +.. ======== \ No newline at end of file diff --git a/doc/source/_includes/toc-title-admintasks-kub.rest b/doc/source/_includes/toc-title-admintasks-kub.rest new file mode 100644 index 000000000..3c5a53f4e --- /dev/null +++ b/doc/source/_includes/toc-title-admintasks-kub.rest @@ -0,0 +1 @@ +.. include:: /_includes/toc-contents.rest \ No newline at end of file diff --git a/doc/source/_includes/toc-title-admintasks-os.rest b/doc/source/_includes/toc-title-admintasks-os.rest new file mode 100644 index 000000000..3c5a53f4e --- /dev/null +++ b/doc/source/_includes/toc-title-admintasks-os.rest @@ -0,0 +1 @@ +.. include:: /_includes/toc-contents.rest \ No newline at end of file diff --git a/doc/source/_includes/toc-title-backup-kub.rest b/doc/source/_includes/toc-title-backup-kub.rest new file mode 100644 index 000000000..3c5a53f4e --- /dev/null +++ b/doc/source/_includes/toc-title-backup-kub.rest @@ -0,0 +1 @@ +.. include:: /_includes/toc-contents.rest \ No newline at end of file diff --git a/doc/source/_includes/toc-title-backup-os.rest b/doc/source/_includes/toc-title-backup-os.rest new file mode 100644 index 000000000..3c5a53f4e --- /dev/null +++ b/doc/source/_includes/toc-title-backup-os.rest @@ -0,0 +1 @@ +.. include:: /_includes/toc-contents.rest \ No newline at end of file diff --git a/doc/source/_includes/toc-title-datanet-kub.rest b/doc/source/_includes/toc-title-datanet-kub.rest new file mode 100644 index 000000000..3c5a53f4e --- /dev/null +++ b/doc/source/_includes/toc-title-datanet-kub.rest @@ -0,0 +1 @@ +.. include:: /_includes/toc-contents.rest \ No newline at end of file diff --git a/doc/source/_includes/toc-title-datanet-os.rest b/doc/source/_includes/toc-title-datanet-os.rest new file mode 100644 index 000000000..3c5a53f4e --- /dev/null +++ b/doc/source/_includes/toc-title-datanet-os.rest @@ -0,0 +1 @@ +.. include:: /_includes/toc-contents.rest \ No newline at end of file diff --git a/doc/source/_includes/toc-title-dc-kub.rest b/doc/source/_includes/toc-title-dc-kub.rest new file mode 100644 index 000000000..3c5a53f4e --- /dev/null +++ b/doc/source/_includes/toc-title-dc-kub.rest @@ -0,0 +1 @@ +.. include:: /_includes/toc-contents.rest \ No newline at end of file diff --git a/doc/source/_includes/toc-title-deploy-kub.rest b/doc/source/_includes/toc-title-deploy-kub.rest new file mode 100644 index 000000000..62bb63ace --- /dev/null +++ b/doc/source/_includes/toc-title-deploy-kub.rest @@ -0,0 +1 @@ +.. .. include:: /_includes/toc-contents.rest diff --git a/doc/source/_includes/toc-title-deploy-os.rest b/doc/source/_includes/toc-title-deploy-os.rest new file mode 100644 index 000000000..62bb63ace --- /dev/null +++ b/doc/source/_includes/toc-title-deploy-os.rest @@ -0,0 +1 @@ +.. .. include:: /_includes/toc-contents.rest diff --git a/doc/source/_includes/toc-title-fm-kub.rest b/doc/source/_includes/toc-title-fm-kub.rest new file mode 100644 index 000000000..3c5a53f4e --- /dev/null +++ b/doc/source/_includes/toc-title-fm-kub.rest @@ -0,0 +1 @@ +.. include:: /_includes/toc-contents.rest \ No newline at end of file diff --git a/doc/source/_includes/toc-title-fm-os.rest b/doc/source/_includes/toc-title-fm-os.rest new file mode 100644 index 000000000..3c5a53f4e --- /dev/null +++ b/doc/source/_includes/toc-title-fm-os.rest @@ -0,0 +1 @@ +.. include:: /_includes/toc-contents.rest \ No newline at end of file diff --git a/doc/source/_includes/toc-title-guest-kub.rest b/doc/source/_includes/toc-title-guest-kub.rest new file mode 100644 index 000000000..0dcb5f73f --- /dev/null +++ b/doc/source/_includes/toc-title-guest-kub.rest @@ -0,0 +1,3 @@ +===================== +Container Integration +===================== \ No newline at end of file diff --git a/doc/source/_includes/toc-title-guest-os.rest b/doc/source/_includes/toc-title-guest-os.rest new file mode 100644 index 000000000..61e266923 --- /dev/null +++ b/doc/source/_includes/toc-title-guest-os.rest @@ -0,0 +1,3 @@ +========================= +OpenStack VNF Integration +========================= \ No newline at end of file diff --git a/doc/source/_includes/toc-title-node-kub.rest b/doc/source/_includes/toc-title-node-kub.rest new file mode 100644 index 000000000..3c5a53f4e --- /dev/null +++ b/doc/source/_includes/toc-title-node-kub.rest @@ -0,0 +1 @@ +.. include:: /_includes/toc-contents.rest \ No newline at end of file diff --git a/doc/source/_includes/toc-title-node-os.rest b/doc/source/_includes/toc-title-node-os.rest new file mode 100644 index 000000000..3c5a53f4e --- /dev/null +++ b/doc/source/_includes/toc-title-node-os.rest @@ -0,0 +1 @@ +.. include:: /_includes/toc-contents.rest \ No newline at end of file diff --git a/doc/source/_includes/toc-title-planning-kub.rest b/doc/source/_includes/toc-title-planning-kub.rest new file mode 100644 index 000000000..329e5b531 --- /dev/null +++ b/doc/source/_includes/toc-title-planning-kub.rest @@ -0,0 +1 @@ +.. .. include:: /_includes/toc-contents.rest \ No newline at end of file diff --git a/doc/source/_includes/toc-title-planning-os.rest b/doc/source/_includes/toc-title-planning-os.rest new file mode 100644 index 000000000..329e5b531 --- /dev/null +++ b/doc/source/_includes/toc-title-planning-os.rest @@ -0,0 +1 @@ +.. .. include:: /_includes/toc-contents.rest \ No newline at end of file diff --git a/doc/source/_includes/toc-title-security-kub.rest b/doc/source/_includes/toc-title-security-kub.rest new file mode 100644 index 000000000..3c5a53f4e --- /dev/null +++ b/doc/source/_includes/toc-title-security-kub.rest @@ -0,0 +1 @@ +.. include:: /_includes/toc-contents.rest \ No newline at end of file diff --git a/doc/source/_includes/toc-title-security-os.rest b/doc/source/_includes/toc-title-security-os.rest new file mode 100644 index 000000000..3c5a53f4e --- /dev/null +++ b/doc/source/_includes/toc-title-security-os.rest @@ -0,0 +1 @@ +.. include:: /_includes/toc-contents.rest \ No newline at end of file diff --git a/doc/source/_includes/toc-title-storage-kub.rest b/doc/source/_includes/toc-title-storage-kub.rest new file mode 100644 index 000000000..3c5a53f4e --- /dev/null +++ b/doc/source/_includes/toc-title-storage-kub.rest @@ -0,0 +1 @@ +.. include:: /_includes/toc-contents.rest \ No newline at end of file diff --git a/doc/source/_includes/toc-title-storage-os.rest b/doc/source/_includes/toc-title-storage-os.rest new file mode 100644 index 000000000..3c5a53f4e --- /dev/null +++ b/doc/source/_includes/toc-title-storage-os.rest @@ -0,0 +1 @@ +.. include:: /_includes/toc-contents.rest \ No newline at end of file diff --git a/doc/source/_includes/toc-title-sys-conf-kub.rest b/doc/source/_includes/toc-title-sys-conf-kub.rest new file mode 100644 index 000000000..3c5a53f4e --- /dev/null +++ b/doc/source/_includes/toc-title-sys-conf-kub.rest @@ -0,0 +1 @@ +.. include:: /_includes/toc-contents.rest \ No newline at end of file diff --git a/doc/source/_includes/toc-title-sys-conf-os.rest b/doc/source/_includes/toc-title-sys-conf-os.rest new file mode 100644 index 000000000..3c5a53f4e --- /dev/null +++ b/doc/source/_includes/toc-title-sys-conf-os.rest @@ -0,0 +1 @@ +.. include:: /_includes/toc-contents.rest \ No newline at end of file diff --git a/doc/source/_includes/toc-title-updates-kub.rest b/doc/source/_includes/toc-title-updates-kub.rest new file mode 100644 index 000000000..3c5a53f4e --- /dev/null +++ b/doc/source/_includes/toc-title-updates-kub.rest @@ -0,0 +1 @@ +.. include:: /_includes/toc-contents.rest \ No newline at end of file diff --git a/doc/source/_includes/toc-title-updates-os.rest b/doc/source/_includes/toc-title-updates-os.rest new file mode 100644 index 000000000..3c5a53f4e --- /dev/null +++ b/doc/source/_includes/toc-title-updates-os.rest @@ -0,0 +1 @@ +.. include:: /_includes/toc-contents.rest \ No newline at end of file diff --git a/doc/source/_includes/toc-title-usertasks-kub.rest b/doc/source/_includes/toc-title-usertasks-kub.rest new file mode 100644 index 000000000..3c5a53f4e --- /dev/null +++ b/doc/source/_includes/toc-title-usertasks-kub.rest @@ -0,0 +1 @@ +.. include:: /_includes/toc-contents.rest \ No newline at end of file diff --git a/doc/source/admintasks/index.rst b/doc/source/admintasks/index.rst index 4809f5e8e..66d58aa7c 100644 --- a/doc/source/admintasks/index.rst +++ b/doc/source/admintasks/index.rst @@ -4,13 +4,17 @@ Admin Tasks =========== -The |prod-long| Kubernetes administration tutorials provide working examples -of common administrative tasks. - ---------- Kubernetes ---------- +.. kub-begin + +The |prod-long| Kubernetes administration tutorials provide working examples +of common administrative tasks. + +.. kub-end + .. toctree:: :maxdepth: 2 @@ -20,9 +24,12 @@ Kubernetes StarlingX OpenStack ------------------- +.. os-begin + |prod| supports configuring Nova's dedicated and shared CPU pools on a per openstack-compute host basis. +.. os-end .. toctree:: :maxdepth: 2 diff --git a/doc/source/admintasks/kubernetes/index.rst b/doc/source/admintasks/kubernetes/index.rst index a063aa1fc..3719c667a 100644 --- a/doc/source/admintasks/kubernetes/index.rst +++ b/doc/source/admintasks/kubernetes/index.rst @@ -1,13 +1,13 @@ -.. _admin-tasks-title: +.. _admintasks-kubernetes-index: -======== -Contents -======== +.. include:: /_includes/toc-title-admintasks-kub.rest --------------------- -StarlingX Kubernetes --------------------- +.. only:: partner + + .. include:: /admintasks/index.rst + :start-after: kub-begin + :end-before: kub-end .. toctree:: :maxdepth: 1 diff --git a/doc/source/admintasks/openstack/index.rst b/doc/source/admintasks/openstack/index.rst index 3f8d02025..4c0a383a6 100644 --- a/doc/source/admintasks/openstack/index.rst +++ b/doc/source/admintasks/openstack/index.rst @@ -1,10 +1,12 @@ -------------------- -StarlingX OpenStack -------------------- +.. _admintasks-openstack-index: -=========== -Admin Tasks -=========== +.. include:: /_includes/toc-title-admintasks-os.rest + +.. only:: partner + + .. include:: /admintasks/index.rst + :start-after: os-begin + :end-before: os-end .. toctree:: :maxdepth: 1 diff --git a/doc/source/backup/kubernetes/index.rs1 b/doc/source/backup/kubernetes/index.rs1 deleted file mode 100644 index d4a31a1a1..000000000 --- a/doc/source/backup/kubernetes/index.rs1 +++ /dev/null @@ -1,17 +0,0 @@ -===================================== -|prod-long| System Backup and Restore -===================================== - -- System Data Backup - - - :ref:`Backing Up Platform System Data ` - - - :ref:`Running Ansible Backup Playbook Locally on the Controller ` - - :ref:`Running Ansible Backup Playbook Remotely ` - - -- System Data and Storage Restore - - - :ref:`Restoring Platform System Data and Storage ` - - :ref:`Running Restore Playbook Locally on the Controller ` - - :ref:`Running Ansible Restore Playbook Remotely ` diff --git a/doc/source/backup/kubernetes/index.rst b/doc/source/backup/kubernetes/index.rst index fd3f73d53..ff9af3874 100644 --- a/doc/source/backup/kubernetes/index.rst +++ b/doc/source/backup/kubernetes/index.rst @@ -3,13 +3,7 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. ----------- -Kubernetes ----------- - -================== -Backup and Restore -================== +.. include:: /_includes/toc-title-backup-kub.rest ------------- System backup diff --git a/doc/source/backup/openstack/index.rst b/doc/source/backup/openstack/index.rst index 14c11cd74..840d3b1b7 100644 --- a/doc/source/backup/openstack/index.rst +++ b/doc/source/backup/openstack/index.rst @@ -1,7 +1,5 @@ ---------- -OpenStack ---------- +.. include:: /_includes/toc-title-backup-kub.rest ================== Backup and Restore diff --git a/doc/source/datanet/index.rst b/doc/source/datanet/index.rst index 042469f06..2f9583ef6 100644 --- a/doc/source/datanet/index.rst +++ b/doc/source/datanet/index.rst @@ -10,9 +10,13 @@ Data Networks Kubernetes ---------- +.. kub-begin + |prod-long| data network management allows you to model the L2 networks that are attached to node data, pci-sriov and pci-passthrough interfaces. +.. kub-end + .. toctree:: :maxdepth: 2 @@ -23,9 +27,13 @@ are attached to node data, pci-sriov and pci-passthrough interfaces. OpenStack --------- +.. os-begin + Data networks are used to model the L2 Networks that nodes' data, pci-sriov and pci-passthrough interfaces attach to. +.. os-end + .. toctree:: :maxdepth: 2 diff --git a/doc/source/datanet/kubernetes/index.rst b/doc/source/datanet/kubernetes/index.rst index 40f616538..e82800e86 100644 --- a/doc/source/datanet/kubernetes/index.rst +++ b/doc/source/datanet/kubernetes/index.rst @@ -2,9 +2,13 @@ .. _datanet_kubernetes_index: -======== -Overview -======== +.. include:: /_includes/toc-title-datanet-kub.rest + +.. only:: partner + + .. include:: /datanet/index.rst + :start-after: kub-begin + :end-before: kub-end .. toctree:: :maxdepth: 1 diff --git a/doc/source/datanet/openstack/index.rst b/doc/source/datanet/openstack/index.rst index 38a62d7c1..766ea2b8b 100644 --- a/doc/source/datanet/openstack/index.rst +++ b/doc/source/datanet/openstack/index.rst @@ -1,11 +1,12 @@ -.. Data networks file, created by - sphinx-quickstart on Thu Sep 3 15:14:59 2020. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. +.. _datanet_openstack_index: -======== -Contents -======== +.. include:: /_includes/toc-title-datanet-os.rest + +.. only:: partner + + .. include:: /datanet/index.rst + :start-after: os-begin + :end-before: os-end .. toctree:: :maxdepth: 1 diff --git a/doc/source/deploy/index.rst b/doc/source/deploy/index.rst index bcc31600c..b0a66d09f 100644 --- a/doc/source/deploy/index.rst +++ b/doc/source/deploy/index.rst @@ -4,6 +4,8 @@ Deployment Configurations ========================= +.. kub-begin + A variety of |prod-long| deployment configuration options are supported. **All-in-one Simplex** @@ -23,6 +25,8 @@ A variety of |prod-long| deployment configuration options are supported. A two node HA controller node cluster with a 2-9 node Ceph storage cluster, managing up to 200 worker nodes. +.. kub-end + .. toctree:: :maxdepth: 2 diff --git a/doc/source/deploy/kubernetes/index.rst b/doc/source/deploy/kubernetes/index.rst index d94594237..fe99f05d0 100644 --- a/doc/source/deploy/kubernetes/index.rst +++ b/doc/source/deploy/kubernetes/index.rst @@ -1,11 +1,15 @@ -.. Deployment Configurations file, created by - sphinx-quickstart on Thu Sep 3 15:14:59 2020. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. +.. _deploy-kubernetes-index: -======== -Contents -======== + +.. only:: starlingx + + .. include:: /_includes/toc-title-deploy-kub.rest + +.. only:: partner + + .. include:: /deploy/index.rst + :start-after: kub-begin + :end-before: kub-end .. toctree:: :maxdepth: 1 diff --git a/doc/source/dist_cloud/index.rst b/doc/source/dist_cloud/index.rst index d7ea13cff..60e2e540c 100644 --- a/doc/source/dist_cloud/index.rst +++ b/doc/source/dist_cloud/index.rst @@ -5,10 +5,14 @@ Distributed Cloud ================= +.. kub-begin + |prod-long| |prod-dc| configuration supports an edge computing solution by providing central management and orchestration for a geographically distributed network of |prod| systems. +.. kub-end + .. toctree:: :maxdepth: 2 diff --git a/doc/source/dist_cloud/kubernetes/index.rst b/doc/source/dist_cloud/kubernetes/index.rst index 08587033b..1d572dbda 100644 --- a/doc/source/dist_cloud/kubernetes/index.rst +++ b/doc/source/dist_cloud/kubernetes/index.rst @@ -1,9 +1,13 @@ .. _dist-cloud-kubernetes-index: -======== -Contents -======== +.. include:: /_includes/toc-title-dc-kub.rest + +.. only:: partner + + .. include:: /dist_cloud/index.rst + :start-after: kub-begin + :end-before: kub-end ------------ Introduction diff --git a/doc/source/fault-mgmt/index.rst b/doc/source/fault-mgmt/index.rst index d0927c06a..acc3cab7b 100644 --- a/doc/source/fault-mgmt/index.rst +++ b/doc/source/fault-mgmt/index.rst @@ -11,6 +11,10 @@ Fault Management StarlingX Kubernetes -------------------- +.. kub-begin + +.. kub-end + .. toctree:: :maxdepth: 2 @@ -20,12 +24,16 @@ StarlingX Kubernetes StarlingX OpenStack ------------------- +.. os-begin + |prod-os| is a containerized application running on top of |prod|. This section provides the list of OpenStack related Alarms and Customer Logs that are monitored and reported for the |prod-os| application through the |prod| fault management interfaces. +.. os-end + .. toctree:: :maxdepth: 2 diff --git a/doc/source/fault-mgmt/kubernetes/index.rs1 b/doc/source/fault-mgmt/kubernetes/index.rs1 deleted file mode 100644 index 0566c0eae..000000000 --- a/doc/source/fault-mgmt/kubernetes/index.rs1 +++ /dev/null @@ -1,67 +0,0 @@ -============================ -|prod-long| Fault Management -============================ - -- Fault Management Overview - - - :ref:`Fault Management Overview ` - -- The Global Alarm Banner - - - :ref:`The Global Alarm Banner ` - -- Viewing Active Alarms - - - :ref:`Viewing Active Alarms Using Horizon ` - - :ref:`Viewing Active Alarms Using the CLI ` - - :ref:`Viewing Alarm Details Using the CLI ` - -- Viewing the Event Log - - - :ref:`Viewing the Event Log Using Horizon ` - - :ref:`Viewing the Event Log Using the CLI ` - -- Deleting an Alarm - - - :ref:`Deleting an Alarm Using the CLI ` - -- Events Suppression - - - :ref:`Events Suppression Overview ` - - :ref:`Suppressing and Unsuppressing Events ` - - :ref:`Viewing Suppressed Alarms Using the CLI ` - - :ref:`Suppressing an Alarm Using the CLI ` - - :ref:`Unsuppressing an Alarm Using the CLI ` - -- CLI Commands and Paged Output - - - :ref:`CLI Commands and Paged Output ` - -- SNMP - - - :ref:`SNMP Overview ` - - :ref:`Enabling SNMP Support ` - - :ref:`Traps ` - - :ref:`SNMP Event Table ` - - :ref:`Setting SNMP Identifying Information ` - -- :ref:`Troubleshooting Log Collection ` -- |prod| Alarm Messages - - - :ref:`Alarm Messages Overview ` - - :ref:`100 Series Alarm Messages <100-series-alarm-messages>` - - :ref:`200 Series Alarm Messages <200-series-alarm-messages>` - - :ref:`300 Series Alarm Messages <300-series-alarm-messages>` - - :ref:`400 Series Alarm Messages <400-series-alarm-messages>` - - :ref:`500 Series Alarm Messages <500-series-alarm-messages>` - - :ref:`750 Series Alarm Messages <750-series-alarm-messages>` - - :ref:`800 Series Alarm Messages <800-series-alarm-messages>` - - :ref:`900 Series Alarm Messages <900-series-alarm-messages>` - -- |prod| Customer Log Messages - - - :ref:`200 Series Maintenance Customer Log Messages <200-series-maintenance-customer-log-messages>` - - :ref:`400 Series Customer Log Messages <400-series-customer-log-messages>` - - :ref:`900 Series Orchestration Customer Log Messages <900-series-orchestration-customer-log-messages>` - - diff --git a/doc/source/fault-mgmt/kubernetes/index.rst b/doc/source/fault-mgmt/kubernetes/index.rst index f6450e048..4142cc373 100644 --- a/doc/source/fault-mgmt/kubernetes/index.rst +++ b/doc/source/fault-mgmt/kubernetes/index.rst @@ -1,11 +1,12 @@ -.. Fault Management file, created by - sphinx-quickstart on Thu Sep 3 15:14:59 2020. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. +.. _fault-mgmt-kubernetes-index: -======== -Contents -======== +.. include:: /_includes/toc-title-fm-kub.rest + +.. only:: partner + + .. include:: /fault-mgmt/index.rst + :start-after: kub-begin + :end-before: kub-end .. toctree:: :maxdepth: 1 diff --git a/doc/source/fault-mgmt/openstack/index.rst b/doc/source/fault-mgmt/openstack/index.rst index e30d8744f..a02caecfe 100644 --- a/doc/source/fault-mgmt/openstack/index.rst +++ b/doc/source/fault-mgmt/openstack/index.rst @@ -1,11 +1,12 @@ -.. Fault Management file, created by - sphinx-quickstart on Thu Sep 3 15:14:59 2020. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. +.. _fault-mgmt-openstack-index: -======== -Contents -======== +.. include:: /_includes/toc-title-fm-os.rest + +.. only:: partner + + .. include:: /fault-mgmt/index.rst + :start-after: os-begin + :end-before: os-end .. toctree:: :maxdepth: 1 diff --git a/doc/source/guest_integration/index.rst b/doc/source/guest_integration/index.rst index 653b5102d..9003a1aea 100644 --- a/doc/source/guest_integration/index.rst +++ b/doc/source/guest_integration/index.rst @@ -1,7 +1,4 @@ -.. Fault Management file, created by - sphinx-quickstart on Thu Sep 3 15:14:59 2020. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. +.. _guest-integration-index: ================= Guest Integration @@ -11,10 +8,14 @@ Guest Integration Kubernetes container integration -------------------------------- +.. kub-begin + |prod-long| supports applications that rely on |PTP| for synchronization. These applications are able to receive |PTP| status notifications from |prod-long| hosting the application. +.. kub-end + .. toctree:: :maxdepth: 2 @@ -24,10 +25,14 @@ applications are able to receive |PTP| status notifications from OpenStack VNF integration ------------------------- +.. os-begin + The |VNF| Integration document contains information specific to |VNF| or |VM| application writers that assists them with integrating their application on |prod-os|. +.. os-end + .. toctree:: :maxdepth: 2 diff --git a/doc/source/guest_integration/kubernetes/index.rst b/doc/source/guest_integration/kubernetes/index.rst index 39346f608..f8644788c 100644 --- a/doc/source/guest_integration/kubernetes/index.rst +++ b/doc/source/guest_integration/kubernetes/index.rst @@ -1,6 +1,12 @@ -===================== -Container Integration -===================== +.. _guest-kubernetes-index: + +.. include:: /_includes/toc-title-guest-kub.rest + +.. only:: partner + + .. include:: /guest_integration/index.rst + :start-after: kub-begin + :end-before: kub-end ---------------- PTP Notification diff --git a/doc/source/guest_integration/openstack/index.rst b/doc/source/guest_integration/openstack/index.rst index 4fe9a63ff..cef70158d 100644 --- a/doc/source/guest_integration/openstack/index.rst +++ b/doc/source/guest_integration/openstack/index.rst @@ -1,6 +1,12 @@ -========================= -OpenStack VNF Integration -========================= +.. _guest-openstack-index: + +.. include:: /_includes/toc-title-guest-os.rest + +.. only:: partner + + .. include:: /guest_integration/index.rst + :start-after: os-begin + :end-before: os-end .. only:: starlingx @@ -32,12 +38,12 @@ Virtual Network Interfaces standard-virtio-backed-with-vhost-support use-a-vif-model-when-creating-ports - + -------------------- Use Host's PTP Clock -------------------- .. toctree:: :maxdepth: 1 - + configure-kvm-virtual-ptp-driver diff --git a/doc/source/node_management/index.rst b/doc/source/node_management/index.rst index 5432cfa6e..808310a7a 100644 --- a/doc/source/node_management/index.rst +++ b/doc/source/node_management/index.rst @@ -6,6 +6,8 @@ Node Management Kubernetes ---------- +.. kub-begin + You can perform |prod-long| node management of worker hosts that comprise resource pools for hosting guest applications. @@ -33,6 +35,8 @@ Complete instructions for adding a worker node are provided in the `StarlingX Installation and Deployment Guide `__. +.. kub-end + .. toctree:: :maxdepth: 2 @@ -42,10 +46,14 @@ Complete instructions for adding a worker node are provided in the OpenStack --------- +.. os-begin + You can add OpenStack compute nodes to an existing |AIO| Duplex system, and use labels to identify OpenStack Nodes. -Guidelines for VMs in a duplex system remain unchanged. +Guidelines for |VMs| in a duplex system remain unchanged. + +.. os-end ***************************** Add an OpenStack compute node diff --git a/doc/source/node_management/kubernetes/index.rst b/doc/source/node_management/kubernetes/index.rst index 7c642484c..5b5614cd1 100644 --- a/doc/source/node_management/kubernetes/index.rst +++ b/doc/source/node_management/kubernetes/index.rst @@ -1,6 +1,13 @@ -======== -Contents -======== + +.. _node-mgmt-kubernetes-index: + +.. include:: /_includes/toc-title-node-kub.rest + +.. only:: partner + + .. include:: /node_management/index.rst + :start-after: kub-begin + :end-before: kub-end ------------ Introduction diff --git a/doc/source/node_management/openstack/index.rst b/doc/source/node_management/openstack/index.rst index fd14a4bcc..065096c19 100644 --- a/doc/source/node_management/openstack/index.rst +++ b/doc/source/node_management/openstack/index.rst @@ -1,6 +1,13 @@ -======== -Contents -======== + +.. _node-mgmt-openstack-index: + +.. include:: /_includes/toc-title-node-os.rest + +.. only:: partner + + .. include:: /node_management/index.rst + :start-after: os-begin + :end-before: os-end .. toctree:: :maxdepth: 1 @@ -9,7 +16,6 @@ Contents adding-compute-nodes-to-an-existing-duplex-system using-labels-to-identify-openstack-nodes - ------------------------- PCI Device Access for VMs ------------------------- diff --git a/doc/source/planning/index.rst b/doc/source/planning/index.rst index 1212b643f..1034b2657 100755 --- a/doc/source/planning/index.rst +++ b/doc/source/planning/index.rst @@ -11,6 +11,8 @@ Planning Kubernetes ---------- +.. kub-begin + |prod| platform planning helps ensure that the requirements of your containers, and the requirements of your cloud administration and operations teams can be met. It ensures proper integration of a |prod| into the target data center or @@ -19,6 +21,8 @@ telecom office, and helps you plan up front for future cloud growth. Planning your |prod| installation is a prerequisite for further |prod-os| installation planning. +.. kub-end + .. toctree:: :maxdepth: 2 @@ -28,9 +32,13 @@ installation planning. OpenStack --------- +.. os-begin + |prod-os| is installed as an application in a deployed |prod| environment and requires additional network, storage, security and resource planning. +.. os-end + .. toctree:: :maxdepth: 2 diff --git a/doc/source/planning/kubernetes/index.rst b/doc/source/planning/kubernetes/index.rst index 712250943..612691473 100755 --- a/doc/source/planning/kubernetes/index.rst +++ b/doc/source/planning/kubernetes/index.rst @@ -1,8 +1,12 @@ .. _planning_kubernetes_index: ----------- -Kubernetes ----------- +.. include:: /_includes/toc-title-planning-kub.rest + +.. only:: partner + + .. include:: /planning/index.rst + :start-after: kub-begin + :end-before: kub-end ************ Introduction diff --git a/doc/source/planning/openstack/index.rst b/doc/source/planning/openstack/index.rst index d96ba0645..0500a30b1 100755 --- a/doc/source/planning/openstack/index.rst +++ b/doc/source/planning/openstack/index.rst @@ -1,7 +1,13 @@ ---------- -OpenStack ---------- +.. _planning-openstack-index: + +.. include:: /_includes/toc-title-planning-os.rest + +.. only:: partner + + .. include:: /planning/index.rst + :start-after: os-begin + :end-before: os-end ================ Network planning diff --git a/doc/source/security/index.rst b/doc/source/security/index.rst index 3839deb0b..7439ea03d 100644 --- a/doc/source/security/index.rst +++ b/doc/source/security/index.rst @@ -6,8 +6,9 @@ Security Kubernetes ---------- -|prod-long| security encompasses a broad number of features. +.. kub-begin +|prod-long| security encompasses a broad number of features. .. _overview-of-starlingx-security-ul-ezc-k5f-p3b: @@ -28,6 +29,11 @@ Kubernetes - Signed software updates +.. kub-end + +Contents: +--------- + .. toctree:: :maxdepth: 2 @@ -37,7 +43,9 @@ Kubernetes OpenStack --------- -.. check what put here +.. os-begin + +.. os-end .. toctree:: :maxdepth: 2 diff --git a/doc/source/security/kubernetes/index.rst b/doc/source/security/kubernetes/index.rst index 2582155f1..dbf6040ca 100644 --- a/doc/source/security/kubernetes/index.rst +++ b/doc/source/security/kubernetes/index.rst @@ -1,6 +1,12 @@ -======== -Contents -======== +.. _security-kubernetes-index: + +.. include:: /_includes/toc-title-security-kub.rest + +.. only:: partner + + .. include:: /security/index.rst + :start-after: kub-begin + :end-before: kub-end *************** System Accounts diff --git a/doc/source/security/openstack/index.rst b/doc/source/security/openstack/index.rst index 61351dc41..813ce3d52 100644 --- a/doc/source/security/openstack/index.rst +++ b/doc/source/security/openstack/index.rst @@ -1,6 +1,13 @@ -======== -Contents -======== + +.. _security-openstack-index: + +.. include:: /_includes/toc-title-security-os.rest + +.. only:: partner + + .. include:: /security/index.rst + :start-after: os-begin + :end-before: os-end ----------------- Keystone Accounts diff --git a/doc/source/security/openstack/openstack-keystone-accounts.rst b/doc/source/security/openstack/openstack-keystone-accounts.rst index 60d0a36a2..7c0218e9e 100644 --- a/doc/source/security/openstack/openstack-keystone-accounts.rst +++ b/doc/source/security/openstack/openstack-keystone-accounts.rst @@ -18,5 +18,3 @@ API. .. seealso:: :ref:`System Account Password Rules ` - - diff --git a/doc/source/storage/index.rst b/doc/source/storage/index.rst index 4aba3e003..d60e13060 100644 --- a/doc/source/storage/index.rst +++ b/doc/source/storage/index.rst @@ -1,15 +1,20 @@ ======= Storage ======= + ---------- Kubernetes ---------- +.. kub-begin + |prod| uses storage resources on the controller and worker hosts, and on storage hosts if they are present.The |prod| storage configuration is highly flexible. The specific configuration depends on the type of system installed, and the requirements of the system. +.. kub-end + .. toctree:: :maxdepth: 2 @@ -19,6 +24,14 @@ and the requirements of the system. OpenStack --------- +.. os-begin + +|prod-os| is a containerized application running on top of the |prod-long|. + +The storage management of hosts is not specific to |prod-os|. + +.. os-end + .. toctree:: :maxdepth: 2 diff --git a/doc/source/storage/kubernetes/index.rst b/doc/source/storage/kubernetes/index.rst index 29270e8de..e3bde1865 100644 --- a/doc/source/storage/kubernetes/index.rst +++ b/doc/source/storage/kubernetes/index.rst @@ -1,6 +1,12 @@ -======== -Contents -======== +.. _storage-kubernetes-index: + +.. include:: /_includes/toc-title-storage-kub.rest + +.. only:: partner + + .. include:: /storage/index.rst + :start-after: kub-begin + :end-before: kub-end -------- Overview diff --git a/doc/source/storage/openstack/index.rst b/doc/source/storage/openstack/index.rst index d073d2a92..c3b30339c 100644 --- a/doc/source/storage/openstack/index.rst +++ b/doc/source/storage/openstack/index.rst @@ -1,8 +1,12 @@ -======== -Contents -======== +.. _storage-openstack-index: -.. check what put here +.. include:: /_includes/toc-title-storage-os.rest + +.. only:: partner + + .. include:: /storage/index.rst + :start-after: os-begin + :end-before: os-end .. toctree:: :maxdepth: 1 diff --git a/doc/source/storage/openstack/storage-configuration-and-management-overview.rst b/doc/source/storage/openstack/storage-configuration-and-management-overview.rst index a848c7be3..51d641d7a 100644 --- a/doc/source/storage/openstack/storage-configuration-and-management-overview.rst +++ b/doc/source/storage/openstack/storage-configuration-and-management-overview.rst @@ -13,6 +13,6 @@ information, see |prod-long| System Configuration: .. xbooklink :ref:`System Configuration Management Overview `. -This chapter covers concepts and additional considerations related to storage +This section covers concepts and additional considerations related to storage management that are specific to |prod-os|. diff --git a/doc/source/system_configuration/index.rst b/doc/source/system_configuration/index.rst index bfae93aba..d936d6389 100644 --- a/doc/source/system_configuration/index.rst +++ b/doc/source/system_configuration/index.rst @@ -9,10 +9,14 @@ System Configuration StarlingX Kubernetes -------------------- +.. kub-begin + |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. +.. kub-end + .. toctree:: :maxdepth: 2 @@ -22,12 +26,16 @@ and to set additional system configuration data. StarlingX OpenStack ------------------- +.. os-begin + |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 +charts. In the case of |prod|, there is generally a Helm chart for every OpenStack service. +.. os-end + .. toctree:: :maxdepth: 3 diff --git a/doc/source/system_configuration/kubernetes/index.rst b/doc/source/system_configuration/kubernetes/index.rst index 2323f31ad..87bf6a31a 100644 --- a/doc/source/system_configuration/kubernetes/index.rst +++ b/doc/source/system_configuration/kubernetes/index.rst @@ -1,8 +1,12 @@ .. _sysconf_kubernetes_index: -========== -Kubernetes -========== +.. include:: /_includes/toc-title-sys-conf-kub.rest + +.. only:: partner + + .. include:: /system_configuration/index.rst + :start-after: kub-begin + :end-before: kub-end ---------------------- Timezone Configuration diff --git a/doc/source/system_configuration/openstack/index.rst b/doc/source/system_configuration/openstack/index.rst index 851bbac6c..17e43dc52 100644 --- a/doc/source/system_configuration/openstack/index.rst +++ b/doc/source/system_configuration/openstack/index.rst @@ -1,8 +1,12 @@ .. _sysconf_openstack_index: -=================== -StarlingX OpenStack -=================== +.. include:: /_includes/toc-title-sys-conf-os.rest + +.. only:: partner + + .. include:: /system_configuration/index.rst + :start-after: os-begin + :end-before: os-end ------------------------------------------------------- Configure OpenStack Services Using Helm Chart Overrides diff --git a/doc/source/updates/index.rst b/doc/source/updates/index.rst index 9d3882d25..1a85895ef 100644 --- a/doc/source/updates/index.rst +++ b/doc/source/updates/index.rst @@ -6,9 +6,13 @@ Updates and Upgrades Kubernetes ---------- +.. kub-begin + Kubernetes version upgrade cloud orchestration allows the Kubernetes version on all hosts of an entire |prod-long| cloud to be updated with a single operation. +.. kub-end + .. toctree:: :maxdepth: 2 @@ -18,10 +22,14 @@ all hosts of an entire |prod-long| cloud to be updated with a single operation. Openstack --------- +.. os-begin + The system application-update -n |prefix|-openstack -v command is used for corrective content \(bug fixes\) -type updates to the running containerized openstack application. +.. os-end + .. toctree:: :maxdepth: 2 diff --git a/doc/source/updates/kubernetes/index.rst b/doc/source/updates/kubernetes/index.rst index 51cc39f2e..532f925a8 100644 --- a/doc/source/updates/kubernetes/index.rst +++ b/doc/source/updates/kubernetes/index.rst @@ -1,7 +1,13 @@ -========== -Kubernetes -========== +.. _updates_kubernetes_index: + +.. include:: /_includes/toc-title-updates-kub.rest + +.. only:: partner + + .. include:: /updates/index.rst + :start-after: kub-begin + :end-before: kub-end ------------ Introduction diff --git a/doc/source/updates/openstack/index.rst b/doc/source/updates/openstack/index.rst index 5127221de..3eb055abd 100644 --- a/doc/source/updates/openstack/index.rst +++ b/doc/source/updates/openstack/index.rst @@ -1,7 +1,13 @@ ---------- -OpenStack ---------- +.. _updates_openstack_index: + +.. include:: /_includes/toc-title-updates-os.rest + +.. only:: partner + + .. include:: /updates/index.rst + :start-after: os-begin + :end-before: os-end =============== Software Update diff --git a/doc/source/usertasks/index.rs1 b/doc/source/usertasks/index.rs1 deleted file mode 100644 index e69de29bb..000000000 diff --git a/doc/source/usertasks/index.rst b/doc/source/usertasks/index.rst index 76257f8ef..b18de1572 100644 --- a/doc/source/usertasks/index.rst +++ b/doc/source/usertasks/index.rst @@ -6,9 +6,13 @@ User Tasks Kubernetes ---------- +.. kub-begin + The |prod-long| Kubernetes user tutorials provide working examples of common end-user tasks. +.. kub-end + .. toctree:: :maxdepth: 2 diff --git a/doc/source/usertasks/kubernetes/index.rst b/doc/source/usertasks/kubernetes/index.rst index c534e40ff..907e9d968 100644 --- a/doc/source/usertasks/kubernetes/index.rst +++ b/doc/source/usertasks/kubernetes/index.rst @@ -1,6 +1,12 @@ -======== -Contents -======== +.. _usertasks-kubernetes-index: + +.. include:: /_includes/toc-title-usertasks-kub.rest + +.. only:: partner + + .. include:: /usertasks/index.rst + :start-after: kub-begin + :end-before: kub-end ------------- System access