summaryrefslogtreecommitdiffstats
path: root/docs/oom_quickstart_guide.rst
AgeCommit message (Collapse)AuthorFilesLines
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
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 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-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 Elliott1-1/+5
Documentation updates. Issue-ID: OOM-1590 Signed-off-by: Mike Elliott <mike.elliott@amdocs.com> Change-Id: I4c87d295b140b4be39317b03527470bdd88ab3e9
2019-07-13Update for Keystone v3Brian Freeman1-3/+45
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-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-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-06Add quickstart guide correctionsMike Elliott1-1/+2
Issue-ID: OOM-1896 Signed-off-by: Mike Elliott <mike.elliott@amdocs.com> Change-Id: If226a4da6f7ace4b348a51486e3002ee0a1a8476
2019-05-09Add doc guide fixesMike Elliott1-12/+20
Change-Id: Ibe57c857b4d9367b77878757821c2e9c44c61a7b Issue-ID: OOM-1598 Signed-off-by: Mike Elliott <mike.elliott@amdocs.com>
2019-05-08Add HA k8s documentationMike Elliott1-5/+5
Change-Id: I31a0013b73f942358267532f09d29a93ae83d874 Issue-ID: OOM-1598 Signed-off-by: Mike Elliott <mike.elliott@amdocs.com>
2019-04-17Update Quick Install DOCBrian Freeman1-16/+85
Issue-ID: OOM-1786 Change-Id: I657c1fca993b7837ddbf8277001b18669a4c3fc9 Signed-off-by: Brian Freeman <bf1936@att.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>
2018-11-28Update OOM docs for CasablancaMike Elliott1-118/+15
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-08-14Fix note on openStackEncryptedPasswordAbdelmuhaimen Seaudi1-2/+2
Issue-ID: OOM-1132 Change-Id: I0ae3122475e3aa087172c97a1078e7a1a471a13f Signed-off-by: Abdelmuhaimen Seaudi <abdelmuhaimen.seaudi@orange.com> (cherry picked from commit fa2caf23b9eac4f1239789f43137409d780d7868)
2018-07-26Add note on openStackEncryptedPasswordAbdelmuhaimen Seaudi1-0/+7
This is a note that will help remind how to generate Openstack Encrypted Password in the OOM Quickstart Guide. Issue-ID: OOM-1132 Change-Id: Ibbf341a1a0f8bb299bd09eaec3b48421c414a7f7 Signed-off-by: Abdelmuhaimen Seaudi <abdelmuhaimen.seaudi@orange.com> (cherry picked from commit cfb2b9cb03e97b3e7f5f4f859a260d8575611691)
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-03-29Fixed typo in quickstart guideRoger Maitland1-1/+1
Change-Id: I17508c3a28a2e4d006d5a8d05ce3ac777963224f Signed-off-by: Roger Maitland <Roger.Maitland@amdocs.com> Issue-ID: OOM-822
2018-03-27Reordered instructions, - files, + exampleRoger Maitland1-6/+6
Change-Id: Ifb06023bd1bdf2e58fe28bee167db45b563c9f95 Signed-off-by: Roger Maitland <Roger.Maitland@amdocs.com> Issue-ID: OOM-822
2018-03-26Update quick start guide with current limitationsRoger Maitland1-24/+27
Change-Id: I774ebaa966ac6a71833f79d0a9b2c39abe969bce Signed-off-by: Roger Maitland <Roger.Maitland@amdocs.com> Issue-ID: OOM-822
2018-03-22Adding Beijing DocumentationRoger Maitland1-0/+173
Change-Id: I5484d9c0f12abf3decad2275e661ae16c5545241 Signed-off-by: Roger Maitland <Roger.Maitland@amdocs.com> Issue-ID: OOM-822