kubernetes/README.md

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