diff --git a/doc/source/advanced_deployment/advanced_deployment.rst b/doc/source/advanced_deployment/advanced_deployment.rst deleted file mode 100644 index e7118b0f..00000000 --- a/doc/source/advanced_deployment/advanced_deployment.rst +++ /dev/null @@ -1,12 +0,0 @@ -Advanced Deployment -=================== - -In this chapter you will find advanced deployment of various |project| areas. - - -.. toctree:: - - features - baremetal_nodes - backends - custom diff --git a/doc/source/advanced_deployment/baremetal_nodes.rst b/doc/source/advanced_deployment/baremetal_nodes.rst index ee2c4541..d062d807 100644 --- a/doc/source/advanced_deployment/baremetal_nodes.rst +++ b/doc/source/advanced_deployment/baremetal_nodes.rst @@ -4,10 +4,8 @@ Baremetal Node Configuration Documentation on how to do advanced configuration of baremetal nodes in |project|. - .. toctree:: - node_states root_device introspect_single_node diff --git a/doc/source/basic_deployment/basic_deployment_cli.rst b/doc/source/basic_deployment/basic_deployment_cli.rst index d6b7b9cc..3e758d60 100644 --- a/doc/source/basic_deployment/basic_deployment_cli.rst +++ b/doc/source/basic_deployment/basic_deployment_cli.rst @@ -256,7 +256,7 @@ Load the images into the undercloud Glance:: openstack overcloud image upload -To upload a single image, see :doc:`../advanced_deployment/upload_single_image`. +To upload a single image, see :doc:`../post_deployment/upload_single_image`. Register Nodes -------------- diff --git a/doc/source/basic_deployment/repositories.rst b/doc/source/basic_deployment/repositories.rst index 9e55f779..5e929b7a 100644 --- a/doc/source/basic_deployment/repositories.rst +++ b/doc/source/basic_deployment/repositories.rst @@ -1,3 +1,5 @@ +:orphan: + Repository Enablement ===================== diff --git a/doc/source/developer/tht_walkthrough/changes-puppet-tripleo.rst b/doc/source/developer/tht_walkthrough/changes-puppet-tripleo.rst index f47aabfd..4f47e73c 100644 --- a/doc/source/developer/tht_walkthrough/changes-puppet-tripleo.rst +++ b/doc/source/developer/tht_walkthrough/changes-puppet-tripleo.rst @@ -1,6 +1,8 @@ Updating puppet-tripleo ----------------------- +.. include:: ../../links.rst + The puppet manifests that currently define overcloud node configuration are moved from the tripleo-heat-templates to new puppet-tripleo class definitions as part of the composable services approach. In next iterations, all service diff --git a/doc/source/developer/tht_walkthrough/changes-tht.rst b/doc/source/developer/tht_walkthrough/changes-tht.rst index 20ed296c..2ccf82e0 100644 --- a/doc/source/developer/tht_walkthrough/changes-tht.rst +++ b/doc/source/developer/tht_walkthrough/changes-tht.rst @@ -1,6 +1,8 @@ Updating tripleo-heat-templates ------------------------------- +.. include:: ../../links.rst + This section will describe the changes needed for tripleo-heat-templates. Folder structure convention for tripleo-heat-templates diff --git a/doc/source/developer/tht_walkthrough/introduction.rst b/doc/source/developer/tht_walkthrough/introduction.rst index 78374534..2df649cb 100644 --- a/doc/source/developer/tht_walkthrough/introduction.rst +++ b/doc/source/developer/tht_walkthrough/introduction.rst @@ -1,6 +1,8 @@ Introduction ------------ +.. include:: ../../links.rst + The initial scope of this tutorial is to create a brief walkthrough with some guidelines and naming conventions for future modules and features aligned with the composable services architecture. Regarding the example described in this diff --git a/doc/source/developer/tht_walkthrough/tht_walkthrough.rst b/doc/source/developer/tht_walkthrough/tht_walkthrough.rst index e921222f..0ef4f76e 100644 --- a/doc/source/developer/tht_walkthrough/tht_walkthrough.rst +++ b/doc/source/developer/tht_walkthrough/tht_walkthrough.rst @@ -1,9 +1,7 @@ Composable services tutorial ============================ -.. _composable services architecture: https://blueprints.launchpad.net/tripleo/+spec/composable-services-within-roles -.. _THT repository: https://github.com/openstack/tripleo-heat-templates/tree/master/puppet/services -.. _puppet-tripleo repository: https://github.com/openstack/puppet-tripleo/tree/master/manifests/profile +.. include:: ../../links.rst This guide will be a walkthrough related to how to add new services to a TripleO deployment through additions to the tripleo-heat-templates and puppet-tripleo @@ -14,8 +12,11 @@ repositories, using part of the architecture defined in the `composable services No puppet manifests may be defined in the `THT repository`_, they should go to the `puppet-tripleo repository`_ instead. -.. include:: introduction.rst -.. include:: changes-tht.rst -.. include:: changes-puppet-tripleo.rst -.. include:: design-patterns.rst -.. include:: summary.rst +.. toctree:: + :maxdepth: 2 + + introduction + changes-tht + changes-puppet-tripleo + design-patterns + summary diff --git a/doc/source/environments/environments.rst b/doc/source/environments/environments.rst index 7da99bfc..6814bcbf 100644 --- a/doc/source/environments/environments.rst +++ b/doc/source/environments/environments.rst @@ -4,6 +4,8 @@ Environment Setup |project| can be used in baremetal as well as in virtual environments. This section contains instructions on how to setup your environments properly. -.. include:: virtual.rst -.. include:: baremetal.rst +.. toctree:: + :maxdepth: 2 + virtual + baremetal diff --git a/doc/source/introduction.rst b/doc/source/introduction.rst deleted file mode 100644 index 71d82939..00000000 --- a/doc/source/introduction.rst +++ /dev/null @@ -1,7 +0,0 @@ -Introduction -============ - -TripleO is a program aimed at installing, upgrading and operating OpenStack -clouds using OpenStack's own cloud facilities as the foundations - building -on nova, neutron and heat to automate fleet management at datacentre scale -(and scaling down to as few as 2 machines). diff --git a/doc/source/introduction/components.rst b/doc/source/introduction/components.rst index e6696bed..d3952429 100644 --- a/doc/source/introduction/components.rst +++ b/doc/source/introduction/components.rst @@ -374,7 +374,8 @@ command with consistent syntax and behaviour. **How to contribute** * python-openstackclient uses `tox `_ - to manage the development environment, see `upstream documentation + to manage the development environment, see the + `python-openstackclient documentation `_ for details. Submit your changes via OpenStack Gerrit (see `OpenStack Developer's Guide`_). @@ -395,7 +396,8 @@ like node introspection, overcloud image building and uploading, etc. **How to contribute** * python-tripleoclient uses `tox `_ - to manage the development environment, see `documentation + to manage the development environment, see the + `python-tripleoclient documentation `_ for details. Submit your changes via `Gerrit `_. diff --git a/doc/source/links.rst b/doc/source/links.rst new file mode 100644 index 00000000..9c74b0b5 --- /dev/null +++ b/doc/source/links.rst @@ -0,0 +1,7 @@ +.. Links, citations, etc. +.. _composable services architecture: + https://blueprints.launchpad.net/tripleo/+spec/composable-services-within-roles +.. _THT repository: + https://github.com/openstack/tripleo-heat-templates/tree/master/puppet/services +.. _puppet-tripleo repository: + https://github.com/openstack/puppet-tripleo/tree/master/manifests/profile diff --git a/doc/source/post_deployment/post_deployment.rst b/doc/source/post_deployment/post_deployment.rst index 0b2caa95..c6e3d89b 100644 --- a/doc/source/post_deployment/post_deployment.rst +++ b/doc/source/post_deployment/post_deployment.rst @@ -15,4 +15,5 @@ In this chapter you will find advanced management of various |project| areas. package_update upgrade build_single_image + upload_single_image backup_restore_undercloud diff --git a/doc/source/advanced_deployment/upload_single_image.rst b/doc/source/post_deployment/upload_single_image.rst similarity index 100% rename from doc/source/advanced_deployment/upload_single_image.rst rename to doc/source/post_deployment/upload_single_image.rst diff --git a/doc/source/troubleshooting/troubleshooting-nodes.rst b/doc/source/troubleshooting/troubleshooting-nodes.rst index 3a3f0b40..951ba4a0 100644 --- a/doc/source/troubleshooting/troubleshooting-nodes.rst +++ b/doc/source/troubleshooting/troubleshooting-nodes.rst @@ -71,15 +71,17 @@ ironic-inspector times out introspection process after some time (defaulting to 1 hour) if it never gets response from the introspection ramdisk. This can be a sign of a bug in the introspection ramdisk, but usually it happens due to environment misconfiguration, particularly BIOS boot settings. Please refer to -`ironic-inspector troubleshooting documentation`_ for information on how to -detect and fix such problems. +`ironic-inspector troubleshooting documentation +`_ +for information on how to detect and fix such problems. Accessing the ramdisk ~~~~~~~~~~~~~~~~~~~~~ -Note that the introspection ramdisk is by default built with `the -dynamic-login element`_, so you can set up an SSH key and log into it for -debugging. +Note that the introspection ramdisk is by default built with the +`dynamic-login element +`_, +so you can set up an SSH key and log into it for debugging. First, think of a temporary root password. Generate a hash by feeding it into ``openssl passwd -1`` command. Edit ``/httpboot/inspector.ipxe`` diff --git a/doc/source/troubleshooting/troubleshooting.rst b/doc/source/troubleshooting/troubleshooting.rst index 9104fc94..c49eec48 100644 --- a/doc/source/troubleshooting/troubleshooting.rst +++ b/doc/source/troubleshooting/troubleshooting.rst @@ -4,9 +4,11 @@ Troubleshooting At this chapter you will find answers for frequently asked questions and help with troubleshooting when using |project|. +.. toctree:: + :maxdepth: 2 -.. include:: troubleshooting-virt-setup.rst -.. include:: troubleshooting-image-build.rst -.. include:: troubleshooting-nodes.rst -.. include:: troubleshooting-overcloud.rst -.. include:: troubleshooting-tripleo-heat-templates.rst + troubleshooting-virt-setup + troubleshooting-image-build + troubleshooting-nodes + troubleshooting-overcloud + troubleshooting-tripleo-heat-templates