From: Trevor Bramwell <tbramwell@linuxfoundation.org>
Date: Tue, 15 May 2018 14:24:57 +0000 (-0700)
Subject: Add documentation for CFP files
X-Git-Tag: v0.21.0~17
X-Git-Url: https://gerrit.linuxfoundation.org/infra/gitweb?a=commitdiff_plain;h=2fea1a4a0f368248851312fc74e2a3e1aefeb1a8;p=releng%2Fglobal-jjb.git

Add documentation for CFP files

* jjbini
* jenkins-log-archives-settings
* packer-cloud-env

Change-Id: I316e4f1b93605029b5956fb1f5d1fd45b1d00c0d
Signed-off-by: Trevor Bramwell <tbramwell@linuxfoundation.org>
---

diff --git a/docs/configuration.rst b/docs/configuration.rst
index 4c597cc6..66b4f41c 100644
--- a/docs/configuration.rst
+++ b/docs/configuration.rst
@@ -1,5 +1,3 @@
-.. _configuration:
-
 #############
 Configuration
 #############
@@ -115,7 +113,7 @@ Documentation for npmrc is available via the `npm project
 
 Create a "Custom file" with contents:
 
-.. code::
+.. code-block:: ini
 
    registry = https://nexus.opendaylight.org/content/repositories/npmjs/
 
@@ -134,12 +132,111 @@ in $HOME/.config/pip/pip.conf. Documentation for pip.conf is available via the
 
 Create a "Custom file" with contents:
 
-.. code::
+.. code-block:: ini
 
    [global]
    timeout = 60
    index-url = https://nexus3.opendaylight.org/repository/PyPi/simple
 
+.. _jjbini:
+
+jjbini
+------
+
+This file contains the Jenkins Job Builder `configuration
+<https://docs.openstack.org/infra/jenkins-job-builder/execution.html#configuration-file>`_
+for :doc:`jjb/lf-ci-jobs`.
+
+:Required: This file MUST exist.
+:type: Custom file
+
+Create a "Custom file" with contents:
+
+.. code-block:: ini
+
+    [job_builder]
+    ignore_cache=True
+    keep_descriptions=False
+    include_path=.:scripts:~/git/
+    recursive=True
+
+    [jenkins]
+    user=jenkins-jobbuilder
+    password=1234567890abcdef1234567890abcdef
+    url=https://jenkins.example.org
+    query_plugins_info=False
+
+    [production]
+    user=jenkins-jobbuilder
+    password=1234567890abcdef1234567890abcdef
+    url=https://jenkins.example.org
+    query_plugins_info=False
+
+    [sandbox]
+    user=jenkins-jobbuilder
+    password=1234567890abcdef1234567890abcdef
+    url=https://jenkins.example.org/sandbox
+    query_plugins_info=False
+
+The last 2 sections are for the ``jenkins-cfg`` job use, they should match the
+``silo`` names for the respective Jenkins systems, typically ``production`` and
+``sandbox``.
+
+.. _jenkins-log-archives-settings:
+
+jenkins-log-archives-settings
+-----------------------------
+
+See :ref:`lf-infra-ship-logs` for usage. If not archiving logs then keep this
+file with default settings, global-jjb needs the file to exist to function.
+
+Requires a *credential* named 'logs' of type 'Username and Password' created in
+the Jenkins Credentials system.
+
+#. Add Server Credentials
+#. Set ``ServerId`` to ``logs``
+#. Set ``Credentials`` to the ``logs`` user created in the Credentials System
+
+:Required: This file MUST exist if using log archiving.
+:type: Maven settings.xml
+
+.. code-block:: xml
+
+   <?xml version="1.0" encoding="UTF-8"?>
+   <settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
+             xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+             xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0 http://maven.apache.org/xsd/settings-1.0.0.xsd">
+   </settings>
+
+.. note::
+
+   This example is the default boilerplate generated by Jenkins with
+   the comments stripped out. We can also use the default generated by Jenkins
+   without modifying it.
+
+.. _packer-cloud-env:
+
+packer-cloud-env
+----------------
+
+Cloud environment configuration variables for Packer jobs. These can
+contain credentials and configuration for whichever clouds packer jobs
+are using.
+
+:Required: This file MUST exist to use packer jobs.
+:type: Json file
+
+.. code-block:: json
+
+   {
+     "cloud_auth_url": "https://auth.vexxhost.net/v3/",
+     "cloud_tenant": "TENANT_ID",
+     "cloud_user": "CLOUD_USERNAME",
+     "cloud_pass": "CLOUD_PASSWORD",
+     "cloud_network": "CLOUD_NETWORK",
+     "ssh_proxy_host": ""
+   }
+
 .. _jenkins-ci-jobs:
 
 Jenkins CI Jobs
diff --git a/docs/jjb/lf-macros.rst b/docs/jjb/lf-macros.rst
index 9f7693a7..35727e50 100644
--- a/docs/jjb/lf-macros.rst
+++ b/docs/jjb/lf-macros.rst
@@ -107,6 +107,8 @@ way using git-review.
         email addresses to CC on the patch.
     :project: Gerrit project name.
 
+.. _lf-infra-ship-logs:
+
 lf-infra-ship-logs
 ------------------