Correct readme for Casablanca 60/85560/1
authorEric Debeau <eric.debeau@orange.com>
Wed, 17 Apr 2019 11:14:40 +0000 (11:14 +0000)
committerEric Debeau <eric.debeau@orange.com>
Wed, 17 Apr 2019 11:16:13 +0000 (11:16 +0000)
Align README.md content with Casablanca installation and readthedocs

Change-Id: Ie3053b923594a375df3040e4c4b3e01e0217ab8b
Issue-ID: OOM-1807
Signed-off-by: Eric Debeau <eric.debeau@orange.com>
kubernetes/README.md

index 9d8d4cc..c7c980a 100644 (file)
@@ -1,11 +1,13 @@
 ## **Quick Start Guide**
 
 
-This is a quick start guide describing how to deploy ONAP on Kubernetes using Helm.
+This is a quick start guide describing how to deploy ONAP on Kubernetes using
+Helm.
 
 Pre-requisites:
 
--  Your Kubernetes environment must be available. For more information see, [ONAP on Kubernetes](https://wiki.onap.org/display/DW/ONAP+on+Kubernetes).
+-  Your Kubernetes environment must be available. For more information see,
+[ONAP on Kubernetes](https://wiki.onap.org/display/DW/ONAP+on+Kubernetes).
 -  Deployment artifacts are customized for your location.
 
 
@@ -14,11 +16,20 @@ Pre-requisites:
 Step 1. Clone the OOM repository from ONAP gerrit:
 
 ```
-> git clone http://gerrit.onap.org/r/oom
+> git clone -b casablanca http://gerrit.onap.org/r/oom
 > cd oom/kubernetes
 ```
 
-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
+Step 2. Install Helm Plugins required to deploy the ONAP Casablanca release::
+```
+> sudo cp -R ~/oom/kubernetes/helm/plugins/ ~/.helm 
+```
+
+Step 3. 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 SO
+ecnrypted value of the openstack tenant password
 ```
 Example:
 ...
@@ -32,8 +43,10 @@ so: # Service Orchestrator
   enabled: true
 ...
 ```
-Step 3. To setup a local Helm repository to serve up the local ONAP charts:
-        [Note: ensure helm init has been executed on the node, or run helm init --client-only]
+
+Step 4. To setup a local Helm repository to serve up the local ONAP charts:
+        [Note: ensure helm init has been executed on the node,
+        or run helm init --client-only]
 ```
 > helm serve &
 ```
@@ -42,33 +55,39 @@ Note the port number that is listed and use it in the Helm repo add as follows:
 > helm repo add local http://127.0.0.1:8879
 ```
 
-Step 4. Build a local Helm repository (from the kubernetes directory):
+Step 5. Build a local Helm repository (from the kubernetes directory):
 ```
 > make all
 ```
 
-Step 5. Display the charts that are available to be deployed:
+Step 6. Display the charts that are available to be deployed:
 ```
 > helm search -l
 NAME                    VERSION    DESCRIPTION
-local/appc              2.0.0      Application Controller
-local/clamp             2.0.0      ONAP Clamp
-local/onap              2.0.0      Open Network Automation Platform (ONAP)
-local/robot             2.0.0      A helm Chart for kubernetes-ONAP Robot
-local/so                2.0.0      ONAP Service Orchestrator
-...
+local/appc              3.0.0      Application Controller
+local/clamp             3.0.0      ONAP Clamp
+local/onap              3.0.0      Open Network Automation Platform (ONAP)
+local/robot             3.0.0      A helm Chart for kubernetes-ONAP Robot
+local/so                3.0.0      ONAP Service Orchestrator
+
 ```
 
 **Note:**
-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.
+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.
 
-Step 6. Once the repo is setup, installation of ONAP can be done with a single command:
+Step 7. Once the repo is setup, installation of ONAP can be done with a single
+command:
 ```
-> helm install local/onap --name dev --namespace onap
+> helm deploy dev local/onap --namespace onap
 ```
-**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.
+**Note:** the **--namespace onap** is currently required while all onap helm
+charts are migrated to version 3.0. After this activity is complete, namespaces
+will be optional.
 
-Use the following to monitor your deployment and determine when ONAP is ready for use:
+Use the following to monitor your deployment and determine when ONAP is ready
+for use:
 ```
 > kubectl get pods --all-namespaces -o=wide
 ```
@@ -78,12 +97,10 @@ Use the following to monitor your deployment and determine when ONAP is ready fo
 
 To delete a deployed instance, use the following command:
 ```
-> helm del dev --purge
+> helm undeploy dev --purge
 ```
 
-
-
 For more information on OOM project documentation, refer to:
 
  -  [Quick Start Guide on Wiki](https://wiki.onap.org/display/DW/ONAP+Operations+Manager+Project#ONAPOperationsManagerProject-QuickStartGuide)
- -  [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)
+ -  [Quick Start Guide on readthedocs](https://docs.onap.org/en/casablanca/submodules/oom.git/docs/oom_quickstart_guide.html)