-
Notifications
You must be signed in to change notification settings - Fork 576
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #6843 from OpenNMS/ranger/release-notes-32.0.5
Release Notes for Horizon 32.0.5
- Loading branch information
Showing
7 changed files
with
158 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,14 @@ | ||
opennms (32.0.5-1) stable; urgency=high | ||
|
||
* Release 32.0.5 contains a bunch of security updates to Drools, | ||
Hibernate, Jetty, and more, plus a number of other bug fixes and | ||
a slew of documentation updates. | ||
|
||
For details on what has changed, see: | ||
https://docs.opennms.com/horizon/32.0.5/index.html | ||
|
||
-- OpenNMS Release Manager <[email protected]> Tue, 07 Nov 2023 13:08:00 -0500 | ||
|
||
opennms (32.0.4-1) stable; urgency=low | ||
|
||
* Release 32.0.4 contains documentation updates as well as a number of | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,90 @@ | ||
|
||
[[container-deployment]] | ||
= Containerized Deployment | ||
:description: Learn how to install OpenNMS Horizon/Meridian in a containerized environment like Kubernetes or Red Hat OpenShift. | ||
|
||
If your organization uses Kubernetes or Red Hat OpenShift, OpenNMS makes a Helm chart available to simplify {page-component-title} deployment. | ||
For information on deploying in a Docker environment, see the Docker tabs in https://docs.opennms.com/horizon/latest/deployment/core/getting-started.html[installation and configuration]. | ||
|
||
The OpenNMS Helm Chart is based and tested against the latest {page-component-title}. | ||
The minimum version available is | ||
ifeval::["{page-component-title}" == "Horizon"] | ||
Horizon 32.x. | ||
endif::[] | ||
|
||
ifeval::["{page-component-title}" == "Meridian"] | ||
Meridian 2023.x. | ||
endif::[] | ||
|
||
== Before you begin | ||
|
||
You must have a deep understanding of containerized environments (https://kubernetes.io/docs/home/[Kubernetes], https://access.redhat.com/documentation/en-us/openshift_container_platform/[Red Hat OpenShift]) and https://helm.sh/docs[Helm], which is the package manager for Kubernetes. | ||
|
||
You should also be familiar with {page-component-title}, its components, and how the environment works. | ||
|
||
== Requirements | ||
|
||
* https://kubernetes.io/docs/reference/kubectl/[kubectl] | ||
* https://kubernetes.io/docs/reference/kubectl/[Helm] version 3 | ||
* Kubernetes 1.20+ OR Red Hat OpenShift 4.12+ | ||
|
||
=== External dependencies | ||
|
||
{page-component-title} requires the following as part of its monitoring environment. | ||
Make sure to set them up, with SSL enabled, before deploying {page-component-title}. | ||
|
||
* 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. | ||
* Elasticsearch cluster for flow persistence | ||
* Grafana Loki server for log aggregation | ||
** https://grafana.com/docs/loki/v2.8.x/tools/logcli/[logcli] helps extract OpenNMS logs from the command line for troubleshooting purposes. | ||
* https://cert-manager.io/docs/[cert-manager] to provide HTTPS/TLS support to the web-based services the ingress controller manages. | ||
** A `ClusterIssuer` to use it across multiple independent {page-component-title} installations. | ||
* Nginx Ingress Controller, as the solution has not been tested with other Ingress implementations. | ||
|
||
== Deployment on Kubernetes | ||
Once you have set up Helm properly, use the following commands to deploy {page-component-title} on Kubernetes: | ||
|
||
[source, console] | ||
---- | ||
helm repo add opennms https://opennms.github.io/helm-charts | ||
helm install monms opennms/horizon --set domain=domain1.com --create-namespace | ||
---- | ||
|
||
Update configuration values in the `values.yml` file, as required, for your environment. | ||
These values include various passwords (Kafka, database, PostgreSQL), timezone, CPU limits, and so on. | ||
For a list of values and their defaults, see https://github.com/OpenNMS/helm-charts/blob/main/horizon/README.md#values[Values] in the project's readme file on GitHub. | ||
|
||
== Installation on OpenShift | ||
|
||
There are a few known issues and limitations with installation on OpenShift: | ||
|
||
* Removing `CAP_NET_RAW` capability or setting allowPrivilegeEscalation to false will impact ICMP and auto discovery features. | ||
** WORKAROUND: Use a Minion that is located outside of the OpenShift cluster. | ||
|
||
* By default, OpenNMS will create a ClusterRole, ClusterRoleBinding, Route, SecurityContextConstraints, and ServiceAccount. | ||
The user used to install OpenNMS must have the required permissions to make these modifications the OpenShift Cluster, including admin access. | ||
There are options to disable the creation of these elements, but if you do so, you will need to figure out a way to get the pods to work. | ||
|
||
To install {page-component-title} on OpenShift, follow these steps: | ||
|
||
1. Log in to OpenShift and switch to Developer view. | ||
2. Create a project with a unique name. | ||
3. Go to the Helm section. | ||
4. In the Create drop-down menu, select Repository. | ||
* In the Create Repository page, | ||
* Add a unique name and display name. | ||
* Use https://opennms.github.io/helm-charts/ for the URL. | ||
* Save the changes. | ||
5. In the Create drop-down menu, select Helm Release. | ||
6. Under Repository, select the newly created repository entry. | ||
7. Click on Horizon. | ||
8. Make sure that the project name matches the name you set in step 2. | ||
* Skip this step if you are setting “CreateNamespace” option to true. | ||
9. Make the required modifications (for example, set the PostgreSQL information). | ||
10. Click Create. | ||
11. Wait for the pods to come up. This may take a few minutes. | ||
|
||
NOTE: The process to install the Minion is similar. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
11 changes: 11 additions & 0 deletions
11
opennms-assemblies/minion/src/main/filtered/debian/changelog
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,14 @@ | ||
opennms-minion (32.0.5-1) stable; urgency=high | ||
|
||
* Release 32.0.5 contains a bunch of security updates to Drools, | ||
Hibernate, Jetty, and more, plus a number of other bug fixes and | ||
a slew of documentation updates. | ||
|
||
For details on what has changed, see: | ||
https://docs.opennms.com/horizon/32.0.5/index.html | ||
|
||
-- OpenNMS Release Manager <[email protected]> Tue, 07 Nov 2023 13:08:00 -0500 | ||
|
||
opennms-minion (32.0.4-1) stable; urgency=low | ||
|
||
* Release 32.0.4 contains documentation updates as well as a number of | ||
|
11 changes: 11 additions & 0 deletions
11
opennms-assemblies/sentinel/src/main/filtered/debian/changelog
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,14 @@ | ||
opennms-sentinel (32.0.5-1) stable; urgency=high | ||
|
||
* Release 32.0.5 contains a bunch of security updates to Drools, | ||
Hibernate, Jetty, and more, plus a number of other bug fixes and | ||
a slew of documentation updates. | ||
|
||
For details on what has changed, see: | ||
https://docs.opennms.com/horizon/32.0.5/index.html | ||
|
||
-- OpenNMS Release Manager <[email protected]> Tue, 07 Nov 2023 13:08:00 -0500 | ||
|
||
opennms-sentinel (32.0.4-1) stable; urgency=low | ||
|
||
* Release 32.0.4 contains documentation updates as well as a number of | ||
|