-from docs_conf.conf import *
+project = "onap"
+release = "master"
+version = "master"
-master_doc = 'index'
+author = "Open Network Automation Platform"
+# yamllint disable-line rule:line-length
+copyright = "ONAP. Licensed under Creative Commons Attribution 4.0 International License"
+
+pygments_style = "sphinx"
+html_theme = "sphinx_rtd_theme"
+html_theme_options = {
+ "style_nav_header_background": "white",
+ "sticky_navigation": "False" }
+html_logo = "_static/logo_onap_2017.png"
+html_favicon = "_static/favicon.ico"
+html_static_path = ["_static"]
+html_show_sphinx = False
+
+extensions = [
+ 'sphinx.ext.intersphinx',
+ 'sphinx.ext.graphviz',
+ 'sphinxcontrib.blockdiag',
+ 'sphinxcontrib.seqdiag',
+ 'sphinxcontrib.swaggerdoc',
+ 'sphinxcontrib.plantuml'
+]
+
+#
+# Map to 'latest' if this file is used in 'latest' (master) 'doc' branch.
+# Change to {releasename} after you have created the new 'doc' branch.
+#
+
+branch = 'latest'
intersphinx_mapping = {}
+doc_url = 'https://docs.onap.org/projects'
+master_doc = 'index'
+
+exclude_patterns = ['.tox']
+
+spelling_lang = "en_GB"
+spelling_word_list_filename='spelling_wordlist.txt'
+spelling_exclude_patterns=['release-notes.rst']
linkcheck_ignore = [
'http://localhost',
package: api/openecomp-sdc-rest-webapp/externaltesting-rest/externaltesting-rest-services
-Code to hold data types for the VTP API and the implemation of the interface to VTP is contained
+Code to hold data types for the VTP API and the implementation of the interface to VTP is contained
in these packages:
-Provide the API and serialization classes for the REST API to VTP
+Provide the API and serialisation classes for the REST API to VTP
package: lib/openecomp-sdc-externaltesting-lib/openecomp-sdc-externaltesting-api
These are links to the SDC user guides found in ONAP User Guides:
* :ref:`sdc_onboarding_package_types`
-* :ref:`User Guides <onap-doc:doc_guide_user_des>`
-
---------------------------
The logs for the application are available in the docker itself at /var/lib/jetty/logs/
In Heat deployment the dockers are mapped into /data/logs on the vm where the application is running.
-In OOM you can use the logging project to access the loggings collected from the applications.
+In OOM you can use the logging project to access the logs collected from the applications.
In the OOM deployment the log location in the docker is /var/log/onap
- ETSI SOL004 Tosca CSAR Package
- Basic Helm package support for CNF
-For an extensive guide on how to perform onboarding, please refer to the ONAP User guide:
-* :ref:`User Guides <onap-doc:doc_guide_user_des>`
-
+For an extensive guide on how to perform onboarding, please refer to the ONAP User guide
Heat Package
^^^^^^^^^^^^
templates in the package can have any name. All environment files that are included in the package must have the same
name as its corresponding yaml file with a .env file extension.
-An example of a simple heat package stucture is a zip archive containing the following 3 files
+An example of a simple heat package structure is a zip archive containing the following 3 files
- base_vFW.yaml (heat template)
- base_vFW.env (corresponding environment file)
If the package is onboarded using the ETSI SOL001 v2.5.1 model, the structure of the supported CSAR package
is as described in `ETSI NFV-SOL 004v2.5.1`_ csar structure option 1 i.e. CSAR containing a TOSCA-Metadata directory.
-The supported descriptor included in the package is aligned to `ETSI NFV-SOL 001v2.5.1`_. The tosca types defined in this version of the ETSI NFV-SOL 001 are used in the created VF (rather than the types defined in the SDC AID model).
+The supported descriptor included in the package is aligned to `ETSI NFV-SOL 001v2.5.1`_. The TOSCA types defined in this version of the ETSI NFV-SOL 001 are used in the created VF (rather than the types defined in the SDC AID model).
Note in relation to model selection:
- CSAR package contains TOSCA-Metadata directory
- The TOSCA.meta file exists within the TOSCA-Metadata directory
-- The TOSCA.meta file contains the following keynames in block_0
+- The TOSCA.meta file contains the following key names in block_0
- Entry-Definitions
- ETSI-Entry-Manifest
.. note::
For SDC to validate the authenticity and integrity of the onboarding package, the root certificate of the trusted CA
- needs to be pre-installed in SDC before onboarding is started. The details of this procedure are described :ref:`here <doc_guide_user_des_res-onb_pre-install_root_certificate>`.
+ needs to be pre-installed in SDC before onboarding is started.
.. _ETSI NFV-SOL 004v2.6.1: https://docbox.etsi.org/ISG/NFV/Open/Publications_pdf/Specs-Reports/NFV-SOL%20004v2.6.1%20-%20GS%20-%20VNF%20Package%20Stage%203%20-%20spec.pdf
.. _ETSI NFV-SOL 004v2.5.1: https://docbox.etsi.org/ISG/NFV/Open/Publications_pdf/Specs-Reports/NFV-SOL%20004v2.5.1%20-%20GS%20-%20VNF%20Package%20Stage%203%20spec.pdf
=============
Version: 1.12.0
-==============
+===============
:Release Date: 2022-10-28
N/A
Version: 1.11.9
-==============
+===============
:Release Date: 2022-09-28
N/A
Version: 1.11.8
-==============
+===============
:Release Date: 2022-09-09
N/A
Version: 1.11.7
-==============
+===============
:Release Date: 2022-08-15
N/A
Version: 1.11.6
-==============
+===============
:Release Date: 2022-07-21
N/A
Version: 1.11.5
-==============
+===============
:Release Date: 2022-06-24
N/A
Version: 1.11.4
-==============
+===============
:Release Date: 2022-06-09
N/A
Version: 1.11.3
-==============
+===============
:Release Date: 2022-05-17
N/A
Version: 1.11.2
-==============
+===============
:Release Date: 2022-04-23
N/A
Version: 1.11.1
-==============
+===============
:Release Date: 2022-04-08
N/A
Version: 1.11.0
-==============
+===============
:Release Date: 2022-04-05
Version: 1.10.3
-==============
+===============
:Release Date: 2022-03-22
N/A
Version: 1.10.2
-==============
+===============
:Release Date: 2022-03-15
* `SDC-3861 <https://jira.onap.org/browse/SDC-3861>`_ - Support for multiple directives
* `SDC-3898 <https://jira.onap.org/browse/SDC-3898>`_ - Support properties of type List<Map<String, String>>
* `SDC-3891 <https://jira.onap.org/browse/SDC-3891>`_ - Update SDC for rename of TOSCA CL to ACM
-* `SDC-3891 <https://jira.onap.org/browse/SDC-3882>`_ - Support occurrences on node templates
-* `SDC-3891 <https://jira.onap.org/browse/SDC-3897>`_ - Support complex types in interface operation inputs
-* `SDC-3891 <https://jira.onap.org/browse/SDC-3899>`_ - Support complex types for artifact properties in interface operation implementation
-* `SDC-3891 <https://jira.onap.org/browse/SDC-3887>`_ - Support instance count on node template
+* `SDC-3882 <https://jira.onap.org/browse/SDC-3882>`_ - Support occurrences on node templates
+* `SDC-3897 <https://jira.onap.org/browse/SDC-3897>`_ - Support complex types in interface operation inputs
+* `SDC-3899 <https://jira.onap.org/browse/SDC-3899>`_ - Support complex types for artifact properties in interface operation implementation
+* `SDC-3887 <https://jira.onap.org/browse/SDC-3887>`_ - Support instance count on node template
**Bug Fixes**
* `SDC-3889 <https://jira.onap.org/browse/SDC-3889>`_ - Error when no derived from exists
* `SDC-3888 <https://jira.onap.org/browse/SDC-3888>`_ - VSP upload with large files can handle the upload status incorrectly
* `SDC-3901 <https://jira.onap.org/browse/SDC-3901>`_ - Cannot create node filter capability if capability has different type properties
-* `SDC-3901 <https://jira.onap.org/browse/SDC-3907>`_ - Exception when mouse over and out the node pallet in the composition screen
-* `SDC-3901 <https://jira.onap.org/browse/SDC-3905>`_ - Error updating node filter capability
-* `SDC-3901 <https://jira.onap.org/browse/SDC-3904>`_ - Error creating node filter capability using get_property
+* `SDC-3907 <https://jira.onap.org/browse/SDC-3907>`_ - Exception when mouse over and out the node pallet in the composition screen
+* `SDC-3905 <https://jira.onap.org/browse/SDC-3905>`_ - Error updating node filter capability
+* `SDC-3904 <https://jira.onap.org/browse/SDC-3904>`_ - Error creating node filter capability using get_property
**Tasks**
N/A
Version: 1.10.1
-==============
+===============
:Release Date: 2022-02-02
* `SDC-3851 <https://jira.onap.org/browse/SDC-3851>`_ - Decrypt errors in sdc-be logs
* `SDC-3852 <https://jira.onap.org/browse/SDC-3852>`_ - Cassandra init dockers not working with latest version of cqlsh
* `SDC-2902 <https://jira.onap.org/browse/SDC-2902>`_ - Make sure Optionals values are defined before calling their `get` method
-* `SDC-3837 <https://jira.onap.org/browse/SDC-3840>`_ - Remove test-jar generation
+* `SDC-3840 <https://jira.onap.org/browse/SDC-3840>`_ - Remove test-jar generation
**Tasks**
Version: 1.10.0
-==============
+===============
:Release Date: 2022-01-07
**Stories**
-The full list of implemented stories is available on `JIRA ISTANBUL TASKS <https://jira.onap.org/issues/?jql=project%20%3D%20SDC%20AND%20issuetype%20%3D%20story%20AND%20fixVersion%20%3D%20%22Istanbul%20Release%22>`_
+The full list of implemented stories is available on `JIRA ISTANBUL STORIES <https://jira.onap.org/issues/?jql=project%20%3D%20SDC%20AND%20issuetype%20%3D%20story%20AND%20fixVersion%20%3D%20%22Istanbul%20Release%22>`_
**Tasks**
- improve code coverage of the SDC code.
- SDC introduced two new experimental projects the DCAE-D and WorkFlow which enhance the modeling capabilities of SDC.
-DCAE-D information is available here: `DCAE-DS <https://wiki.onap.org/display/DW/SDC-DCAE-D>`_
+DCAE-D information is available here: `DCAE-DS <https://wiki.onap.org/pages/viewpage.action?pageId=16005787>`_
Workflow information is available in readthedocs
**Epics**
-lfdocs-conf
sphinx>=4.2.0 # BSD
sphinx-rtd-theme>=1.0.0 # MIT
+sphinxcontrib-blockdiag # BSD
+sphinxcontrib-seqdiag # BSD
+sphinxcontrib-swaggerdoc
+sphinxcontrib-spelling
+sphinxcontrib-plantuml
Offered API
-----------
-.. Latest Open API model: :download:`OpenAPI.yaml <https://gerrit.onap.org/r/gitweb?p=sdc/sdc-helm-validator.git;a=blob_plain;f=OpenAPI.yaml;hb=refs/heads/master>`
-
-
-Latest Open API model: |sdc-helm-validator-open-api|_
+Latest Open API model: :download:`OpenAPI.yaml <https://gerrit.onap.org/r/gitweb?p=sdc/sdc-helm-validator.git;a=blob_plain;f=OpenAPI.yaml;hb=refs/heads/master>`
Validation
--- /dev/null
+Kohn
+init
+json
+Backend
+Catalog
+yaml
+janusgraph
+Onboarding
+externaltesting
+vnfrepo
+Frontend
+onboarding
+onapapi
+vnfsdk
+PackageResource
+csars
+csar
+vtp
+testsuites
+testSuiteName
+testcases
+testCaseName
+sdc
+cassandra
+Externalized
+onboarded
+subprojects
+openecomp
+api
+webapp
+impl
+xml
+src
+backend
+catalog
+frontend
+validator
+trift
+async
+http
+vm
+feproxy
+Guilin
+Pluggable
+onap
+stderrout
+logback
+config
+fe
+artifactArtifact
+Env
+artifact
+artifacts
+lifecycle
+serviceresource
+url
+VNF
+ENV
+MURANO
+boolean
+env
+uniqueId
+Artifact
+req
+forcap
+innerType
+adapters
+runtime
+xNF
+mano
+tgz
+pnfd
+Cryptographic
+pre
+vFW
+readme
+Deployable
+versionDesired
+vX
+isLinted
+isStrictLinted
+tosca
+jtosca
[tox]
minversion = 1.6
-envlist = docs,
+envlist = docs,docs-linkcheck,docs-spellcheck
skipsdist = true
[testenv:docs]
deps =
-r{toxinidir}/requirements-docs.txt
-chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt
- -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt
+ -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=master
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
+ sphinx-build -W -q -b html -n -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/html
[testenv:docs-linkcheck]
basepython = python3.8
-#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
+deps =
+ -r{toxinidir}/requirements-docs.txt
+ -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt
+ -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=master
+commands =
+ sphinx-build -W -q -b linkcheck -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/linkcheck
+
+[testenv:docs-spellcheck]
+basepython = python3.8
+deps =
+ -r{toxinidir}/requirements-docs.txt
+ -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt
+ -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=master
+commands =
+ sphinx-build -W -q -b spelling -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/spellcheck