summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorPawel Wieczorek <p.wieczorek2@samsung.com>2019-11-14 16:29:59 +0100
committerPawel Wieczorek <p.wieczorek2@samsung.com>2019-11-15 12:29:54 +0100
commitd7a30356e735749f77bf062a10626449b1d11b77 (patch)
tree5853dcdf4b6eb2864d5eb7f56ebe8a038e31e97f
parent3c7c6c7956eb3104abdb228b04bac116193923c7 (diff)
docs: Enclose all snippets in code blocks
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>
-rw-r--r--docs/oom_quickstart_guide.rst37
1 files changed, 17 insertions, 20 deletions
diff --git a/docs/oom_quickstart_guide.rst b/docs/oom_quickstart_guide.rst
index 6023565e0a..a04306ce46 100644
--- a/docs/oom_quickstart_guide.rst
+++ b/docs/oom_quickstart_guide.rst
@@ -69,11 +69,10 @@ The ROBOT encrypted Password uses the same encryption.key as SO but an
openssl algorithm that works with the python based Robot Framework.
.. note::
- To generate ROBOT openStackEncryptedPasswordHere :
+ To generate ROBOT openStackEncryptedPasswordHere::
- ``cd so/resources/config/mso/``
-
- ``/oom/kubernetes/so/resources/config/mso# echo -n "<openstack tenant password>" | openssl aes-128-ecb -e -K `cat encryption.key` -nosalt | xxd -c 256 -p``
+ cd so/resources/config/mso/
+ /oom/kubernetes/so/resources/config/mso# echo -n "<openstack tenant password>" | openssl aes-128-ecb -e -K `cat encryption.key` -nosalt | xxd -c 256 -p``
c. Generating SO Encrypted Password:
The SO Encrypted Password uses a java based encryption utility since the
@@ -81,23 +80,21 @@ Java encryption library is not easy to integrate with openssl/python that
ROBOT uses in Dublin.
.. note::
- To generate SO openStackEncryptedPasswordHere and openStackSoEncryptedPassword:
-
- SO_ENCRYPTION_KEY=`cat ~/oom/kubernetes/so/resources/config/mso/encryption.key`
-
- OS_PASSWORD=XXXX_OS_CLEARTESTPASSWORD_XXXX
-
- git clone http://gerrit.onap.org/r/integration
-
- cd integration/deployment/heat/onap-rke/scripts
+ To generate SO openStackEncryptedPasswordHere and openStackSoEncryptedPassword
+ ensure ``default-jdk`` is installed::
+ apt-get update; apt-get install default-jdk
- javac Crypto.java
+ Then execute::
- [ if javac is not installed 'apt-get update ; apt-get install default-jdk' ]
+ SO_ENCRYPTION_KEY=`cat ~/oom/kubernetes/so/resources/config/mso/encryption.key`
+ OS_PASSWORD=XXXX_OS_CLEARTESTPASSWORD_XXXX
- java Crypto "$OS_PASSWORD" "$SO_ENCRYPTION_KEY"
+ git clone http://gerrit.onap.org/r/integration
+ cd integration/deployment/heat/onap-rke/scripts
+ javac Crypto.java
+ java Crypto "$OS_PASSWORD" "$SO_ENCRYPTION_KEY"
d. Update the OpenStack parameters:
@@ -207,12 +204,12 @@ Use the following to monitor your deployment and determine when ONAP is ready fo
.. note::
While all pods may be in a Running state, it is not a guarantee that all components are running fine.
- Launch the healthcheck tests using Robot to verify that the components are healthy.
+ Launch the healthcheck tests using Robot to verify that the components are healthy::
- > ~/oom/kubernetes/robot/ete-k8s.sh onap health
+ > ~/oom/kubernetes/robot/ete-k8s.sh onap health
-**Step 10.** Undeploy ONAP
+**Step 10.** Undeploy ONAP::
-> helm undeploy dev --purge
+ > helm undeploy dev --purge
More examples of using the deploy and undeploy plugins can be found here: https://wiki.onap.org/display/DW/OOM+Helm+%28un%29Deploy+plugins