Chore: Upgrade Jenkins-job-builder to 6.3.0

[releng/global-jjb.git] / docs / configuration.rst

diff --git a/docs/configuration.rst b/docs/configuration.rst
index 221217d..239ee6a 100644 (file)
--- a/docs/configuration.rst
+++ b/docs/configuration.rst
@@ -36,11 +36,14 @@ values used by global-jjb templates.
 :git-url: Set this to the base URL of your GitHub repo. In
     general this should be https://github.com. If you are using
     GitHub Enterprise, or some other GitHub-style system, then it
-    should be whatever your installation base URL is.
+    should be whatever your installation base URL is. This sets a job
+    property that GitHub Pull Request Builder requires to work.
+    Note that this is the web url to your project: (eg. https://github.com/$ORG/$PROJECT)
 
 :git-clone-url: This is the clone prefix used by GitHub jobs.
-    Set this to either the same thing as **git-url** or the
-    'git@github.com:' including the trailing ':'
+    Set this to either the same base url as **git-url**, or to
+    'git@github.com:' including the trailing ':'.  Determined
+    by your clone method (https or git).
 
 :github-org: The name of the GitHub organization interpolated
     into the scm config.
@@ -48,7 +51,7 @@ values used by global-jjb templates.
 :github_pr_org: The name of the GitHub organization. All members
     of this organization will be able to trigger jobs.
 
-:github_pr_whitelist: List of GitHub members you wish to be able to
+:github_pr_allowlist: List of GitHub members you wish to be able to
     trigger jobs.
 
 :github_pr_admin_list: List of GitHub members that will have admin
@@ -78,7 +81,7 @@ Example GitHub Infra:
        # lf-infra defaults
        jenkins-ssh-credential: jenkins-ssh
        github-org: lfit
-       github_pr_whitelist:
+       github_pr_allowlist:
          - jpwku
          - tykeal
          - zxiiro
@@ -95,7 +98,7 @@ Jenkins Files
 
 global-jjb makes use of the Jenkins Config File Provider plugin to provide some
 default configurations for certain tools. This section details the files to
-define in Jenkins' **Manage Files** configuration.
+define in Jenkins' **Managed Files** configuration (eg: https://jenkins.example.org/configfiles/index).
 
 .. _npmrc:
 
@@ -110,12 +113,48 @@ Documentation for npmrc is available via the `npm project
     proxy is not available for the project.
 :type: Custom file
 
-Create a "Custom file" with contents:
+Create a **Custom file** with contents:
 
 .. code-block:: ini
 
    registry = https://nexus.opendaylight.org/content/repositories/npmjs/
 
+.. _clouds-yaml:
+
+clouds-yaml
+-----------
+
+Needed by ``openstack client`` and ``packer`` to fetch OpenStack
+credentials and configuration. This file is OpenStack's `clouds.yaml
+<https://docs.openstack.org/python-openstackclient/pike/configuration/index.html>`_
+file.
+
+:Optional: Needed for jobs that use ``openstack client``. ``packer`` if
+    building against OpenStack infra.
+:type: Custom file
+
+Create a **Custom file** with contents:
+
+.. code-block:: yaml
+
+   clouds:
+   vex:
+    auth:
+      project_name: OS_PROJECT_NAME
+      username: OS_USERNAME
+      password: OS_PASSWORD
+      auth_url: 'https://auth.vexxhost.net/v3/'
+      user_domain_name: Default
+      project_domain_name: Default
+    region_name: ca-ymq-1
+
+.. warning::
+
+   If using packer 1.3.0 make sure that the clouds.yaml **profile**
+   configuration is **NOT** configured. Using **profile** causes packer to look
+   for another file called ``clouds-public.yaml`` for configuration.
+
+
 .. _pipconf:
 
 pipconf
@@ -129,7 +168,7 @@ in $HOME/.config/pip/pip.conf. Documentation for pip.conf is available via the
     proxy is not available for the project.
 :type: Custom file
 
-Create a "Custom file" with contents:
+Create a **Custom file** with contents:
 
 .. code-block:: ini
 
@@ -143,13 +182,13 @@ jjbini
 ------
 
 This file contains the Jenkins Job Builder `configuration
-<https://docs.openstack.org/infra/jenkins-job-builder/execution.html#configuration-file>`_
+<https://jenkins-job-builder.readthedocs.io/en/latest/execution.html#configuration-file>`_
 for :doc:`jjb/lf-ci-jobs`.
 
 :Required: This file MUST exist.
 :type: Custom file
 
-Create a "Custom file" with contents:
+Create a **Custom file** with contents:
 
 .. code-block:: ini