aboutsummaryrefslogtreecommitdiffstats
path: root/docs
AgeCommit message (Collapse)AuthorFilesLines
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-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
2020-08-19[DOC] Correct RST filesEric Debeau13-250/+277
Correct different RST files to remove warnings generated by Doc8 - long lines - yaml code bad formated - tabulation Add a new file to store the hardcoded certificates (easier to manage with a CSV file than a RST table) Correct some minor editorial errors Issue-ID: OOM-2542 Signed-off-by: Eric Debeau <eric.debeau@orange.com> Change-Id: I89bfea619fbeda581dc04ca2abea80adfe1a8a02
2020-08-03Improved readability of Hardcoded Certs list docdeen19851-34/+34
Change-Id: I677ccc5048130c605bb06d0031508d62947d50b5 Signed-off-by: deen1985 <damian.nowak@nokia.com> Issue-ID: OOM-2531
2020-06-16[DOC] Use the right version for ONAP FrankfurtSylvain Desbureaux1-3/+4
The version given for Frankfurt version is not the right one. So we fix it with this commit. Issue-ID: OOM-2424 Signed-off-by: Sylvain Desbureaux <sylvain.desbureaux@orange.com> Change-Id: I9e24f0b15d821904e70d758a978c2979a530adf0
2020-06-15Merge "[DOC] Update release note"Sylvain Desbureaux9-700/+874
2020-06-15[DOC] Update release noteSylvain Desbureaux9-700/+874
Create release note for Frankfurt Issue-ID: OOM-2382 Signed-off-by: Sylvain Desbureaux <sylvain.desbureaux@orange.com> Change-Id: Ia78f6eee0dd07b0ebba84c8c714c6a95e4d99a34
2020-06-11Merge "[AAF SMS] Use certInitializer for certificates"Krzysztof Opasiak1-0/+2
2020-06-08[DOC] retrieve submodules at clone in guideSylvain Desbureaux1-1/+1
The git clone command was missing the automatic retrieve of submodules. Issue-ID: DOC-618 Signed-off-by: Sylvain Desbureaux <sylvain.desbureaux@orange.com> Change-Id: Ic43fa71c3b931b21160095ed9a9f4e48f733cbf4
2020-06-08[AAF SMS] Use certInitializer for certificatesSylvain Desbureaux1-0/+2
AAF SMS was hardcoding its certificates in the container. This patch makes use of certInitializer in order to retrieve "fresh" certificates. In order to use certInitiliazer in a sub component, we had to move charts to component and add the right requirements. Issue-ID: AAF-1159 Signed-off-by: Sylvain Desbureaux <sylvain.desbureaux@orange.com> Change-Id: I6ec55eddffd54dd56b03cea1a6f0b437f8bfa299
2020-05-28[AAF] Add CMPv2 Cert ServiceEmmettCox1-0/+2
This new micro service allow retrieval of certificates using CMPv2 protocol and relay the requests to CA server (such as EJBCA provided in contrib folder). Issue-ID: AAF-1083 Change-Id: Ib3acba3d071533ad933d043f067147e8406d8fa8 Signed-off-by: EmmettCox <emmett.cox@est.tech> Signed-off-by: Sylvain Desbureaux <sylvain.desbureaux@orange.com>
2020-05-12Merge "[COMMON] Override truststore in aaf_agent image"Sylvain Desbureaux1-2/+4
2020-05-07Merge changes I0947c006,I73f799d9Sylvain Desbureaux3-0/+164
* changes: DOC howto setup ingress on the Kubernetes cluster Ingress quick start guide notice
2020-05-06[COMMON] Override truststore in aaf_agent imageKrzysztof Opasiak1-2/+4
aaf_agent image currently contains hardcoded truststores in order to be able to connect to certman to retrieve certificate for given component. The goal is to remove hardcoded truststore from aaf_agent immage but first we need to be sure that all its users are able to provide the truststore to the pod as a configmap. Issue-ID: AAF-1134 Signed-off-by: Krzysztof Opasiak <k.opasiak@samsung.com> Change-Id: Ibe9de6ad7264c05aeca2af858918fc2b4d3a772b
2020-05-06DOC howto setup ingress on the Kubernetes clusterLucjan Bryndza2-0/+160
User manual howto setup ingress controller on the kubernetes cluster using Nginx and MetalLB Issue-ID: OOM-1878 Change-Id: I0947c0060851fd7a43bfa92b0472b9ec898857b6 Signed-off-by: Lucjan Bryndza <l.bryndza@samsung.com>
2020-05-06Ingress quick start guide noticeLucjan Bryndza1-0/+4
Notice about experimental ingress configuration Signed-off-by: Lucjan Bryndza <l.bryndza@samsung.com> Change-Id: I73f799d9fb254a5d40b1c7d22c75350010780a1d Issue-ID: OOM-1878
2020-05-05MUSIC spring boot helm charts (music-sb)Tschaen, Brendan1-0/+2
Removal of tomcat and zookeeper as per latest music version.. Replaced with cassandra only and spring boot version of music, adding support for https and running the music container under a non-root user Update oof-has music-api configuration, use https Switch to music-api-springboot for all the ready.py Issue-ID: MUSIC-572 Signed-off-by: Tschaen, Brendan <ctschaen@att.com> Change-Id: Idbfac29cb5e9808787b5994e2575f055c292a146 Signed-off-by: vrvarma <vikas.varma@att.com>
2020-05-04Release RC1Huabing Zhao1-0/+2
This change addresses two issues: MSB-467: Certificate in MSB is set to use *.zte.com.cn MSB-462: Pods still run as root These two issue have been fixed in docker images, but also need to be reflected in K8s manifest. Issue-ID: MSB-467 Signed-off-by: Huabing Zhao <zhao.huabing@zte.com.cn> Change-Id: Id67e521b3051e9651051083f05d9e54973803030
2020-04-22Merge "[DOC] Bump the version of rancher, k8s and helm"Krzysztof Opasiak3-11/+7
2020-04-20Merge "[DOC] First Release Note update"Krzysztof Opasiak1-20/+56
2020-04-20[DOC] update list of host to setSylvain Desbureaux1-0/+1
sdc.workflow.plugin.simpledemo.onap.org was missing in the list Issue-ID: OOM-1368 Signed-off-by: Sylvain Desbureaux <sylvain.desbureaux@orange.com> Change-Id: I40374b0302c9fe2729f86a212b185cc1f4351216
2020-04-20[DOC] Bump the version of rancher, k8s and helmSylvain Desbureaux3-11/+7
Update the versions on doc to the recommanded ones for Frankfurt. Issue-ID: OOM-2367 Signed-off-by: Sylvain Desbureaux <sylvain.desbureaux@orange.com> Change-Id: Ie3b3511f01df6f62f98dbb80d15fe0c76de4edf4
2020-04-16Add HTTPS ceritificate in CLI OOM chartsjitendra sharma1-0/+2
Issue-ID: CLI-265 Signed-off-by: Kanagaraj Manickam <kanagaraj.manickam@huawei.com> Change-Id: I4dc6cf5c9f7e8ec913491ea8580f414ab5ca199f
2020-04-16Merge "Update sparky-be server cert"Krzysztof Opasiak1-0/+2
2020-04-16[DOC] First Release Note updateSylvain Desbureaux1-20/+56
Issue-ID: OOM-2075 Signed-off-by: Sylvain Desbureaux <sylvain.desbureaux@orange.com> Change-Id: I634ade031aa95f9c79abad8f1f59015085ebc525
2020-04-15Merge "[DOC] Update documentation for Frankfurt"Krzysztof Opasiak1-9/+21
2020-04-15[DOC] Update documentation for FrankfurtSylvain Desbureaux1-9/+21
Initial documentation update with the following changes: * Remove last old release references * Explain the "masterPassword" mandatory parameter Issue-ID: OOM-2324 Issue-ID: OOM-1960 Signed-off-by: Sylvain Desbureaux <sylvain.desbureaux@orange.com> Change-Id: Ib3b1ba7c585c7e27793329ec5eb43d797e23da99
2020-04-15Update sparky-be server certJimmy Forsyth1-0/+2
Issue-ID: AAI-2869 Signed-off-by: Jimmy Forsyth <jf2512@att.com> Change-Id: I4a4b5f05ae149149137369cfb588b1c27e156281