diff --git a/doc/conf.py b/doc/conf.py index e1742ea6..eafad3cc 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -41,7 +41,7 @@ master_doc = 'index' # General information about the project. project = u'OpenStack CI' -copyright = u'2011, Monty Taylor and James Blair' +copyright = u'2011, Monty Taylor, James Blair and Andrew Hutchings' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the @@ -212,5 +212,5 @@ latex_documents = [ # (source start file, name, description, authors, manual section). man_pages = [ ('index', 'openstackci', u'OpenStack CI Documentation', - [u'Monty Taylor and James Blair'], 1) + [u'Monty Taylor, James Blair and Andrew Hutchings'], 1) ] diff --git a/doc/gerrit.rst b/doc/gerrit.rst index 5263b30f..65d31706 100644 --- a/doc/gerrit.rst +++ b/doc/gerrit.rst @@ -306,6 +306,19 @@ shell command build step (no other configuration):: Later, we will configure Jenkins jobs that we want to behave this way to use this build step. +Auto Review Expiry +================== + +Puppet automatically installs a daily cron job called ``expire_old_reviews.py`` +onto the gerrit servers. This script follows two rules: + + #. If the review hasn't been touched in 2 weeks, mark as abandoned. + #. If there is a negative review and it hasn't been touched in 1 week, mark as + abandoned. + +If your review gets touched by either of these rules it is possible to +unabandon a review on the gerrit web interface. + Launchpad Sync ============== diff --git a/doc/puppet.rst b/doc/puppet.rst index bdf7f6d7..5893e699 100644 --- a/doc/puppet.rst +++ b/doc/puppet.rst @@ -1,11 +1,31 @@ Puppet Modules ============== +Overview +-------- + Much of the OpenStack project infrastructure is deployed and managed using puppet. The OpenStack CI team manage a number of custom puppet modules outlined in this document. +Doc Server +---------- + +The doc_server module configures nginx [4]_ to serve the documentation for +several specified OpenStack projects. At the moment to add a site to this +you need to edit ``modules/doc_server/manifests/init.pp`` and add a line as +follows: + +.. code-block:: ruby + :linenos: + + doc_server::site { "swift": } + +In this example nginx will be configured to serve ``swift.openstack.org`` +from ``/srv/docs/swift`` and ``swift.openstack.org/tarballs/`` from +``/srv/tarballs/swift`` + Lodgeit ------- @@ -53,6 +73,15 @@ Finally if an image is given that will be used instead of text inside the h1 tag of the site. The images need to be stored in the ``modules/lodgeit/files`` directory. +Lodgeit Backups +^^^^^^^^^^^^^^^ + +The lodgeit module will automatically create a git repository in ``/var/backups/lodgeit_db``. Inside this every site will have its own SQL file, for example "openstack" will have a file called ``openstack.sql``. Every day a cron job will update the SQL file (one job per file) and commit it to the git repository. + +.. note:: + 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. + .. rubric:: Footnotes .. [1] `Lodgeit homepage `_ .. [2] `dcolish's Lodgeit fork `_