aboutsummaryrefslogtreecommitdiffstats
path: root/docs
AgeCommit message (Collapse)AuthorFilesLines
2019-11-15docs: Mark filenames and inline codePawel Wieczorek1-20/+20
To improve readability and avoid confusion, this patch makes: * all path names and package names - italics, * all snippets as well as command names and arguments - fixed length. Issue-ID: OOM-2207 Change-Id: Ib8075c25cb0479e56e3f7634639eb4d7556b36c7 Signed-off-by: Pawel Wieczorek <p.wieczorek2@samsung.com>
2019-11-15docs: Use definition list syntax to clarify termsPawel Wieczorek1-21/+15
Definition list syntax quick reference: http://docutils.sourceforge.net/docs/user/rst/quickref.html#definition-lists Issue-ID: OOM-2208 Change-Id: Iaab4b3befd92288813a70d4e1bac8c4c7bb6e4c6 Signed-off-by: Pawel Wieczorek <p.wieczorek2@samsung.com>
2019-11-15docs: Enclose all snippets in code blocksPawel Wieczorek1-20/+17
This patch improves documentation readability by making all runnable code snippets stand out. Issue-ID: OOM-2207 Change-Id: I0ffd7892a6c3af4d91f5bdd9adb49c1e01a9c475 Signed-off-by: Pawel Wieczorek <p.wieczorek2@samsung.com>
2019-11-15docs: Ensure literalinclude directive renderingPawel Wieczorek1-0/+2
Literalinclude directive is not rendered as such unless separated from the surrounding paragraphs by blank lines (like all paragraphs) [1]. [1] http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#literal-blocks Issue-ID: OOM-1612 Change-Id: I51e7f8f2f99dfe157b24fe7c5ae4d62281d72e86 Signed-off-by: Pawel Wieczorek <p.wieczorek2@samsung.com>
2019-11-15docs: Replace include directives for non existent filePawel Wieczorek2-2/+2
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-10-17Add OOM-2132 to release notesMike Elliott1-0/+1
Issue-ID: OOM-2102 Signed-off-by: Mike Elliott <mike.elliott@amdocs.com> Change-Id: Ic973542b48e721808284d1a9bd705c06c24bc29c
2019-10-11Add Known Issues to release notesMike Elliott1-0/+12
El Alto High defects that are pushed to Frankfurt. Issue-ID: OOM-2103 Signed-off-by: Mike Elliott <mike.elliott@amdocs.com> Change-Id: I2570d1e299072e1ac96dbc3fcbe19181cd568bd0 (cherry picked from commit f40ce5c9f5db76331d7aa895615c06a636d1940e)
2019-10-10Removed space from slave_nfs_node.shMike Elliott1-1/+1
Issue-ID: OOM-1577 Signed-off-by: Mike Elliott <mike.elliott@amdocs.com> Change-Id: I8314d029ac9acc3a35488a57a8eecd3d53aa3845
2019-10-06Merge "Add El Alto release notes"Borislav Glozman1-0/+40
2019-10-04Add El Alto release notesMike Elliott1-0/+40
Issue-ID: OOM-2103 Signed-off-by: Mike Elliott <mike.elliott@amdocs.com> Change-Id: I9a378602c8d73df4df2fef4fcf52b88fa5000eb6
2019-10-03Updated docs to ref 5.0.1-ONAP tagMike Elliott1-2/+2
Issue-ID: OOM-1590 Signed-off-by: Mike Elliott <mike.elliott@amdocs.com> Change-Id: I61b3531545b5a648fcfabb850ee85fa5f0a4a46a
2019-10-02Updated software versions for El AltoMike Elliott4-61/+66
Documentation updates. Issue-ID: OOM-1590 Signed-off-by: Mike Elliott <mike.elliott@amdocs.com> Change-Id: I4c87d295b140b4be39317b03527470bdd88ab3e9
2019-08-16Update release notes for El Alto Early DropPrudence Au1-0/+13
Issue-ID: OOM-2023 Signed-off-by: Prudence Au <prudence.au@amdocs.com> Change-Id: I5cab68dee9f4f07bcc009e7230c4ad0c41827b53
2019-07-14Merge "docs: Use auto-enumerated list"Borislav Glozman1-7/+7
2019-07-14Merge "docs: Ensure literal block rendering"Borislav Glozman1-7/+13
2019-07-13Update for Keystone v3Brian Freeman2-3/+109
Updates for new variables to init cloud in SO Issue-ID: OOM-1982 Change-Id: Icf4f6bafb1884bc3758fabe4072733526c79cc42 Signed-off-by: Brian Freeman <bf1936@att.com>
2019-07-10docs: Use auto-enumerated listPawel Wieczorek1-7/+7
Reference: http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#enumerated-lists Issue-ID: OOM-1978 Change-Id: Id81a00c24a271d4e05546a29bf93b93c7aded954 Signed-off-by: Pawel Wieczorek <p.wieczorek2@samsung.com>
2019-07-10docs: Ensure literal block renderingPawel Wieczorek1-7/+13
Literal block is not rendered as such unless prefixed with two colons ("::") [1]. Sphinx "code-block" directive takes a language name as an argument [2] and fails if none is supplied. [1] http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#literal-blocks [2] https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-code-block Issue-ID: OOM-1612 Change-Id: Ibf5ddf9b50753206b5bcec0df83c8a19346e6ad9 Signed-off-by: Pawel Wieczorek <p.wieczorek2@samsung.com>
2019-07-09Update quickstart guideMike Elliott1-7/+25
It has been determined that, in certain environments, readiness and liveness probe values need to be increased. This improves reliability on the initial deployment of ONAP. Addressed documentation feedback. Issue-ID: OOM-1959 Signed-off-by: Mike Elliott <mike.elliott@amdocs.com> Change-Id: I8cfb30b52e4bdbd6bab7756ec247c9574efcb503
2019-07-04Merge "Document OJSI-202 (CVE-2019-12127) vulnerability"Sylvain Desbureaux1-0/+1
2019-07-02Update quickstart guideMike Elliott1-11/+3
It has been determined that, in certain environments, readiness and liveness probe values need to be increased. This improves reliability on the initial deployment of ONAP. Issue-ID: OOM-1959 Signed-off-by: Mike Elliott <mike.elliott@amdocs.com> Change-Id: I0d910608d6d72d58b9a981bfb30267c6b2233b46
2019-06-26Removed duplicate OOM doc linksMike Elliott1-7/+7
Issue-ID: OOM-1939 Signed-off-by: Mike Elliott <mike.elliott@amdocs.com> Change-Id: I66406dc202155879106d22f63c0fefae7e8e52fe
2019-06-12Merge "Document OJSI-188 vulnerability"Borislav Glozman1-0/+1
2019-06-12Merge "Document OJSI-134 vulnerability"Borislav Glozman1-0/+2
2019-06-12Merge "Improve security release notes"Borislav Glozman1-0/+6
2019-06-06Add quickstart guide correctionsMike Elliott1-1/+2
Issue-ID: OOM-1896 Signed-off-by: Mike Elliott <mike.elliott@amdocs.com> Change-Id: If226a4da6f7ace4b348a51486e3002ee0a1a8476
2019-06-05Document OJSI-202 (CVE-2019-12127) vulnerabilityKrzysztof Opasiak1-0/+1
Issue-ID: OJSI-202 Signed-off-by: Krzysztof Opasiak <k.opasiak@samsung.com> Change-Id: I46d31d23309f8f34cb1a21d025aac0ff9a5b709a
2019-06-05Document OJSI-188 vulnerabilityKrzysztof Opasiak1-0/+1
Issue-ID: OJSI-188 Signed-off-by: Krzysztof Opasiak <k.opasiak@samsung.com> Change-Id: I6d088a55e85f77b4e4b783b0981193b1844a6150
2019-06-05Document OJSI-134 vulnerabilityKrzysztof Opasiak1-0/+2
Issue-ID: OJSI-134 Signed-off-by: Krzysztof Opasiak <k.opasiak@samsung.com> Change-Id: Ic48733b90bc80836fadb78c085b378180c5cb1c3
2019-06-05Improve security release notesKrzysztof Opasiak1-0/+6
In order to provide users with more details of project's state in terms of security let's divide the security release notes into three sections: - Fixed Security Issues Contains a list of security fixes merged during this release (especially those reported via OJSI tickets). - Known Security Issues Contains a list of vulnerabilities detected in project during release which have not been fixed yet and thus should be mitigated by the user. - Known Vulnerabilities in Used Modules Contains information about NexusIQ scan results Issue-ID: SECCOM-238 Signed-off-by: Krzysztof Opasiak <k.opasiak@samsung.com> Change-Id: I029a60199831c5a899a2a72e32f61ffbeb756ea8
2019-06-05Add dublin release notesMike Elliott1-0/+53
Issue-ID: OOM-1916 Signed-off-by: Mike Elliott <mike.elliott@amdocs.com> Change-Id: I42b8bbeed23fd2cf54bb61b0363dbc868b6eee37
2019-05-09Add doc guide fixesMike Elliott4-75/+115
Change-Id: Ibe57c857b4d9367b77878757821c2e9c44c61a7b Issue-ID: OOM-1598 Signed-off-by: Mike Elliott <mike.elliott@amdocs.com>
2019-05-08Add HA k8s documentationMike Elliott40-416/+537
Change-Id: I31a0013b73f942358267532f09d29a93ae83d874 Issue-ID: OOM-1598 Signed-off-by: Mike Elliott <mike.elliott@amdocs.com>
2019-05-07Add table format fixMike Elliott1-8/+8
Change-Id: Iffb67cb32d6038a001227028d786b1e91ba3ccfe Issue-ID: OOM-1598 Signed-off-by: Mike Elliott <mike.elliott@amdocs.com>
2019-04-29Documented Dublin docker,helm,k8s versionsMike Elliott1-0/+1
Change-Id: I1d8a42caf331edf56a640694331c57d1e3cfb6b2 Issue-ID: OOM-1608 Signed-off-by: Mike Elliott <mike.elliott@amdocs.com>
2019-04-17Update Quick Install DOCBrian Freeman3-16/+152
Issue-ID: OOM-1786 Change-Id: I657c1fca993b7837ddbf8277001b18669a4c3fc9 Signed-off-by: Brian Freeman <bf1936@att.com>
2019-02-11Merge "docs: Ensure literal block rendering"Borislav Glozman1-1/+3
2019-02-11Merge "correct doclint D001 error"Borislav Glozman1-19/+23
2019-02-04Merge "correct doclint D001 error"Alexis de Talhouët1-9/+13
2019-02-04correct doclint issuesSylvain Desbureaux1-27/+57
on too long lines Change-Id: Ie9981b2951f3cf914f9cd58be7e15cfcc8d4f0bc Issue-ID: DOC-389 Signed-off-by: Sylvain Desbureaux <sylvain.desbureaux@orange.com>
2019-01-31correct doclint D001 errorSylvain Desbureaux1-9/+13
D001 is line too long. Change-Id: I851aa361e06a743629153422d42d37b4c5d4bda7 Issue-ID: DOC-389 Signed-off-by: Sylvain Desbureaux <sylvain.desbureaux@orange.com>
2019-01-28correct doclint D001 errorSylvain Desbureaux1-19/+23
D001 is line too long. Change-Id: I782767aad81e1f1f8da9e1fd4af62178813869da Issue-ID: DOC-389 Signed-off-by: Sylvain Desbureaux <sylvain.desbureaux@orange.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: Ensure literal block renderingPawel Wieczorek1-1/+3
Literal block is not rendered as such unless separated from the surrounding paragraphs by blank lines [1]. [1] http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#literal-blocks Issue-ID: DOC-382 Change-Id: I54811c93bf126005d0eeb954102e010ad0055c48 Signed-off-by: Pawel Wieczorek <p.wieczorek2@samsung.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>
2019-01-14docs: Remove vim editor marksKrzysztof Opasiak1-4/+0
Presenting VIM bottom line and ~ as a file content may be misleading so let's remove them and leave just real content. Issue-ID: DOC-379 Change-Id: I7186c275259d1ef35319ed4ef3876eac261ab577 Signed-off-by: Krzysztof Opasiak <k.opasiak@samsung.com>
2019-01-14docs: Update kubectl versionKrzysztof Opasiak2-2/+2
Update default value of KUBECTL_VERSION to match requirements of current release. Issue-ID: DOC-378 Change-Id: I35eb3675fe8e5aba340331512fe378e342a75182 Signed-off-by: Krzysztof Opasiak <k.opasiak@samsung.com>
2019-01-10adjust rtd doc for deploy clustersMichael O'Brien1-10/+12
Change-Id: If5447aacc00f1631c3805d4aef7d5b5ab915d105 Issue-ID: OOM-1530 Signed-off-by: Michael O'Brien <michael@obrienlabs.org>
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-29Update format of release summaryMike Elliott1-9/+9
Change-Id: Ic0f0d402aee990ebe65d11c1b64e3beb7e1f9257 Issue-ID: OOM-1498 Signed-off-by: Mike Elliott <mike.elliott@amdocs.com>