kubernetes/README.md

   1 ## **Quick Start Guide**
   2
   3
   4 This is a quick start guide describing how to deploy ONAP on Kubernetes using
   5 Helm.
   6
   7 Pre-requisites:
   8
   9 -  Your Kubernetes environment must be available. For more information see,
  10 [ONAP on Kubernetes](https://wiki.onap.org/display/DW/ONAP+on+Kubernetes).
  11 -  Deployment artifacts are customized for your location.
  12
  13
  14 ### **Deploy ONAP Instance**
  15
  16 Step 1. Clone the OOM repository from ONAP gerrit:
  17
  18 ```
  19 > git clone -b casablanca http://gerrit.onap.org/r/oom
  20 > cd oom/kubernetes
  21 ```
  22
  23 Step 2. Install Helm Plugins required to deploy the ONAP Casablanca release::
  24 ```
  25 > sudo cp -R ~/oom/kubernetes/helm/plugins/ ~/.helm
  26 ```
  27
  28 Step 3. Customize the oom/kubernetes/onap parent chart, like the values.yaml
  29 file, to suit your deployment. You may want to selectively enable or disable
  30 ONAP components by changing the subchart **enabled** flags to *true* or
  31 *false*.  The .yaml file for OpenStackEncryptedPassword should be the SO
  32 ecnrypted value of the openstack tenant password
  33 ```
  34 Example:
  35 ...
  36 robot: # Robot Health Check
  37   enabled: true
  38 sdc:
  39   enabled: false
  40 sdnc:
  41   enabled: false
  42 so: # Service Orchestrator
  43   enabled: true
  44 ...
  45 ```
  46
  47 Step 4. To setup a local Helm repository to serve up the local ONAP charts:
  48         [Note: ensure helm init has been executed on the node,
  49         or run helm init --client-only]
  50 ```
  51 > helm serve &
  52 ```
  53 Note the port number that is listed and use it in the Helm repo add as follows:
  54 ```
  55 > helm repo add local http://127.0.0.1:8879
  56 ```
  57
  58 Step 5. Build a local Helm repository (from the kubernetes directory):
  59 ```
  60 > make all
  61 ```
  62
  63 Step 6. Display the charts that are available to be deployed:
  64 ```
  65 > helm search -l
  66 NAME                    VERSION    DESCRIPTION
  67 local/appc              3.0.0      Application Controller
  68 local/clamp             3.0.0      ONAP Clamp
  69 local/onap              3.0.0      Open Network Automation Platform (ONAP)
  70 local/robot             3.0.0      A helm Chart for kubernetes-ONAP Robot
  71 local/so                3.0.0      ONAP Service Orchestrator
  72
  73 ```
  74
  75 **Note:**
  76 Setup of this Helm repository is a one time activity. If you make changes to
  77 your deployment charts or values be sure to use **make** to update your local
  78 Helm repository.
  79
  80 Step 7. Once the repo is setup, installation of ONAP can be done with a single
  81 command:
  82 ```
  83 > helm deploy dev local/onap --namespace onap
  84 ```
  85 **Note:** the **--namespace onap** is currently required while all onap helm
  86 charts are migrated to version 3.0. After this activity is complete, namespaces
  87 will be optional.
  88
  89 Use the following to monitor your deployment and determine when ONAP is ready
  90 for use:
  91 ```
  92 > kubectl get pods --all-namespaces -o=wide
  93 ```
  94
  95
  96 #### **Cleanup deployed ONAP instance**
  97
  98 To delete a deployed instance, use the following command:
  99 ```
 100 > helm undeploy dev --purge
 101 ```
 102
 103 For more information on OOM project documentation, refer to:
 104
 105  -  [Quick Start Guide on Wiki](https://wiki.onap.org/display/DW/ONAP+Operations+Manager+Project#ONAPOperationsManagerProject-QuickStartGuide)
 106  -  [Quick Start Guide on readthedocs](https://docs.onap.org/en/casablanca/submodules/oom.git/docs/oom_quickstart_guide.html)