diff --git a/doc/source/advanced_deployment/advanced_deployment.rst b/doc/source/advanced_deployment/advanced_deployment.rst index e4864c26..e7118b0f 100644 --- a/doc/source/advanced_deployment/advanced_deployment.rst +++ b/doc/source/advanced_deployment/advanced_deployment.rst @@ -6,29 +6,7 @@ In this chapter you will find advanced deployment of various |project| areas. .. toctree:: - node_states - root_device - build_single_image - introspect_single_node - profile_matching - ready_state - introspection_data - node_config - node_specific_hieradata - extra_config - template_deploy - network_isolation - network_isolation_virt - high_availability - deploy_manila - cinder_custom_backend - cinder_netapp - ceph_config - neutron_midonet - ssl - node_placement - ops_tools - # TODO(bnemec): Add a new developer section for the docs that aren't - # relevant to regular users. - tripleo.sh - in_progress_review + features + baremetal_nodes + backends + custom diff --git a/doc/source/advanced_deployment/backends.rst b/doc/source/advanced_deployment/backends.rst new file mode 100644 index 00000000..23320649 --- /dev/null +++ b/doc/source/advanced_deployment/backends.rst @@ -0,0 +1,14 @@ +Backend Configuration +===================== + +Documentation on how to enable and configure various backends available for +OpenStack projects. + + +.. toctree:: + + deploy_manila + cinder_custom_backend + cinder_netapp + ceph_config + neutron_midonet diff --git a/doc/source/advanced_deployment/baremetal_nodes.rst b/doc/source/advanced_deployment/baremetal_nodes.rst new file mode 100644 index 00000000..12349974 --- /dev/null +++ b/doc/source/advanced_deployment/baremetal_nodes.rst @@ -0,0 +1,16 @@ +Baremetal Node Configuration +============================ + +Documentation on how to do advanced configuration of baremetal nodes in +|project|. + + +.. toctree:: + + + node_states + root_device + introspect_single_node + profile_matching + ready_state + introspection_data diff --git a/doc/source/advanced_deployment/custom.rst b/doc/source/advanced_deployment/custom.rst new file mode 100644 index 00000000..44619ba1 --- /dev/null +++ b/doc/source/advanced_deployment/custom.rst @@ -0,0 +1,12 @@ +Custom Configurations +===================== + +Documentation on how to deploy custom configurations with |project|. + + +.. toctree:: + + node_config + node_specific_hieradata + extra_config + template_deploy diff --git a/doc/source/advanced_deployment/features.rst b/doc/source/advanced_deployment/features.rst new file mode 100644 index 00000000..b873c7a5 --- /dev/null +++ b/doc/source/advanced_deployment/features.rst @@ -0,0 +1,16 @@ +Feature Configuration +===================== + +Documentation on how to enable and configure various features available in +|project|. + + +.. toctree:: + + + network_isolation + network_isolation_virt + ssl + node_placement + ops_tools + high_availability diff --git a/doc/source/basic_deployment/basic_deployment_cli.rst b/doc/source/basic_deployment/basic_deployment_cli.rst index 32c02e94..745d28e7 100644 --- a/doc/source/basic_deployment/basic_deployment_cli.rst +++ b/doc/source/basic_deployment/basic_deployment_cli.rst @@ -159,7 +159,7 @@ non-root user that was used to install the undercloud. It is also possible to use this functionality to use an in-progress review as part of the overcloud image build. See - :doc:`../advanced_deployment/in_progress_review` for details. + :doc:`../developer/in_progress_review` for details. :: @@ -169,7 +169,7 @@ non-root user that was used to install the undercloud. This command will build **overcloud-full** images (\*.qcow2, \*.initrd, \*.vmlinuz) and **ironic-python-agent** images (\*.initramfs, \*.kernel) - To rebuild only a single image, see :doc:`../advanced_deployment/build_single_image`. + To rebuild only a single image, see :doc:`../post_deployment/build_single_image`. Upload Images ------------- diff --git a/doc/source/developer/developer.rst b/doc/source/developer/developer.rst new file mode 100644 index 00000000..aaa25679 --- /dev/null +++ b/doc/source/developer/developer.rst @@ -0,0 +1,11 @@ +Developer Documentation +======================= + +Documentation of developer-specific options in |project|. + + +.. toctree:: + + tripleo.sh + in_progress_review + tht_walkthrough/tht_walkthrough diff --git a/doc/source/advanced_deployment/in_progress_review.rst b/doc/source/developer/in_progress_review.rst similarity index 100% rename from doc/source/advanced_deployment/in_progress_review.rst rename to doc/source/developer/in_progress_review.rst diff --git a/doc/source/tht_walkthrough/changes-puppet-tripleo.rst b/doc/source/developer/tht_walkthrough/changes-puppet-tripleo.rst similarity index 100% rename from doc/source/tht_walkthrough/changes-puppet-tripleo.rst rename to doc/source/developer/tht_walkthrough/changes-puppet-tripleo.rst diff --git a/doc/source/tht_walkthrough/changes-tht.rst b/doc/source/developer/tht_walkthrough/changes-tht.rst similarity index 100% rename from doc/source/tht_walkthrough/changes-tht.rst rename to doc/source/developer/tht_walkthrough/changes-tht.rst diff --git a/doc/source/tht_walkthrough/design-patterns.rst b/doc/source/developer/tht_walkthrough/design-patterns.rst similarity index 100% rename from doc/source/tht_walkthrough/design-patterns.rst rename to doc/source/developer/tht_walkthrough/design-patterns.rst diff --git a/doc/source/tht_walkthrough/introduction.rst b/doc/source/developer/tht_walkthrough/introduction.rst similarity index 100% rename from doc/source/tht_walkthrough/introduction.rst rename to doc/source/developer/tht_walkthrough/introduction.rst diff --git a/doc/source/tht_walkthrough/summary.rst b/doc/source/developer/tht_walkthrough/summary.rst similarity index 100% rename from doc/source/tht_walkthrough/summary.rst rename to doc/source/developer/tht_walkthrough/summary.rst diff --git a/doc/source/tht_walkthrough/tht_walkthrough.rst b/doc/source/developer/tht_walkthrough/tht_walkthrough.rst similarity index 100% rename from doc/source/tht_walkthrough/tht_walkthrough.rst rename to doc/source/developer/tht_walkthrough/tht_walkthrough.rst diff --git a/doc/source/advanced_deployment/tripleo.sh.rst b/doc/source/developer/tripleo.sh.rst similarity index 100% rename from doc/source/advanced_deployment/tripleo.sh.rst rename to doc/source/developer/tripleo.sh.rst diff --git a/doc/source/index.rst b/doc/source/index.rst index 5f3a51c7..2948c2f0 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -12,10 +12,13 @@ Contents: environments/environments installation/installation basic_deployment/basic_deployment_cli - advanced_deployment/advanced_deployment post_deployment/post_deployment + advanced_deployment/features + advanced_deployment/baremetal_nodes + advanced_deployment/backends + advanced_deployment/custom troubleshooting/troubleshooting - tht_walkthrough/tht_walkthrough + developer/developer contributions/contributions diff --git a/doc/source/installation/installing.rst b/doc/source/installation/installing.rst index cd5cdf19..acd6251a 100644 --- a/doc/source/installation/installing.rst +++ b/doc/source/installation/installing.rst @@ -89,7 +89,7 @@ Installing the Undercloud It is also possible to use this functionality to use an in-progress review as part of the undercloud install. See - :doc:`../advanced_deployment/in_progress_review` for details. + :doc:`../developer/in_progress_review` for details. .. admonition:: SSL :class: ssl diff --git a/doc/source/advanced_deployment/build_single_image.rst b/doc/source/post_deployment/build_single_image.rst similarity index 100% rename from doc/source/advanced_deployment/build_single_image.rst rename to doc/source/post_deployment/build_single_image.rst diff --git a/doc/source/post_deployment/post_deployment.rst b/doc/source/post_deployment/post_deployment.rst index 8661755c..7ecff57c 100644 --- a/doc/source/post_deployment/post_deployment.rst +++ b/doc/source/post_deployment/post_deployment.rst @@ -13,4 +13,5 @@ In this chapter you will find advanced management of various |project| areas. replace_controller vm_snapshot package_update + build_single_image backup_restore_undercloud