summaryrefslogtreecommitdiffstats
path: root/docs
AgeCommit message (Collapse)AuthorFilesLines
2021-10-15[COMMON] Bump ONAP versionSylvain Desbureaux5-62/+70
Use version 9.0.0 for Istanbul Also update the doc. Issue-ID: OOM-1 Signed-off-by: Sylvain Desbureaux <sylvain.desbureaux@orange.com> Change-Id: I03e11799bf487226784c98b04116f005c89d1e70
2021-10-04Merge "[COMMON] Add and run pre-commit linters via tox"Sylvain Desbureaux1-41/+41
2021-09-27[DOC] Fix a few mispellingsguillaume.lambert9-17/+17
Many words were advertised by the spell checker. Some of them are obviously mispelled and are fixed here. Issue-ID: DOC-710 Signed-off-by: guillaume.lambert <guillaume.lambert@orange.com> Change-Id: I4108ba7e5d89099d16ae5714609a9701137ae83c
2021-09-27[DOC] Update spellchecker white listguillaume.lambert1-0/+10
White list is retrieved from an URL common to all project and has not been updated for a while. Issue-ID: DOC-710 Signed-off-by: guillaume.lambert <guillaume.lambert@orange.com> Change-Id: I429642847e76c09a27c7fbf33e018f7975ca684b
2021-09-26[COMMON] Add and run pre-commit linters via toxguillaume.lambert1-41/+41
- create a .pre-commit-config.yaml configuration file with * gitlint * trailing blanks linter * tabs removal linter - exclude .git folder from it - exclude Makefiles since tabs are mandatory by default in them - create a tox pre-commit profile to run it from tox note gitlint is not runnable at this pre-commit stage - create pre-commit-install and pre-commit-uninstall tox profiles to (un)install hooks locally and (un)perform tests at each "git commit" call (i.e. without calling manually the pre-commit tox profile) - precise pre-commit stages/types in the pre-commit configuration file so that hooks are installed correctly. This avoids messages about skipped tests when they are run at a wrong stage. Issue-ID: OOM-2643 Signed-off-by: guillaume.lambert <guillaume.lambert@orange.com> Change-Id: Ie95bb4f6f90be80b05a1398973caffeff7936881
2021-09-26[DOC] Fix docs requirements and Sphinx profilesEric Debeau1-14/+8
- force lfdocs-confr~=0.7.5 in docs/requirements-docs.txt - add funcparserlib==1.0.0a0 in docs/requirements-docs.txt - enforce compatible versions in other listed packages Issue-ID: DOC-765 Signed-off-by: guillaume.lambert <guillaume.lambert@orange.com> Change-Id: If3c9758cb9d691b222b04a22145f33cfb4f2a72b
2021-09-26[DOC] Fix some doc8 issuesguillaume.lambert6-28/+35
- move doc8 dependency from docs/requirements-docs.txt to tox.ini since it is not needed by other tox profiles - disable doc8 tox profile voting since linelength issues are not completely fixed yet - fix a few linelength issues Issue-ID: DOC-765 Signed-off-by: guillaume.lambert <guillaume.lambert@orange.com> Change-Id: I704fc2ee8087ffbb8a83d693f6dc5a5f7c992b10
2021-09-22[COMMON] Enforce checkbashisms tox profileGuillaume Lambert1-1/+1
- add checkbahims to tox.ini default profiles - remove -f options to unforce bashisms detection in explicit bash scripts and to differentiate treatments between bash and sh - migrate #!/bin/bash shebangs to #!/bin/sh for scripts without bashisms The following scripts have not been migrated since they still use bashisms difficult to migrate (mostly arrays - more details below) ./kubernetes/common/mariadb-init/resources/config/db_init.sh ./kubernetes/portal/components/portal-mariadb/resources/config/ \ mariadb/docker-entrypoint.sh ./kubernetes/helm/plugins/deploy/deploy.sh ./kubernetes/helm/plugins/undeploy/undeploy.sh ./kubernetes/sdnc/components/sdnc-prom/resources/bin/ensureSdncActive.sh $ find . -not -path '*/\.*' -name *.sh -exec checkbashisms -f {} + 2>&1\ | grep line | cut -d' ' -f 7- | sort | uniq -c | sort -k1,1nr 18 (bash arrays, ${name[0|*|@]}): 2 (declare): 1 ($FUNCNAME): 1 (shopt): 1 (trap with ERR|DEBUG|RETURN): https://mywiki.wooledge.org/Bashism#Arrays https://mywiki.wooledge.org/Bashism#Special_Variables https://mywiki.wooledge.org/Bashism#Builtins https://www.oilshell.org/release/0.5.alpha2/test/spec.wwz/builtin-trap.html Issue-ID: OOM-2643 Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com> Change-Id: Id06ad1d45004321a293bdd26038d8da5f7b6b4ac
2021-09-14[CMPV2-CERT-PROVIDER][DOC] Improve documentationJoanna Jeremicz1-2/+4
- Improve CMPv2 assets upgrade instructions Issue-ID: OOM-2753 Signed-off-by: Joanna Jeremicz <joanna.jeremicz@nokia.com> Change-Id: I625cf42ab4e57e92c10445d91b3b536df606aef4
2021-09-09Merge "[CONTRIB] Introduce certificate update use case in CertService"Sylvain Desbureaux2-54/+184
2021-09-06[CONTRIB] Introduce certificate update use case in CertServicePiotr Marcinkiewicz2-54/+184
1. Make changes in order to allow performing KUR/CR in EJBCA: - Add Certificate Update Admin role - Enable EndEntityAuthentication module - Create and set CA with constant UID - Add configuration for provider. 2. Update CertService, which provides with new certificate update endpoint. 3. Update release-notes. Issue-ID: OOM-2753 Issue-ID: OOM-2754 Signed-off-by: Piotr Marcinkiewicz <piotr.marcinkiewicz@nokia.com> Change-Id: I9cb0cb4d6d6939ad229a4ea254f2bc35d45a3d52 Signed-off-by: Joanna Jeremicz <joanna.jeremicz@nokia.com>
2021-09-02[ESR] Remove ESR from OOMmorganrol2-3/+0
Integration team believes that it will have no impact assuming that ESR is not used directly. Some AAI API mentions ESR but no direct call to ESR in the tests. This gate shall prove it or not... Issue-ID: INT-1972 Signed-off-by: morganrol <morgan.richomme@orange.com> Change-Id: If37199dc25fa9c268baa1dc88921aa22d6cb7277
2021-06-24[COMMON] Fix some bashismsGuillaume Lambert4-14/+14
pointed out by checkbashisms: - variable name HOSTNAME - source instead of . - sleep with suffix - string increments And migrate a few shebangs to /bin/sh Issue-ID: OOM-2643 Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com> Change-Id: I653c14454a3232b5a349ca1564ece53ddc94289d
2021-06-23[COMMON] Revert "[COMMON] Fix a few bashisms"Krzysztof Opasiak4-14/+14
This reverts commit 62178a49cc9e4088019d426636657d9f2980d242. This commit introduced regression on portal db config job which is now unable to start: /usr/local/bin/docker-entrypoint.sh: line 114: syntax error near unexpected token `(' Issue-ID: OOM-1 Signed-off-by: Krzysztof Opasiak <k.opasiak@samsung.com> Change-Id: I3cb72cd7625b180b364b713fe942d5956736ebef
2021-06-15[COMMON] Fix a few bashismsGuillaume Lambert4-14/+14
pointed out by checkbashisms: - variable name HOSTNAME - source instead of . - variable increments - sleep with suffix And migrate a few shebangs to /bin/sh Issue-ID: OOM-2643 Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com> Change-Id: I82981bcff17e88cf824935b841ce37a585ddde00
2021-05-10[PLATFORM] Remove certificate generation deploymentPiotr Marcinkiewicz4-26/+32
- remove certificate generation deployment - change certificate secret for provider (from server to client) - correct documentation Issue-ID: OOM-2712 Signed-off-by: Piotr Marcinkiewicz <piotr.marcinkiewicz@nokia.com> Change-Id: I21a8e277e1fd5f5190c7b67fb6ef97c1b3355230
2021-05-06[DOC] Release Notes for HonoluluSylvain Desbureaux1-5/+40
Updating release notes to match work done for Honolulu. Issue-ID: OOM-1 Signed-off-by: Sylvain Desbureaux <sylvain.desbureaux@orange.com> Change-Id: Ib63c3ad04efead593ec8ff941f2877b76455cbc3
2021-04-22[PLATFORM] Generate Cert-Service certs with Cert-ManagerPiotr Marcinkiewicz1-0/+6
Utilize Cert-Manager to secure communication between Cert-Service and its clients, adjust templates and configs. Issue-ID: OOM-2712 Signed-off-by: Piotr Marcinkiewicz <piotr.marcinkiewicz@nokia.com> Change-Id: I96426b1a184b4d254575e76d29214d9deda08cce Signed-off-by: Remigiusz Janeczek <remigiusz.janeczek@nokia.com>
2021-04-15[DOC] Installation guidelines for Cert-ManagerSylwia Jakubek1-4/+6
This patch adds a table of contents to make it more convenient to browse through the document Issue-ID: OOM-2701 Signed-off-by: Sylwia Jakubek <sylwia.jakubek@nokia.com> Change-Id: I3fcfaac2bd1ef00db6482db7826edc8567f10296
2021-03-30[DOC] Update user guide docramagp1-26/+89
This is to update outdated command output versions and options Change-Id: I9cf7a5f8344767146739084f63b512ca39a02cec Issue-ID: OOM-2602 Signed-off-by: ramagp <ramakrishnagp@aarnanetworks.com>
2021-03-24[DOC][COMMON] Prepare Honolulu releaseSylvain Desbureaux9-1120/+105
Updating the documentation and bumping version to 8.0.0 Issue-ID: OOM-1 Signed-off-by: Sylvain Desbureaux <sylvain.desbureaux@orange.com> Change-Id: I6f942f1466fed64264c44fb8fc0e1ffc93a98f18
2021-03-18[DOC] Installation guidelines for PaaS componentsSylwia Jakubek2-1/+105
Guidelines for installation of Prometheus Stack and Cert-Manager Issue-ID: OOM-2701 Signed-off-by: Sylwia Jakubek <sylwia.jakubek@nokia.com> Change-Id: Id8d9787109df7a90eb1f938836e75cbdd3a904b8
2021-03-03[CPS] Configuration Persistence Service Chartsputhuparambil.aditya2-0/+3
CPS Helm charts added Issue-ID: CPS-7 Co-authored-by: puthuparambil.aditya <aditya.puthuparambil@bell.ca> Co-authored-by: Sylvain Desbureaux <sylvain.desbureaux@orange.com> Co-authored-by: Bruno Sakoto <bruno.sakoto@bell.ca> Signed-off-by: Claudio David Gasparini <claudio.gasparini@pantheon.tech> Signed-off-by: Sylvain Desbureaux <sylvain.desbureaux@orange.com> Signed-off-by: puthuparambil.aditya <aditya.puthuparambil@bell.ca> Signed-off-by: Bruno Sakoto <bruno.sakoto@bell.ca> Change-Id: I027e5e4b3eec78ce889168f8796d55e6f9fd9be6 Signed-off-by: puthuparambil.aditya <aditya.puthuparambil@bell.ca>
2021-02-11Merge "[COMMON] Add a spellchecker tox profile"Krzysztof Opasiak1-0/+451
2021-02-10[COMMON] Add a spellchecker tox profileGuillaume Lambert1-0/+451
inspired from openStack https://github.com/openstack/qa-specs/blob/master/tox.ini https://doughellmann.com/blog/tag/sphinxcontrib-spelling/ https://pypi.org/project/sphinxcontrib-spelling/ Issue-ID: OOM-2648 Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com> Change-Id: Ia341f96a906c82f88257a885fd66005450a15d16
2021-02-09[DOCS] Fix Helm3 install guide in regard of "deploy" stepBartek Grzybowski1-1/+1
In contrary to helm v2 behaviour helm v3 does not automatically create namespace even if "--namespace" option is passed to it's "install" or "upgrade" subcommand. Additional flag "--create-namespace" has to be set. Alternatively namespace can be created manually before running "helm deploy" without that flag. Change-Id: I3c425667db3065e2aa04a8f140e1037d5080c96a Issue-ID: OOM-2562 Signed-off-by: Bartek Grzybowski <b.grzybowski@partner.samsung.com>
2021-02-09[DOCS] Fix Helm3 install guide regarding "helm search" commandBartek Grzybowski1-1/+1
For helm v3 the correct syntax for "search" command is "helm search repo [keyword]" Change-Id: Ie2c824ce5c0cdd38dd38de3b621e8302685dd743 Issue-ID: OOM-2562 Signed-off-by: Bartek Grzybowski <b.grzybowski@partner.samsung.com>
2021-02-02[COMMON] Fix tox docs profiles configurationGuillaume Lambert2-23/+1
- sphinx-build '-W' option needed only once - remove docs/tox.ini since * same profiles are declared in tox.ini * once run from the docs folder, this generates invalid files in doc/.tox for linters setup (e.g. docs/.tox/[..]/invalid.rst). They can cause warnings treated as errors by root tox profiles. - modify requirements.txt to force a sphinxcontrib-needs version prior to 0.6.0 . This latest version introduces a new services support functionality that cannot be easily disabled here and that requires additional configuration parameters to link GitHub issues. We cannot provide these parameters since this project uses JIRA. As a result, sphinx generates a warning treated as an error that makes the gate fail. https://sphinxcontrib-needs.readthedocs.io/en/service/services/index.html Issue-ID: OOM-2648 Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com> Change-Id: I14e9045482750f15a3e5e98af47197e2c9f60f60
2021-01-04[DOC] Update oom quick start guide with additional commandsramagp1-1/+20
This is to add few commands and notes under quick start guide Change-Id: I871348bfabb23c0fe302a6a3992bedb15682715d Issue-ID: OOM-2540 Signed-off-by: ramagp <ramakrishnagp@aarnanetworks.com>
2021-01-04[DOC] Remove doc linting warningSylvain Desbureaux1-0/+2
add :orphan: directive because guilin release note is not in toctree. Issue-ID: OOM-2646 Signed-off-by: Sylvain Desbureaux <sylvain.desbureaux@orange.com> Change-Id: I81a051e82c44f71b31595da2d485e595adc81cf1
2020-12-17Merge "[COMMON][MARIADB] Upgrade Mariadb DB galera version"Krzysztof Opasiak2-33/+158
2020-12-17Merge "[DOC] Update example override files in quick start guide documentation"Sylvain Desbureaux2-8/+23
2020-12-14[COMMON][MARIADB] Upgrade Mariadb DB galera versionSylvain Desbureaux2-33/+158
Mariadb DB Galera containers version is outdated and unmaintained. We need them to move to a new image provider. As new image provider is not compatible with our old templates, we also update the templates (by reworking bitnami mariadb-galera chart). An update of global mariadb image is also done in order to match mariadb galera version. Issue-ID: OOM-1720 Signed-off-by: Sylvain Desbureaux <sylvain.desbureaux@orange.com> Change-Id: Ib9976227759e90022183d4f37fc655143be4d6ac
2020-12-14Merge "[COMMON] Configure paths for Ingress"Krzysztof Opasiak1-1/+0
2020-12-14[DOC] Update example override files in quick start guide documentationramagp2-8/+23
This is to describe openstack parameters in example override files Change-Id: Ic03897f60317169360d9a0984d3ba4a64963bbe4 Issue-ID: OOM-2541 Signed-off-by: ramagp <ramakrishnagp@aarnanetworks.com>
2020-12-09[COMMON] Add doc lintingSylvain Desbureaux5-9/+12
Add 3 automated doc linting (sphinx building, linkchecking and doc8) in order to have an error free documentations Fix also issues found by these linters in order to start without errors. Issue-ID: OOM-2648 Signed-off-by: Sylvain Desbureaux <sylvain.desbureaux@orange.com> Change-Id: I318718c956020412a120ba3caeb9e21d35a99833
2020-12-08Add information on Docker dependencyPawel Wieczorek1-2/+7
Automated setup of "kubernetes/platform/components/oom-cert-service" requires having Docker in the deployment environment. Previously Docker was required only on Kubernetes cluster nodes. Issue-ID: OOM-2526 Change-Id: Ibe3353df62483af418803e5fba230d9f06d063cd Signed-off-by: Pawel Wieczorek <p.wieczorek2@samsung.com>
2020-12-08Merge "Remove no longer needed "make" target"Sylvain Desbureaux1-1/+1
2020-12-08[COMMON] Configure paths for IngressSylvain Desbureaux1-1/+0
Instead of globally choosing between virtualhosts and path based ingress, it's better to allow to choose it per component. Issue-ID: OOM-2641 Signed-off-by: Sylvain Desbureaux <sylvain.desbureaux@orange.com> Change-Id: I952826d03722693ebae7c95a083b95bf83752d68
2020-12-07Merge "[DOC] Remove warnings from documentation build"Sylvain Desbureaux10-6/+20
2020-12-07[DOC] Remove warnings from documentation buildEric Debeau10-6/+20
conf.py => use add_css_file as recommended oom_developer_guide.rst => suppres anchor for nexus link oom_user_guide.rst => - modify anchor for K8S link - add `` fo http example to avoid link to be checked For release-notes-<Release>.rst and oom_hardcoded_certificates.rst => - add :orphan: directive because rst file not in toctree Issue-ID: OOM-2646 Signed-off-by: Eric Debeau <eric.debeau@orange.com> Change-Id: Icfecde7807e2417a1825f25a1d57a1830c4222a0
2020-12-04[DOCS] Add helm3 install guideJakub Latusek3-0/+982
Document helm 3 deployment as our experimental feature. Issue-ID: OOM-2562 Change-Id: I188f53d7b90657d710109e6966220e0cfb9db8be Signed-off-by: Jakub Latusek <j.latusek@samsung.com> [Fix issues reported in review] Signed-off-by: Krzysztof Opasiak <k.opasiak@samsung.com>
2020-12-02Remove no longer needed "make" targetPawel Wieczorek1-1/+1
With predictable chart build process running "make onap" after "make all" is no longer necessary. Issue-ID: OOM-2399 Change-Id: I4db334aaf5371e5a40b3f1458e61a432d33297e3 Signed-off-by: Pawel Wieczorek <p.wieczorek2@samsung.com>
2020-12-01Merge "[DOC] Update OOM Quick Start Guide documentation section"Sylvain Desbureaux1-0/+4
2020-11-30[DOC] Update OOM Quick Start Guide documentation sectionramagp1-0/+4
This commit adds change to the Verify ONAP installation step to add another command in oom_quickstart_guide documentation section. Change-Id: I16ace8c330abdd7a073b8c5ca289522533b7522e Issue-ID: OOM-2548 Signed-off-by: ramagp <ramakrishnagp@aarnanetworks.com>
2020-11-30[COMMON][DOC] Bump version GuilinSylvain Desbureaux6-91/+244
Update charts and requirements to 7.0.0. Create release notes for Guilin Update documentation Issue-ID: OOM-2638 Signed-off-by: Sylvain Desbureaux <sylvain.desbureaux@orange.com> Change-Id: I965ed6b6ebb7d74bfddaff73edd3dd55a657841c
2020-11-30Merge "Missing commands to be added"Krzysztof Opasiak2-0/+14
2020-11-30Missing commands to be addedramagp2-0/+14
Change-Id: I11bd3ceacf8baa89fe78d318f12a25ced5e8b51b Issue-ID: OOM-2530 Signed-off-by: ramagp <ramakrishnagp@aarnanetworks.com>
2020-10-16Update makefiles to use specific helm versionJakub Latusek2-2/+10
Helm is now called by HELM_BIN variable which by default is set to helm and makefiles use helm from path. HELM_BIN can be overwritten so user can have two version of helm in system and choose which one to use. Signed-off-by: Jakub Latusek <j.latusek@samsung.com> Issue-ID: OOM-2562 Change-Id: I0917796aafe234e87afa0ac3c4c15720296276d5
2020-09-04[GENERAL] Use readiness container v3.0.1Sylvain Desbureaux2-2/+2
Readiness container v3.x and up are now present in ONAP main repository. They're also not using root user anymore and then script path has changed. Finally, "job_complete" script has been integrated in main "ready" script. As those changes are significant, we must upgrade all the components at once. Depends-On: I5afa83892043f4844afe12e61724a8d368a9f2e0 Issue-ID: OOM-2545 Signed-off-by: Grzegorz Lis <grzegorz.lis@nokia.com> Change-Id: I0b4eb5dd86390273532d67d0a9696e1cfcadf110