X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=kubernetes%2FREADME.md;h=696ede70c071009a9bf8ba62dc59918cddb1070b;hb=57901a9e3decbcafb4c9405fcefdfe44381e12ef;hp=9c315cbafe643e78f92a7f9159b002e4dd8cb532;hpb=0a58b6bc3ceb10947b1675667d6943ed1da3d0c2;p=oom.git diff --git a/kubernetes/README.md b/kubernetes/README.md index 9c315cbafe..696ede70c0 100644 --- a/kubernetes/README.md +++ b/kubernetes/README.md @@ -1,5 +1,8 @@ ## **Quick Start Guide** +> **WARNING**: This README is no longer maintained and will be deprecated. +> Please refer to the official OOM guide here - [OOM Guide](https://docs.onap.org/projects/onap-oom/en/latest/sections/oom_project_description.html) + This is a quick start guide describing how to deploy ONAP on Kubernetes using Helm. @@ -18,7 +21,7 @@ Step 1. Clone the OOM repository from ONAP gerrit: > 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*. +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 ``` Example: ... @@ -32,8 +35,8 @@ 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] ``` > helm serve & ``` @@ -64,7 +67,7 @@ Setup of this Helm repository is a one time activity. If you make changes to you Step 6. Once the repo is setup, installation of ONAP can be done with a single command: ``` -> helm install local/onap -name dev --namespace onap +> helm install local/onap --name dev --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.