From b7b7a34ff7694b7ea4054fbeaafa01099cf9fa65 Mon Sep 17 00:00:00 2001 From: Stone Date: Tue, 16 Feb 2021 15:12:44 -0500 Subject: [PATCH] Storage updates Created new storage/kubernetes/index file and modified storage/index to point to it. This is to match changes to other docs. Stripped Windows line ends off htmlChecks.sh Signed-off-by: Stone Change-Id: I328c4bf39cf90f86fb08f02af728d99e168709cc --- doc/source/storage/index.rst | 153 +---------------------- doc/source/storage/kubernetes/index.rst | 156 ++++++++++++++++++++++++ htmlChecks.sh | 2 +- 3 files changed, 163 insertions(+), 148 deletions(-) create mode 100644 doc/source/storage/kubernetes/index.rst diff --git a/doc/source/storage/index.rst b/doc/source/storage/index.rst index b44478f42..9622ace2d 100644 --- a/doc/source/storage/index.rst +++ b/doc/source/storage/index.rst @@ -5,156 +5,15 @@ Storage Kubernetes ---------- -******** -Overview -******** +|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. .. toctree:: - :maxdepth: 1 - - kubernetes/storage-configuration-storage-resources - kubernetes/disk-naming-conventions + :maxdepth: 2 -********************************************* -Disks, Partitions, Volumes, and Volume Groups -********************************************* - -.. toctree:: - :maxdepth: 1 - - kubernetes/work-with-local-volume-groups - kubernetes/local-volume-groups-cli-commands - kubernetes/increase-the-size-for-lvm-local-volumes-on-controller-filesystems - -Work with Disk Partitions -************************* - -.. toctree:: - :maxdepth: 1 - - kubernetes/work-with-disk-partitions - kubernetes/identify-space-available-for-partitions - kubernetes/list-partitions - kubernetes/view-details-for-a-partition - kubernetes/add-a-partition - kubernetes/increase-the-size-of-a-partition - kubernetes/delete-a-partition - -Work with Physical Volumes -************************** - -.. toctree:: - :maxdepth: 1 - - kubernetes/work-with-physical-volumes - kubernetes/add-a-physical-volume - kubernetes/list-physical-volumes - kubernetes/view-details-for-a-physical-volume - kubernetes/delete-a-physical-volume - -**************** -Storage Backends -**************** - -.. toctree:: - :maxdepth: 1 - - kubernetes/storage-backends - kubernetes/configure-the-internal-ceph-storage-backend - kubernetes/configure-an-external-netapp-deployment-as-the-storage-backend - kubernetes/configure-netapps-using-a-private-docker-registry - kubernetes/uninstall-the-netapp-backend - -**************** -Controller Hosts -**************** - -.. toctree:: - :maxdepth: 1 - - kubernetes/controller-hosts-storage-on-controller-hosts - kubernetes/ceph-cluster-on-a-controller-host - kubernetes/increase-controller-filesystem-storage-allotments-using-horizon - kubernetes/increase-controller-filesystem-storage-allotments-using-the-cli - -************ -Worker Hosts -************ - -.. toctree:: - :maxdepth: 1 - - kubernetes/storage-configuration-storage-on-worker-hosts - -************* -Storage Hosts -************* - -.. toctree:: - :maxdepth: 1 - - kubernetes/storage-hosts-storage-on-storage-hosts - kubernetes/replication-groups - -***************************** -Configure Ceph OSDs on a Host -***************************** - -.. toctree:: - :maxdepth: 1 - - kubernetes/ceph-storage-pools - kubernetes/osd-replication-factors-journal-functions-and-storage-tiers - kubernetes/storage-functions-osds-and-ssd-backed-journals - kubernetes/add-ssd-backed-journals-using-horizon - kubernetes/add-ssd-backed-journals-using-the-cli - kubernetes/add-a-storage-tier-using-the-cli - kubernetes/replace-osds-and-journal-disks - kubernetes/provision-storage-on-a-controller-or-storage-host-using-horizon - kubernetes/provision-storage-on-a-storage-host-using-the-cli - -************************* -Persistent Volume Support -************************* - -.. toctree:: - :maxdepth: 1 - - kubernetes/about-persistent-volume-support - kubernetes/default-behavior-of-the-rbd-provisioner - kubernetes/storage-configuration-create-persistent-volume-claims - kubernetes/storage-configuration-mount-persistent-volumes-in-containers - kubernetes/enable-pvc-support-in-additional-namespaces - kubernetes/enable-additional-storage-classes - kubernetes/install-additional-rbd-provisioners - -**************** -Storage Profiles -**************** - -.. toctree:: - :maxdepth: 1 - - kubernetes/storage-profiles - -**************************** -Storage-Related CLI Commands -**************************** - -.. toctree:: - :maxdepth: 1 - - kubernetes/storage-configuration-storage-related-cli-commands - -********************* -Storage Usage Details -********************* - -.. toctree:: - :maxdepth: 1 - - kubernetes/storage-usage-details-storage-utilization-display - kubernetes/view-storage-utilization-using-horizon + kubernetes/index --------- OpenStack diff --git a/doc/source/storage/kubernetes/index.rst b/doc/source/storage/kubernetes/index.rst new file mode 100644 index 000000000..fe3f610d9 --- /dev/null +++ b/doc/source/storage/kubernetes/index.rst @@ -0,0 +1,156 @@ +======== +Contents +======== + +-------- +Overview +-------- + +.. toctree:: + :maxdepth: 1 + + storage-configuration-storage-resources + disk-naming-conventions + +--------------------------------------------- +Disks, Partitions, Volumes, and Volume Groups +--------------------------------------------- + +.. toctree:: + :maxdepth: 1 + + work-with-local-volume-groups + local-volume-groups-cli-commands + increase-the-size-for-lvm-local-volumes-on-controller-filesystems + +************************* +Work with Disk Partitions +************************* + +.. toctree:: + :maxdepth: 1 + + work-with-disk-partitions + identify-space-available-for-partitions + list-partitions + view-details-for-a-partition + add-a-partition + increase-the-size-of-a-partition + delete-a-partition + +************************** +Work with Physical Volumes +************************** + +.. toctree:: + :maxdepth: 1 + + work-with-physical-volumes + add-a-physical-volume + list-physical-volumes + view-details-for-a-physical-volume + delete-a-physical-volume + +---------------- +Storage Backends +---------------- + +.. toctree:: + :maxdepth: 1 + + storage-backends + configure-the-internal-ceph-storage-backend + configure-an-external-netapp-deployment-as-the-storage-backend + configure-netapps-using-a-private-docker-registry + uninstall-the-netapp-backend + +---------------- +Controller Hosts +---------------- + +.. toctree:: + :maxdepth: 1 + + controller-hosts-storage-on-controller-hosts + ceph-cluster-on-a-controller-host + increase-controller-filesystem-storage-allotments-using-horizon + increase-controller-filesystem-storage-allotments-using-the-cli + +------------ +Worker Hosts +------------ + +.. toctree:: + :maxdepth: 1 + + storage-configuration-storage-on-worker-hosts + +------------- +Storage Hosts +------------- + +.. toctree:: + :maxdepth: 1 + + storage-hosts-storage-on-storage-hosts + replication-groups + +----------------------------- +Configure Ceph OSDs on a Host +----------------------------- + +.. toctree:: + :maxdepth: 1 + + ceph-storage-pools + osd-replication-factors-journal-functions-and-storage-tiers + storage-functions-osds-and-ssd-backed-journals + add-ssd-backed-journals-using-horizon + add-ssd-backed-journals-using-the-cli + add-a-storage-tier-using-the-cli + replace-osds-and-journal-disks + provision-storage-on-a-controller-or-storage-host-using-horizon + provision-storage-on-a-storage-host-using-the-cli + +------------------------- +Persistent Volume Support +------------------------- + +.. toctree:: + :maxdepth: 1 + + about-persistent-volume-support + default-behavior-of-the-rbd-provisioner + storage-configuration-create-persistent-volume-claims + storage-configuration-mount-persistent-volumes-in-containers + enable-pvc-support-in-additional-namespaces + enable-additional-storage-classes + install-additional-rbd-provisioners + +---------------- +Storage Profiles +---------------- + +.. toctree:: + :maxdepth: 1 + + storage-profiles + +---------------------------- +Storage-Related CLI Commands +---------------------------- + +.. toctree:: + :maxdepth: 1 + + storage-configuration-storage-related-cli-commands + +--------------------- +Storage Usage Details +--------------------- + +.. toctree:: + :maxdepth: 1 + + storage-usage-details-storage-utilization-display + view-storage-utilization-using-horizon diff --git a/htmlChecks.sh b/htmlChecks.sh index 934642a7f..65b5b68c2 100755 --- a/htmlChecks.sh +++ b/htmlChecks.sh @@ -23,4 +23,4 @@ if [ ${#GREY_FILES[@]} != 0 ]; then fi fi -# 2. do - check for emdash before option (missing backticks) \ No newline at end of file +# 2. do - check for emdash before option (missing backticks)