Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

NMS-17733 : Support Modifications to Elasticsearch Templates at Runtime. #7669

Open
wants to merge 12 commits into
base: develop
Choose a base branch
from
Open

NMS-17733 : Support Modifications to Elasticsearch Templates at Runtime. #7669

wants to merge 12 commits into from

Conversation

mwajahatabbasi
Copy link
Contributor

@mwajahatabbasi mwajahatabbasi marked this pull request as ready for review March 28, 2025 16:38
@christianpape christianpape requested a review from cgorantla March 31, 2025 08:50
christianpape
christianpape requested changes Apr 1, 2025
View reviewed changes
.../flows/elastic/src/main/java/org/opennms/netmgt/flows/elastic/AggregateIndexInitializer.java
public class AggregateIndexInitializer extends DefaultTemplateInitializer {

public static final String TEMPLATE_RESOURCE = "/netflow_agg-template";
private static final String FLOW_TEMPLATE_DIR = System.getProperty("flow.templates.dir","");
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please prefix the property:

Suggested change
private static final String FLOW_TEMPLATE_DIR = System.getProperty("flow.templates.dir","");
private static final String FLOW_TEMPLATE_DIR = System.getProperty("org.opennms.flow.templates.dir","");

.../flows/elastic/src/main/java/org/opennms/netmgt/flows/elastic/AggregateIndexInitializer.java
public class AggregateIndexInitializer extends DefaultTemplateInitializer {

public static final String TEMPLATE_RESOURCE = "/netflow_agg-template";
private static final String FLOW_TEMPLATE_DIR = System.getProperty("flow.templates.dir","");
public static final String TEMPLATE_RESOURCE = Paths.get(FLOW_TEMPLATE_DIR, "/netflow_agg-template").toString();
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The / is not necessary.

Suggested change
public static final String TEMPLATE_RESOURCE = Paths.get(FLOW_TEMPLATE_DIR, "/netflow_agg-template").toString();
public static final String TEMPLATE_RESOURCE = Paths.get(FLOW_TEMPLATE_DIR, "netflow_agg-template").toString();

features/flows/elastic/src/main/java/org/opennms/netmgt/flows/elastic/RawIndexInitializer.java
public class RawIndexInitializer extends DefaultTemplateInitializer {

public static final String TEMPLATE_RESOURCE = "/netflow-template";
private static final String FLOW_TEMPLATE_DIR = System.getProperty("flow.templates.dir","");
public static final String TEMPLATE_RESOURCE = Paths.get(FLOW_TEMPLATE_DIR, "/netflow-template").toString();
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
public static final String TEMPLATE_RESOURCE = Paths.get(FLOW_TEMPLATE_DIR, "/netflow-template").toString();
public static final String TEMPLATE_RESOURCE = Paths.get(FLOW_TEMPLATE_DIR, "netflow-template").toString();

opennms-base-assembly/src/main/filtered/etc/opennms.properties
@@ -869,3 +869,4 @@ org.opennms.newts.nan_on_counter_wrap=true

# By default hostnames are determined for a node's IP addresses during the provisioning's audit phase.
# org.opennms.provisiond.reverseResolveRequisitionIpInterfaceHostnames=true
flow.templates.dir=${flow.templates.dir}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please prefix the property:

Suggested change
flow.templates.dir=${flow.templates.dir}
flow.templates.dir=${org.opennms.flow.templates.dir}

features/flows/elastic/src/main/java/org/opennms/netmgt/flows/elastic/RawIndexInitializer.java
public class RawIndexInitializer extends DefaultTemplateInitializer {

public static final String TEMPLATE_RESOURCE = "/netflow-template";
private static final String FLOW_TEMPLATE_DIR = System.getProperty("flow.templates.dir","");
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
private static final String FLOW_TEMPLATE_DIR = System.getProperty("flow.templates.dir","");
private static final String FLOW_TEMPLATE_DIR = System.getProperty("org.opennms.flow.templates.dir","");

pom.xml
@@ -1698,7 +1698,7 @@
<install.etc.dir>${install.dir}/etc</install.etc.dir>
<install.logs.dir>${install.dir}/logs</install.logs.dir>
<install.pid.file>${install.logs.dir}/opennms.pid</install.pid.file>

<flow.templates.dir>${install.etc.dir}/elastic-templates</flow.templates.dir>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<flow.templates.dir>${install.etc.dir}/elastic-templates</flow.templates.dir>
<org.opennms.flow.templates.dir>${install.etc.dir}/elastic-templates</org.opennms.flow.templates.dir>

opennms-base-assembly/src/main/filtered/etc/opennms.properties
@@ -869,3 +869,4 @@ org.opennms.newts.nan_on_counter_wrap=true

# By default hostnames are determined for a node's IP addresses during the provisioning's audit phase.
# org.opennms.provisiond.reverseResolveRequisitionIpInterfaceHostnames=true
flow.templates.dir=${flow.templates.dir}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please also add a comment and describe what this property is used for. Please also add a description of the new options in docs/modules/releasenotes/pages/whatsnew.adoc.

cgorantla
cgorantla requested changes Apr 1, 2025
View reviewed changes
Copy link
Contributor

@cgorantla cgorantla left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Create a separate feature branch called features/elastic-improvements which should be based on foundation-2024 and target this to this new feature branch.

pom.xml
@@ -1698,7 +1698,7 @@
<install.etc.dir>${install.dir}/etc</install.etc.dir>
<install.logs.dir>${install.dir}/logs</install.logs.dir>
<install.pid.file>${install.logs.dir}/opennms.pid</install.pid.file>

<flow.templates.dir>${install.etc.dir}/elastic-templates</flow.templates.dir>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think sub directories in etc doesn't need to be specified here.

opennms-base-assembly/src/main/filtered/etc/opennms.properties
@@ -869,3 +869,4 @@ org.opennms.newts.nan_on_counter_wrap=true

# By default hostnames are determined for a node's IP addresses during the provisioning's audit phase.
# org.opennms.provisiond.reverseResolveRequisitionIpInterfaceHostnames=true
flow.templates.dir=${flow.templates.dir}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we are not adding any new properties in opennms.properties. Keep the defaults in the code.
And specify the system property in the doc.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@christianpape christianpape christianpape requested changes

@cgorantla cgorantla cgorantla requested changes

@Junaid-Khan-Nant Junaid-Khan-Nant Awaiting requested review from Junaid-Khan-Nant

@naeem-afzal naeem-afzal Awaiting requested review from naeem-afzal

@smunir-onms smunir-onms Awaiting requested review from smunir-onms

Requested changes must be addressed to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@mwajahatabbasi @christianpape @cgorantla