summaryrefslogtreecommitdiffstats
path: root/docs/oom_user_guide.rst
AgeCommit message (Collapse)AuthorFilesLines
2021-05-10[PLATFORM] Remove certificate generation deploymentPiotr Marcinkiewicz1-2/+7
- 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-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 Desbureaux1-31/+26
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
2020-12-09[COMMON] Add doc lintingSylvain Desbureaux1-2/+3
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-07[DOC] Remove warnings from documentation buildEric Debeau1-3/+3
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-11-30[COMMON][DOC] Bump version GuilinSylvain Desbureaux1-6/+6
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-10-16Update makefiles to use specific helm versionJakub Latusek1-1/+5
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-08-19[DOC] Correct RST filesEric Debeau1-10/+12
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-06-15Merge "[DOC] Update release note"Sylvain Desbureaux1-1/+1
2020-06-15[DOC] Update release noteSylvain Desbureaux1-1/+1
Create release note for Frankfurt Issue-ID: OOM-2382 Signed-off-by: Sylvain Desbureaux <sylvain.desbureaux@orange.com> Change-Id: Ia78f6eee0dd07b0ebba84c8c714c6a95e4d99a34
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-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-09Automation adds oom_project_description.rstJessica Wagantall1-0/+1
Add additional labels to create consistency across all docs. Issue-ID: CIMAN-376 Signed-off-by: Jessica Wagantall <jwagantall@linuxfoundation.org> Change-Id: I6d3dd67adb6669fb897e4978cb88e3b7404d2897
2020-03-02[DOC] Remove references to old versionsSylvain Desbureaux1-8/+8
Also add requirements for Frankfurt release Issue-ID: OOM-1960 Signed-off-by: Sylvain Desbureaux <sylvain.desbureaux@orange.com> Change-Id: Idaa4925515737221c90c4bf9141406fa1d428f15
2019-11-15docs: Replace include directives for non existent filePawel Wieczorek1-1/+1
This patch resolves issue with including non existent file in OOM documentation. Included file has been removed in [1] and seems to be replaced by "kubernetes/onap/values.yaml" from [2] (91% similarity [3]). [1] ed5ff714fac29651318868a65267030e3c31c3ee (Change-Id: Ia51db5f1489e8d63fd7e1f10e80174eb9f182f0f) [2] ac281bd0798ae7308402f4d19d537546d101afba (Change-Id: I4b74a3a8a35a178298af7205762e2aca7c65dda3) [3] Similarity measured with: $ git checkout ed5ff714^ $ wdiff --no-deleted --no-inserted --no-common --statistics \ kubernetes/onap/values.yaml docs/onap_values.yaml Issue-ID: OOM-2203 Change-Id: I9634797c75f4da4652194f72190b21e30c4feb21 Signed-off-by: Pawel Wieczorek <p.wieczorek2@samsung.com>
2019-01-28correct doclint D001 errorSylvain Desbureaux1-14/+24
D001 is line too long. Change-Id: I002dd3132c7ba1109f8853f823201d96b7a3cf1b Issue-ID: DOC-389 Signed-off-by: Sylvain Desbureaux <sylvain.desbureaux@orange.com>
2019-01-23docs: Replace Helm "install" using "deploy" pluginPawel Wieczorek1-4/+8
With Casablanca release "deploy" Helm plugin has become preferred way of ONAP installation (even though it is a temporary solution). This patch replaces all but one occurences of "helm install" command - the remaining one is the placeholder for installation from osn repo. It also imports plugin installation step from Quick Start Guide. Issue-ID: DOC-381 Change-Id: I5ec6379b7a55eb2fd9230c17e3973980a03e77c9 Signed-off-by: Pawel Wieczorek <p.wieczorek2@samsung.com>
2018-11-30Add missing notes to etc/hostsandreasgeissler1-2/+17
Added missing entries in the /etc/hosts to use the portal and hints to use the HTTPS URL Issue-ID: OOM-1368 Change-Id: I48b1c88cec7b91bf37cb696b11c6de29e4c7458d Signed-off-by: andreasgeissler <andreas-geissler@telekom.de>
2018-11-28Update OOM docs for CasablancaMike Elliott1-8/+8
Updating release notes, Helm and K8s versions and started documenting use of (un)deploy plugins. Change-Id: Ia51db5f1489e8d63fd7e1f10e80174eb9f182f0f Issue-ID: OOM-1497 Signed-off-by: Mike Elliott <mike.elliott@amdocs.com>
2018-11-08fix typosStanislav Chlebec1-2/+2
Change-Id: Ibddae18efbaa4dc92b97a4d48a4f9b6f305f87af Signed-off-by: Stanislav Chlebec <stanislav.chlebec@pantheon.tech> Issue-ID: AAF-582
2018-08-29Merge "Add note for Portal GUI access"Mandeep Khinda1-9/+21
2018-08-20helm 2.9.1 from 2.8.2Michael O'Brien1-2/+2
Change-Id: I5e2920607d6fd4e0cc4b9afaef48ca64362fc41d Issue-ID: OOM-1299 Signed-off-by: Michael O'Brien <frank.obrien@amdocs.com>
2018-08-14Add note for Portal GUI accessHector Anapan-Lavalle1-9/+21
Change-Id: Ic1e655755b3fb77acca818042dffe6dc3311d5b3 Issue-ID: OOM-1302 Signed-off-by: Hector Anapan-Lavalle <ha076r@att.com>
2018-06-07Update documentation to clone from beijing branchRoger Maitland1-1/+1
Change-Id: I93a5f7628ba030a2250e6f0c62458dbd5398cbe9 Signed-off-by: Roger Maitland <Roger.Maitland@amdocs.com> Issue-ID: OOM-1129
2018-06-04Revise Helm package version from 2.7.2 to 2.8.2Cong Phuoc Hoang1-2/+2
When tiller version is 2.8.2, helm should be updated. Change-Id: Iaad073bab95b3773b80b57ae5bf740c1bac9bf27 Signed-off-by: Phuoc Hoang <hoangphuocbk2.07@gmail.com> Issue-ID: OOM-1119
2018-05-18Fix typo in ReadTheDocsGildas Lanilis1-3/+3
Change-Id: I3c48b6d539d35aa5898ed9bab32ed932426b3714 Issue-ID: OOM-1100 Signed-off-by: Gildas Lanilis <gildas.lanilis@huawei.com>
2018-05-15Add Portal access instructions to OOM User GuideRoger Maitland1-1/+55
Change-Id: I1ec1dc410d28913884ece53a31e41243515ec407 Signed-off-by: Roger Maitland <Roger.Maitland@amdocs.com> Issue-ID: OOM-1063
2018-04-18upgrade kubernetes client to 1.8.10Michael O'Brien1-1/+1
Change-Id: Icb0af6cf3bea98119229571ebf6205d7beed440a Signed-off-by: Michael O'Brien <frank.obrien@amdocs.com> Issue-ID: OOM-962
2018-04-10User Guide: Changed Helm from 2.6.1 -> 2.7.2Roger Maitland1-2/+2
Change-Id: I1bb285ce7bb5f5b13264f689b19446bdafb0ef48 Signed-off-by: Roger Maitland <Roger.Maitland@amdocs.com> Issue-ID: OOM-822
2018-04-09Fix User Guide: '-name' -> '--name'Roger Maitland1-3/+3
Change-Id: Iba1597938fbaa9a9252b8bcec49b000118ce472f Signed-off-by: Roger Maitland <Roger.Maitland@amdocs.com> Issue-ID: OOM-822
2018-04-05Added kubectl and helm install to user guideRoger Maitland1-2/+45
Change-Id: I44edef3b6225c94717fa804ffec7644e95be12c4 Signed-off-by: Roger Maitland <Roger.Maitland@amdocs.com> Issue-ID: OOM-822
2018-03-27Reordered instructions, - files, + exampleRoger Maitland1-4/+4
Change-Id: Ifb06023bd1bdf2e58fe28bee167db45b563c9f95 Signed-off-by: Roger Maitland <Roger.Maitland@amdocs.com> Issue-ID: OOM-822
2018-03-22Adding Beijing DocumentationRoger Maitland1-0/+581
Change-Id: I5484d9c0f12abf3decad2275e661ae16c5545241 Signed-off-by: Roger Maitland <Roger.Maitland@amdocs.com> Issue-ID: OOM-822