diff options
| -rw-r--r-- | .gitignore | 3 | ||||
| -rw-r--r-- | INFO.yaml | 51 | ||||
| -rw-r--r-- | docs/conf.py | 1 | ||||
| -rw-r--r-- | docs/conf.yaml | 3 | ||||
| -rw-r--r-- | docs/requirements.txt | 2 | ||||
| -rw-r--r-- | tests/adhoc/smoke01-clean.sh | 16 | ||||
| -rw-r--r-- | tests/adhoc/smoke01.sh | 10 | ||||
| -rw-r--r-- | tox.ini | 17 |
8 files changed, 95 insertions, 8 deletions
@@ -1,6 +1,7 @@ *~ .*.sw? /build/ -/docs_build/ /docs_output/ /releng/ +.tox +docs/_build/* diff --git a/INFO.yaml b/INFO.yaml new file mode 100644 index 0000000..e4730ff --- /dev/null +++ b/INFO.yaml @@ -0,0 +1,51 @@ +--- +project: 'Virtualized Infrastructure Deployment Policies (Copper)' +project_creation_date: 'December 9, 2014' +project_category: 'Requirements' +lifecycle_state: 'Incubation' +project_lead: &opnfv_copper_ptl + name: 'Aimee Ukasick' + email: 'aimeeu@research.att.com' + company: 'research.att.com' + id: 'aimeeu' +primary_contact: *opnfv_copper_ptl +issue_tracking: + type: 'jira' + url: 'https://jira.opnfv.org/projects/COPPER' + key: 'COPPER' +mailing_list: + type: 'mailman2' + url: 'opnfv-tech-discuss@lists.opnfv.org' + tag: '[copper]' +realtime_discussion: + type: irc + server: 'freenode.net' + channel: '#opnfv-copper' +meetings: + - type: 'gotomeeting+irc' + agenda: # eg: 'https://wiki.opnfv.org/display/' + url: # eg: 'https://global.gotomeeting.com/join/819733085' + server: 'freenode.net' + channel: '#opnfv-meeting' + repeats: 'weekly' + time: # eg: '16:00 UTC' +repositories: + - 'copper' +committers: + - <<: *opnfv_copper_ptl + - name: 'David Lenrow' + email: 'david.lenrow@huawei.com' + company: 'huawei.com' + id: 'dlenrow' + - name: 'Zhipeng (Howard) Huang' + email: 'huangzhipeng@huawei.com' + company: 'huawei.com' + id: 'zhipengh' + - name: 'Bryan Sullivan' + email: 'bryan.sullivan@att.com' + company: 'att.com' + id: 'blsaws' +tsc: + # yamllint disable rule:line-length + approval: 'http//meetbot.opnfv.org/meetings/' + # yamllint enable rule:line-length diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..3c4453e --- /dev/null +++ b/docs/conf.py @@ -0,0 +1 @@ +from docs_conf.conf import * diff --git a/docs/conf.yaml b/docs/conf.yaml new file mode 100644 index 0000000..50b4385 --- /dev/null +++ b/docs/conf.yaml @@ -0,0 +1,3 @@ +--- +project_cfg: opnfv +project: COPPER diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..9fde2df --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,2 @@ +lfdocs-conf +sphinx_opnfv_theme diff --git a/tests/adhoc/smoke01-clean.sh b/tests/adhoc/smoke01-clean.sh index cfd5861..fa38a3b 100644 --- a/tests/adhoc/smoke01-clean.sh +++ b/tests/adhoc/smoke01-clean.sh @@ -14,16 +14,22 @@ # limitations under the License. # -# What this is: Cleanup script for a basic test to validate an OPNFV install. +# What this is: Cleanup script for a basic test to validate an OPNFV install. # -# Status: this is a work in progress, under test. +# Prerequisites: +# OpenStack installed. +# Environment setting script (e.g. admin-openrc.sh) available, and executed +# so OpenStack environment variables are setup. +# OpenStack clients installed e.g. via setup_osc.sh in the OPNFV Models repo. # # How to use: # Install Congress test server per https://wiki.opnfv.org/copper/academy -# $ source ~/git/copper/tests/adhoc/smoke01.sh +# $ bash ~/git/copper/tests/adhoc/smoke01.sh <openrc> +# <openrc>: path to your openrc script # After test, cleanup with -# $ source ~/git/copper/tests/adhoc/smoke01-clean.sh - +# $ bash ~/git/copper/tests/adhoc/smoke01-clean.sh +# +# Status: this is a work in progress, under test. function log() { f=$(caller 0 | awk '{print $2}') diff --git a/tests/adhoc/smoke01.sh b/tests/adhoc/smoke01.sh index 18e617f..207cec3 100644 --- a/tests/adhoc/smoke01.sh +++ b/tests/adhoc/smoke01.sh @@ -20,13 +20,19 @@ # Status: this is a work in progress, under test. Automated ping test to the # internet and between VMs has not yet been implemented. # +# Prerequisites: +# OpenStack installed. +# Environment setting script (e.g. admin-openrc.sh) available. +# OpenStack clients installed e.g. via setup_osc.sh in the OPNFV Models repo. +# # How to use: # Install Congress test server per https://wiki.opnfv.org/copper/academy # $ bash ~/git/copper/tests/adhoc/smoke01.sh <openrc> # <openrc>: path to your openrc script # After test, cleanup with -# $ bash ~/git/copper/tests/adhoc/smoke01-clean.sh <openrc> - +# $ bash ~/git/copper/tests/adhoc/smoke01-clean.sh +# +# Status: this is a work in progress, under test. trap 'fail' ERR @@ -0,0 +1,17 @@ +[tox] +minversion = 1.6 +envlist = + docs, + docs-linkcheck +skipsdist = true + +[testenv:docs] +deps = -rdocs/requirements.txt +commands = + sphinx-build -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html + echo "Generated docs available in {toxinidir}/docs/_build/html" +whitelist_externals = echo + +[testenv:docs-linkcheck] +deps = -rdocs/requirements.txt +commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck |