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/conf.py | 15 | ||||
| -rw-r--r-- | docs/conf.yaml | 7 | ||||
| -rw-r--r-- | docs/helm-search.txt | 84 | ||||
| -rw-r--r-- | docs/oom_hardcoded_certificates.rst | 54 | ||||
| -rw-r--r-- | docs/release-notes.rst | 15 | ||||
| -rw-r--r-- | docs/requirements-docs.txt | 15 | ||||
| -rw-r--r-- | docs/tox.ini | 22 |
11 files changed, 221 insertions, 57 deletions
diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 0000000000..43ca5b671f --- /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 0000000000..6008cb1a08 --- /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 0000000000..cb712ebd20 --- /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 0000000000..5d064f431c --- /dev/null +++ b/docs/_static/logo_onap_2017.png diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000000..8f40e8b817 --- /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 0000000000..ab5928131c --- /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/helm-search.txt b/docs/helm-search.txt index c071b95f4b..c7c4a7fe97 100644 --- a/docs/helm-search.txt +++ b/docs/helm-search.txt @@ -1,42 +1,42 @@ -NAME CHART VERSION APP VERSION DESCRIPTION -local/onap 5.0.0 Dublin Open Network Automation Platform (ONAP) -local/aaf 5.0.0 ONAP Application Authorization Framework -local/aai 5.0.0 ONAP Active and Available Inventory -local/appc 5.0.0 Application Controller -local/cassandra 5.0.0 ONAP cassandra -local/cds 5.0.0 ONAP Controller Design Studio (CDS) -local/clamp 5.0.0 ONAP Clamp -local/cli 5.0.0 ONAP Command Line Interface -local/common 5.0.0 Common templates for inclusion in other charts -local/consul 5.0.0 ONAP Consul Agent -local/contrib 5.0.0 ONAP optional tools -local/dcaegen2 5.0.0 ONAP DCAE Gen2 -local/dgbuilder 5.0.0 D.G. Builder application -local/dmaap 5.0.0 ONAP DMaaP components -local/esr 5.0.0 ONAP External System Register -local/log 5.0.0 ONAP Logging ElasticStack -local/mariadb-galera 5.0.0 Chart for MariaDB Galera cluster -local/mongo 5.0.0 MongoDB Server -local/msb 5.0.0 ONAP MicroServices Bus -local/multicloud 5.0.0 ONAP multicloud broker -local/music 5.0.0 MUSIC - Multi-site State Coordination Service -local/mysql 5.0.0 MySQL Server -local/nbi 5.0.0 ONAP Northbound Interface -local/network-name-gen 5.0.0 Name Generation Micro Service -local/nfs-provisioner 5.0.0 NFS provisioner -local/oof 5.0.0 ONAP Optimization Framework -local/pnda 5.0.0 ONAP DCAE PNDA -local/policy 5.0.0 ONAP Policy Administration Point -local/pomba 5.0.0 ONAP Post Orchestration Model Based Audit -local/portal 5.0.0 ONAP Web Portal -local/postgres 5.0.0 ONAP Postgres Server -local/robot 5.0.0 A helm Chart for kubernetes-ONAP Robot -local/sdc 5.0.0 Service Design and Creation Umbrella Helm charts -local/sdnc 5.0.0 SDN Controller -local/sdnc-prom 5.0.0 ONAP SDNC Policy Driven Ownership Management -local/sniro-emulator 5.0.0 ONAP Mock Sniro Emulator -local/so 5.0.0 ONAP Service Orchestrator -local/uui 5.0.0 ONAP uui -local/vfc 5.0.0 ONAP Virtual Function Controller (VF-C) -local/vid 5.0.0 ONAP Virtual Infrastructure Deployment -local/vnfsdk 5.0.0 ONAP VNF SDK
\ No newline at end of file +NAME CHART VERSION APP VERSION DESCRIPTION +local/onap 6.0.0 Frankfurt Open Network Automation Platform (ONAP) +local/aaf 6.0.0 ONAP Application Authorization Framework +local/aai 6.0.0 ONAP Active and Available Inventory +local/appc 6.0.0 Application Controller +local/cassandra 6.0.0 ONAP cassandra +local/cds 6.0.0 ONAP Controller Design Studio (CDS) +local/clamp 6.0.0 ONAP Clamp +local/cli 6.0.0 ONAP Command Line Interface +local/common 6.0.0 Common templates for inclusion in other charts +local/consul 6.0.0 ONAP Consul Agent +local/contrib 6.0.0 ONAP optional tools +local/dcaegen2 6.0.0 ONAP DCAE Gen2 +local/dgbuilder 6.0.0 D.G. Builder application +local/dmaap 6.0.0 ONAP DMaaP components +local/esr 6.0.0 ONAP External System Register +local/log 6.0.0 ONAP Logging ElasticStack +local/mariadb-galera 6.0.0 Chart for MariaDB Galera cluster +local/mongo 6.0.0 MongoDB Server +local/msb 6.0.0 ONAP MicroServices Bus +local/multicloud 6.0.0 ONAP multicloud broker +local/music 6.0.0 MUSIC - Multi-site State Coordination Service +local/mysql 6.0.0 MySQL Server +local/nbi 6.0.0 ONAP Northbound Interface +local/network-name-gen 6.0.0 Name Generation Micro Service +local/nfs-provisioner 6.0.0 NFS provisioner +local/oof 6.0.0 ONAP Optimization Framework +local/pnda 6.0.0 ONAP DCAE PNDA +local/policy 6.0.0 ONAP Policy Administration Point +local/pomba 6.0.0 ONAP Post Orchestration Model Based Audit +local/portal 6.0.0 ONAP Web Portal +local/postgres 6.0.0 ONAP Postgres Server +local/robot 6.0.0 A helm Chart for kubernetes-ONAP Robot +local/sdc 6.0.0 Service Design and Creation Umbrella Helm charts +local/sdnc 6.0.0 SDN Controller +local/sdnc-prom 6.0.0 ONAP SDNC Policy Driven Ownership Management +local/sniro-emulator 6.0.0 ONAP Mock Sniro Emulator +local/so 6.0.0 ONAP Service Orchestrator +local/uui 6.0.0 ONAP uui +local/vfc 6.0.0 ONAP Virtual Function Controller (VF-C) +local/vid 6.0.0 ONAP Virtual Infrastructure Deployment +local/vnfsdk 6.0.0 ONAP VNF SDK diff --git a/docs/oom_hardcoded_certificates.rst b/docs/oom_hardcoded_certificates.rst index eb53a2d848..0745ec0df4 100644 --- a/docs/oom_hardcoded_certificates.rst +++ b/docs/oom_hardcoded_certificates.rst @@ -11,18 +11,42 @@ ONAP Hardcoded certificates ONAP current installation have hardcoded certificates. Here's the list of these certificates: - +-----------------------------------------------------------------------------------------------------------------------------+ - | Project | ONAP Certificate | Own Certificate | Path | - +============+==================+==================+==========================================================================+ - | VID | No | Yes | kubernetes/vid/resources/cert | - +------------+------------------+------------------+--------------------------------------------------------------------------+ - | AAI | Yes | No | aai/oom/resources/config/haproxy/aai.pem | - +------------+------------------+------------------+--------------------------------------------------------------------------+ - | AAI | Yes | No | aai/oom/resources/config/aai/aai_keystore | - +------------+------------------+------------------+--------------------------------------------------------------------------+ - | AAI | Yes | No | aai/oom/components/aai-search-data/resources/config/auth/tomcat_keystore | - +------------+------------------+------------------+--------------------------------------------------------------------------+ - | AAI | No | Yes | aai/oom/components/aai-babel/resources/config/auth/tomcat_keystore | - +------------+------------------+------------------+--------------------------------------------------------------------------+ - | AAI | Yes | Yes | aai/oom/components/aai-model-loaderresources/config/auth/tomcat_keystore | - +------------+------------------+------------------+--------------------------------------------------------------------------+ + +-----------------------------------------------------------------------------------------------------------------------------------------------------+ + | Project | ONAP Certificate | Own Certificate | MSB Certificate | Path | + +==================+==================+==================+============================================================================================+ + | AAI | Yes | No | No | aai/oom/resources/config/haproxy/aai.pem | + +------------------+------------------+------------------+--------------------------------------------------------------------------------------------+ + | AAI | Yes | No | No | aai/oom/resources/config/aai/aai_keystore | + +------------------+------------------+------------------+--------------------------------------------------------------------------------------------+ + | AAI/SEARCH-DATA | Yes | No | No | aai/oom/components/aai-search-data/resources/config/auth/tomcat_keystore | + +------------------+------------------+------------------+--------------------------------------------------------------------------------------------+ + | AAI/BABEL | No | Yes | No | aai/oom/components/aai-babel/resources/config/auth/tomcat_keystore | + +------------------+------------------+------------------+--------------------------------------------------------------------------------------------+ + | AAI/MODEL-LOADER | Yes | Yes | No | aai/oom/components/aai-model-loaderresources/config/auth/tomcat_keystore | + +------------------+------------------+------------------+--------------------------------------------------------------------------------------------+ + | SDC | Yes | No? | No? | kubernetes/sdc/resources/cert | + +------------------+------------------+------------------+--------------------------------------------------------------------------------------------+ + | SO | Yes | No? | Yes | kubernetes/so/resources/config/certificates | + +------------------+------------------+------------------+--------------------------------------------------------------------------------------------+ + | SO/BPMN | Yes | No? | Yes | kubernetes/so/resources/config/certificates | + +------------------+------------------+------------------+--------------------------------------------------------------------------------------------+ + | SO/Catalog | Yes | No? | Yes | kubernetes/so/resources/config/certificates | + +------------------+------------------+------------------+--------------------------------------------------------------------------------------------+ + | SO/Monitoring | Yes | No? | Yes | kubernetes/so/resources/config/certificates | + +------------------+------------------+------------------+--------------------------------------------------------------------------------------------+ + | SO/OpenStack | Yes | No? | Yes | kubernetes/so/resources/config/certificates | + +------------------+------------------+------------------+--------------------------------------------------------------------------------------------+ + | SO/RequestDb | Yes | No? | Yes | kubernetes/so/resources/config/certificates | + +------------------+------------------+------------------+--------------------------------------------------------------------------------------------+ + | SO/SDC | Yes | No? | Yes | kubernetes/so/resources/config/certificates | + +------------------+------------------+------------------+--------------------------------------------------------------------------------------------+ + | SO/SDNC | Yes | No? | Yes | kubernetes/so/resources/config/certificates | + +------------------+------------------+------------------+--------------------------------------------------------------------------------------------+ + | SO/VE/VNFM | Yes | No? | Yes | kubernetes/so/resources/config/certificates | + +------------------+------------------+------------------+--------------------------------------------------------------------------------------------+ + | SO/VFC | Yes | No? | Yes | kubernetes/so/resources/config/certificates | + +------------------+------------------+------------------+--------------------------------------------------------------------------------------------+ + | SO/VNFM | Yes | No? | Yes | kubernetes/so/resources/config/certificates | + +------------------+------------------+------------------+--------------------------------------------------------------------------------------------+ + | VID | No | Yes | No | kubernetes/vid/resources/cert | + +------------------+------------------+------------------+--------------------------------------------------------------------------------------------+ diff --git a/docs/release-notes.rst b/docs/release-notes.rst index fd90a37428..154c6ab1cd 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -61,6 +61,21 @@ Quick Links: - `Passing Badge information for OOM <https://bestpractices.coreinfrastructure.org/en/projects/1631>`_ +Version 6.0.0 (Frankfurt) +---------------------------------- + +:Release Date: 2020-05-14 + +Summary +------- + +**Software Requirements** + +* Upgraded to Kubernetes 1.15.x and Helm 2.16.x + +**Hardcoded Password removal** + +* All mariadb galera password are not hardcoded Version 5.0.0 (El Alto Early Drop) diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt new file mode 100644 index 0000000000..b3188ddd38 --- /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 0000000000..edac8c35fc --- /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 |
