aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
Diffstat
-rw-r--r--.readthedocs.yaml20
-rw-r--r--INFO.yaml144
-rw-r--r--cmso-database/src/main/resources/cmso-dbchangelog/onap-cmso-v1-schema.sql2
-rw-r--r--cmso-database/src/main/resources/cmso-dbchangelog/onap-cmso-v1.1-add-uuid.sql1
-rw-r--r--cmso-database/src/main/resources/cmso-dbchangelog/onap-cmso-v1.1-drop-ids.sql1
-rw-r--r--cmso-database/src/main/resources/cmso-dbchangelog/onap-cmso-v1.1-drop-indices.sql1
-rw-r--r--cmso-database/src/main/resources/cmso-dbchangelog/onap-cmso-v1.1-restore-indices.sql1
-rw-r--r--cmso-database/src/main/resources/optimizer-dbchanges/onap-optimizer-v1-schema.sql11
-rw-r--r--docs/.gitignore3
-rw-r--r--docs/_static/css/ribbon.css63
-rwxr-xr-xdocs/_static/favicon.icobin0 -> 2102 bytes
-rw-r--r--docs/_static/logo_onap_2017.pngbin0 -> 12278 bytes
-rw-r--r--docs/conf.py15
-rw-r--r--docs/conf.yaml7
-rw-r--r--docs/requirements-docs.txt15
-rw-r--r--docs/tox.ini22
16 files changed, 228 insertions, 78 deletions
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
new file mode 100644
index 0000000..3797dc8
--- /dev/null
+++ b/.readthedocs.yaml
@@ -0,0 +1,20 @@
+---
+# .readthedocs.yml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+# Required
+version: 2
+
+formats:
+ - htmlzip
+
+build:
+ image: latest
+
+python:
+ version: 3.7
+ install:
+ - requirements: docs/requirements-docs.txt
+
+sphinx:
+ configuration: docs/conf.py
diff --git a/INFO.yaml b/INFO.yaml
index 0b79111..d23ce79 100644
--- a/INFO.yaml
+++ b/INFO.yaml
@@ -3,78 +3,90 @@ project: 'optf-cmso'
project_creation_date: '2017-07-06'
lifecycle_state: 'Incubation'
project_lead: &onap_releng_ptl
- name: 'Shankaranarayanan Puzhavakath Narayanan'
- email: 'snarayanan@research.att.com'
- id: 'snarayanan'
- company: 'ATT'
- timezone: 'America/Bedminster'
+ name: 'Shankaranarayanan Puzhavakath Narayanan'
+ email: 'snarayanan@research.att.com'
+ id: 'snarayanan'
+ company: 'ATT'
+ timezone: 'America/Bedminster'
project_category: ''
primary_contact: *onap_releng_ptl
issue_tracking:
- type: 'jira'
- url: 'https://jira.onap.org/projects/OPTFRA'
- key: 'OPTFRA'
+ type: 'jira'
+ url: 'https://jira.onap.org/projects/OPTFRA'
+ key: 'OPTFRA'
mailing_list:
- type: 'groups.io'
- url: 'lists.onap.org'
- tag: '<[sub-project_name]>'
+ type: 'groups.io'
+ url: 'lists.onap.org'
+ tag: '<[sub-project_name]>'
realtime_discussion: ''
meetings:
- - type: 'zoom'
- agenda: 'https://wiki.onap.org/display/DW/Project+Resources+for+OOF'
- url: 'https://wiki.onap.org/display/DW/Optimization+Framework+Project'
- server: 'n/a'
- channel: 'n/a'
- repeats: 'weekly'
- time: '15:00 UTC'
+ - type: 'zoom'
+ agenda: 'https://wiki.onap.org/display/DW/Project+Resources+for+OOF'
+ url: 'https://wiki.onap.org/display/DW/Optimization+Framework+Project'
+ server: 'n/a'
+ channel: 'n/a'
+ repeats: 'weekly'
+ time: '15:00 UTC'
repositories:
- - 'optf-cmso'
- - 'optf-fgps'
- - 'optf-has'
- - 'optf-osdf'
+ - 'optf/cmso'
committers:
- - <<: *onap_releng_ptl
- - name: 'Sarat Puthenpura'
- email: 'sarat@research.att.com'
- company: 'ATT'
- id: 'sarat'
- timezone: 'America/Bedminster'
- - name: 'ramki krishnan'
- email: 'ramkri123@gmail.com'
- company: 'VMWare'
- id: 'ramkri123'
- timezone: 'America/Los_Angeles'
- - name: 'Dileep Ranganathan'
- email: 'dileep.ranganathan@intel.com'
- company: 'Intel'
- id: 'dileep.ranganathan'
- timezone: 'America/Los_Angeles'
- - name: 'Vikas Varma'
- email: 'vikas.varma@att.com'
- company: 'ATT'
- id: 'vrvarma'
- timezone: 'America/New_York'
+ - <<: *onap_releng_ptl
+ - name: 'Sarat Puthenpura'
+ email: 'sarat@research.att.com'
+ company: 'ATT'
+ id: 'sarat'
+ timezone: 'America/Bedminster'
+ - name: 'ramki krishnan'
+ email: 'ramkri123@gmail.com'
+ company: 'VMWare'
+ id: 'ramkri123'
+ timezone: 'America/Los_Angeles'
+ - name: 'Dileep Ranganathan'
+ email: 'dileep.ranganathan@intel.com'
+ company: 'Intel'
+ id: 'dileep.ranganathan'
+ timezone: 'America/Los_Angeles'
+ - name: 'Vikas Varma'
+ email: 'vikas.varma@att.com'
+ company: 'ATT'
+ id: 'vrvarma'
+ timezone: 'America/New_York'
+ - name: 'Arthur Martella'
+ email: 'arthur.martella.1@att.com'
+ company: 'ATT'
+ id: 'amartell'
+ timezone: 'America/New_York'
tsc:
- approval: 'https://lists.onap.org/pipermail/onap-tsc'
- changes:
- - type: 'Addition'
- name: 'Ankitkumar Patel'
- link: 'https://lists.onap.org/pipermail/onap-tsc/2018-April/004657.html'
- - type: 'Removal'
- name: 'maopeng zhang'
- name: 'Sastry Isukapalli'
- name: 'Yoram Zini'
- link: 'https://lists.onap.org/pipermail/onap-tsc/2018-June/004975.html'
- - type: 'Addition'
- name: 'ramki krishnan'
- name: 'Dileep Ranganathan'
- link: 'https://lists.onap.org/g/ONAP-TSC/message/3205'
- - type: 'Removal'
- name: 'Ankitkumar Patel'
- link: 'https://lists.onap.org/g/ONAP-TSC/message/3550'
- - type: 'Addition'
- name: 'Vikas Varma'
- link: 'http://ircbot.wl.linuxfoundation.org/meetings/onap-meeting/2018/onap-meeting.2018-08-30-13.57.log.txt'
- - type: 'Addition'
- name: 'Shankaranarayanan Puzhavakath Narayanan'
- link: 'https://civs.cs.cornell.edu/cgi-bin/results.pl?id=E_2696d1c15c2fdd16' \ No newline at end of file
+ approval: 'https://lists.onap.org/pipermail/onap-tsc'
+ changes:
+ - type: 'Addition'
+ name: 'Ankitkumar Patel'
+ link: 'https://lists.onap.org/pipermail/onap-tsc/2018-April/004657.html'
+ - type: 'Removal'
+ name: 'maopeng zhang'
+ link: 'https://lists.onap.org/pipermail/onap-tsc/2018-June/004975.html'
+ - type: 'Removal'
+ name: 'Sastry Isukapalli'
+ link: 'https://lists.onap.org/pipermail/onap-tsc/2018-June/004975.html'
+ - type: 'Removal'
+ name: 'Yoram Zini'
+ link: 'https://lists.onap.org/pipermail/onap-tsc/2018-June/004975.html'
+ - type: 'Addition'
+ name: 'ramki krishnan'
+ link: 'https://lists.onap.org/g/ONAP-TSC/message/3205'
+ - type: 'Addition'
+ name: 'Dileep Ranganathan'
+ link: 'https://lists.onap.org/g/ONAP-TSC/message/3205'
+ - type: 'Removal'
+ name: 'Ankitkumar Patel'
+ link: 'https://lists.onap.org/g/ONAP-TSC/message/3550'
+ - type: 'Addition'
+ name: 'Vikas Varma'
+ link: 'https://wiki.onap.org/x/IplFAg'
+ - type: 'Addition'
+ name: 'Shankaranarayanan Puzhavakath Narayanan'
+ # yamllint disable-line rule:line-length
+ link: 'https://civs.cs.cornell.edu/cgi-bin/results.pl?id=E_2696d1c15c2fdd16'
+ - type: 'Addition'
+ name: 'Arthur Martella'
+ link: 'https://wiki.onap.org/x/qiVIB'
diff --git a/cmso-database/src/main/resources/cmso-dbchangelog/onap-cmso-v1-schema.sql b/cmso-database/src/main/resources/cmso-dbchangelog/onap-cmso-v1-schema.sql
index 470cb3d..3c75563 100644
--- a/cmso-database/src/main/resources/cmso-dbchangelog/onap-cmso-v1-schema.sql
+++ b/cmso-database/src/main/resources/cmso-dbchangelog/onap-cmso-v1-schema.sql
@@ -1,6 +1,4 @@
-CREATE DATABASE IF NOT EXISTS CMSO;
-USE CMSO;
CREATE TABLE IF NOT EXISTS DOMAINS (
domain VARCHAR(256) NOT NULL,
diff --git a/cmso-database/src/main/resources/cmso-dbchangelog/onap-cmso-v1.1-add-uuid.sql b/cmso-database/src/main/resources/cmso-dbchangelog/onap-cmso-v1.1-add-uuid.sql
index 639a030..b77490d 100644
--- a/cmso-database/src/main/resources/cmso-dbchangelog/onap-cmso-v1.1-add-uuid.sql
+++ b/cmso-database/src/main/resources/cmso-dbchangelog/onap-cmso-v1.1-add-uuid.sql
@@ -1,4 +1,3 @@
-USE CMSO;
-- Schedules Add UUID column
ALTER TABLE SCHEDULES ADD COLUMN uuid BINARY(16) NOT NULL FIRST;
diff --git a/cmso-database/src/main/resources/cmso-dbchangelog/onap-cmso-v1.1-drop-ids.sql b/cmso-database/src/main/resources/cmso-dbchangelog/onap-cmso-v1.1-drop-ids.sql
index 5522f64..b6df3ae 100644
--- a/cmso-database/src/main/resources/cmso-dbchangelog/onap-cmso-v1.1-drop-ids.sql
+++ b/cmso-database/src/main/resources/cmso-dbchangelog/onap-cmso-v1.1-drop-ids.sql
@@ -1,4 +1,3 @@
-USE CMSO;
-- --------------------------------------------------------------
-- DROP ALL OF THE INTENGER IDs
diff --git a/cmso-database/src/main/resources/cmso-dbchangelog/onap-cmso-v1.1-drop-indices.sql b/cmso-database/src/main/resources/cmso-dbchangelog/onap-cmso-v1.1-drop-indices.sql
index ec74432..75df726 100644
--- a/cmso-database/src/main/resources/cmso-dbchangelog/onap-cmso-v1.1-drop-indices.sql
+++ b/cmso-database/src/main/resources/cmso-dbchangelog/onap-cmso-v1.1-drop-indices.sql
@@ -1,4 +1,3 @@
-USE CMSO;
-- -----------------------------------------------------
-- DROP THE FOREIGN KEYS THAT USE INT IDs
diff --git a/cmso-database/src/main/resources/cmso-dbchangelog/onap-cmso-v1.1-restore-indices.sql b/cmso-database/src/main/resources/cmso-dbchangelog/onap-cmso-v1.1-restore-indices.sql
index 0cb224a..19b9eca 100644
--- a/cmso-database/src/main/resources/cmso-dbchangelog/onap-cmso-v1.1-restore-indices.sql
+++ b/cmso-database/src/main/resources/cmso-dbchangelog/onap-cmso-v1.1-restore-indices.sql
@@ -1,4 +1,3 @@
-USE CMSO;
-- -----------------------------------------------------
-- UPDATE THE PRIMARY KEYS
diff --git a/cmso-database/src/main/resources/optimizer-dbchanges/onap-optimizer-v1-schema.sql b/cmso-database/src/main/resources/optimizer-dbchanges/onap-optimizer-v1-schema.sql
index d91a17e..803276a 100644
--- a/cmso-database/src/main/resources/optimizer-dbchanges/onap-optimizer-v1-schema.sql
+++ b/cmso-database/src/main/resources/optimizer-dbchanges/onap-optimizer-v1-schema.sql
@@ -1,6 +1,5 @@
-CREATE SCHEMA IF NOT EXISTS `optimizer` DEFAULT CHARACTER SET utf8 ;
-CREATE TABLE IF NOT EXISTS `optimizer`.`request` (
+CREATE TABLE IF NOT EXISTS `request` (
uuid BINARY(16) NOT NULL,
request LONGTEXT NOT NULL,
created_time BIGINT(20) NULL DEFAULT NULL,
@@ -12,7 +11,7 @@ CREATE TABLE IF NOT EXISTS `optimizer`.`request` (
ENGINE = InnoDB
DEFAULT CHARACTER SET = utf8;
-CREATE TABLE IF NOT EXISTS `optimizer`.`response` (
+CREATE TABLE IF NOT EXISTS `response` (
uuid BINARY(16) NOT NULL,
response LONGTEXT NULL DEFAULT NULL,
delivered_time BIGINT(20) NULL DEFAULT NULL,
@@ -21,7 +20,7 @@ ENGINE = InnoDB
DEFAULT CHARACTER SET = utf8;
-CREATE TABLE IF NOT EXISTS `optimizer`.`topology` (
+CREATE TABLE IF NOT EXISTS `topology` (
uuid BINARY(16) NOT NULL,
topology LONGTEXT NULL DEFAULT NULL,
topology_start BIGINT(20) NULL DEFAULT NULL,
@@ -32,7 +31,7 @@ CREATE TABLE IF NOT EXISTS `optimizer`.`topology` (
ENGINE = InnoDB
DEFAULT CHARACTER SET = utf8;
-CREATE TABLE IF NOT EXISTS `optimizer`.`tickets` (
+CREATE TABLE IF NOT EXISTS `tickets` (
uuid BINARY(16) NOT NULL,
tickets LONGTEXT NULL DEFAULT NULL,
tickets_start BIGINT(20) NULL DEFAULT NULL,
@@ -43,7 +42,7 @@ CREATE TABLE IF NOT EXISTS `optimizer`.`tickets` (
ENGINE = InnoDB
DEFAULT CHARACTER SET = utf8;
-CREATE TABLE IF NOT EXISTS `optimizer`.`optimizer` (
+CREATE TABLE IF NOT EXISTS `optimizer` (
uuid BINARY(16) NOT NULL,
optimize_response LONGTEXT NULL DEFAULT NULL,
optimize_start BIGINT(20) NULL DEFAULT NULL,
diff --git a/docs/.gitignore b/docs/.gitignore
new file mode 100644
index 0000000..43ca5b6
--- /dev/null
+++ b/docs/.gitignore
@@ -0,0 +1,3 @@
+/.tox
+/_build/*
+/__pycache__/*
diff --git a/docs/_static/css/ribbon.css b/docs/_static/css/ribbon.css
new file mode 100644
index 0000000..6008cb1
--- /dev/null
+++ b/docs/_static/css/ribbon.css
@@ -0,0 +1,63 @@
+.ribbon {
+ z-index: 1000;
+ background-color: #a00;
+ overflow: hidden;
+ white-space: nowrap;
+ position: fixed;
+ top: 25px;
+ right: -50px;
+ -webkit-transform: rotate(45deg);
+ -moz-transform: rotate(45deg);
+ -ms-transform: rotate(45deg);
+ -o-transform: rotate(45deg);
+ transform: rotate(45deg);
+ -webkit-box-shadow: 0 0 10px #888;
+ -moz-box-shadow: 0 0 10px #888;
+ box-shadow: 0 0 10px #888;
+
+}
+
+.ribbon a {
+ border: 1px solid #faa;
+ color: #fff;
+ display: block;
+ font: bold 81.25% 'Helvetica Neue', Helvetica, Arial, sans-serif;
+ margin: 1px 0;
+ padding: 10px 50px;
+ text-align: center;
+ text-decoration: none;
+ text-shadow: 0 0 5px #444;
+ transition: 0.5s;
+}
+
+.ribbon a:hover {
+ background: #c11;
+ color: #fff;
+}
+
+
+/* override table width restrictions */
+@media screen and (min-width: 767px) {
+
+ .wy-table-responsive table td, .wy-table-responsive table th {
+ /* !important prevents the common CSS stylesheets from overriding
+ this as on RTD they are loaded after this stylesheet */
+ white-space: normal !important;
+ }
+
+ .wy-table-responsive {
+ overflow: visible !important;
+ }
+}
+
+@media screen and (max-width: 767px) {
+ .wy-table-responsive table td {
+ white-space: nowrap;
+ }
+}
+
+/* fix width of the screen */
+
+.wy-nav-content {
+ max-width: none;
+}
diff --git a/docs/_static/favicon.ico b/docs/_static/favicon.ico
new file mode 100755
index 0000000..cb712eb
--- /dev/null
+++ b/docs/_static/favicon.ico
Binary files differ
diff --git a/docs/_static/logo_onap_2017.png b/docs/_static/logo_onap_2017.png
new file mode 100644
index 0000000..5d064f4
--- /dev/null
+++ b/docs/_static/logo_onap_2017.png
Binary files differ
diff --git a/docs/conf.py b/docs/conf.py
new file mode 100644
index 0000000..8f40e8b
--- /dev/null
+++ b/docs/conf.py
@@ -0,0 +1,15 @@
+from docs_conf.conf import *
+
+branch = 'latest'
+master_doc = 'index'
+
+linkcheck_ignore = [
+ 'http://localhost',
+]
+
+intersphinx_mapping = {}
+
+html_last_updated_fmt = '%d-%b-%y %H:%M'
+
+def setup(app):
+ app.add_stylesheet("css/ribbon_onap.css")
diff --git a/docs/conf.yaml b/docs/conf.yaml
new file mode 100644
index 0000000..ab59281
--- /dev/null
+++ b/docs/conf.yaml
@@ -0,0 +1,7 @@
+---
+project_cfg: onap
+project: onap
+
+# Change this to ReleaseBranchName to modify the header
+default-version: latest
+#
diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt
new file mode 100644
index 0000000..b3188dd
--- /dev/null
+++ b/docs/requirements-docs.txt
@@ -0,0 +1,15 @@
+tox
+Sphinx
+doc8
+docutils
+setuptools
+six
+sphinx_rtd_theme>=0.4.3
+sphinxcontrib-blockdiag
+sphinxcontrib-needs>=0.2.3
+sphinxcontrib-nwdiag
+sphinxcontrib-seqdiag
+sphinxcontrib-swaggerdoc
+sphinxcontrib-plantuml
+sphinx_bootstrap_theme
+lfdocs-conf
diff --git a/docs/tox.ini b/docs/tox.ini
new file mode 100644
index 0000000..edac8c3
--- /dev/null
+++ b/docs/tox.ini
@@ -0,0 +1,22 @@
+[tox]
+minversion = 1.6
+envlist = docs,
+skipsdist = true
+
+[testenv:docs]
+basepython = python3
+deps = -r{toxinidir}/requirements-docs.txt
+commands =
+ sphinx-build -b html -n -d {envtmpdir}/doctrees ./ {toxinidir}/_build/html
+ echo "Generated docs available in {toxinidir}/_build/html"
+whitelist_externals =
+ echo
+ git
+ sh
+
+[testenv:docs-linkcheck]
+basepython = python3
+#deps = -r{toxinidir}/requirements-docs.txt
+commands = echo "Link Checking not enforced"
+#commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./ {toxinidir}/_build/linkcheck
+whitelist_externals = echo