From fdc17e506aaa4c715f4353fc545080cf8c067e7c Mon Sep 17 00:00:00 2001 From: Andrew Hutchings Date: Fri, 3 Feb 2012 18:26:42 +0000 Subject: [PATCH] Adds docs for planet puppet module Change-Id: I4e1d70b36cfdc003e37c804bb2856b12449fefa3 --- doc/puppet.rst | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) diff --git a/doc/puppet.rst b/doc/puppet.rst index 5893e699..8ef080e9 100644 --- a/doc/puppet.rst +++ b/doc/puppet.rst @@ -82,8 +82,42 @@ The lodgeit module will automatically create a git repository in ``/var/backups/ Ideally the SQL files would have a row on every line to keep the diffs stored in git small, but ``drizzledump`` does not yet support this. +Planet +------ + +The planet module installs Planet Venus [5]_ along with required dependancies +on a server. It also configures specified planets based on options given. + +Planet Venus works by having a cron job which creates static files. In this +module the static files are served using nginx [4]_. + +To use this module you need to add something similar to the following into the +main ``site.pp`` manifest: + +.. code-block:: ruby + :linenos: + + node "planet.openstack.org" { + include planet + + planet::site { "openstack": + git_url => "https://github.com/openstack/openstack-planet.git" + } + } + +In this example the name "openstack" is used to create the site +``paste.openstack.org``. The site will be served from +``/srv/planet/openstack/`` and the checkout of the ``git_url`` supplied will +be maintained in ``/var/lib/planet/openstack/``. + +This module will also create a cron job to pull new feed data 3 minutes past each hour. + +The ``git_url`` parameter needs to point to a git repository which stores the +planet.ini configuration for the planet (which stores a list of feeds) and any required theme data. This will be pulled every time puppet is run. + .. rubric:: Footnotes .. [1] `Lodgeit homepage `_ .. [2] `dcolish's Lodgeit fork `_ .. [3] `Drizzle homepage `_ .. [4] `nginx homepage `_ +.. [5] `Planet Venus `_