Merge pull request #16 from OpenNMS/jira/NMS-15671

NMS-15671: k8s: docs: Technical details/"About" section

antora-playbook-local.yml

@@ -6,8 +6,6 @@ content:
   sources:
     - url: .
       branches: HEAD
-      tags:
-        - v*
       start_path: docs
 ui:
   bundle:

docs/modules/ROOT/nav.adoc

@@ -4,18 +4,13 @@
 .Installation
 * xref:installation:introduction.adoc[]
 * xref:installation:installation.adoc[]
-* xref:installation:minion.adoc[]
-* xref:installation:sentinel.adoc[]
 
 .Configuration
 * xref:configuration:configuration.adoc[]
 
-.Operation
-* xref:operation:operation.adoc[]
-
 .Troubleshooting
 * xref:troubleshooting:debugging.adoc[]
 
 .Reference
-* xref:reference:reference.adoc[]
-* xref:reference:ingress.adoc[]
+* xref:reference:ingress.adoc[]
+* xref:reference:tools.adoc[]

docs/modules/about/pages/about.adoc

@@ -17,8 +17,6 @@ The following illustrates the general architecture for the OpenNMS Helm Charts s
 It also displays external dependencies: Loki, PostgreSQL, Elasticsearch, Kafka, and Cortex.
 For more detailed information on Kubernetes and containerized environments, see the https://kubernetes.io/docs/home/[Kubernetes documentation].
 
-_Still requires editing_
-
 //needs to be revised
 
 .General architecture
@@ -37,8 +35,8 @@ The name of the `namespace` is used as follows:
 * The name of the deployed Helm application.
 * A prefix for the OpenNMS and Grafana databases in PostgreSQL.
 * A prefix for the index names in Elasticsearch when processing flows.
-* A prefix for the topics in Kafka (requires configuring the OpenNMS instance ID on Minions).
-* A prefix for the Consumer Group IDs in OpenNMS and Sentinel.
+* A prefix for the topics in Kafka.
+* A prefix for the Consumer Group IDs in OpenNMS.
 * Part of the subdomain used by the Ingress Controller to expose Web UIs.
 
 //removed shared volumes, as it included `storageClass` which is going away, and also Cloud options which we aren't documenting for 32.

docs/modules/installation/pages/installation.adoc

@@ -5,10 +5,6 @@
 Before installing OpenNMS Helm Charts, make sure your environment meets the xref:installation:introduction.adoc#requirements[minimum requirements].
 
 This section describes a basic local installation on different operating systems with a Horizon Core.
-For information on other installation options, see the following:
-
-* xref:installation:minion.adoc[OpenNMS Minion for extended reach]
-* xref:installation:sentinel.adoc[OpenNMS Sentinel for scalability]
 
 == Installation and configuration
 
@@ -41,12 +37,12 @@ include::os/RHEL.adoc[]
 
 NOTE: For information on how to set up with minikube, see the following on GitHub:
 
-* https://github.com/OpenNMS/helm-charts/tree/main/docs/modules/os/os-text-files/minikube_ALMA9.1_notes.txt[minikube Alma 9.1]
-* https://github.com/OpenNMS/helm-charts/tree/main/docs/modules/os/os-text-files/minikube_RHEL9.1.txt[minikube RHEL 9.1]
-* https://github.com/OpenNMS/helm-charts/tree/main/docs/modules/os/os-text-files/minikube_ROCKY9.1.txt[minikube Rocky 9.1]
-* https://github.com/OpenNMS/helm-charts/tree/main/docs/modules/os/os-text-files/minikube_Debian.txt[minkube Debian]
-* https://github.com/OpenNMS/helm-charts/tree/main/docs/modules/os/os-text-files/minikube_Ubuntu.txt[minikube Ubuntu]
-* https://github.com/OpenNMS/helm-charts/tree/main/docs/modules/os/os-text-files/minikube_IP_bridge.txt[minikube IP Bridge]
+* https://github.com/OpenNMS/helm-charts/tree/main/docs/modules/installation/pages/os/OS-text-files/minikube_ALMA9.1.txt[minikube Alma 9.1]
+* https://github.com/OpenNMS/helm-charts/tree/main/docs/modules/installation/pages/os/OS-text-files/minikube_RHEL9.1.txt[minikube RHEL 9.1]
+* https://github.com/OpenNMS/helm-charts/tree/main/docs/modules/installation/pages/os/OS-text-files/minikube_ROCKY9.1.txt[minikube Rocky 9.1]
+* https://github.com/OpenNMS/helm-charts/tree/main/docs/modules/installation/pages/os/OS-text-files/minikube_Debian.txt[minkube Debian]
+* https://github.com/OpenNMS/helm-charts/tree/main/docs/modules/installation/pages/os/OS-text-files/minikube_Ubuntu.txt[minikube Ubuntu]
+* https://github.com/OpenNMS/helm-charts/tree/main/docs/modules/installation/pages/os/OS-text-files/minikube_IP_bridge.txt[minikube IP Bridge]
 
 === Start the OpenNMS environment on your Kubernetes cluster
 
@@ -70,7 +66,6 @@ Keep in mind that is only an example.
 Treat the content of `helm-cloud.yaml` as a sample for testing.
 Make sure to tune it properly so that you avoid overriding settings via `--set`.
 
-
 === Check the output file
 
 When the update completes, check the output file to determine if you need to make changes.
@@ -86,8 +81,4 @@ See the following topics might be useful after installation:
 
 * xref:configuration:configuration.adoc[Manual configuration changes]
 * xref:troubleshooting:debugging.adoc[Troubleshooting]
-* xref:reference:reference.adoc[Useful tools and commands] 
-
-
-
-
+* xref:reference:reference.adoc[Useful tools and commands]

docs/modules/installation/pages/introduction.adoc

@@ -3,7 +3,20 @@
 :!sectids:
 
 OpenNMS Helm Charts is based and tested against the latest Horizon.
-We do not yet support it for Meridian.
+See the following for version compatibilty:
+
+[options="header"]
+[cols="1,1,1"]
+|===
+
+| Helm chart version
+| Horizon version
+| Meridian version
+
+| 1.x
+| Horizon 32.x
+| Meridian 2023.x
+|===
 
 [[requirements]]
 == Requirements
@@ -64,8 +77,6 @@ Kafka, Elasticsearch, and PostgreSQL running externally (and maintained separate
 * PostgreSQL server as the central database for OpenNMS and Grafana.
 ** For Google Cloud, the solution was tested using Google SQL for PostgreSQL with SSL and a private IP.
 
-* Kafka cluster for OpenNMS-to-Minion communication.
-
 * Elasticsearch cluster for flow persistence.
 
 * Grafana Loki server for log aggregation.