Merge pull request #41 from OpenNMS/NMS-16221

NMS-16221: Update Helm Charts readme file - updated to reflect updates to the process and changes in the product docs. More links to extra information.

README.md

@@ -1,13 +1,10 @@
 # OpenNMS Helm Charts
 
-OpenNMS Helm Charts makes it easier for users to run OpenNMS Horizon locally in a Kubernetes cluster.
-It is not yet available for a Cloud environment.
-
-Each deployment through OpenNMS Helm Charts has a single Core server, Grafana, and a custom Ingress that shares the RRD files and some configuration files, and multiple Sentinels for flow processing.
+If your organization uses Kubernetes or Red Hat OpenShift, OpenNMS makes a Helm chart available to simplify deployment of Horizon and Meridian.
 
 Note that this is one way to approach the solution.
 We recommend that you study the content of the Helm chart and tune it for your needs.
 
 ## Charts
 * [Horizon](horizon/README.md)
-* [Minion](minion/README.md); This is an experimental chart.
+* [Minion](minion/README.md). This is an experimental chart.

horizon/README.md

@@ -1,34 +1,24 @@
 # OpenNMS Helm Charts -- Horizon
 
-OpenNMS Helm Charts makes it easier for users to run OpenNMS Horizon locally in a Kubernetes cluster or Red Hat OpenShift.
-It is not yet available for a Cloud environment.
-
-Each deployment through OpenNMS Helm Charts has a single Core server, Grafana, and a custom Ingress that shares the RRD files and some configuration files, and multiple Sentinels for flow processing.
+If your organization uses Kubernetes or Red Hat OpenShift, OpenNMS makes a Helm chart available to simplify deployment of Horizon and Meridian.
 
 Note that this is one way to approach the solution.
 We recommend that you study the content of the Helm chart and tune it for your needs.
 
-## Quick Start
-
-You can bring up an instance of OpenNMS for testing using the following commands:
+For more information about deploying in a containerized environment, including requirements and external dependencies, refer to [Containerized Deployment](https://docs.opennms.com/horizon/latest/deployment/core/containers.html) in the main product documentation.
 
-```
-helm upgrade --install ingress-nginx ingress-nginx \
-  --repo https://kubernetes.github.io/ingress-nginx \
-  --namespace ingress-nginx --create-namespace
+If you are not already familiar with Horizon or Meridian, we recommend reviewing our product documentation ([Horizon](https://docs.opennms.com/horizon/latest/deployment/core/introduction.html), [Meridian](https://docs.opennms.com/meridian/latest/deployment/core/introduction.html)) and our [Horizon](https://www.opennms.com/horizon/) or [Meridian](https://www.opennms.com/meridian/) websites.
 
-cd scripts
+## Quick Start
 
-./start-dependencies.sh
+Use the following commands to bring up an instance of Horizon for testing:
 
+```
 helm repo add opennms https://opennms.github.io/helm-charts
 
 helm install monms opennms/horizon --set domain=domain1.com  --create-namespace
 ```
 
-## Product documentation
-For information on requirements, installation, manual configuration, and troubleshooting tips, see the [product documentation](https://docs.opennms.com/opennmshelmcharts/latest/installation/introduction.html#requirements).
-
 ## Version compatibility
 
 | Helm chart version | Horizon version(s) | Meridian version(s) |

horizon/README.md.gotmpl

@@ -1,34 +1,24 @@
 # OpenNMS Helm Charts -- Horizon
 
-OpenNMS Helm Charts makes it easier for users to run OpenNMS Horizon locally in a Kubernetes cluster or Red Hat OpenShift.
-It is not yet available for a Cloud environment.
-
-Each deployment through OpenNMS Helm Charts has a single Core server, Grafana, and a custom Ingress that shares the RRD files and some configuration files, and multiple Sentinels for flow processing.
+If your organization uses Kubernetes or Red Hat OpenShift, OpenNMS makes a Helm chart available to simplify deployment of Horizon and Meridian.
 
 Note that this is one way to approach the solution.
 We recommend that you study the content of the Helm chart and tune it for your needs.
 
-## Quick Start
-
-You can bring up an instance of OpenNMS for testing using the following commands:
+For more information about deploying in a containerized environment, including requirements and external dependencies, refer to [Containerized Deployment](https://docs.opennms.com/horizon/latest/deployment/core/containers.html) in the main product documentation.
 
-```
-helm upgrade --install ingress-nginx ingress-nginx \
-  --repo https://kubernetes.github.io/ingress-nginx \
-  --namespace ingress-nginx --create-namespace
+If you are not already familiar with Horizon or Meridian, we recommend reviewing our product documentation ([Horizon](https://docs.opennms.com/horizon/latest/deployment/core/introduction.html), [Meridian](https://docs.opennms.com/meridian/latest/deployment/core/introduction.html)) and our [Horizon](https://www.opennms.com/horizon/) or [Meridian](https://www.opennms.com/meridian/) websites.
 
-cd scripts
+## Quick Start
 
-./start-dependencies.sh
+Use the following commands to bring up an instance of Horizon for testing:
 
+```
 helm repo add opennms https://opennms.github.io/helm-charts
 
 helm install monms opennms/horizon --set domain=domain1.com  --create-namespace
 ```
 
-## Product documentation
-For information on requirements, installation, manual configuration, and troubleshooting tips, see the [product documentation](https://docs.opennms.com/opennmshelmcharts/latest/installation/introduction.html#requirements).
-
 ## Version compatibility
 
 | Helm chart version | Horizon version(s) | Meridian version(s) |