Brian Freeman | cce79bd | 2019-04-17 10:34:32 -0500 | [diff] [blame] | 1 | .. This work is licensed under a |
| 2 | .. Creative Commons Attribution 4.0 International License. |
Roger Maitland | 953b5f1 | 2018-03-22 15:24:04 -0400 | [diff] [blame] | 3 | .. http://creativecommons.org/licenses/by/4.0 |
Mike Elliott | f137b2c | 2019-04-30 16:28:07 -0400 | [diff] [blame] | 4 | .. Copyright 2019 Amdocs, Bell Canada |
Roger Maitland | 953b5f1 | 2018-03-22 15:24:04 -0400 | [diff] [blame] | 5 | |
| 6 | .. _quick-start-label: |
| 7 | |
| 8 | OOM Quick Start Guide |
| 9 | ##################### |
| 10 | |
| 11 | .. figure:: oomLogoV2-medium.png |
| 12 | :align: right |
| 13 | |
| 14 | Once a kubernetes environment is available (follow the instructions in |
| 15 | :ref:`cloud-setup-guide-label` if you don't have a cloud environment |
| 16 | available), follow the following instructions to deploy ONAP. |
| 17 | |
| 18 | **Step 1.** Clone the OOM repository from ONAP gerrit:: |
| 19 | |
Mike Elliott | f137b2c | 2019-04-30 16:28:07 -0400 | [diff] [blame] | 20 | > git clone -b 4.0.0-ONAP http://gerrit.onap.org/r/oom --recurse-submodules |
Roger Maitland | d1237f3 | 2018-03-26 13:14:04 -0400 | [diff] [blame] | 21 | > cd oom/kubernetes |
Roger Maitland | 953b5f1 | 2018-03-22 15:24:04 -0400 | [diff] [blame] | 22 | |
Mike Elliott | f137b2c | 2019-04-30 16:28:07 -0400 | [diff] [blame] | 23 | **Step 2.** Install Helm Plugins required to deploy ONAP:: |
Pawel Wieczorek | aa859cd | 2019-01-23 17:32:18 +0100 | [diff] [blame] | 24 | |
| 25 | > sudo cp -R ~/oom/kubernetes/helm/plugins/ ~/.helm |
Roger Maitland | 953b5f1 | 2018-03-22 15:24:04 -0400 | [diff] [blame] | 26 | |
Brian Freeman | cce79bd | 2019-04-17 10:34:32 -0500 | [diff] [blame] | 27 | |
Mike Elliott | 474c350 | 2019-05-09 10:56:16 -0400 | [diff] [blame^] | 28 | **Step 3.** Customize the helm charts like oom/kubernetes/onap/values.yaml or an override |
| 29 | file like onap-all.yaml, onap-vfw.yaml or openstack.yaml file to suit your deployment with items like the |
Brian Freeman | cce79bd | 2019-04-17 10:34:32 -0500 | [diff] [blame] | 30 | OpenStack tenant information. |
| 31 | |
Mike Elliott | 474c350 | 2019-05-09 10:56:16 -0400 | [diff] [blame^] | 32 | .. note:: |
| 33 | Standard and example override files (e.g. onap-all.yaml, openstack.yaml) can be found in |
| 34 | the oom/kubernetes/onap/resources/overrides/ directory. |
| 35 | |
Brian Freeman | cce79bd | 2019-04-17 10:34:32 -0500 | [diff] [blame] | 36 | |
| 37 | a. You may want to selectively enable or disable ONAP components by changing |
| 38 | the `enabled: true/false` flags. |
| 39 | |
| 40 | |
| 41 | b. Encyrpt the OpenStack password using the shell tool for robot and put it in |
Mike Elliott | 474c350 | 2019-05-09 10:56:16 -0400 | [diff] [blame^] | 42 | the robot helm charts or robot section of openstack.yaml |
Brian Freeman | cce79bd | 2019-04-17 10:34:32 -0500 | [diff] [blame] | 43 | |
| 44 | |
| 45 | c. Encrypt the OpenStack password using the java based script for SO helm charts |
Mike Elliott | 474c350 | 2019-05-09 10:56:16 -0400 | [diff] [blame^] | 46 | or SO section of openstack.yaml. |
Brian Freeman | cce79bd | 2019-04-17 10:34:32 -0500 | [diff] [blame] | 47 | |
| 48 | |
| 49 | d. Update the OpenStack parameters that will be used by robot, SO and APPC helm |
| 50 | charts or use an override file to replace them. |
| 51 | |
| 52 | |
| 53 | |
| 54 | |
| 55 | a. Enabling/Disabling Components: |
Mike Elliott | f137b2c | 2019-04-30 16:28:07 -0400 | [diff] [blame] | 56 | Here is an example of the nominal entries that need to be provided. |
| 57 | We have different values file available for different contexts. |
Roger Maitland | 953b5f1 | 2018-03-22 15:24:04 -0400 | [diff] [blame] | 58 | |
Mike Elliott | ed5ff71 | 2018-11-07 15:47:19 -0500 | [diff] [blame] | 59 | .. literalinclude:: onap-values.yaml |
| 60 | :language: yaml |
Roger Maitland | 953b5f1 | 2018-03-22 15:24:04 -0400 | [diff] [blame] | 61 | |
Brian Freeman | cce79bd | 2019-04-17 10:34:32 -0500 | [diff] [blame] | 62 | |
| 63 | b. Generating ROBOT Encrypted Password: |
| 64 | The ROBOT encrypted Password uses the same encryption.key as SO but an |
| 65 | openssl algorithm that works with the python based Robot Framework. |
| 66 | |
Abdelmuhaimen Seaudi | d7133a1 | 2018-07-18 10:59:20 +0000 | [diff] [blame] | 67 | .. note:: |
Brian Freeman | cce79bd | 2019-04-17 10:34:32 -0500 | [diff] [blame] | 68 | To generate ROBOT openStackEncryptedPasswordHere : |
Abdelmuhaimen Seaudi | d7133a1 | 2018-07-18 10:59:20 +0000 | [diff] [blame] | 69 | |
Mike Elliott | 474c350 | 2019-05-09 10:56:16 -0400 | [diff] [blame^] | 70 | ``cd so/resources/config/mso/`` |
Abdelmuhaimen Seaudi | d7133a1 | 2018-07-18 10:59:20 +0000 | [diff] [blame] | 71 | |
Mike Elliott | 474c350 | 2019-05-09 10:56:16 -0400 | [diff] [blame^] | 72 | ``/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`` |
Abdelmuhaimen Seaudi | d7133a1 | 2018-07-18 10:59:20 +0000 | [diff] [blame] | 73 | |
Brian Freeman | cce79bd | 2019-04-17 10:34:32 -0500 | [diff] [blame] | 74 | c. Generating SO Encrypted Password: |
| 75 | The SO Encrypted Password uses a java based encryption utility since the |
| 76 | Java encryption library is not easy to integrate with openssl/python that |
| 77 | ROBOT uses in Dublin. |
| 78 | |
| 79 | .. note:: |
| 80 | To generate SO openStackEncryptedPasswordHere : |
| 81 | |
| 82 | SO_ENCRYPTION_KEY=`cat ~/oom/kubenertes/so/resources/config/mso/encrypt.key` |
| 83 | OS_PASSWORD=XXXX_OS_CLEARTESTPASSWORD_XXXX |
| 84 | |
| 85 | git clone http://gerrit.onap.org/r/integration |
| 86 | cd integration/deployment/heat/onap-oom/scripts |
| 87 | javac Crypto.java |
| 88 | java Crypto "$OS_PASSWORD" "$SO_ENCRYPTION_KEY" |
| 89 | |
| 90 | |
| 91 | d. Update the OpenStack parameters: |
| 92 | |
| 93 | .. literalinclude:: example-integration-override.yaml |
| 94 | :language: yaml |
| 95 | |
| 96 | **Step 4.** To setup a local Helm server to server up the ONAP charts:: |
Roger Maitland | 953b5f1 | 2018-03-22 15:24:04 -0400 | [diff] [blame] | 97 | |
| 98 | > helm serve & |
| 99 | |
| 100 | Note the port number that is listed and use it in the Helm repo add as |
| 101 | follows:: |
| 102 | |
| 103 | > helm repo add local http://127.0.0.1:8879 |
| 104 | |
Brian Freeman | cce79bd | 2019-04-17 10:34:32 -0500 | [diff] [blame] | 105 | **Step 5.** Verify your Helm repository setup with:: |
Roger Maitland | 953b5f1 | 2018-03-22 15:24:04 -0400 | [diff] [blame] | 106 | |
| 107 | > helm repo list |
| 108 | NAME URL |
| 109 | local http://127.0.0.1:8879 |
| 110 | |
Brian Freeman | cce79bd | 2019-04-17 10:34:32 -0500 | [diff] [blame] | 111 | **Step 6.** Build a local Helm repository (from the kubernetes directory):: |
Roger Maitland | 9e5067c | 2018-03-27 10:57:08 -0400 | [diff] [blame] | 112 | |
Mike Elliott | ed5ff71 | 2018-11-07 15:47:19 -0500 | [diff] [blame] | 113 | > make all; make onap |
Roger Maitland | 9e5067c | 2018-03-27 10:57:08 -0400 | [diff] [blame] | 114 | |
Brian Freeman | cce79bd | 2019-04-17 10:34:32 -0500 | [diff] [blame] | 115 | **Step 7.** Display the onap charts that available to be deployed:: |
Roger Maitland | 953b5f1 | 2018-03-22 15:24:04 -0400 | [diff] [blame] | 116 | |
Brian Freeman | cce79bd | 2019-04-17 10:34:32 -0500 | [diff] [blame] | 117 | > helm search onap -l |
| 118 | |
Mike Elliott | ed5ff71 | 2018-11-07 15:47:19 -0500 | [diff] [blame] | 119 | .. literalinclude:: helm-search.txt |
Roger Maitland | 953b5f1 | 2018-03-22 15:24:04 -0400 | [diff] [blame] | 120 | |
| 121 | .. note:: |
Roger Maitland | d1237f3 | 2018-03-26 13:14:04 -0400 | [diff] [blame] | 122 | 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. |
Roger Maitland | 953b5f1 | 2018-03-22 15:24:04 -0400 | [diff] [blame] | 123 | |
Brian Freeman | cce79bd | 2019-04-17 10:34:32 -0500 | [diff] [blame] | 124 | **Step 8.** Once the repo is setup, installation of ONAP can be done with a |
| 125 | single command |
Roger Maitland | 953b5f1 | 2018-03-22 15:24:04 -0400 | [diff] [blame] | 126 | |
Mike Elliott | 474c350 | 2019-05-09 10:56:16 -0400 | [diff] [blame^] | 127 | .. note:: |
| 128 | The --timeout 900 is currently required in Dublin to address long running initialization tasks |
| 129 | for DMaaP and SO. Without this timeout value both applications may fail to deploy. |
Brian Freeman | cce79bd | 2019-04-17 10:34:32 -0500 | [diff] [blame] | 130 | |
Mike Elliott | 474c350 | 2019-05-09 10:56:16 -0400 | [diff] [blame^] | 131 | a. To deploy all ONAP applications use this command:: |
Roger Maitland | d1237f3 | 2018-03-26 13:14:04 -0400 | [diff] [blame] | 132 | |
Mike Elliott | 474c350 | 2019-05-09 10:56:16 -0400 | [diff] [blame^] | 133 | > cd oom/kubernetes |
| 134 | > helm deploy dev local/onap --namespace onap -f onap/resources/overrides/onap-all.yaml -f onap/resources/overrides/openstack.yaml --timeout 900 |
Roger Maitland | 953b5f1 | 2018-03-22 15:24:04 -0400 | [diff] [blame] | 135 | |
Mike Elliott | 474c350 | 2019-05-09 10:56:16 -0400 | [diff] [blame^] | 136 | b. If you are using a custom override (e.g. integration-override.yaml) use this command:: |
Brian Freeman | cce79bd | 2019-04-17 10:34:32 -0500 | [diff] [blame] | 137 | |
Mike Elliott | 474c350 | 2019-05-09 10:56:16 -0400 | [diff] [blame^] | 138 | > helm deploy dev local/onap -f /root/integration-override.yaml --namespace onap --timeout 900 |
Brian Freeman | cce79bd | 2019-04-17 10:34:32 -0500 | [diff] [blame] | 139 | |
| 140 | |
| 141 | c. If you have a slower cloud environment you may want to use the public-cloud.yaml |
| 142 | which has longer delay intervals on database updates.:: |
| 143 | |
Mike Elliott | 474c350 | 2019-05-09 10:56:16 -0400 | [diff] [blame^] | 144 | > helm deploy dev local/onap -f /root/oom/kubernetes/onap/resources/environments/public-cloud.yaml -f /root/integration-override.yaml --namespace onap --timeout 900 |
Brian Freeman | cce79bd | 2019-04-17 10:34:32 -0500 | [diff] [blame] | 145 | |
| 146 | |
| 147 | **Step 9.** Commands to interact with the OOM installation |
| 148 | |
| 149 | Use the following to monitor your deployment and determine when ONAP is |
| 150 | ready for use:: |
Roger Maitland | 953b5f1 | 2018-03-22 15:24:04 -0400 | [diff] [blame] | 151 | |
Mike Elliott | 474c350 | 2019-05-09 10:56:16 -0400 | [diff] [blame^] | 152 | > kubectl get pods -n onap -o=wide |
Mike Elliott | ed5ff71 | 2018-11-07 15:47:19 -0500 | [diff] [blame] | 153 | |
| 154 | Undeploying onap can be done using the following command:: |
Pawel Wieczorek | aa859cd | 2019-01-23 17:32:18 +0100 | [diff] [blame] | 155 | |
Mike Elliott | ed5ff71 | 2018-11-07 15:47:19 -0500 | [diff] [blame] | 156 | > helm undeploy dev --purge |
| 157 | |
| 158 | |
Brian Freeman | cce79bd | 2019-04-17 10:34:32 -0500 | [diff] [blame] | 159 | More examples of using the deploy and undeploy plugins can be found here: https://wiki.onap.org/display/DW/OOM+Helm+%28un%29Deploy+plugins |