summaryrefslogtreecommitdiffstats
path: root/kubernetes/helm/starters/onap-app/README.md
diff options
context:
space:
mode:
authorMandeep Khinda <Mandeep.Khinda@amdocs.com>2018-03-20 16:51:43 +0000
committerGerrit Code Review <gerrit@onap.org>2018-03-20 16:51:43 +0000
commita68cf4f3da292a9b41b6570067470bb456ca41c6 (patch)
treedf2988de41c1f23f1f164ec528d0d700315b0b46 /kubernetes/helm/starters/onap-app/README.md
parentf7c77bfc3add6c94c8f018e270beea993beefea5 (diff)
parent282a3873eb2206fcc8ce134fc32de76412c6e40d (diff)
Merge "Add Helm Chart "template" Starter"
Diffstat (limited to 'kubernetes/helm/starters/onap-app/README.md')
-rw-r--r--kubernetes/helm/starters/onap-app/README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/kubernetes/helm/starters/onap-app/README.md b/kubernetes/helm/starters/onap-app/README.md
new file mode 100644
index 0000000000..897a07392a
--- /dev/null
+++ b/kubernetes/helm/starters/onap-app/README.md
@@ -0,0 +1,14 @@
+# Starter Helm Chart for ONAP Applications
+
+Clone the onap-app directory and rename it to the name for your new Helm Chart.
+
+Helm Charts for specific applications should be moved into the oom/kubernetes
+directory. If the application is a common reusable Helm Chart (eg. mariadb), a
+more appropriate location might be the oom/kubernetes/common directory.
+
+Edit each yaml file in the new Helm Chart directoy, substituing real values
+for those inside brackets (eg. `<onap-app>`). Some comments have been provided in
+the file to help guide changes that need to be made. This starter Helm Chart is
+in no way complete. It can serve as the basis for creating a new Helm Chart that
+attempts to apply Helm best practices to ONAP applications being configured,
+deployed and managed in Kubernetes.