docs/oom_quickstart_guide.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3 .. Copyright 2018 Amdocs, Bell Canada
   4
   5 .. _quick-start-label:
   6
   7 OOM Quick Start Guide
   8 #####################
   9
  10 .. figure:: oomLogoV2-medium.png
  11    :align: right
  12
  13 Once a kubernetes environment is available (follow the instructions in
  14 :ref:`cloud-setup-guide-label` if you don't have a cloud environment
  15 available), follow the following instructions to deploy ONAP.
  16
  17 **Step 1.** Clone the OOM repository from ONAP gerrit::
  18
  19   > git clone -b casablanca http://gerrit.onap.org/r/oom
  20   > cd oom/kubernetes
  21
  22 **Step 2.** Install Helm Plugins required to deploy the ONAP Casablanca release::
  23
  24   > sudo cp -R ~/oom/kubernetes/helm/plugins/ ~/.helm
  25
  26 **Step 3.** Customize the onap/values.yaml file to suit your deployment. You
  27 may want to selectively enable or disable ONAP components by changing the
  28 `enabled: true/false` flags as shown below:
  29
  30 .. literalinclude:: onap-values.yaml
  31    :language: yaml
  32
  33 .. note::
  34   To generate openStackEncryptedPasswordHere :
  35
  36   ``root@olc-rancher:~# cd so/resources/config/mso/``
  37
  38   ``root@olc-rancher:~/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``
  39
  40 **Step 3.** To setup a local Helm server to server up the ONAP charts::
  41
  42   > helm serve &
  43
  44 Note the port number that is listed and use it in the Helm repo add as
  45 follows::
  46
  47   > helm repo add local http://127.0.0.1:8879
  48
  49 **Step 4.** Verify your Helm repository setup with::
  50
  51   > helm repo list
  52   NAME   URL
  53   local  http://127.0.0.1:8879
  54
  55 **Step 5.** Build a local Helm repository (from the kubernetes directory)::
  56
  57   > make all; make onap
  58
  59 **Step 6.** Display the charts that available to be deployed::
  60
  61   > helm search -l
  62 .. literalinclude:: helm-search.txt
  63
  64 .. note::
  65   The setup of the Helm repository is a one time activity. If you make changes to your deployment charts or values be sure to use `make` to update your local Helm repository.
  66
  67 **Step 7.** Once the repo is setup, installation of ONAP can be done with a
  68 single command::
  69
  70   > helm deploy dev local/onap --namespace onap
  71
  72
  73 Use the following to monitor your deployment and determine when ONAP is ready for use::
  74
  75   > kubectl get pods --all-namespaces -o=wide
  76
  77 Undeploying onap can be done using the following command::
  78
  79   > helm undeploy dev --purge
  80
  81
  82 More examples of using the deploy and undeploy plugins can be found here: https://wiki.onap.org/display/DW/OOM+Helm+%28un%29Deploy+plugins