aboutsummaryrefslogtreecommitdiffstats
path: root/docs
AgeCommit message (Collapse)AuthorFilesLines
2022-12-14[APPC] Remove appc chart and refsefiacor5-34/+0
Removing appc chart Removing most appc refs Some SO data may need to be followed up with SO team Signed-off-by: efiacor <fiachra.corcoran@est.tech> Change-Id: I183e3dfb7e33a3ada1ac9925ee96b9f32d89bd5a Issue-ID: OOM-3069
2022-12-08[DOC] Update Kohn release dateAndreas Geissler1-1/+1
Update the release date for kohn in the release notes. Issue-ID: OOM-3064 Signed-off-by: Andreas Geissler <andreas-geissler@telekom.de> Change-Id: Id2ea4555f34d30cde616183e1f4a055c0645df07
2022-11-28[DOC] ServiceMesh documentationAndreas Geissler12-116/+540
Add instructions for SM Installation (addon guide), ONAP configuration (customize_override) and access guide Issue-ID: OOM-3006 Signed-off-by: Andreas Geissler <andreas-geissler@telekom.de> Change-Id: I31acad2c8c84ed3382e1c43897333f9ff565ff6d
2022-11-18Merge "[DOC] Update strimzi doc version"Andreas Geissler3-6/+6
2022-11-18[DOC] Update strimzi doc versionefiacor1-1/+1
Bump strimzi in versions table Signed-off-by: efiacor <fiachra.corcoran@est.tech> Change-Id: I38ae67827c27db706b4a785f063f452c6a5a2c32 Issue-ID: OOM-3057
2022-11-10[COMMON] Bump ONAP versionAndreas Geissler1-0/+1
Update chart versions 12.0.0 for London Issue-ID: OOM-3046 Signed-off-by: Andreas Geissler <andreas-geissler@telekom.de> Change-Id: Ic196235ff4f6ae14a7ecad799bd75a9666b2594a
2022-11-10[DOC] Update release version for RTDs in KohnAndreas Geissler2-5/+5
Modify the versions in conf.* files to create Kohn RTDs Issue-ID: OOM-3040 Signed-off-by: Andreas Geissler <andreas-geissler@telekom.de> Change-Id: I43334f1f642aa61ca7b0c6becbd8efcfece56dce
2022-11-08[DOC] Create Kohn release NoteAndreas Geissler3-22/+18
Added RN text for Kohn and fixed release dated for old releases Issue-ID: OOM-3040 Signed-off-by: Andreas Geissler <andreas-geissler@telekom.de> Change-Id: I79b8275429254c01ad7914d99ffdc8c2e8713dc1
2022-11-07[RDT] Refactoring RTDefiacor111-214/+2575
Major refactor Moved some old docs etc to archived dir Added sub section for guides Added section for deployment options etc Signed-off-by: efiacor <fiachra.corcoran@est.tech> Change-Id: I5832c7a94d58c3110655f0c676a5f2a19172dc68 Issue-ID: OOM-3028
2022-06-24[COMMON] Bump ONAP versionAndreas Geissler3-67/+68
Use version 11.0.0 for Kohn Issue-ID: OOM-2971 Signed-off-by: Andreas Geissler <andreas-geissler@telekom.de> Change-Id: Icc0e0839fc6def2035383b5fa4c9153fc15fafda
2022-05-11[DOC] Jarata rel notes updateefiacor1-1/+1
Rel notes update for jakarta Jira items Signed-off-by: efiacor <fiachra.corcoran@est.tech> Change-Id: I2ca1572b28cb95b998fc84470ac89e1c661f826d Issue-ID: OOM-2953
2022-05-03[DOCS] Clean up docs etcefiacor72-531/+204
Clean up docs dir Add some stuff for J release Signed-off-by: efiacor <fiachra.corcoran@est.tech> Change-Id: Ie34bfe9c70129e3ffc34800481e4052faaebe067 Issue-ID: OOM-2953
2022-03-31[STRIMZI] Adding strimzi projectefiacor4-10/+66
Deploy a 2 node replica strimzi kafka cluster Reduce MR kafka to 1 replica Add kafka ready check to cps-temporal Update readthedocs with strimzi prerequisite Modify deploy.sh to deploy the strimzi kafka in advance Signed-off-by: efiacor <fiachra.corcoran@est.tech> Change-Id: I87e54ad69a174174cb86f096c07d58878e3ab14e Issue-ID: DMAAP-1621
2021-12-07[GLOBAL] Migrate to helm v3efiacor4-79/+73
Move all Chart.yaml to use apiVersion: 2 Move dependencies from requirements.yaml to Chart.yaml Changes to all makeFiles Changes to helm deploy plugin Signed-off-by: efiacor <fiachra.corcoran@est.tech> Change-Id: I03c5290eee9e40f76eacbf171e774204cf5fb1c0 Issue-ID: OOM-2845
2021-10-26[DOC] Remove Guilin infra tools compatibility noteBartek Grzybowski1-4/+0
This will be still retained in Guilin's own documentation branch Change-Id: Iea5d0ef8e506cc92c36a17e0e5201cea072faa19 Issue-ID: OOM-1 Signed-off-by: Bartek Grzybowski <b.grzybowski@partner.samsung.com>
2021-10-26[DOC] Upgrade kubectl and helm versionsBartek Grzybowski1-3/+3
Kubectl/Helm version in installation description got updated to those required by current release. Change-Id: I0526577321a46603f5cf65643cbed5d01b8d59df Issue-ID: OOM-1 Signed-off-by: Bartek Grzybowski <b.grzybowski@partner.samsung.com>
2021-10-26[DOC] Update OOM User Guide chapter titleBartek Grzybowski1-2/+2
Since the Honolulu release Helm v3 is the only supported version so it should no longer be documented as experimental. Updating the chapter title for disambiguation. Change-Id: I0c9ec2ac801ce8479549b096e8c3671b44b21f53 Issue-ID: OOM-1 Signed-off-by: Bartek Grzybowski <b.grzybowski@partner.samsung.com>
2021-10-20Merge "[COMMON] Adds 2 upper-constraints files to pin all dependencies"Sylvain Desbureaux1-9/+0
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-14[COMMON] Adds 2 upper-constraints files to pin all dependenciesCédric Ollivier1-9/+0
It leverages the latest change from lfdocs-conf and the upper-constraints.txt now centralized in ONAP docs. In a long run, upperconstraints.os.txt should be removed once ONAP is synced with OpenStack. docs/requirements-docs.txt is renamed requirements.txt as it mixes both docs and linter dependencies. It removes tox and setuptools from requirements as nothing depends on them (most requirements should be removed except lfdocsconf) Issue-ID: DOC-765 Change-Id: Iae808297484f4798de82a43597ccad7905ff4c94 Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com>
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