diff --git a/doc/source/index.rst b/doc/source/index.rst index 39158cbaf..c7929a645 100755 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -55,7 +55,7 @@ Planning .. toctree:: :maxdepth: 2 - planning/index + planning/index-planning-332af0718d15 ------------------- Installation guides diff --git a/doc/source/planning/index.rst b/doc/source/planning/index-planning-332af0718d15.rst old mode 100755 new mode 100644 similarity index 72% rename from doc/source/planning/index.rst rename to doc/source/planning/index-planning-332af0718d15.rst index 1034b2657..83e5e9e10 --- a/doc/source/planning/index.rst +++ b/doc/source/planning/index-planning-332af0718d15.rst @@ -1,45 +1,42 @@ -.. Planning 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. - -======== -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 -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 - - kubernetes/index - ---------- -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 - - openstack/index +.. _index-planning-332af0718d15: + +======== +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 +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 + + kubernetes/index-planning-kub-913bd621ac0f + +--------- +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 + + openstack/index-planning-os-e815f964d279 diff --git a/doc/source/planning/kubernetes/index.rst b/doc/source/planning/kubernetes/index-planning-kub-913bd621ac0f.rst old mode 100755 new mode 100644 similarity index 92% rename from doc/source/planning/kubernetes/index.rst rename to doc/source/planning/kubernetes/index-planning-kub-913bd621ac0f.rst index 612691473..b07e14521 --- a/doc/source/planning/kubernetes/index.rst +++ b/doc/source/planning/kubernetes/index-planning-kub-913bd621ac0f.rst @@ -1,113 +1,113 @@ -.. _planning_kubernetes_index: - -.. include:: /_includes/toc-title-planning-kub.rest - -.. only:: partner - - .. include:: /planning/index.rst - :start-after: kub-begin - :end-before: kub-end - -************ -Introduction -************ - -.. toctree:: - :maxdepth: 1 - - overview-of-starlingx-planning - -**************** -Network planning -**************** - -.. toctree:: - :maxdepth: 1 - - network-requirements - networks-for-a-simplex-system - networks-for-a-duplex-system - networks-for-a-system-with-controller-storage - networks-for-a-system-with-dedicated-storage - network-requirements-ip-support - network-planning-the-pxe-boot-network - the-cluster-host-network - the-storage-network - -Internal management network -*************************** - -.. toctree:: - :maxdepth: 1 - - the-internal-management-network - internal-management-network-planning - multicast-subnets-for-the-management-network - -OAM network -*********** - -.. toctree:: - :maxdepth: 1 - - about-the-oam-network - oam-network-planning - dns-and-ntp-servers - network-planning-firewall-options - -L2 access switches -****************** - -.. toctree:: - :maxdepth: 1 - - l2-access-switches - redundant-top-of-rack-switch-deployment-considerations - -Ethernet interfaces -******************* - -.. toctree:: - :maxdepth: 1 - - about-ethernet-interfaces - network-planning-ethernet-interface-configuration - the-ethernet-mtu - shared-vlan-or-multi-netted-ethernet-interfaces - -**************** -Storage planning -**************** - -.. toctree:: - :maxdepth: 1 - - storage-planning-storage-resources - storage-planning-storage-on-controller-hosts - storage-planning-storage-on-worker-hosts - storage-planning-storage-on-storage-hosts - external-netapp-trident-storage - -***************** -Security planning -***************** - -.. toctree:: - :maxdepth: 1 - - security-planning-uefi-secure-boot-planning - tpm-planning - -********************************** -Installation and resource planning -********************************** - -.. toctree:: - :maxdepth: 1 - - installation-and-resource-planning-https-access-planning - starlingx-hardware-requirements - verified-commercial-hardware - starlingx-boot-sequence-considerations - hard-drive-options - controller-disk-configurations-for-all-in-one-systems +.. _index-planning-kub-913bd621ac0f: + +.. include:: /_includes/toc-title-planning-kub.rest + +.. only:: partner + + .. include:: /planning/index-planning-332af0718d15.rst + :start-after: kub-begin + :end-before: kub-end + +************ +Introduction +************ + +.. toctree:: + :maxdepth: 1 + + overview-of-starlingx-planning + +**************** +Network planning +**************** + +.. toctree:: + :maxdepth: 1 + + network-requirements + networks-for-a-simplex-system + networks-for-a-duplex-system + networks-for-a-system-with-controller-storage + networks-for-a-system-with-dedicated-storage + network-requirements-ip-support + network-planning-the-pxe-boot-network + the-cluster-host-network + the-storage-network + +Internal management network +*************************** + +.. toctree:: + :maxdepth: 1 + + the-internal-management-network + internal-management-network-planning + multicast-subnets-for-the-management-network + +OAM network +*********** + +.. toctree:: + :maxdepth: 1 + + about-the-oam-network + oam-network-planning + dns-and-ntp-servers + network-planning-firewall-options + +L2 access switches +****************** + +.. toctree:: + :maxdepth: 1 + + l2-access-switches + redundant-top-of-rack-switch-deployment-considerations + +Ethernet interfaces +******************* + +.. toctree:: + :maxdepth: 1 + + about-ethernet-interfaces + network-planning-ethernet-interface-configuration + the-ethernet-mtu + shared-vlan-or-multi-netted-ethernet-interfaces + +**************** +Storage planning +**************** + +.. toctree:: + :maxdepth: 1 + + storage-planning-storage-resources + storage-planning-storage-on-controller-hosts + storage-planning-storage-on-worker-hosts + storage-planning-storage-on-storage-hosts + external-netapp-trident-storage + +***************** +Security planning +***************** + +.. toctree:: + :maxdepth: 1 + + security-planning-uefi-secure-boot-planning + tpm-planning + +********************************** +Installation and resource planning +********************************** + +.. toctree:: + :maxdepth: 1 + + installation-and-resource-planning-https-access-planning + starlingx-hardware-requirements + verified-commercial-hardware + starlingx-boot-sequence-considerations + hard-drive-options + controller-disk-configurations-for-all-in-one-systems diff --git a/doc/source/planning/openstack/index.rst b/doc/source/planning/openstack/index-planning-os-e815f964d279.rst old mode 100755 new mode 100644 similarity index 91% rename from doc/source/planning/openstack/index.rst rename to doc/source/planning/openstack/index-planning-os-e815f964d279.rst index 0500a30b1..6e25676a0 --- a/doc/source/planning/openstack/index.rst +++ b/doc/source/planning/openstack/index-planning-os-e815f964d279.rst @@ -1,121 +1,120 @@ - -.. _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 -================ - -.. toctree:: - :maxdepth: 1 - - network-planning-ip-support - the-pxe-boot-network - network-planning-the-internal-management-network - network-planning-the-cluster-host-network - the-oam-network - -************* -Data networks -************* - -.. toctree:: - :maxdepth: 1 - - network-planning-data-networks - physical-network-planning - resource-planning - -.. toctree:: - :maxdepth: 1 - - network-planning-l2-access-switches - -******************* -Ethernet interfaces -******************* - -.. toctree:: - :maxdepth: 1 - - ethernet-interfaces - ethernet-interface-configuration - the-ethernet-mtu - network-planning-shared-vlan-or-multi-netted-ethernet-interfaces - -************************* -Virtual or cloud networks -************************* - -.. toctree:: - :maxdepth: 1 - - virtual-or-cloud-networks - os-data-networks-overview - project-networks - -Project network planning -************************ - -.. toctree:: - :maxdepth: 1 - - project-network-planning - project-network-ip-address-management - subnet-details - internal-dns-resolution - data-network-planning - vxlans - vlan-aware-vms - -VM network interface options -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. toctree:: - :maxdepth: 1 - - vm-network-interface-options - port-security-extension - pci-passthrough-ethernet-interfaces - sr-iov-ethernet-interfaces - -================ -Storage planning -================ - -.. toctree:: - :maxdepth: 1 - - storage-resources - storage-configuration-storage-on-hosts - block-storage-for-virtual-machines - vm-storage-settings-for-migration-resize-or-evacuation - - -================= -Security planning -================= - -.. toctree:: - :maxdepth: 1 - - uefi-secure-boot-planning - https-access-planning - -================================== -Installation and resource planning -================================== - -.. toctree:: - :maxdepth: 1 - - hardware-requirements - installation-and-resource-planning-verified-commercial-hardware +.. _index-planning-os-e815f964d279: + +.. include:: /_includes/toc-title-planning-os.rest + +.. only:: partner + + .. include:: /planning/index-planning-332af0718d15.rst + :start-after: os-begin + :end-before: os-end + +================ +Network planning +================ + +.. toctree:: + :maxdepth: 1 + + network-planning-ip-support + the-pxe-boot-network + network-planning-the-internal-management-network + network-planning-the-cluster-host-network + the-oam-network + +************* +Data networks +************* + +.. toctree:: + :maxdepth: 1 + + network-planning-data-networks + physical-network-planning + resource-planning + +.. toctree:: + :maxdepth: 1 + + network-planning-l2-access-switches + +******************* +Ethernet interfaces +******************* + +.. toctree:: + :maxdepth: 1 + + ethernet-interfaces + ethernet-interface-configuration + the-ethernet-mtu + network-planning-shared-vlan-or-multi-netted-ethernet-interfaces + +************************* +Virtual or cloud networks +************************* + +.. toctree:: + :maxdepth: 1 + + virtual-or-cloud-networks + os-data-networks-overview + project-networks + +Project network planning +************************ + +.. toctree:: + :maxdepth: 1 + + project-network-planning + project-network-ip-address-management + subnet-details + internal-dns-resolution + data-network-planning + vxlans + vlan-aware-vms + +VM network interface options +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. toctree:: + :maxdepth: 1 + + vm-network-interface-options + port-security-extension + pci-passthrough-ethernet-interfaces + sr-iov-ethernet-interfaces + +================ +Storage planning +================ + +.. toctree:: + :maxdepth: 1 + + storage-resources + storage-configuration-storage-on-hosts + block-storage-for-virtual-machines + vm-storage-settings-for-migration-resize-or-evacuation + + +================= +Security planning +================= + +.. toctree:: + :maxdepth: 1 + + uefi-secure-boot-planning + https-access-planning + +================================== +Installation and resource planning +================================== + +.. toctree:: + :maxdepth: 1 + + hardware-requirements + installation-and-resource-planning-verified-commercial-hardware installation-and-resource-planning-controller-disk-configurations-for-all-in-one-systems \ No newline at end of file