in the document directory, this file will be copied to that directory
before the document builder jobs ('opnfv-docs-verify' and 'opnfv-docs-merge').
-See https://wiki.opnfv.org/documentation/tools .
+You may need python package installation for new sphinx extension.
+Install python package with 'pip' in your machine and add the extension to
+the 'extensions' list below to test the documentation build locally.
+If you feel that your extensions would be useful for other projects too,
+we encourage you to propose a change in the releng repository.
+
+For further guidance see the https://wiki.opnfv.org/documentation/tools page.
'''
extensions = ['sphinxcontrib.httpdomain']
--- /dev/null
+sphinxcontrib-httpdomain
new conf.py in the document directory (e.g. 'docs/how-to-use-docs/conf.py')
that will be used in build process instead of default for OPNFV document
build. The OPNFV default configuration can be found in releng repo
-(see `conf.py`_).
+(see `docs/etc/conf.py`_).
-.. _conf.py:
+.. _docs/etc/conf.py:
https://gerrit.opnfv.org/gerrit/gitweb?p=releng.git;a=blob;f=docs/etc/conf.py;
In the build process, the following parameters are automatically added if they
/output/
/releng/
-Verify Jobs
-===========
+Jenkins Jobs
+============
+
+Enabling Jenkins Jobs
+---------------------
+
+Jenkins in OPNFV infra performs the jobs to verify and update your documents.
+To make your project repository watched by Jenkins to execute those jobs, you
+have to add your project name in 'project-pattern' of the following jobs by
+sending patch to update `jjb/opnfv/opnfv-docs.yml`_ on gerrit.
+
+.. _jjb/opnfv/opnfv-docs.yml:
+ https://gerrit.opnfv.org/gerrit/gitweb?p=releng.git;a=blob;f=jjb/opnfv/opnfv-docs.yml;
+
+Verify Job
+----------
The verify job name is **opnfv-docs-verify**.
PDF creation failed. This is a provisional workaround, since many projects are
not ready for PDF creation yet.
-Merge Jobs
-==========
+Merge Job
+----------
The merge job name is **opnfv-docs-merge**.
``http://artifacts.opnfv.org/<Project Name>/docs/`` .
You can put links in your project wiki page, so that everyone can see the
latest document always.
+
+Sphinx Extensions
+=================
+
+You can see available sphinx extension(s) in `docs/etc/requirements.txt`_.
+
+.. _docs/etc/requirements.txt:
+ https://gerrit.opnfv.org/gerrit/gitweb?p=releng.git;a=blob;f=docs/etc/requirements.txt;
+
+You can use other sphinx extensions to improve your documents.
+To share such tips, we encourage you to enable the extension in OPNFV infra
+by asking releng and opnfvdocs teams to add new sphinx extension via gerrit
+(proposing change in `docs/etc/conf.py`_ and `docs/etc/requirements.txt`_).
+After quick sanity checks, we'll install python package (if needed) and make
+it available in OPNFV document build.
installer: 'apex'
controller:
- - 'opencontrail'
- - 'opendaylight'
+ - 'odl'
- 'onos'
+ - 'opencontrail'
- pod: 'intel-pod2'
+ pod: 'intelpod2-jumphost'
stream:
- master:
gs-pathname: ''
jobs:
- - 'opnfv-apex-{controller}-daily-{stream}'
- - 'opnfv-apex-daily-deploy-{stream}'
+ - 'opnfv-apex-{controller}-{pod}-daily-{stream}'
+ - 'opnfv-apex-deploy-{pod}-daily-{stream}'
########################
# job templates
########################
- job-template:
- name: 'opnfv-apex-{controller}-daily-{stream}'
+ name: 'opnfv-apex-{controller}-{pod}-daily-{stream}'
disabled: true
git-revision: true
block: true
predefined-parameters:
- CONTROLLER='{controller}'
+ CONTROLLER={controller}
- job-template:
- name: 'opnfv-apex-daily-deploy-{stream}'
+ name: 'opnfv-apex-deploy-{pod}-daily-{stream}'
disabled: true
installer: 'compass4nfv'
controller:
- - 'opencontrail'
- - 'opendaylight'
+ - 'odl'
- 'onos'
+ - 'opencontrail'
- pod: 'huawei-sc-pod1'
+ pod: 'huawei-us-deploy-bare-1'
stream:
- master:
gs-pathname: ''
jobs:
- - 'opnfv-compass4nfv-{controller}-daily-{stream}'
- - 'opnfv-compass4nfv-daily-deploy-{stream}'
+ - 'opnfv-compass4nfv-{controller}-{pod}-daily-{stream}'
+ - 'opnfv-compass4nfv-deploy-{pod}-daily-{stream}'
########################
# job templates
########################
- job-template:
- name: 'opnfv-compass4nfv-{controller}-daily-{stream}'
+ name: 'opnfv-compass4nfv-{controller}-{pod}-daily-{stream}'
disabled: true
git-revision: true
block: true
predefined-parameters:
- CONTROLLER='{controller}'
+ CONTROLLER={controller}
- job-template:
- name: 'opnfv-compass4nfv-daily-deploy-{stream}'
+ name: 'opnfv-compass4nfv-deploy-{pod}-daily-{stream}'
disabled: true
installer: 'fuel'
controller:
- - 'opencontrail'
- - 'opendaylight'
+ - 'odl'
- 'onos'
+ - 'opencontrail'
- pod: 'lf-pod2'
+ pod:
+ - 'opnfv-jump-2'
+ - 'ericsson-pod1'
+
+ loop:
+ - 'daily'
stream:
- master:
gs-pathname: ''
jobs:
- - 'opnfv-fuel-{controller}-daily-{stream}'
- - 'opnfv-fuel-daily-deploy-{stream}'
+ - 'opnfv-fuel-{controller}-{pod}-{loop}-{stream}'
+ - 'opnfv-fuel-deploy-{pod}-{loop}-{stream}'
########################
# job templates
########################
- job-template:
- name: 'opnfv-fuel-{controller}-daily-{stream}'
+ name: 'opnfv-fuel-{controller}-{pod}-{loop}-{stream}'
disabled: true
concurrent: false
- node: ericsson-build
-
parameters:
- project-parameter:
project: '{installer}'
+ - 'ericsson-ca-build-1-defaults'
- '{installer}-defaults':
controller: '{controller}'
git-revision: true
block: true
predefined-parameters:
- CONTROLLER='{controller}'
+ CONTROLLER={controller}
- job-template:
- name: 'opnfv-fuel-daily-deploy-{stream}'
+ name: 'opnfv-fuel-deploy-{pod}-{loop}-{stream}'
disabled: true
parameters:
- project-parameter:
project: '{installer}'
- - '{pod}-defaults'
+ - '{pod}-defaults':
+ loop: '{loop}'
- '{installer}-defaults'
scm:
installer_type: 'compass'
installer_ip: '192.168.200.2'
- joid:
- node: 'intel-us-deploy-bare-pod5'
+ node: 'intel-pod5'
installer_type: 'compass'
installer_ip: '127.0.0.1'
pod:
node: 'huawei-us-deploy-bare-1'
installer_type: 'compass'
installer_ip: '192.168.200.2'
- - intel-us-deploy-bare-pod5:
- node: 'intel-us-deploy-bare-pod5'
+ - intel-pod5:
+ node: 'intel-pod5'
installer_type: 'joid'
installer_ip: '127.0.0.1'
description: "Override GIT_BASE"
- parameter:
- name: intel-us-deploy-bare-pod5
+ name: intel-pod5
parameters:
- string:
name: GIT_BASE
########################
- project:
- name: 'opnfv-joid'
+ name: 'joid'
installer: 'joid'
- controller:
- - 'opencontrail'
- - 'opendaylight'
- - 'onos'
+ controller: 'odl'
pod: 'intel-pod5'
gs-pathname: ''
jobs:
- - 'opnfv-joid-{controller}-daily-{stream}'
- - 'opnfv-joid-daily-deploy-{stream}'
+ - 'joid-{controller}-{pod}-daily-{stream}'
+ - 'joid-deploy-{pod}-daily-{stream}'
########################
# job templates
########################
- job-template:
- name: 'opnfv-joid-{controller}-daily-{stream}'
+ name: 'joid-{controller}-{pod}-daily-{stream}'
- disabled: true
+ disabled: false
concurrent: false
parameters:
- project-parameter:
project: '{installer}'
- - '{pod}-defaults'
+ - 'intel-us-build-1-defaults'
- '{installer}-defaults':
controller: '{controller}'
builders:
- trigger-builds:
- - project: 'opnfv-joid-daily-deploy-{stream}'
+ - project: 'joid-deploy-{pod}-daily-{stream}'
git-revision: true
block: true
predefined-parameters:
- CONTROLLER='{controller}'
+ CONTROLLER={controller}
- job-template:
- name: 'opnfv-joid-daily-deploy-{stream}'
+ name: 'joid-deploy-{pod}-daily-{stream}'
- disabled: true
+ disabled: false
concurrent: false
- project-parameter:
project: '{installer}'
- '{pod}-defaults'
- - '{installer}-defaults'
+ - '{installer}-defaults':
+ controller: '{controller}'
scm:
- git-scm:
builders:
- shell: |
#!/bin/bash
- echo "Hello World from OPNFV $INSTALLER_NAME"
echo "Running $INSTALLER_NAME with controller $CONTROLLER"
-
+ echo "Please note that this is a quick try to see how joid deployment works"
+ cd $WORKSPACE/ci
+ ./clean.sh
+ ./02-maasdeploy.sh intelpod5
+ ./deploy.sh -o liberty -s $CONTROLLER -t ha -l intelpod5
description: 'Installer used for deploying OPNFV on this POD'
- string:
name: CONTROLLER
- default: '{controller}'
+ default: none
description: 'Controller name'
- parameter:
description: 'Installer used for deploying OPNFV on this POD'
- string:
name: CONTROLLER
- default: '{controller}'
+ default: none
description: 'Controller name'
- parameter:
description: 'Installer used for deploying OPNFV on this POD'
- string:
name: CONTROLLER
- default: '{controller}'
+ default: none
description: 'Controller name'
- parameter:
description: 'Installer used for deploying OPNFV on this POD'
- string:
name: CONTROLLER
- default: '{controller}'
+ default: none
description: 'Controller name'
cd $WORKSPACE/docker
elif [[ "$DOCKER_REPO_NAME" == "opnfv/yardstick" ]]; then
cd $WORKSPACE/ci/docker/yardstick-ci
+elif [[ "$DOCKER_REPO_NAME" == "opnfv/storperf" ]]; then
+ cd $WORKSPACE/docker
else
echo "ERROR: DOCKER_REPO_NAME parameter not valid: $DOCKER_REPO_NAME"
exit 1
project:
- 'functest'
- 'yardstick'
+ - 'storperf'
jobs:
- '{project}-docker-build-push-{stream}'
projects:
- project-compare-type: 'REG_EXP'
#Left out arno projects oscar|octopus|functest|genesis
- project-pattern: 'vswitchperf|yardstick|apex|availability|bottlenecks|compass4nfv|conductor|copper|doctor|dovetail|dpacc|escalator|fastpathmetrics|fuel|inspector|ipv6|joid|kvmfornfv|lsoapi|moon|movie|multisite|onosfw|ovsnfv|parser|prediction|promise|qtip|releng|rs|sdnvpn|sfc|vnf_forwarding_graph|enfv|pinpoint|pharos|opnfvdocs'
+ project-pattern: 'vswitchperf|yardstick|apex|availability|bottlenecks|compass4nfv|conductor|copper|doctor|dovetail|dpacc|escalator|fastpathmetrics|fuel|inspector|ipv6|joid|kvmfornfv|lsoapi|moon|movie|multisite|onosfw|ovsnfv|parser|prediction|promise|qtip|releng|rs|sdnvpn|sfc|vnf_forwarding_graph|enfv|pinpoint|pharos|opnfvdocs|cperf'
branches:
- branch-compare-type: 'ANT'
branch-pattern: '**/master'
comment-contains-value: 'remerge'
projects:
- project-compare-type: 'REG_EXP'
- project-pattern: 'vswitchperf|yardstick|apex|availability|bottlenecks|compass4nfv|conductor|copper|doctor|dovetail|dpacc|escalator|fastpathmetrics|fuel|inspector|ipv6|joid|kvmfornfv|lsoapi|moon|movie|multisite|onosfw|ovsnfv|parser|prediction|promise|qtip|releng|rs|sdnvpn|sfc|vnf_forwarding_graph|enfv|pinpoint|pharos|opnfvdocs'
+ project-pattern: 'vswitchperf|yardstick|apex|availability|bottlenecks|compass4nfv|conductor|copper|doctor|dovetail|dpacc|escalator|fastpathmetrics|fuel|inspector|ipv6|joid|kvmfornfv|lsoapi|moon|movie|multisite|onosfw|ovsnfv|parser|prediction|promise|qtip|releng|rs|sdnvpn|sfc|vnf_forwarding_graph|enfv|pinpoint|pharos|opnfvdocs|cperf'
branches:
- branch-compare-type: 'ANT'
branch-pattern: '**/master'
- parameter:
- name: 'lf-pod1-defaults'
+ name: 'opnfv-jump-1-defaults'
parameters:
- node:
name: SLAVE_NAME
description: 'SSH key to use for Apex'
- parameter:
- name: 'lf-pod2-defaults'
+ name: 'opnfv-jump-2-defaults'
parameters:
- node:
name: SLAVE_NAME
- string:
name: GIT_BASE
default: ssh://gerrit.opnfv.org:29418/$PROJECT
- description: 'Git URL for LF POD2'
description: 'Git URL to use on the jumphost'
+ - string:
+ name: YARDSTICK_TEST_SUITE
+ default: opnfv_${{NODE_NAME}}_{loop}.yaml
+ description: 'Path to test suite'
+ - string:
+ name: YARDSTICK_DB_BACKEND
+ default: 'db_args'
+ description: 'Arguments to use in order to choose the backend DB'
+
+- parameter:
+ name: 'ericsson-pod1-defaults'
+ parameters:
+ - node:
+ name: SLAVE_NAME
+ description: 'Slave name on Jenkins'
+ allowed-slaves:
+ - ericsson-pod1
+ default-slaves:
+ - ericsson-pod1
+ - string:
+ name: INSTALLER_VERSION
+ default: latest
+ description: 'Version of the installer to deploy'
+ - string:
+ name: GIT_BASE
+ default: https://gerrit.opnfv.org/gerrit/$PROJECT
+ description: 'Git URL to use on the jumphost'
+ - string:
+ name: YARDSTICK_TEST_SUITE
+ default: opnfv_${{NODE_NAME}}_{loop}.yaml
+ description: 'Path to test suite'
- parameter:
name: 'ericsson-pod2-defaults'
name: SLAVE_NAME
description: 'Slave name on Jenkins'
allowed-slaves:
- - ericsson-ca-fuel-bare-1
+ - ericsson-pod2
default-slaves:
- - ericsson-ca-fuel-bare-1
+ - ericsson-pod2
- string:
name: INSTALLER_VERSION
default: latest
description: 'Git URL to use on the jumphost'
- parameter:
- name: 'intel-pod2-defaults'
+ name: 'intelpod2-jumphost-defaults'
parameters:
- node:
name: SLAVE_NAME
name: SLAVE_NAME
description: 'Slave name on Jenkins'
allowed-slaves:
- - intelpod5-jumphost
+ - intel-pod5
default-slaves:
- - intelpod5-jumphost
+ - intel-pod5
- string:
name: INSTALLER_VERSION
default: stable
name: SLAVE_NAME
description: 'Slave name on Jenkins'
allowed-slaves:
- - intelpod6-jumphost
+ - intel-pod6
default-slaves:
- - intelpod6-jumphost
+ - intel-pod6
- string:
name: INSTALLER_VERSION
default: latest
name: SLAVE_NAME
description: 'Slave name on Jenkins'
allowed-slaves:
- - intelpod8-jumphost
+ - intel-pod8
default-slaves:
- - intelpod8-jumphost
+ - intel-pod8
- string:
name: INSTALLER_VERSION
default: latest
description: 'Git URL to use on the jumphost'
- parameter:
- name: 'huawei-sc-pod1-defaults'
+ name: 'huawei-us-deploy-bare-1-defaults'
parameters:
- node:
name: SLAVE_NAME
name: GIT_BASE
default: https://gerrit.opnfv.org/gerrit/$PROJECT
description: 'Git URL to use on the jumphost'
+
+- parameter:
+ name: 'intel-us-build-1-defaults'
+ parameters:
+ - node:
+ name: SLAVE_NAME
+ description: 'Slave name on Jenkins'
+ allowed-slaves:
+ - intel-us-build-1
+ default-slaves:
+ - intel-us-build-1
+ - string:
+ name: GIT_BASE
+ default: https://gerrit.opnfv.org/gerrit/$PROJECT
+ description: 'Git URL to use on the slave'
+
+- parameter:
+ name: 'intel-us-build-2-defaults'
+ parameters:
+ - node:
+ name: SLAVE_NAME
+ description: 'Slave name on Jenkins'
+ allowed-slaves:
+ - intel-us-build-2
+ default-slaves:
+ - intel-us-build-2
+ - string:
+ name: GIT_BASE
+ default: https://gerrit.opnfv.org/gerrit/$PROJECT
+ description: 'Git URL to use on the slave'
+
+- parameter:
+ name: 'ericsson-ca-build-1-defaults'
+ parameters:
+ - node:
+ name: SLAVE_NAME
+ description: 'Slave name on Jenkins'
+ allowed-slaves:
+ - ericsson-ca-build-1
+ default-slaves:
+ - ericsson-ca-build-1
+ - string:
+ name: GIT_BASE
+ default: https://gerrit.opnfv.org/gerrit/$PROJECT
+ description: 'Git URL to use on the slave'
- 'qtip-ssl-parallel'
triggers:
- - timed: "@midnight"
+ - timed: '0 0,11,18 * * *'
###########################
#biuilder macros
builders:
- shell: |
#! /bin/bash
- if [[ ! -f $WORKSPACE/opnfv-openrc.sh ]]; then
- echo "Unable to access file $WORKSPACE/opnfv-openrc.sh"
+ if [[ ! -f $WORKSPACE/opnfv-stack.sh ]]; then
+ echo "Unable to access file $WO:qRKSPACE/opnfv-openrc.sh"
exit 1
fi
- source $WORKSPACE/opnfv-openrc.sh
+ source $WORKSPACE/opnfv-stack.sh
cd $WORKSPACE
echo "Running QTIP dhrystone with First Test case"
python qtip.py -s compute -b dhrystone_serial.yaml
builders:
- shell: |
#!/bin/bash
- if [[ ! -f $WORKSPACE/opnfv-openrc.sh ]]; then
+ if [[ ! -f $WORKSPACE/opnfv-stack.sh ]]; then
echo "Unable to access file $WORKSPACE/opnfv-openrc.sh"
exit 1
fi
- source $WORKSPACE/opnfv-openrc.sh
+ source $WORKSPACE/opnfv-stack.sh
cd $WORKSPACE
echo "Running QTIP dhrystone with Second Test case"
python qtip.py -s compute -b ssl_parallel.yaml
cd $WORKSPACE
git clone https://gerrit.opnfv.org/gerrit/releng
cd $WORKSPACE/releng/utils
- ./fetch_os_creds.sh #To test the problem with creating the file in $HOME
- ./fetch_os_creds.sh -d $WORKSPACE #To test if the file can be created in $WORKSPACE
+ #./fetch_os_creds.sh #To test the problem with creating the file in $HOME
+ ./fetch_os_creds.sh -d $WORKSPACE/opnfv-stack.sh #To test if the file can be created in $WORKSPACE
Code Review / releng.git / commitdiff