--- /dev/null
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS =
+SPHINXBUILD = sphinx-build
+PAPER =
+BUILDDIR = _build
+
+# User-friendly check for sphinx-build
+ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
+ $(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don\'t have Sphinx installed, grab it from http://sphinx-doc.org/)
+endif
+
+# Internal variables.
+PAPEROPT_a4 = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help
+help:
+ @echo "Please use \`make <target>' where <target> is one of"
+ @echo " html to make standalone HTML files"
+ @echo " dirhtml to make HTML files named index.html in directories"
+ @echo " singlehtml to make a single large HTML file"
+ @echo " pickle to make pickle files"
+ @echo " json to make JSON files"
+ @echo " htmlhelp to make HTML files and a HTML help project"
+ @echo " qthelp to make HTML files and a qthelp project"
+ @echo " applehelp to make an Apple Help Book"
+ @echo " devhelp to make HTML files and a Devhelp project"
+ @echo " epub to make an epub"
+ @echo " epub3 to make an epub3"
+ @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+ @echo " latexpdf to make LaTeX files and run them through pdflatex"
+ @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
+ @echo " text to make text files"
+ @echo " man to make manual pages"
+ @echo " texinfo to make Texinfo files"
+ @echo " info to make Texinfo files and run them through makeinfo"
+ @echo " gettext to make PO message catalogs"
+ @echo " changes to make an overview of all changed/added/deprecated items"
+ @echo " xml to make Docutils-native XML files"
+ @echo " pseudoxml to make pseudoxml-XML files for display purposes"
+ @echo " linkcheck to check all external links for integrity"
+ @echo " doctest to run all doctests embedded in the documentation (if enabled)"
+ @echo " coverage to run coverage check of the documentation (if enabled)"
+
+.PHONY: clean
+clean:
+ rm -rf $(BUILDDIR)/*
+
+.PHONY: html
+html:
+ $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+.PHONY: dirhtml
+dirhtml:
+ $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+.PHONY: singlehtml
+singlehtml:
+ $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+ @echo
+ @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+.PHONY: pickle
+pickle:
+ $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+ @echo
+ @echo "Build finished; now you can process the pickle files."
+
+.PHONY: json
+json:
+ $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+ @echo
+ @echo "Build finished; now you can process the JSON files."
+
+.PHONY: htmlhelp
+htmlhelp:
+ $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+ @echo
+ @echo "Build finished; now you can run HTML Help Workshop with the" \
+ ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+.PHONY: qthelp
+qthelp:
+ $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+ @echo
+ @echo "Build finished; now you can run "qcollectiongenerator" with the" \
+ ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+ @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/OpenDaylightRelEngBuilder.qhcp"
+ @echo "To view the help file:"
+ @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/OpenDaylightRelEngBuilder.qhc"
+
+.PHONY: applehelp
+applehelp:
+ $(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
+ @echo
+ @echo "Build finished. The help book is in $(BUILDDIR)/applehelp."
+ @echo "N.B. You won't be able to view it unless you put it in" \
+ "~/Library/Documentation/Help or install it in your application" \
+ "bundle."
+
+.PHONY: devhelp
+devhelp:
+ $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+ @echo
+ @echo "Build finished."
+ @echo "To view the help file:"
+ @echo "# mkdir -p $$HOME/.local/share/devhelp/OpenDaylightRelEngBuilder"
+ @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/OpenDaylightRelEngBuilder"
+ @echo "# devhelp"
+
+.PHONY: epub
+epub:
+ $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+ @echo
+ @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+.PHONY: epub3
+epub3:
+ $(SPHINXBUILD) -b epub3 $(ALLSPHINXOPTS) $(BUILDDIR)/epub3
+ @echo
+ @echo "Build finished. The epub3 file is in $(BUILDDIR)/epub3."
+
+.PHONY: latex
+latex:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo
+ @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+ @echo "Run \`make' in that directory to run these through (pdf)latex" \
+ "(use \`make latexpdf' here to do that automatically)."
+
+.PHONY: latexpdf
+latexpdf:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo "Running LaTeX files through pdflatex..."
+ $(MAKE) -C $(BUILDDIR)/latex all-pdf
+ @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+.PHONY: latexpdfja
+latexpdfja:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo "Running LaTeX files through platex and dvipdfmx..."
+ $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
+ @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+.PHONY: text
+text:
+ $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+ @echo
+ @echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+.PHONY: man
+man:
+ $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+ @echo
+ @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+.PHONY: texinfo
+texinfo:
+ $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+ @echo
+ @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+ @echo "Run \`make' in that directory to run these through makeinfo" \
+ "(use \`make info' here to do that automatically)."
+
+.PHONY: info
+info:
+ $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+ @echo "Running Texinfo files through makeinfo..."
+ make -C $(BUILDDIR)/texinfo info
+ @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+.PHONY: gettext
+gettext:
+ $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+ @echo
+ @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+.PHONY: changes
+changes:
+ $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+ @echo
+ @echo "The overview file is in $(BUILDDIR)/changes."
+
+.PHONY: linkcheck
+linkcheck:
+ $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+ @echo
+ @echo "Link check complete; look for any errors in the above output " \
+ "or in $(BUILDDIR)/linkcheck/output.txt."
+
+.PHONY: doctest
+doctest:
+ $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+ @echo "Testing of doctests in the sources finished, look at the " \
+ "results in $(BUILDDIR)/doctest/output.txt."
+
+.PHONY: coverage
+coverage:
+ $(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
+ @echo "Testing of coverage in the sources finished, look at the " \
+ "results in $(BUILDDIR)/coverage/python.txt."
+
+.PHONY: xml
+xml:
+ $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
+ @echo
+ @echo "Build finished. The XML files are in $(BUILDDIR)/xml."
+
+.PHONY: pseudoxml
+pseudoxml:
+ $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
+ @echo
+ @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
--- /dev/null
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#
+# OpenDaylight RelEng/Builder documentation build configuration file, created by
+# sphinx-quickstart on Thu May 5 10:17:10 2016.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys
+import os
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#sys.path.insert(0, os.path.abspath('.'))
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = []
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = 'OpenDaylight RelEng/Builder'
+copyright = '2016, Andrew Grimberg, Thanh Ha, Daniel Farell'
+author = 'Andrew Grimberg, Thanh Ha, Daniel Farell'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = '1.0.0'
+# The full version, including alpha/beta/rc tags.
+release = '1.0.0'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This patterns also effect to html_static_path and html_extra_path
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+# The reST default role (used for this markup: `text`) to use for all
+# documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+# If true, keep warnings as "system message" paragraphs in the built documents.
+#keep_warnings = False
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = False
+
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages. See the documentation for
+# a list of builtin themes.
+html_theme = 'alabaster'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further. For a list of options available for each theme, see the
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents.
+# "<project> v<release> documentation" by default.
+#html_title = 'OpenDaylight RelEng/Builder v1.0.0'
+
+# A shorter title for the navigation bar. Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (relative to this directory) to use as a favicon of
+# the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# Add any extra paths that contain custom files (such as robots.txt or
+# .htaccess) here, relative to this directory. These files are copied
+# directly to the root of the documentation.
+#html_extra_path = []
+
+# If not None, a 'Last updated on:' timestamp is inserted at every page
+# bottom, using the given strftime format.
+# The empty string is equivalent to '%b %d, %Y'.
+#html_last_updated_fmt = None
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it. The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Language to be used for generating the HTML full-text search index.
+# Sphinx supports the following languages:
+# 'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja'
+# 'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr', 'zh'
+#html_search_language = 'en'
+
+# A dictionary with options for the search language support, empty by default.
+# 'ja' uses this config value.
+# 'zh' user can custom change `jieba` dictionary path.
+#html_search_options = {'type': 'default'}
+
+# The name of a javascript file (relative to the configuration directory) that
+# implements a search results scorer. If empty, the default will be used.
+#html_search_scorer = 'scorer.js'
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'OpenDaylightRelEngBuilderdoc'
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+# The paper size ('letterpaper' or 'a4paper').
+#'papersize': 'letterpaper',
+
+# The font size ('10pt', '11pt' or '12pt').
+#'pointsize': '10pt',
+
+# Additional stuff for the LaTeX preamble.
+#'preamble': '',
+
+# Latex figure (float) alignment
+#'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+# author, documentclass [howto, manual, or own class]).
+latex_documents = [
+ (master_doc, 'OpenDaylightRelEngBuilder.tex', 'OpenDaylight RelEng/Builder Documentation',
+ 'Andrew Grimberg, Thanh Ha, Daniel Farell', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+ (master_doc, 'opendaylightrelengbuilder', 'OpenDaylight RelEng/Builder Documentation',
+ [author], 1)
+]
+
+# If true, show URL addresses after external links.
+#man_show_urls = False
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+# dir menu entry, description, category)
+texinfo_documents = [
+ (master_doc, 'OpenDaylightRelEngBuilder', 'OpenDaylight RelEng/Builder Documentation',
+ author, 'OpenDaylightRelEngBuilder', 'One line description of project.',
+ 'Miscellaneous'),
+]
+
+# Documents to append as an appendix to all manuals.
+#texinfo_appendices = []
+
+# If false, no module index is generated.
+#texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+#texinfo_show_urls = 'footnote'
+
+# If true, do not generate a @detailmenu in the "Top" node's menu.
+#texinfo_no_detailmenu = False
--- /dev/null
+Jenkins
+=======
+
+The `Release Engineering Project <releng-wiki_>`_ consolidates the Jenkins jobs from
+project-specific VMs to a single Jenkins server. Each OpenDaylight project
+has a tab for their jobs on the `jenkins-master`_. The system utilizes
+`Jenkins Job Builder <jjb-docs_>`_ for the creation and management of the
+Jenkins jobs.
+
+Sections:
+
+.. contents::
+ :depth: 3
+ :local:
+
+Jenkins Master
+--------------
+
+The `jenkins-master`_ is the home for all project's Jenkins jobs. All
+maintenance and configuration of these jobs must be done via JJB through the
+`releng-builder-repo`_. Project contributors can no longer edit the Jenkins jobs
+directly on the server.
+
+Build Slaves
+------------
+
+The Jenkins jobs are run on build slaves (executors) which are created on an
+as-needed basis. If no idle build slaves are available a new VM is brought
+up. This process can take up to 2 minutes. Once the build slave has finished a
+job, it will remain online for 45 minutes before shutting down. Subsequent
+jobs will use an idle build slave if available.
+
+Our Jenkins master supports many types of dynamic build slaves. If you are
+creating custom jobs then you will need to have an idea of what type of slaves
+are available. The following are the current slave types and descriptions.
+Slave Template Names are needed for jobs that take advantage of multiple
+slaves as they must be specifically called out by template name instead of
+label.
+
+Adding New Components to the Slaves
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+If your project needs something added to one of the slaves used during build
+and test you can help us get things added faster by doing one of the following:
+
+* Submit a patch to RelEng/Builder for the `spinup-scripts`_ that
+ configures your new piece of software.
+* Submit a patch to RelEng/Builder for the Vagrant template's bootstrap.sh in
+ the `vagrant-definitions`_ directory that configures your new piece of
+ software.
+
+Going the first route will be faster in the short term as we can inspect the
+changes and make test modifications in the sandbox to verify that it works.
+
+The second route, however, is better for the community as a whole as it will
+allow others that utilize our Vagrant setups to replicate our systems more
+closely. It is, however, more time consuming as an image snapshot needs to be
+created based on the updated Vagrant definition before it can be attached to
+the sandbox for validation testing.
+
+In either case, the changes must be validated in the sandbox with tests to
+make sure that we don't break current jobs and that the new software features
+are operating as intended. Once this is done the changes will be merged and
+the updates applied to the RelEng Jenkins production silo.
+
+Please note that the combination of a Vagrant slave snapshot and a Jenkins
+spinup script is what defines a given slave. For instance, a slave may be
+defined by the `vagrant-basic-java-node`_ Vagrant definition
+and the `spinup-scripts-controller.sh`_ Jenkins spinup script
+(as the dynamic\_controller slave is). The pair provides the full definition of
+the realized slave. Jenkins starts a slave using the last-spun Vagrant snapshot
+for the specified definition. Once the base Vagrant instance is online Jenkins
+checks out the RelEng/Builder repo on it and executes two scripts. The first is
+`spinup-scripts-basic_settings.sh`_, which is a baseline for all of the slaves.
+The second is
+the specialized spinup script, which handles any system updates, new software
+installs or extra environment tweaks that don't make sense in a snapshot. After
+all of these scripts have executed Jenkins will finally attach the slave as an
+actual slave and start handling jobs on it.
+
+Pool: Rackspace - Docker
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. raw:: html
+
+ <table border="1">
+ <tr>
+ <td><b>Jenkins Label</b><br/> dynamic_docker</td>
+ <td><b>Slave Template name</b><br/> rk-f20-docker</td>
+ <td><b>Vagrant Definition</b><br/> releng/builder/vagrant/ovsdb-docker</td>
+ <td><b>Spinup Script</b><br/> releng/builder/jenkins-scripts/docker.sh</td>
+ </tr>
+ <tr>
+ <td colspan="4">
+ A Fedora 20 system that is configured with OpenJDK 1.7 (aka Java7) and
+ Docker. This system was originally custom built for the test needs of
+ the OVSDB project but other projects have expressed interest in using
+ it.
+ </td>
+ </tr>
+ </table>
+
+Pool: Rackspace DFW
+^^^^^^^^^^^^^^^^^^^
+
+.. raw:: html
+
+ <table border="1">
+ <tr>
+ <td><b>Jenkins Label</b><br/> dynamic_verify</td>
+ <td><b>Slave Template name</b><br/> rk-c-el65-build</td>
+ <td><b>Vagrant Definition</b><br/> releng/builder/vagrant/basic-builder</td>
+ <td><b>Spinup Script</b><br/> releng/builder/jenkins-scripts/builder.sh</td>
+ </tr>
+ <tr>
+ <td colspan="4">
+ A CentOS 6 build slave. This system has OpenJDK 1.7 (Java7) and OpenJDK
+ 1.8 (Java8) installed on it along with all the other components and
+ libraries needed for building any current OpenDaylight project. This is
+ the label that is used for all basic -verify and -daily- builds for
+ projects.
+ </td>
+ </tr>
+ </table>
+
+ <table border="1">
+ <tr>
+ <td><b>Jenkins Label</b><br/> dynamic_merge</td>
+ <td><b>Slave Template name</b><br/> rk-c-el65-build</td>
+ <td><b>Vagrant Definition</b><br/> releng/builder/vagrant/basic-builder</td>
+ <td><b>Spinup Script</b><br/> releng/builder/jenkins-scripts/builder.sh</td>
+ </tr>
+ <tr>
+ <td colspan="4">
+ See dynamic_verify (same image on the back side). This is the label that
+ is used for all basic -merge and -integration- builds for projects.
+ </td>
+ </tr>
+ </table>
+
+Pool: Rackspace DFW - Devstack
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. raw:: html
+
+ <table border="1">
+ <tr>
+ <td><b>Jenkins Label</b><br/> dynamic_devstack</td>
+ <td><b>Slave Template name</b><br/> rk-c7-devstack</td>
+ <td><b>Vagrant Definition</b><br/> releng/builder/vagrant/ovsdb-devstack</td>
+ <td><b>Spinup Script</b><br/> releng/builder/jenkins-scripts/devstack.sh</td>
+ </tr>
+ <tr>
+ <td colspan="4">
+ A CentOS 7 system purpose built for doing OpenStack testing using
+ DevStack. This slave is primarily targeted at the needs of the OVSDB
+ project. It has OpenJDK 1.7 (aka Java7) and other basic DevStack related
+ bits installed.
+ </td>
+ </tr>
+ </table>
+
+Pool: Rackspace DFW - Integration
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. raw:: html
+
+ <table border="1">
+ <tr>
+ <td><b>Jenkins Label</b><br/> dynamic_robot</td>
+ <td><b>Slave Template name</b><br/> rk-c-el6-robot</td>
+ <td><b>Vagrant Definition</b><br/> releng/builder/vagrant/integration-robotframework</td>
+ <td><b>Spinup Script</b><br/> releng/builder/jenkins-scripts/robot.sh</td>
+ </tr>
+ <tr>
+ <td colspan="4">
+ A CentOS 6 slave that is configured with OpenJDK 1.7 (Java7) and all the
+ current packages used by the integration project for doing robot driven
+ jobs. If you are executing robot framework jobs then your job should be
+ using this as the slave that you are tied to. This image does not
+ contain the needed libraries for building components of OpenDaylight,
+ only for executing robot tests.
+ </td>
+ </tr>
+ </table>
+
+Pool: Rackspace DFW - Integration Dynamic Lab
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. raw:: html
+
+ <table border="1">
+ <tr>
+ <td><b>Jenkins Label</b><br/> dynamic_controller</td>
+ <td><b>Slave Template name</b><br/> rk-c-el6-java</td>
+ <td><b>Vagrant Definition</b><br/> releng/builder/vagrant/basic-java-node</td>
+ <td><b>Spinup Script</b><br/> releng/builder/jenkins-scripts/controller.sh</td>
+ </tr>
+ <tr>
+ <td colspan="4">
+ A CentOS 6 slave that has the basic OpenJDK 1.7 (Java7) installed and is
+ capable of running the controller, not building.
+ </td>
+ </tr>
+ </table>
+
+ <table border="1">
+ <tr>
+ <td><b>Jenkins Label</b><br/> dynamic_java</td>
+ <td><b>Slave Template name</b><br/> rk-c-el6-java</td>
+ <td><b>Vagrant Definition</b><br/> releng/builder/vagrant/basic-java-node</td>
+ <td><b>Spinup Script</b><br/> releng/builder/jenkins-scripts/controller.sh</td>
+ </tr>
+ <tr>
+ <td colspan="4">
+ See dynamic_controller as it is currently the same image.
+ </td>
+ </tr>
+ </table>
+
+ <table border="1">
+ <tr>
+ <td><b>Jenkins Label</b><br/> dynamic_mininet</td>
+ <td><b>Slave Template name</b><br/> rk-c-el6-mininet</td>
+ <td><b>Vagrant Definition</b><br/> releng/builder/vagrant/basic-mininet-node</td>
+ <td><b>Spinup Script</b><br/> releng/builder/jenkins-scripts/mininet.sh</td>
+ </tr>
+ <tr>
+ <td colspan="4">
+ A CentOS 6 image that has mininet, openvswitch v2.0.x, netopeer and
+ PostgreSQL 9.3 installed. This system is targeted at playing the role of
+ a mininet system for integration tests. Netopeer is installed as it is
+ needed for various tests by Integration. PostgreSQL 9.3 is installed as
+ the system is also capable of being used as a VTN project controller and
+ VTN requires PostgreSQL 9.3.
+ </td>
+ </tr>
+ </table>
+
+ <table border="1">
+ <tr>
+ <td><b>Jenkins Label</b><br/> dynamic_mininet_fedora</td>
+ <td><b>Slave Template name</b><br/> rk-f21-mininet</td>
+ <td><b>Vagrant Definition</b><br/> releng/builder/vagrant/basic-mininet-fedora-node</td>
+ <td><b>Spinup Script</b><br/> releng/builder/jenkins-scripts/mininet-fedora.sh</td>
+ </tr>
+ <tr>
+ <td colspan="4">
+ Basic Fedora 21 system with ovs v2.3.x and mininet 2.2.1
+ </td>
+ </tr>
+ </table>
+
+ <table border="1">
+ <tr>
+ <td><b>Jenkins Label</b><br/> ubuntu_mininet</td>
+ <td><b>Slave Template name</b><br/> ubuntu-trusty-mininet</td>
+ <td><b>Vagrant Definition</b><br/> releng/builder/vagrant/ubuntu-mininet</td>
+ <td><b>Spinup Script</b><br/> releng/builder/jenkins-scripts/mininet-ubuntu.sh</td>
+ </tr>
+ <tr>
+ <td colspan="4">
+ Basic Ubuntu system with ovs 2.0.2 and mininet 2.1.0
+ </td>
+ </tr>
+ </table>
+
+ <table border="1">
+ <tr>
+ <td><b>Jenkins Label</b><br/> ubuntu_mininet_ovs_23</td>
+ <td><b>Slave Template name</b><br/> ubuntu-trusty-mininet-ovs-23</td>
+ <td><b>Vagrant Definition</b><br/> releng/builder/vagrant/ubuntu-mininet-ovs-23</td>
+ <td><b>Spinup Script</b><br/> releng/builder/jenkins-scripts/mininet-ubuntu.sh</td>
+ </tr>
+ <tr>
+ <td colspan="4">
+ Basic Ubuntu system with ovs 2.3 and mininet 2.2.1
+ </td>
+ </tr>
+ </table>
+
+Pool: Rackspace DFW - Matrix
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. raw:: html
+
+ <table border="1">
+ <tr>
+ <td><b>Jenkins Label</b><br/> matrix_master</td>
+ <td><b>Slave Template name</b><br/> rk-c-el6-matrix</td>
+ <td><b>Vagrant Definition</b><br/> releng/builder/vagrant/basic-java-node</td>
+ <td><b>Spinup Script</b><br/> releng/builder/jenkins-scripts/matrix.sh</td>
+ </tr>
+ <tr>
+ <td colspan="4">
+ This is a very minimal system that is designed to spin up with 2 build
+ instances on it. The purpose is to have a location that is not the
+ Jenkins master itself for jobs that are executing matrix operations
+ since they need a director location. This image should not be used for
+ anything but tying matrix jobs before the matrx defined label ties.
+ </td>
+ </tr>
+ </table>
+
+Creating Jenkins Jobs
+---------------------
+
+Jenkins Job Builder takes simple descriptions of Jenkins jobs in YAML format
+and uses them to configure Jenkins.
+
+* `Jenkins Job Builder (JJB) documentation <jjb-docs_>`_
+* `RelEng/Builder Gerrit <releng-builder-gerrit_>`_
+* `RelEng/Builder Git repository <releng-builder-repo_>`_
+
+Getting Jenkins Job Builder
+---------------------------
+
+OpenDaylight uses Jenkins Job Builder to translate our in-repo YAML job
+configuration into job descriptions suitable for consumption by Jenkins.
+When testing new Jenkins Jobs in the `Jenkins Sandbox`_, you'll
+need to use the `jenkins-jobs` executable to translate a set of jobs into
+their XML descriptions and upload them to the sandbox Jenkins server.
+
+We document `installing <Installing Jenkins Job Builder_>`_ `jenkins-jobs`
+below. We also provide
+a `pre-built Docker image <jjb-docker_>`_ with `jenkins-jobs` already installed.
+
+Installing Jenkins Job Builder
+------------------------------
+
+For users who aren't already experienced with Docker or otherwise don't want
+to use our `pre-built JJB Docker image <jjb-docker_>`_, installing JJB into a
+virtual environment is an equally good option.
+
+We recommend using `pip <Installing JJB using pip_>`_ to assist with JJB
+installs, but we
+also document `installing from a git repository manually
+<Installing JJB Manually_>`_.
+For both, we recommend using Python `Virtual Environments`_
+to isolate JJB and its dependencies.
+
+The `builder/jjb/requirements.txt <odl-jjb-requirements.txt_>`_ file contains the currently
+recommended JJB version. Because JJB is fairly unstable, it may be necessary
+to debug things by installing different versions. This is documented for both
+`pip-assisted <Installing JJB using pip_>`_ and `manual
+<Installing JJB Manually_>`_ installs.
+
+Virtual Environments
+--------------------
+
+For both `pip-assisted <Installing JJB using pip_>`_ and `manual
+<Installing JJB Manually_>`_ JJB
+installs, we recommend using `Python Virtual Environments <python-virtualenv_>`_
+to manage JJB and its
+Python dependencies. The `python-virtualenvwrapper`_ tool can help you do so.
+
+There are good docs for installing `python-virtualenvwrapper`_. On Linux systems
+with pip (typical), they amount to:
+
+.. code-block:: bash
+
+ sudo pip install virtualenvwrapper
+
+A virtual environment is simply a directory that you install Python programs
+into and then append to the front of your path, causing those copies to be
+found before any system-wide versions.
+
+Create a new virtual environment for JJB.
+
+.. code-block:: bash
+
+ # Virtaulenvwrapper uses this dir for virtual environments
+ $ echo $WORKON_HOME
+ /home/daniel/.virtualenvs
+ # Make a new virtual environment
+ $ mkvirtualenv jjb
+ # A new venv dir was created
+ (jjb)$ ls -rc $WORKON_HOME | tail -n 1
+ jjb
+ # The new venv was added to the front of this shell's path
+ (jjb)$ echo $PATH
+ /home/daniel/.virtualenvs/jjb/bin:<my normal path>
+ # Software installed to venv, like pip, is found before system-wide copies
+ (jjb)$ command -v pip
+ /home/daniel/.virtualenvs/jjb/bin/pip
+
+With your virtual environment active, you should install JJB. Your install will
+be isolated to that virtual environment's directory and only visible when the
+virtual environment is active.
+
+You can easily leave and return to your venv. Make sure you activate it before
+each use of JJB.
+
+.. code-block:: bash
+
+ (jjb)$ deactivate
+ $ command -v jenkins-jobs
+ # No jenkins-jobs executable found
+ $ workon jjb
+ (jjb)$ command -v jenkins-jobs
+ $WORKON_HOME/jjb/bin/jenkins-jobs
+
+Installing JJB using pip
+------------------------
+
+The recommended way to install JJB is via pip.
+
+First, clone the latest version of the `releng-builder-repo`_.
+
+.. code-block:: bash
+
+ $ git clone https://git.opendaylight.org/gerrit/p/releng/builder.git
+
+Before actually installing JJB and its dependencies, make sure you've `created
+and activated <Virtual Environments_>`_ a virtual environment for JJB.
+
+.. code-block:: bash
+
+ $ mkvirtualenv jjb
+
+The recommended version of JJB to install is the version specified in the
+`builder/jjb/requirements.txt <odl-jjb-requirements.txt_>`_ file.
+
+.. code-block:: bash
+
+ # From the root of the releng/builder repo
+ (jjb)$ pip install -r jjb/requirements.txt
+
+To validate that JJB was successfully installed you can run this command:
+
+.. code-block:: bash
+
+ (jjb)$ jenkins-jobs --version
+
+To change the version of JJB specified by `builder/jjb/requirements.txt
+<odl-jjb-requirements.txt_>`_
+to install from the latest commit to the master branch of JJB's git repository:
+
+.. code-block:: bash
+
+ $ cat jjb/requirements.txt
+ -e git+https://git.openstack.org/openstack-infra/jenkins-job-builder#egg=jenkins-job-builder
+
+To install from a tag, like 1.4.0:
+
+.. code-block:: bash
+
+ $ cat jjb/requirements.txt
+ -e git+https://git.openstack.org/openstack-infra/jenkins-job-builder@1.4.0#egg=jenkins-job-builder
+
+Installing JJB Manually
+-----------------------
+
+This section documents installing JJB from its manually cloned repository.
+
+Note that `installing via pip <Installing JJB using pip_>`_ is typically simpler.
+
+Checkout the version of JJB's source you'd like to build.
+
+For example, using master:
+
+.. code-block:: bash
+
+ $ git clone https://git.openstack.org/openstack-infra/jenkins-job-builder
+
+Using a tag, like 1.4.0:
+
+.. code-block:: bash
+
+ $ git clone https://git.openstack.org/openstack-infra/jenkins-job-builder
+ $ cd jenkins-job-builder
+ $ git checkout tags/1.4.0
+
+Before actually installing JJB and its dependencies, make sure you've `created
+and activated <Virtual Environments_>`_ a virtual environment for JJB.
+
+.. code-block:: bash
+
+ $ mkvirtualenv jjb
+
+You can then use JJB's `requirements.txt <jjb-requirements.txt_>`_ file to
+install its
+dependencies. Note that we're not using `sudo` to install as root, since we want
+to make use of the venv we've configured for our current user.
+
+.. code-block:: bash
+
+ # In the cloned JJB repo, with the desired version of the code checked out
+ (jjb)$ pip install -r requirements.txt
+
+Then install JJB from the repo with:
+
+.. code-block:: bash
+
+ (jjb)$ pip install .
+
+To validate that JJB was successfully installed you can run this command:
+
+.. code-block:: bash
+
+ (jjb)$ jenkins-jobs --version
+
+JJB Docker Image
+----------------
+
+`Docker <docker-docs_>`_ is an open platform used to create virtualized Linux containers
+for shipping self-contained applications. Docker leverages LinuX Containers
+\(LXC\) running on the same operating system as the host machine, whereas a
+traditional VM runs an operating system over the host.
+
+.. code-block:: bash
+
+ docker pull zxiiro/jjb-docker
+ docker run --rm -v ${PWD}:/jjb jjb-docker
+
+This `Dockerfile <jjb-dockerfile_>`_ created the
+`zxiiro/jjb-docker image <jjb-docker_>`_.
+By default it will run:
+
+.. code-block:: bash
+
+ jenkins-jobs test .
+
+You'll need to use the `-v/--volume=[]` parameter to mount a directory
+containing your YAML files, as well as a configured `jenkins.ini` file if you
+wish to upload your jobs to the `Jenkins Sandbox`_.
+
+Jenkins Job Templates
+---------------------
+
+The OpenDaylight `RelEng/Builder <releng-builder-wiki_>`_ project provides
+`jjb-templates`_ that can be used to define basic jobs.
+
+Verify Job Template
+^^^^^^^^^^^^^^^^^^^
+
+Trigger: **recheck**
+
+The Verify job template creates a Gerrit Trigger job that will trigger when a
+new patch is submitted to Gerrit.
+
+Verify jobs can be retriggered in Gerrit by leaving a comment that says
+**recheck**.
+
+Merge Job Template
+^^^^^^^^^^^^^^^^^^
+
+Trigger: **remerge**
+
+The Merge job template is similar to the Verify Job Template except it will
+trigger once a Gerrit patch is merged into the repo. It also automatically
+runs the Maven goals **source:jar** and **javadoc:jar**.
+
+This job will upload artifacts to `OpenDaylight's Nexus <odl-nexus_>`_ on completion.
+
+Merge jobs can be retriggered in Gerrit by leaving a comment that says
+**remerge**.
+
+Daily Job Template
+^^^^^^^^^^^^^^^^^^
+
+The Daily (or Nightly) Job Template creates a job which will run on a build on
+a Daily basis as a sanity check to ensure the build is still working day to
+day.
+
+Sonar Job Template
+^^^^^^^^^^^^^^^^^^
+
+Trigger: **run-sonar**
+
+This job runs Sonar analysis and reports the results to `OpenDaylight's Sonar
+dashboard <odl-sonar_>`_.
+
+The Sonar Job Template creates a job which will run against the master branch,
+or if BRANCHES are specified in the CFG file it will create a job for the
+**First** branch listed.
+
+.. note:: Running the "run-sonar" trigger will cause Jenkins to remove its
+ existing vote if it's already -1'd or +1'd a comment. You will need to
+ re-run your verify job (recheck) after running this to get Jenkins to
+ re-vote.
+
+Integration Job Template
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+The Integration Job Template creates a job which runs when a project that your
+project depends on is successfully built. This job type is basically the same
+as a verify job except that it triggers from other Jenkins jobs instead of via
+Gerrit review updates. The dependencies that triger integration jobs are listed
+in your project.cfg file under the **DEPENDENCIES** variable.
+
+If no dependencies are listed then this job type is disabled by default.
+
+Distribution Test Job
+^^^^^^^^^^^^^^^^^^^^^
+
+Trigger: **test-distribution**
+
+This job builds a distrbution against your patch, passes distribution sanity test
+and reports back the results to Gerrit. Leave a comment with trigger keyword above
+to activate it for a particular patch.
+
+This job is maintained by the Integration/Test (`integration-test-wiki`_) project.
+
+.. note:: Running the "test-distribution" trigger will cause Jenkins to remove
+ it's existing vote if it's already -1 or +1'd a comment. You will need
+ to re-run your verify job (recheck) after running this to get Jenkins
+ to put back the correct vote.
+
+Patch Test Job
+^^^^^^^^^^^^^^
+
+Trigger: **test-integration**
+
+This job runs a full integration test suite against your patch and reports
+back the results to Gerrit. Leave a comment with trigger keyword above to activate it
+for a particular patch.
+
+This job is maintained by the Integration/Test (`integration-test-wiki`_) project.
+
+.. note:: Running the "test-integration" trigger will cause Jenkins to remove
+ it's existing vote if it's already -1 or +1'd a comment. You will need
+ to re-run your verify job (recheck) after running this to get Jenkins
+ to put back the correct vote.
+
+Some considerations when using this job:
+
+* The patch test verification takes some time (~2 hours) + consumes a lot of
+ resources so it is not meant to be used for every patch.
+* The system tests for master patches will fail most of the times because both
+ code and test are unstable during the release cycle (should be good by the
+ end of the cycle).
+* Because of the above, patch test results typically have to be interpreted by
+ system test experts. The Integration/Test (`integration-test-wiki`_) project
+ can help with that.
+
+
+Autorelease Validate Job
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+Trigger: **revalidate**
+
+This job runs the PROJECT-validate-autorelease-BRANCH job which is used as a
+quick sanity test to ensure that a patch does not depend on features that do
+not exist in the current release.
+
+The **revalidate** trigger is useful in cases where a project's verify job
+passed however validate failed due to infra problems or intermittent issues.
+It will retrigger just the validate-autorelease job.
+
+Basic Job Configuration
+-----------------------
+
+To create jobs based on existing `templates <Jenkins Job Templates_>`_, use the
+`jjb-init-project.py`_ helper script. When run from the root of
+`RelEng/Builder's repo <releng-builder-repo_>`_, it will produce a file in
+`jjb/<project>/<project>.yaml` containing your project's base template.
+
+.. code-block:: bash
+
+ $ python scripts/jjb-init-project.py --help
+ usage: jjb-init-project.py [-h] [-c CONF] [-d DEPENDENCIES] [-t TEMPLATES]
+ [-s STREAMS] [-p POM] [-g MVN_GOALS] [-o MVN_OPTS]
+ [-a ARCHIVE_ARTIFACTS]
+ project
+
+ positional arguments:
+ project project
+
+ optional arguments:
+ -h, --help show this help message and exit
+ -c CONF, --conf CONF Config file
+ -d DEPENDENCIES, --dependencies DEPENDENCIES
+ Project dependencies A comma-seperated (no spaces)
+ list of projects your project depends on. This is used
+ to create an integration job that will trigger when a
+ dependent project-merge job is built successfully.
+ Example: aaa,controller,yangtools
+ -t TEMPLATES, --templates TEMPLATES
+ Job templates to use
+ -s STREAMS, --streams STREAMS
+ Release streams to fill with default options
+ -p POM, --pom POM Path to pom.xml to use in Maven build (Default:
+ pom.xml
+ -g MVN_GOALS, --mvn-goals MVN_GOALS
+ Maven Goals
+ -o MVN_OPTS, --mvn-opts MVN_OPTS
+ Maven Options
+ -a ARCHIVE_ARTIFACTS, --archive-artifacts ARCHIVE_ARTIFACTS
+ Comma-seperated list of patterns of artifacts to
+ archive on build completion. See:
+ http://ant.apache.org/manual/Types/fileset.html
+
+If all your project requires is the basic verify, merge, and daily jobs then
+using the job template should be all you need to configure for your jobs.
+
+Auto-Update Job Templates
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+The first line of the job YAML file produced by the `jjb-init-project.py`_ script will
+contain the words `# REMOVE THIS LINE IF...`. Leaving this line will allow the
+RelEng/Builder `jjb-autoupdate-project.py`_ script to maintain this file for your project,
+should the base templates ever change. It is a good idea to leave this line if
+you do not plan to create any complex jobs outside of the provided template.
+
+However, if your project needs more control over your jobs or if you have any
+additional configuration outside of the standard configuration provided by the
+template, then this line should be removed.
+
+Tuning Templates
+""""""""""""""""
+
+Allowing the auto-updated to manage your templates doesn't prevent you from
+doing some configuration changes. Parameters can be passed to templates via
+a `<project>.cfg` in your `builder/jjb/<project>` directory. An example is
+provided below, others can be found in the repos of other projects. Tune as
+necessary. Unnecessary paramaters can be removed or commented out with a "#"
+sign.
+
+.. code-block:: yaml
+
+ JOB_TEMPLATES: verify,merge,sonar
+ STREAMS:
+ - beryllium:
+ branch: master
+ jdks: openjdk7,openjdk8
+ autorelease: true
+ - stable-lithium:
+ branch: stable/lithium
+ jdks: openjdk7
+ POM: dfapp/pom.xml
+ MVN_GOALS: clean install javadoc:aggregate -DrepoBuild -Dmaven.repo.local=$WORKSPACE/.m2repo -Dorg.ops4j.pax.url.mvn.localRepository=$WORKSPACE/.m2repo
+ MVN_OPTS: -Xmx1024m -XX:MaxPermSize=256m
+ DEPENDENCIES: aaa,controller,yangtools
+ ARCHIVE_ARTIFACTS: *.logs, *.patches
+
+.. note:: `STREAMS <streams-design-background_>`_ is a list of branches you want
+ JJB to generate jobs for.
+ The first branch will be the branch that reports Sonar analysis. Each
+ branch must define a "jdks:" section listing the JDKs the verify jobs
+ should run tests against for the branch. The first JDK listed will be
+ used as the default JDK for non-verify type jobs.
+
+.. note:: Projects that are participating in the simultanious release should set
+ "autorelease: true" under the streams they are participating in
+ autorelease for. This enables a new job type validate-autorelease
+ which is used to help identify if Gerrit patches might break
+ autorelease or not.
+
+Advanced
+""""""""
+
+It is also possible to take advantage of both the auto-updater and creating
+your own jobs. To do this, create a YAML file in your project's sub-directory
+with any name other than \<project\>.yaml. The auto-update script will only
+search for files with the name \<project\>.yaml. The normal \<project\>.yaml
+file can then be left in tact with the "# REMOVE THIS LINE IF..." comment so
+it will be automatically updated.
+
+Maven Properties
+----------------
+
+We provide a properties which your job can take advantage of if you want to do
+something different depending on the job type that is run. If you create a
+profile that activates on a property listed blow. The JJB templated jobs will
+be able to activate the profile during the build to run any custom code you
+wish to run in your project.
+
+.. code-block:: bash
+
+ -Dmerge : This flag is passed in our Merge job and is equivalent to the
+ Maven property
+ <merge>true</merge>.
+ -Dsonar : This flag is passed in our Sonar job and is equivalent to the
+ Maven property
+ <sonar>true</sonar>.
+
+Jenkins Sandbox
+---------------
+
+The `jenkins-sandbox`_ instance's purpose is to allow projects to test their JJB
+setups before merging their code over to the RelEng master silo. It is
+configured similarly to the master instance, although it cannot publish
+artifacts or vote in Gerrit.
+
+If your project requires access to the sandbox please open an OpenDaylight
+Helpdesk ticket (<helpdesk@opendaylight.org>) and provide your ODL ID.
+
+Notes Regarding the Sandbox
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+* Jobs are automatically deleted every Saturday at 08:00 UTC
+* Committers can login and configure Jenkins jobs in the sandbox directly
+ (unlike with the master silo)
+* Sandbox configuration mirrors the master silo when possible
+* Sandbox jobs can NOT upload artifacts to Nexus
+* Sandbox jobs can NOT vote on Gerrit
+
+Configuration
+^^^^^^^^^^^^^
+
+Make sure you have Jenkins Job Builder [properly installed](#jjb_install).
+
+If you do not already have access, open an OpenDaylight Helpdesk ticket
+(<helpdesk@opendaylight.org>) to request access to ODL's sandbox instance.
+Integration/Test (`integration-test-wiki`_) committers have access by default.
+
+JJB reads user-specific configuration from a `jenkins.ini`_. An
+example is provided by releng/builder at `example-jenkins.ini`_.
+
+.. code-block:: bash
+
+ # If you don't have RelEng/Builder's repo, clone it
+ $ git clone https://git.opendaylight.org/gerrit/p/releng/builder.git
+ # Make a copy of the example JJB config file (in the builder/ directory)
+ $ cp jenkins.ini.example jenkins.ini
+ # Edit jenkins.ini with your username, API token and ODL's sandbox URL
+ $ cat jenkins.ini
+ <snip>
+ [jenkins]
+ user=<your ODL username>
+ password=<your ODL Jenkins sandbox API token>
+ url=https://jenkins.opendaylight.org/sandbox
+ <snip>
+
+To get your API token, `login to the Jenkins **sandbox** instance
+<jenkins-sandbox-login_>`_ (_not
+the main master Jenkins instance, different tokens_), go to your user page (by
+clicking on your username, for example), click "Configure" and then "Show API
+Token".
+
+Manual Method
+^^^^^^^^^^^^^
+
+If you `installed JJB locally into a virtual environment
+<Installing Jenkins Job Builder_>`_,
+you should now activate that virtual environment to access the `jenkins-jobs`
+executable.
+
+.. code-block:: bash
+
+ $ workon jjb
+ (jjb)$
+
+You'll want to work from the root of the RelEng/Builder repo, and you should
+have your `jenkins.ini` file [properly configured](#sandbox_config).
+
+Testing Jobs
+^^^^^^^^^^^^
+
+It's good practice to use the `test` command to validate your JJB files before
+pushing them.
+
+.. code-block:: bash
+
+ jenkins-jobs --conf jenkins.ini test jjb/ <job-name>
+
+If the job you'd like to test is a template with variables in its name, it
+must be manually expanded before use. For example, the commonly used template
+`{project}-csit-verify-1node-{functionality}` might expand to
+`ovsdb-csit-verify-1node-netvirt`.
+
+.. code-block:: bash
+
+ jenkins-jobs --conf jenkins.ini test jjb/ ovsdb-csit-verify-1node-netvirt
+
+Successful tests output the XML description of the Jenkins job described by
+the specified JJB job name.
+
+Pushing Jobs
+^^^^^^^^^^^^
+
+Once you've `configured your \`jenkins.ini\` <Configuration_>`_ and `verified your
+JJB jobs <Testing Jobs_>`_ produce valid XML descriptions of Jenkins jobs you
+can push them to the Jenkins sandbox.
+
+.. important::
+
+ When pushing with `jenkins-jobs`, a log message with the number
+ of jobs you're pushing will be issued, typically to stdout.
+ **If the number is greater than 1** (or the number of jobs you
+ passed to the command to push) then you are pushing too many
+ jobs and should **`ctrl+c` to cancel the upload**. Else you will
+ flood the system with jobs.
+
+ .. code-block:: bash
+
+ INFO:jenkins_jobs.builder:Number of jobs generated: 1
+
+ **Failing to provide the final `<job-name>` param will push all
+ jobs!**
+
+ .. code-block:: bash
+
+ # Don't push all jobs by omitting the final param! (ctrl+c to abort)
+ jenkins-jobs --conf jenkins.ini update jjb/ <job-name>
+
+Running Jobs
+^^^^^^^^^^^^
+
+Once you have your Jenkins job configuration `pushed to the
+Sandbox <Pushing Jobs_>`_ you can trigger it to run.
+
+Find your newly-pushed job on the `Sandbox's web UI <jenkins-sandbox_>`_. Click
+on its name to see the job's details.
+
+Make sure you're `logged in <jenkins-sandbox-login_>`_ to the Sandbox.
+
+Click "Build with Parameters" and then "Build".
+
+Wait for your job to be scheduled and run. Click on the job number to see
+details, including console output.
+
+Make changes to your JJB configuration, re-test, re-push and re-run until
+your job is ready.
+
+Docker Method
+^^^^^^^^^^^^^
+
+If `using Docker <JJB Docker image_>`_:
+
+.. code-block:: bash
+
+ # To test
+ docker run --rm -v ${PWD}:/jjb zxiiro/jjb-docker
+
+.. important::
+
+ When pushing with `jenkins-jobs`, a log message with
+ the number of jobs you're pushing will be issued, typically to stdout.
+ **If the number is greater than 1** (or the number of jobs you passed to
+ the command to push) then you are pushing too many jobs and should **`ctrl+c`
+ to cancel the upload**. Else you will flood the system with jobs.
+
+ .. code-block:: bash
+
+ INFO:jenkins_jobs.builder:Number of jobs generated: 1
+
+ **Failing to provide the final `<job-name>` param will push all jobs!**
+
+ .. code-block:: bash
+
+ # To upload jobs to the sandbox
+ # Please ensure that you include a configured jenkins.ini in your volume mount
+ # Making sure not to push more jobs than expected, ctrl+c to abort
+ docker run --rm -v ${PWD}:/jjb zxiiro/jjb-docker jenkins-jobs --conf jenkins.ini update . openflowplugin-csit-periodic-1node-cds-longevity-only-master
+
+.. _docker-docs: https://www.docker.com/whatisdocker/
+.. _example-jenkins.ini: https://git.opendaylight.org/gerrit/gitweb?p=releng/builder.git;a=blob;f=jenkins.ini.example
+.. _integration-test-wiki: https://wiki.opendaylight.org/view/Integration/Test
+.. _jenkins-master: https://jenkins.opendaylight.org/releng
+.. _jenkins-sandbox: https://jenkins.opendaylight.org/sandbox
+.. _jenkins-sandbox-login: https://jenkins.opendaylight.org/sandbox/login
+.. _jenkins.ini: http://docs.openstack.org/infra/jenkins-job-builder/execution.html#configuration-file
+.. _jjb-autoupdate-project.py: https://git.opendaylight.org/gerrit/gitweb?p=releng/builder.git;a=blob;f=scripts/jjb-autoupdate-project.py
+.. _jjb-docker: https://hub.docker.com/r/zxiiro/jjb-docker/
+.. _jjb-dockerfile: https://github.com/zxiiro/jjb-docker/blob/master/Dockerfile
+.. _jjb-docs: http://ci.openstack.org/jenkins-job-builder/
+.. _jjb-init-project.py: https://git.opendaylight.org/gerrit/gitweb?p=releng/builder.git;a=blob;f=scripts/jjb-init-project.py
+.. _jjb-repo: https://github.com/openstack-infra/jenkins-job-builder
+.. _jjb-requirements.txt: https://github.com/openstack-infra/jenkins-job-builder/blob/master/requirements.txt
+.. _jjb-templates: https://git.opendaylight.org/gerrit/gitweb?p=releng/builder.git;a=tree;f=jjb
+.. _odl-jjb-requirements.txt: https://git.opendaylight.org/gerrit/gitweb?p=releng/builder.git;a=blob;f=jjb/requirements.txt
+.. _odl-nexus: https://nexus.opendaylight.org
+.. _odl-sonar: https://sonar.opendaylight.org
+.. _python-virtualenv: https://virtualenv.readthedocs.org/en/latest/
+.. _python-virtualenvwrapper: https://virtualenvwrapper.readthedocs.org/en/latest/
+.. _releng-wiki: https://wiki.opendaylight.org/view/RelEng:Main
+.. _releng-builder-gerrit: https://git.opendaylight.org/gerrit/#/admin/projects/releng/builder
+.. _releng-builder-repo: https://git.opendaylight.org/gerrit/gitweb?p=releng%2Fbuilder.git;a=summary
+.. _releng-builder-wiki: https://wiki.opendaylight.org/view/RelEng/Builder
+.. _streams-design-background: https://lists.opendaylight.org/pipermail/release/2015-July/003139.html
+.. _spinup-scripts: https://git.opendaylight.org/gerrit/gitweb?p=releng/builder.git;a=tree;f=jenkins-scripts
+.. _spinup-scripts-basic_settings.sh: https://git.opendaylight.org/gerrit/gitweb?p=releng/builder.git;a=blob;f=jenkins-scripts/basic_settings.sh
+.. _spinup-scripts-controller.sh: https://git.opendaylight.org/gerrit/gitweb?p=releng/builder.git;a=blob;f=jenkins-scripts/controller.sh
+.. _vagrant-basic-java-node: https://git.opendaylight.org/gerrit/gitweb?p=releng/builder.git;a=tree;f=vagrant/basic-java-node
+.. _vagrant-definitions: https://git.opendaylight.org/gerrit/gitweb?p=releng/builder.git;a=tree;f=vagrant
--- /dev/null
+@ECHO OFF\r
+\r
+REM Command file for Sphinx documentation\r
+\r
+if "%SPHINXBUILD%" == "" (\r
+ set SPHINXBUILD=sphinx-build\r
+)\r
+set BUILDDIR=_build\r
+set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .\r
+set I18NSPHINXOPTS=%SPHINXOPTS% .\r
+if NOT "%PAPER%" == "" (\r
+ set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%\r
+ set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%\r
+)\r
+\r
+if "%1" == "" goto help\r
+\r
+if "%1" == "help" (\r
+ :help\r
+ echo.Please use `make ^<target^>` where ^<target^> is one of\r
+ echo. html to make standalone HTML files\r
+ echo. dirhtml to make HTML files named index.html in directories\r
+ echo. singlehtml to make a single large HTML file\r
+ echo. pickle to make pickle files\r
+ echo. json to make JSON files\r
+ echo. htmlhelp to make HTML files and a HTML help project\r
+ echo. qthelp to make HTML files and a qthelp project\r
+ echo. devhelp to make HTML files and a Devhelp project\r
+ echo. epub to make an epub\r
+ echo. epub3 to make an epub3\r
+ echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter\r
+ echo. text to make text files\r
+ echo. man to make manual pages\r
+ echo. texinfo to make Texinfo files\r
+ echo. gettext to make PO message catalogs\r
+ echo. changes to make an overview over all changed/added/deprecated items\r
+ echo. xml to make Docutils-native XML files\r
+ echo. pseudoxml to make pseudoxml-XML files for display purposes\r
+ echo. linkcheck to check all external links for integrity\r
+ echo. doctest to run all doctests embedded in the documentation if enabled\r
+ echo. coverage to run coverage check of the documentation if enabled\r
+ goto end\r
+)\r
+\r
+if "%1" == "clean" (\r
+ for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i\r
+ del /q /s %BUILDDIR%\*\r
+ goto end\r
+)\r
+\r
+\r
+REM Check if sphinx-build is available and fallback to Python version if any\r
+%SPHINXBUILD% 1>NUL 2>NUL\r
+if errorlevel 9009 goto sphinx_python\r
+goto sphinx_ok\r
+\r
+:sphinx_python\r
+\r
+set SPHINXBUILD=python -m sphinx.__init__\r
+%SPHINXBUILD% 2> nul\r
+if errorlevel 9009 (\r
+ echo.\r
+ echo.The 'sphinx-build' command was not found. Make sure you have Sphinx\r
+ echo.installed, then set the SPHINXBUILD environment variable to point\r
+ echo.to the full path of the 'sphinx-build' executable. Alternatively you\r
+ echo.may add the Sphinx directory to PATH.\r
+ echo.\r
+ echo.If you don't have Sphinx installed, grab it from\r
+ echo.http://sphinx-doc.org/\r
+ exit /b 1\r
+)\r
+\r
+:sphinx_ok\r
+\r
+\r
+if "%1" == "html" (\r
+ %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html\r
+ if errorlevel 1 exit /b 1\r
+ echo.\r
+ echo.Build finished. The HTML pages are in %BUILDDIR%/html.\r
+ goto end\r
+)\r
+\r
+if "%1" == "dirhtml" (\r
+ %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml\r
+ if errorlevel 1 exit /b 1\r
+ echo.\r
+ echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.\r
+ goto end\r
+)\r
+\r
+if "%1" == "singlehtml" (\r
+ %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml\r
+ if errorlevel 1 exit /b 1\r
+ echo.\r
+ echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.\r
+ goto end\r
+)\r
+\r
+if "%1" == "pickle" (\r
+ %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle\r
+ if errorlevel 1 exit /b 1\r
+ echo.\r
+ echo.Build finished; now you can process the pickle files.\r
+ goto end\r
+)\r
+\r
+if "%1" == "json" (\r
+ %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json\r
+ if errorlevel 1 exit /b 1\r
+ echo.\r
+ echo.Build finished; now you can process the JSON files.\r
+ goto end\r
+)\r
+\r
+if "%1" == "htmlhelp" (\r
+ %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp\r
+ if errorlevel 1 exit /b 1\r
+ echo.\r
+ echo.Build finished; now you can run HTML Help Workshop with the ^\r
+.hhp project file in %BUILDDIR%/htmlhelp.\r
+ goto end\r
+)\r
+\r
+if "%1" == "qthelp" (\r
+ %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp\r
+ if errorlevel 1 exit /b 1\r
+ echo.\r
+ echo.Build finished; now you can run "qcollectiongenerator" with the ^\r
+.qhcp project file in %BUILDDIR%/qthelp, like this:\r
+ echo.^> qcollectiongenerator %BUILDDIR%\qthelp\OpenDaylightRelEngBuilder.qhcp\r
+ echo.To view the help file:\r
+ echo.^> assistant -collectionFile %BUILDDIR%\qthelp\OpenDaylightRelEngBuilder.ghc\r
+ goto end\r
+)\r
+\r
+if "%1" == "devhelp" (\r
+ %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp\r
+ if errorlevel 1 exit /b 1\r
+ echo.\r
+ echo.Build finished.\r
+ goto end\r
+)\r
+\r
+if "%1" == "epub" (\r
+ %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub\r
+ if errorlevel 1 exit /b 1\r
+ echo.\r
+ echo.Build finished. The epub file is in %BUILDDIR%/epub.\r
+ goto end\r
+)\r
+\r
+if "%1" == "epub3" (\r
+ %SPHINXBUILD% -b epub3 %ALLSPHINXOPTS% %BUILDDIR%/epub3\r
+ if errorlevel 1 exit /b 1\r
+ echo.\r
+ echo.Build finished. The epub3 file is in %BUILDDIR%/epub3.\r
+ goto end\r
+)\r
+\r
+if "%1" == "latex" (\r
+ %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex\r
+ if errorlevel 1 exit /b 1\r
+ echo.\r
+ echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.\r
+ goto end\r
+)\r
+\r
+if "%1" == "latexpdf" (\r
+ %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex\r
+ cd %BUILDDIR%/latex\r
+ make all-pdf\r
+ cd %~dp0\r
+ echo.\r
+ echo.Build finished; the PDF files are in %BUILDDIR%/latex.\r
+ goto end\r
+)\r
+\r
+if "%1" == "latexpdfja" (\r
+ %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex\r
+ cd %BUILDDIR%/latex\r
+ make all-pdf-ja\r
+ cd %~dp0\r
+ echo.\r
+ echo.Build finished; the PDF files are in %BUILDDIR%/latex.\r
+ goto end\r
+)\r
+\r
+if "%1" == "text" (\r
+ %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text\r
+ if errorlevel 1 exit /b 1\r
+ echo.\r
+ echo.Build finished. The text files are in %BUILDDIR%/text.\r
+ goto end\r
+)\r
+\r
+if "%1" == "man" (\r
+ %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man\r
+ if errorlevel 1 exit /b 1\r
+ echo.\r
+ echo.Build finished. The manual pages are in %BUILDDIR%/man.\r
+ goto end\r
+)\r
+\r
+if "%1" == "texinfo" (\r
+ %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo\r
+ if errorlevel 1 exit /b 1\r
+ echo.\r
+ echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.\r
+ goto end\r
+)\r
+\r
+if "%1" == "gettext" (\r
+ %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale\r
+ if errorlevel 1 exit /b 1\r
+ echo.\r
+ echo.Build finished. The message catalogs are in %BUILDDIR%/locale.\r
+ goto end\r
+)\r
+\r
+if "%1" == "changes" (\r
+ %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes\r
+ if errorlevel 1 exit /b 1\r
+ echo.\r
+ echo.The overview file is in %BUILDDIR%/changes.\r
+ goto end\r
+)\r
+\r
+if "%1" == "linkcheck" (\r
+ %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck\r
+ if errorlevel 1 exit /b 1\r
+ echo.\r
+ echo.Link check complete; look for any errors in the above output ^\r
+or in %BUILDDIR%/linkcheck/output.txt.\r
+ goto end\r
+)\r
+\r
+if "%1" == "doctest" (\r
+ %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest\r
+ if errorlevel 1 exit /b 1\r
+ echo.\r
+ echo.Testing of doctests in the sources finished, look at the ^\r
+results in %BUILDDIR%/doctest/output.txt.\r
+ goto end\r
+)\r
+\r
+if "%1" == "coverage" (\r
+ %SPHINXBUILD% -b coverage %ALLSPHINXOPTS% %BUILDDIR%/coverage\r
+ if errorlevel 1 exit /b 1\r
+ echo.\r
+ echo.Testing of coverage in the sources finished, look at the ^\r
+results in %BUILDDIR%/coverage/python.txt.\r
+ goto end\r
+)\r
+\r
+if "%1" == "xml" (\r
+ %SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml\r
+ if errorlevel 1 exit /b 1\r
+ echo.\r
+ echo.Build finished. The XML files are in %BUILDDIR%/xml.\r
+ goto end\r
+)\r
+\r
+if "%1" == "pseudoxml" (\r
+ %SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml\r
+ if errorlevel 1 exit /b 1\r
+ echo.\r
+ echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml.\r
+ goto end\r
+)\r
+\r
+:end\r
Code Review / releng / builder.git / commitdiff