summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--.gitmodules5
-rw-r--r--INFO.yaml52
m---------distributed-kv-store0
-rw-r--r--docs/architecture.rst27
-rw-r--r--docs/configuration.rst27
-rw-r--r--docs/consumedapis.rst16
-rw-r--r--docs/delivery.rst44
-rwxr-xr-xdocs/index.rst19
-rw-r--r--docs/installation.rst20
-rw-r--r--docs/logging.rst22
-rw-r--r--docs/offeredapis.rst16
-rw-r--r--docs/release-notes.rst50
-rwxr-xr-xpom.xml2
13 files changed, 299 insertions, 1 deletions
diff --git a/.gitmodules b/.gitmodules
new file mode 100644
index 00000000..4495accf
--- /dev/null
+++ b/.gitmodules
@@ -0,0 +1,5 @@
+[submodule "distributed-kv-store"]
+ path = distributed-kv-store
+ url = ../music/distributed-kv-store
+ branch = .
+ ignore = dirty
diff --git a/INFO.yaml b/INFO.yaml
new file mode 100644
index 00000000..af41ab20
--- /dev/null
+++ b/INFO.yaml
@@ -0,0 +1,52 @@
+---
+project: 'music'
+project_creation_date: '2018-01-17'
+lifecycle_state: 'Incubation'
+project_lead: &onap_releng_ptl
+ name: 'Bharath Balasubramanian'
+ email: 'bharathb@research.att.com'
+ id: 'bharathb'
+ company: 'ATT'
+ timezone: 'America/New York'
+primary_contact: *onap_releng_ptl
+issue_tracking:
+ type: 'jira'
+ url: 'https://jira.onap.org/projects/MUSIC'
+ key: 'MUSIC'
+meetings:
+ - type: 'zoom'
+ agenda: 'https://wiki.onap.org/display/DW/MUSIC+Project'
+ url: 'https://wiki.onap.org/display/DW/MUSIC+Project'
+ server: 'n/a'
+ channel: 'n/a'
+ repeats: 'weekly'
+ time: '14:00 UTC'
+committers:
+ - <<: *onap_releng_ptl
+ - name: 'Thomas Nelson'
+ email: 'tn1381@att.com'
+ company: 'ATT'
+ id: 'arthurdent3'
+ timezone: 'America/New York'
+ - name: 'Brendan Tschaen'
+ email: 'bptschaen@gmail.com'
+ company: ''
+ id: 'bptschaen'
+ timezone: ''
+ - name: 'Greg Waines'
+ email: 'greg.waines@windriver.com'
+ company: 'Windriver'
+ id: 'gwaines'
+ timezone: ''
+ - name: 'Viswanath Kumar Skand Priya'
+ email: 'viswanath.kumarskandpriya@verizon.com'
+ company: 'Verizon'
+ id: 'kspviswa-vz'
+ timezone: ''
+ - name: 'Shashank Kumar Shankar'
+ email: 'shashank.kumar.shankar@intel.com'
+ company: 'Intel'
+ id: 'shashank.kumar....'
+ timezone: 'America/Portland'
+tsc:
+ approval: 'https://lists.onap.org/pipermail/onap-tsc'
diff --git a/distributed-kv-store b/distributed-kv-store
new file mode 160000
+Subproject 086faa54cc995f9850c0946f42a83b58fed0204
diff --git a/docs/architecture.rst b/docs/architecture.rst
new file mode 100644
index 00000000..8daa0d3b
--- /dev/null
+++ b/docs/architecture.rst
@@ -0,0 +1,27 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Architecture
+============
+
+.. note::
+ * This section is used to describe a software component from a high level
+ view of capability, common usage scenarios, and interactions with other
+ components required in the usage scenarios.
+
+ * The architecture section is typically: provided in a platform-component
+ and sdk collections; and referenced from developer and user guides.
+
+ * This note must be removed after content has been added.
+
+
+Capabilities
+------------
+
+
+Usage Scenarios
+---------------
+
+
+Interactions
+------------
diff --git a/docs/configuration.rst b/docs/configuration.rst
new file mode 100644
index 00000000..085f9c66
--- /dev/null
+++ b/docs/configuration.rst
@@ -0,0 +1,27 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Configuration
+=============
+
+.. note::
+ * This section is used to describe the options a software component offers for configuration.
+
+ * Configuration is typically: provided for platform-component and sdk projects;
+ and referenced in developer and user guides.
+
+ * This note must be removed after content has been added.
+
+
+
+Example ...
+
+You can provide the following in ``basic.conf``
+
+``host=ADDRESS``
+ The address of the host
+
+``port=PORT``
+ The port used for signaling
+
+ Optional. Default: ``8080``
diff --git a/docs/consumedapis.rst b/docs/consumedapis.rst
new file mode 100644
index 00000000..c2af4c20
--- /dev/null
+++ b/docs/consumedapis.rst
@@ -0,0 +1,16 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Consumed APIs
+=============
+
+.. note::
+ * This section is used to reference APIs that a software component depends on
+ and uses from other sources.
+
+ * Consumed APIs should be a specific link to the offered APIs from another component
+ or external source.
+
+ * This note must be removed after content has been added.
+
+
diff --git a/docs/delivery.rst b/docs/delivery.rst
new file mode 100644
index 00000000..f3f083a7
--- /dev/null
+++ b/docs/delivery.rst
@@ -0,0 +1,44 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Delivery
+========
+
+.. note::
+ * This section is used to describe a software component packaging.
+ For a run-time component this might be executable images, containers, etc.
+ For an SDK this might be libraries.
+
+ * This section is typically provided for a platform-component and sdk;
+ and referenced in developer and user guides
+
+ * This note must be removed after content has been added.
+
+Example use of a block diagram.
+
+.. blockdiag::
+
+
+ blockdiag layers {
+ orientation = portrait
+ a -> m;
+ b -> n;
+ c -> x;
+ m -> y;
+ m -> z;
+ group l1 {
+ color = blue;
+ x; y; z;
+ }
+ group l2 {
+ color = yellow;
+ m; n;
+ }
+ group l3 {
+ color = orange;
+ a; b; c;
+ }
+
+ }
+
+
diff --git a/docs/index.rst b/docs/index.rst
new file mode 100755
index 00000000..417b6052
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,19 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. Copyright 2017 AT&T Intellectual Property. All rights reserved.
+
+Music Developer Documentation
+=============================
+
+.. toctree::
+ :maxdepth: 1
+
+ architecture
+ configuration
+ consumedapis
+ delivery
+ index
+ installation
+ logging
+ offeredapis
+ release-notes
diff --git a/docs/installation.rst b/docs/installation.rst
new file mode 100644
index 00000000..be64a63b
--- /dev/null
+++ b/docs/installation.rst
@@ -0,0 +1,20 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Installation
+============
+
+.. note::
+ * This section is used to describe how a software component is acquired and installed.
+
+ * This section is typically: provided for a platform-component and application; and
+ referenced in user guides.
+
+ * This note must be removed after content has been added.
+
+Environment
+-----------
+
+
+Steps
+-----
diff --git a/docs/logging.rst b/docs/logging.rst
new file mode 100644
index 00000000..39eabfba
--- /dev/null
+++ b/docs/logging.rst
@@ -0,0 +1,22 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Logging
+=======
+
+.. note::
+ * This section is used to describe the informational or diagnostic messages emitted from
+ a software component and the methods or collecting them.
+
+ * This section is typically: provided for a platform-component and sdk; and
+ referenced in developer and user guides
+
+ * This note must be removed after content has been added.
+
+
+Where to Access Information
+---------------------------
+
+
+Error / Warning Messages
+------------------------
diff --git a/docs/offeredapis.rst b/docs/offeredapis.rst
new file mode 100644
index 00000000..3dcc7962
--- /dev/null
+++ b/docs/offeredapis.rst
@@ -0,0 +1,16 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Offered APIs
+============
+
+.. note::
+ * This section is used to describe the external interfaces offered by a software component
+
+ * This section is typically: provided for a platform-component and sdk; and
+ referenced in developer guides and api reference manuals.
+
+ * This note must be removed after content has been added.
+
+
+.. swaggerv2doc:: swagger.json
diff --git a/docs/release-notes.rst b/docs/release-notes.rst
new file mode 100644
index 00000000..9b6688c3
--- /dev/null
+++ b/docs/release-notes.rst
@@ -0,0 +1,50 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+
+Release Notes
+=============
+
+.. note::
+ * This Release Notes must be updated each time the team decides to Release new artifacts.
+ * The scope of this Release Notes is for this particular component. In other words, each ONAP component has its Release Notes.
+ * This Release Notes is cumulative, the most recently Released artifact is made visible in the top of this Release Notes.
+ * Except the date and the version number, all the other sections are optional but there must be at least one section describing the purpose of this new release.
+ * This note must be removed after content has been added.
+
+
+Version: x.y.z
+--------------
+
+
+:Release Date: yyyy-mm-dd
+
+
+
+**New Features**
+
+One or two sentences explaining the purpose of this Release.
+
+**Bug Fixes**
+ - `CIMAN-65 <https://jira.onap.org/browse/CIMAN-65>`_ and a sentence explaining what this defect is addressing.
+**Known Issues**
+ - `CIMAN-65 <https://jira.onap.org/browse/CIMAN-65>`_ and two, three sentences.
+ One sentences explaining what is the issue.
+
+ Another sentence explaining the impact of the issue.
+
+ And an optional sentence providing a workaround.
+
+**Security Issues**
+ You may want to include a reference to CVE (Common Vulnerabilities and Exposures) `CVE <https://cve.mitre.org>`_
+
+
+**Upgrade Notes**
+
+**Deprecation Notes**
+
+**Other**
+
+===========
+
+End of Release Notes
diff --git a/pom.xml b/pom.xml
index b81e6ec3..60880b1e 100755
--- a/pom.xml
+++ b/pom.xml
@@ -33,7 +33,7 @@
<parent>
<groupId>org.onap.oparent</groupId>
<artifactId>oparent</artifactId>
- <version>0.1.1</version>
+ <version>1.1.0</version>
<relativePath />
</parent>