diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/.gitignore | 3 | ||||
| -rw-r--r-- | docs/_static/css/ribbon.css | 63 | ||||
| -rwxr-xr-x | docs/_static/favicon.ico | bin | 0 -> 2102 bytes | |||
| -rw-r--r-- | docs/_static/logo_onap_2017.png | bin | 0 -> 12278 bytes | |||
| -rw-r--r-- | docs/architecture.rst | 3 | ||||
| -rw-r--r-- | docs/conf.py | 15 | ||||
| -rw-r--r-- | docs/conf.yaml | 7 | ||||
| -rw-r--r-- | docs/delivery.rst | 18 | ||||
| -rwxr-xr-x | docs/index.rst | 1 | ||||
| -rw-r--r-- | docs/multi.rst | 57 | ||||
| -rw-r--r-- | docs/offeredapis.rst | 1 | ||||
| -rw-r--r-- | docs/release-notes.rst | 47 | ||||
| -rw-r--r-- | docs/requirements-docs.txt | 15 | ||||
| -rw-r--r-- | docs/setup.rst | 11 | ||||
| -rw-r--r-- | docs/single.rst | 3 | ||||
| -rw-r--r-- | docs/swagger.json | 65 | ||||
| -rw-r--r-- | docs/tox.ini | 22 |
17 files changed, 202 insertions, 129 deletions
diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 00000000..43ca5b67 --- /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 00000000..6008cb1a --- /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 Binary files differnew file mode 100755 index 00000000..cb712ebd --- /dev/null +++ b/docs/_static/favicon.ico diff --git a/docs/_static/logo_onap_2017.png b/docs/_static/logo_onap_2017.png Binary files differnew file mode 100644 index 00000000..5d064f43 --- /dev/null +++ b/docs/_static/logo_onap_2017.png diff --git a/docs/architecture.rst b/docs/architecture.rst index f78db7bb..73cfbc2d 100644 --- a/docs/architecture.rst +++ b/docs/architecture.rst @@ -1,5 +1,6 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 +.. _architecture: Architecture ============ @@ -7,7 +8,7 @@ Architecture Project Description ------------------- -To achieve 5 9s of availability on 3 9s or lower software and infrastructure in a cost-effective manner, ONAP components need to work in a reliable, active-active manner across multiple sites (platform-maturity resiliency level 3). A fundamental aspect of this is state management across geo-distributed sites in a reliable, scalable, highly available and efficient manner. This is an important and challenging problem because of three fundamental reasons: +To achieve five 9s of availability on three 9s or lower software and infrastructure in a cost-effective manner, ONAP components need to work in a reliable, active-active manner across multiple sites (platform-maturity resiliency level 3). A fundamental aspect of this is state management across geo-distributed sites in a reliable, scalable, highly available and efficient manner. This is an important and challenging problem because of three fundamental reasons: - Current solutions for state-management of ONAP components like MariaDB clustering, that work very effectively within a site, may not scale across geo-distributed sites (e.g., Beijing, Amsterdam and Irvine) or allow partitioned operation (thereby compromising availability). This is mainly because WAN latencies are much higher across sites and frequent network partitions can occur. diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 00000000..96a85251 --- /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.css")
\ No newline at end of file diff --git a/docs/conf.yaml b/docs/conf.yaml new file mode 100644 index 00000000..ab592813 --- /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/delivery.rst b/docs/delivery.rst index f3f083a7..c90ff818 100644 --- a/docs/delivery.rst +++ b/docs/delivery.rst @@ -27,17 +27,17 @@ Example use of a block diagram. m -> y; m -> z; group l1 { - color = blue; - x; y; z; - } + color = blue; + x; y; z; + } group l2 { - color = yellow; - m; n; - } + color = yellow; + m; n; + } group l3 { - color = orange; - a; b; c; - } + color = orange; + a; b; c; + } } diff --git a/docs/index.rst b/docs/index.rst index 437a50d8..19822636 100755 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,6 +1,7 @@ .. 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. +.. _master_index: Music Developer Documentation ============================= diff --git a/docs/multi.rst b/docs/multi.rst index bc26465f..380f4ea5 100644 --- a/docs/multi.rst +++ b/docs/multi.rst @@ -72,63 +72,6 @@ To access keyspace through cqlsh, login with credentials that are passed to MUSI -Zookeeper: ----------- -Once zookeeper has been installed on all the nodes, modify the **zk_install_location/conf/zoo.cfg** on all the nodes with the following lines: - -:: - - tickTime=2000 - dataDir=/opt/app/music/var/zookeeper - clientPort=2181 - initLimit=5 - syncLimit=2 - quorumListenOnAllIPs=true - server.1=public IP of node 1:2888:3888 - server.2=public IP of node 2:2888:3888 - server.3=public IP of node 3:2888:3888 - -Create the directory /var/zookeeper in all the machines and within that create a file called myid that contains the id of the machine. The machine running node.i will contain just the number i in the file myid. - -Start each of the nodes one by one from the zk_install_location/bin folder using the command: - - - - ./zkServer.sh start - -On each node check the file zookeeper.out in the zk_install_location/ bin to make sure all the machines are talking to each other and there are no errors. Note that while the machines are yet to come up there maybe error messages saying that connection has not yet been established. Clearly, this is ok. - - -If there are no errors, then from zk_install_location/bin simply run the following to get command line access to zookeeper. ./zkCli.sh - - -Run these commands on different machines to make sure the zk nodes are syncing. - -:: - - [zkshell] ls / - [zookeeper] - -Next, create a new znode by running - -:: - - create /zk_test my_data. - -This creates a new znode and associates the string "my_data" with the node. You should see: - -:: - - [zkshell] create /zk_test my_data - Created /zk_test - -Issue another ls / command to see what the directory looks like: - -:: - - [zkshell] ls / - [zookeeper, zk_test] - MUSIC Create a music.properties file and place it in /opt/app/music/etc at each node. Here is a sample of the file: cassandra.yaml:: diff --git a/docs/offeredapis.rst b/docs/offeredapis.rst index a9a59650..c75bd0c0 100644 --- a/docs/offeredapis.rst +++ b/docs/offeredapis.rst @@ -1,6 +1,7 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 +.. _offeredapis: Offered APIs ============ diff --git a/docs/release-notes.rst b/docs/release-notes.rst index d764cedd..5e8885da 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -1,40 +1,41 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. This work is licensed under a +.. Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 +.. _release_notes: Release Notes ============= -Initial Release for Casablanca +Initial Release for Frankfurt -Version: 3.0.24 +Version: 3.2.40 --------------- -:Release Date: 2018-11-30 +:Release Date: 2020-05-20 **New Features** -- MUSIC as a Service: while MUSIC was consumed internally by components in the Beijing release, in Cassablanca MUSIC can be deployed as an independent multi-site clustered service +- MUSIC now runs on a springboot server, instead of a standalone tomcat server -- Designed MUSIC to be a fully sharded, scale out system, where as many ONAP sites/component replicas can be added as required for performance +- HTTPS support for clients through AAF certificates -- Automated failure detection and consistent failover across sites for ONAP components using MUSIC through the PROM recipe +- A background lock clean up daemon will periodically check the status of + current locks, cleaning up 'stale' references. + Clients should see a performance boost if they were previously dealing with + many stale locks. + +- Improved error messaging to the user, allowing clients to better debug their + applications - Continued adherence to ONAP S3P requirements **Bug Fixes** + - `MUSIC-573 <https://jira.onap.org/projects/MUSIC/issues/MUSIC-573>`_ Pods still run as root - - `MUSIC-176 <https://jira.onap.org/projects/MUSIC/issues/MUSIC-176>`_ nc: bad address - - - `MUSIC-154 <https://jira.onap.org/projects/MUSIC/issues/MUSIC-154>`_ Helm charts using latest tag name - - - `MUSIC-152 <https://jira.onap.org/projects/MUSIC/issues/MUSIC-152>`_ MUSIC tomcat returning HTTP 401 - - - `MUSIC-147 <https://jira.onap.org/projects/MUSIC/issues/MUSIC-147>`_ Cassandra-job is failing - - - `MUSIC-143 <https://jira.onap.org/projects/MUSIC/issues/MUSIC-143>`_ Translator Service not picking records from controller + - `MUSIC-557 <https://jira.onap.org/projects/MUSIC/issues/MUSIC-557>`_ Test coverage goals met, and migrated to new sonar location - - `MUSIC-78 <https://jira.onap.org/projects/MUSIC/issues/MUSIC-78>`_ Build failed to find artifact org.onap.music:MUSIC:jar:2.5.5 + - `MUSIC-530 <https://jira.onap.org/browse/MUSIC-530>`_ Security Vulnerability in pom.xml fix @@ -48,22 +49,22 @@ MUSIC code has been formally scanned during build time using NexusIQ and all Cri Quick Links: - `MUSIC project page <https://wiki.onap.org/display/DW/MUSIC+Project>`_ -- `MUSIC Casablanca Release <https://wiki.onap.org/display/DW/MUSIC+Casablanca+Release>`_ +- `MUSIC Frankfurt Release <https://wiki.onap.org/display/DW/MUSIC+Frankfurt>`_ - `Passing Badge information for MUSIC <https://bestpractices.coreinfrastructure.org/en/projects/1722>`_ -- `MUSIC Architecture Page <https://onap.readthedocs.io/en/casablanca/submodules/music.git/docs/architecture.html>`_ -- `Project Vulnerability Review Table for MUSIC <https://wiki.onap.org/pages/viewpage.action?pageId=45285410>`_ +- `MUSIC Architecture Page <TBD>`_ +- `Project Vulnerability Review Table for MUSIC <https://wiki.onap.org/pages/viewpage.action?pageId=64004601>`_ **Upgrade Notes** - N/A + N/A **Deprecation Notes** - N/A + N/A **Other** - N/A + N/A =========== diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt new file mode 100644 index 00000000..b3188ddd --- /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/setup.rst b/docs/setup.rst index b12acd04..7fb5bf49 100644 --- a/docs/setup.rst +++ b/docs/setup.rst @@ -17,27 +17,20 @@ The main MUSIC dir should be:: # These also need to be set up /opt/app/music/etc /opt/app/music/logs - /opt/app/music/lib/zookeeper -When installing Tomcat, Cassandra and Zookeeper they should also be installed here.:: +When installing, Cassandra should also be installed here.:: /opt/app/music/apache-cassandra-n.n.n - /opt/app/music/zookeeper-n.n.n - /opt/app/music/apache-tomcat-n.n.n You could also create links from install dirs to a common name ie\::: ln -s /opt/app/music/apache-cassandra-n.n.n cassandra - ln -s /opt/app/music/zookeeper-n.n.n zookeeper - ln -s /opt/app/music/apache-tomcat-n.n.n tomcat -Cassandra and Zookeeper have data dirs.:: +Cassandra has data dirs.:: # For cassandra it should be (This is the default) /opt/app/music/cassandra/data - # For Zookeeper it should be - /opt/app/music/zookeeper/ Continue by selecting the link to the setup you are doing. diff --git a/docs/single.rst b/docs/single.rst index 060f02b4..632db5ac 100644 --- a/docs/single.rst +++ b/docs/single.rst @@ -15,8 +15,6 @@ Instructions - Ensure you have OpenJDK 8 on your machine. - Download Apache Cassandra 3.0, install into /opt/app/music and follow these instructions http://cassandra.apache.org/doc/latest/getting_started/installing.html till and including Step - By the end of this you should have Cassandra working. -- Download Apache Zookeeper 3.4.6, install into /opt/app/music and follow these instructions https://zookeeper.apache.org/doc/r3.4.6/zookeeperStarted.html pertaining to the standalone operation. By the end of this you should have Zookeeper working. -- Download the Version 8.5 Apache Tomcat and install it using these instructions https://tomcat.apache.org/download-80.cgi (this is for version 8.5). - Create a music.properties file and place it in /opt/app/music/etc/. Here is a sample of the file: music.properties:: @@ -30,7 +28,6 @@ music.properties:: # Optional current values are defaults ###################################### # If using docker this would point to the specific docker name. - #zookeeper.host=localhost #cassandra.host=localhost #music.ip=localhost diff --git a/docs/swagger.json b/docs/swagger.json index 27db769f..3bc67050 100644 --- a/docs/swagger.json +++ b/docs/swagger.json @@ -875,26 +875,43 @@ } } }, - "/v{version}/service/pingCassandra/{consistency}": { + "/v{version}/service/pingZookeeper": { "get": { "tags": [ "Healthcheck Api" ], "summary": "Get Health Status", "description": "", - "operationId": "cassandraStatus", + "operationId": "ZKStatus", "produces": [ "application/json" ], - "parameters": [ - { - "name": "consistency", - "in": "path", - "description": "Consistency level", - "required": true, - "type": "string" + "parameters": [], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "type": "object", + "additionalProperties": { + "type": "object" + } + } } + } + } + }, + "/v{version}/service/musicHealthCheck": { + "get": { + "tags": [ + "Healthcheck Api" ], + "summary": "Get Health Status", + "description": "", + "operationId": "musicHealthCheck", + "produces": [ + "application/json" + ], + "parameters": [], "responses": { "200": { "description": "successful operation", @@ -908,18 +925,26 @@ } } }, - "/v{version}/service/pingZookeeper": { + "/v{version}/service/pingCassandra/{consistency}": { "get": { "tags": [ "Healthcheck Api" ], "summary": "Get Health Status", "description": "", - "operationId": "ZKStatus", + "operationId": "cassandraStatus", "produces": [ "application/json" ], - "parameters": [], + "parameters": [ + { + "name": "consistency", + "in": "path", + "description": "Consistency level", + "required": true, + "type": "string" + } + ], "responses": { "200": { "description": "successful operation", @@ -939,7 +964,7 @@ "Lock Api" ], "summary": "Create Lock", - "description": "Puts the requesting process in the q for this lock. The corresponding node will be created in zookeeper if it did not already exist. Lock Name is the \"key\" of the form keyspaceName.tableName.rowId", + "description": "Puts the requesting process in the q for this lock. The corresponding lock will be created if it did not already exist. Lock Name is the \"key\" of the form keyspaceName.tableName.rowId", "operationId": "createLockReference", "produces": [ "application/json" @@ -1269,20 +1294,6 @@ "description": "Application namespace", "required": true, "type": "string" - }, - { - "name": "userId", - "in": "header", - "description": "userId", - "required": true, - "type": "string" - }, - { - "name": "password", - "in": "header", - "description": "Password", - "required": true, - "type": "string" } ], "responses": { diff --git a/docs/tox.ini b/docs/tox.ini new file mode 100644 index 00000000..edac8c35 --- /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 |
