From 23e155bb9d8baa7babf023949b23891e5950aeb8 Mon Sep 17 00:00:00 2001 From: Thanh Ha Date: Fri, 4 Jan 2019 15:05:08 -0500 Subject: [PATCH] Add documentation regarding clouds.yaml Change-Id: I7baf6a95a1552d178ba6fe48ec89448995d0f927 Signed-off-by: Thanh Ha --- docs/configuration.rst | 42 +++++++++++++++++++++++++++++++++++++++--- 1 file changed, 39 insertions(+), 3 deletions(-) diff --git a/docs/configuration.rst b/docs/configuration.rst index 97e9d5b6..12aac97b 100644 --- a/docs/configuration.rst +++ b/docs/configuration.rst @@ -113,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 +`_ +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 @@ -132,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 @@ -152,7 +188,7 @@ 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 -- 2.16.6