diff --git a/.gitmodules b/.gitmodules index 4088e55..33c7358 100644 --- a/.gitmodules +++ b/.gitmodules @@ -1,9 +1,18 @@ +[submodule "formulas/git"] + path = formulas/git + url = https://github.com/tcpcloud/salt-formula-git.git [submodule "formulas/linux"] path = formulas/linux url = https://github.com/tcpcloud/salt-formula-linux.git +[submodule "formulas/ntp"] + path = formulas/ntp + url = https://github.com/tcpcloud/salt-formula-ntp.git [submodule "formulas/openssh"] path = formulas/openssh url = https://github.com/tcpcloud/salt-formula-openssh.git +[submodule "formulas/reclass"] + path = formulas/reclass + url = https://github.com/tcpcloud/salt-formula-reclass.git [submodule "formulas/salt"] path = formulas/salt url = https://github.com/tcpcloud/salt-formula-salt.git diff --git a/doc/source/conf.py b/doc/source/conf.py index bf82823..4488f83 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -240,7 +240,7 @@ latex_documents = [ # (source start file, name, description, authors, manual section). man_pages = [ (master_doc, 'openstack-salt', - 'openstack-salt Documentation', + 'OpenStack-Salt Documentation', [author], 1) ] @@ -255,7 +255,7 @@ man_pages = [ # dir menu entry, description, category) texinfo_documents = [ (master_doc, 'openstack-salt', - 'openstack-salt Documentation', + 'OpenStack-Salt Documentation', author, 'openstack-salt', 'One line description of project.', 'Miscellaneous'), ] diff --git a/doc/source/index.rst b/doc/source/index.rst index f02d6a8..68bc22c 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1,14 +1,14 @@ .. openstack-salt documentation master file, created by sphinx-quickstart on Mon Nov 25 09:13:17 2015. -Welcome to OpenStack-Salt's documentation! -========================================== - +=============================== +OpenStack-Salt's Documentation +=============================== Overview ======== -This project provides complete set of Salt configuration templates for installing and operating robust OpenStack cloud deployments. +This project provides scalable and reliable IT automation using SaltStack for installing and operating OpenStack cloud deployments. Contents: diff --git a/doc/source/install/overview-reclass.rst b/doc/source/install/overview-pillar.rst similarity index 76% rename from doc/source/install/overview-reclass.rst rename to doc/source/install/overview-pillar.rst index e701f7b..d68a26d 100644 --- a/doc/source/install/overview-reclass.rst +++ b/doc/source/install/overview-pillar.rst @@ -1,5 +1,5 @@ -Reclass classification +Pillars classification ========================= diff --git a/doc/source/install/overview-salt.rst b/doc/source/install/overview-salt.rst index a325370..772571a 100644 --- a/doc/source/install/overview-salt.rst +++ b/doc/source/install/overview-salt.rst @@ -4,14 +4,13 @@ SaltStack configuration OpenStack-Salt Deployment uses Salt configuration platform to install and manage OpenStack. Salt is an automation platform that greatly simplifies system and application deployment. Salt infrastructure uses asynchronous and reliable RAET protocol to communicate and it provides speed of task execution and message transport. -Salt uses *formulas* to define resources written in the YAML language that orchestrate the individual parts of system into the working entity. For more information, see `Salt - Intro to Playbooks `_. +Salt uses *formulas* to define resources written in the YAML language that orchestrate the individual parts of system into the working entity. For more information, see `Salt Formulas `_. -This guide refers to the host running Salt formulas and metadata service as the *master* and the hosts on which Salt installs OSA as the *minions*. +This guide refers to the host running Salt formulas and metadata service as the *master* and the hosts on which Salt installs the OpenStack-Salt as the *minions*. A recommended minimal layout for deployments involves five target hosts in total: three infrastructure hosts, and two compute host. All hosts require one network interface. More information on setting up target hosts can be found in `the section called "Server topology" `_. -For more information on physical, logical, and virtual network interfaces within hosts see `the section called "Host -networking" `_. +For more information on physical, logical, and virtual network interfaces within hosts see `the section called "Server networking" `_. -------------- diff --git a/doc/source/install/overview.rst b/doc/source/install/overview.rst index 38c1fec..6a166e0 100644 --- a/doc/source/install/overview.rst +++ b/doc/source/install/overview.rst @@ -6,7 +6,7 @@ Chapter 1. Overview .. toctree:: overview-salt.rst - overview-reclass.rst + overview-pillar.rst overview-requirements.rst overview-server-networking.rst overview-server-topology.rst diff --git a/doc/source/operate/monitoring-events.rst b/doc/source/operate/monitoring-events.rst new file mode 100644 index 0000000..da494db --- /dev/null +++ b/doc/source/operate/monitoring-events.rst @@ -0,0 +1,8 @@ + +Event monitoring +============================ + + +-------------- + +.. include:: navigation.txt diff --git a/doc/source/operate/monitoring-logs.rst b/doc/source/operate/monitoring-logs.rst new file mode 100644 index 0000000..2792e05 --- /dev/null +++ b/doc/source/operate/monitoring-logs.rst @@ -0,0 +1,8 @@ + +Log monitoring +============================ + + +-------------- + +.. include:: navigation.txt diff --git a/doc/source/operate/monitoring-meters.rst b/doc/source/operate/monitoring-meters.rst new file mode 100644 index 0000000..9d66da6 --- /dev/null +++ b/doc/source/operate/monitoring-meters.rst @@ -0,0 +1,8 @@ + +Meter monitoring +============================ + + +-------------- + +.. include:: navigation.txt diff --git a/doc/source/operate/monitoring.rst b/doc/source/operate/monitoring.rst index 708fe1b..ed5170a 100644 --- a/doc/source/operate/monitoring.rst +++ b/doc/source/operate/monitoring.rst @@ -1,7 +1,20 @@ + +=========================================== + + + + +=========================================== Chapter 2. Monitoring, Metering and Logging =========================================== +.. toctree:: + + monitoring-events.rst + monitoring-meters.rst + monitoring-logs.rst + -------------- -.. include:: navigation.txt \ No newline at end of file +.. include:: navigation.txt diff --git a/doc/source/operate/troubleshoot-database.rst b/doc/source/operate/troubleshoot-database.rst new file mode 100644 index 0000000..8543c31 --- /dev/null +++ b/doc/source/operate/troubleshoot-database.rst @@ -0,0 +1,8 @@ + +Troubleshooting database +============================ + + +-------------- + +.. include:: navigation.txt diff --git a/doc/source/operate/troubleshoot.rst b/doc/source/operate/troubleshoot.rst index e179619..08cfe3d 100644 --- a/doc/source/operate/troubleshoot.rst +++ b/doc/source/operate/troubleshoot.rst @@ -5,6 +5,7 @@ Chapter 3. Troubleshooting OpenStack .. toctree:: + troubleshoot-database.rst troubleshoot-networking.rst --------------