Transform GNMI module to ODL karaf feature #2435

Tobianas · 2025-10-21T13:52:09Z

No description provided.

lighty-modules/lighty-gnmi/lighty-gnmi-sb/pom.xml

ihrasko

Disable maven-dependency plugin and make cleanups.

bnd-parent/pom.xml

bnd-parent/bnd.bnd

features/features-gnmi/pom.xml

...i/lighty-gnmi-commons/src/main/java/io/lighty/modules/gnmi/commons/util/models/ModuleId.java

lighty-modules/lighty-gnmi/lighty-gnmi-connector/pom.xml

ihrasko · 2025-11-10T13:38:28Z

...ty-rcgnmi-app-module/src/main/java/io/lighty/applications/rcgnmi/module/RcGnmiAppModule.java

                    this.gnmiExecutorService, this.appModuleConfig.getGnmiConfiguration(), encryptionService,
                    this.customReactor);
-            startAndWaitLightyModule(this.gnmiSouthboundModule);
+            gnmiSouthboundModule.init();


the next logical step would be to translate this module to OSGI and use @reference gnmiSouthboundModule

Why? RcGnmiAppModule starts lighty restconf and controller. When we want to start the feature we do it just by starting the gnmi plugin, not the entire lighty controller. Now its done the same way as for example OpenApi in ODL

...ighty-gnmi-sb/src/main/java/io/lighty/gnmi/southbound/lightymodule/GnmiSouthboundModule.java

ihrasko · 2025-11-10T13:43:02Z

...ighty-gnmi-sb/src/main/java/io/lighty/gnmi/southbound/lightymodule/util/GnmiConfigUtils.java

                    .YangModuleInfoImpl.getInstance()
    );

+    public static final Set<YangModuleInfo> OPENCONFIG_YANG_MODELS = Set.of(


optional: in follow-up patches we can use dependency on mdsal/ietf features

Tobianas · 2025-11-20T18:36:05Z

How to use:

mvn clean install -DskipTests
cd karaf/target/assembly/bin
./karaf
feature:install gnmi-feature

...lator/src/main/java/io/lighty/modules/gnmi/simulatordevice/utils/GnmiSimulatorConfUtils.java

...ighty-gnmi-sb/src/main/java/io/lighty/gnmi/southbound/lightymodule/GnmiSouthboundModule.java

ihrasko · 2025-11-24T12:03:11Z

...lighty-gnmi-test/src/test/java/io/lighty/modules/gnmi/test/gnmi/GnmiWithoutRestconfTest.java

-                .build();
-        Boolean gnmiStartSuccessfully = gnmiSouthboundModule.start().get(TIMEOUT_MILLIS,  TimeUnit.MILLISECONDS);
-        assertTrue(gnmiStartSuccessfully);
+        gnmiSouthboundModule = new GnmiSouthboundModule(lightyController.getServices().getBindingDataBroker(),


Where is parserFactory?

ihrasko · 2025-11-24T12:04:08Z

bnd-parent/pom.xml

+                <scope>test</scope>
+            </dependency>
+            <dependency>
+                <groupId>com.beust</groupId>


why do we need? separate test deps

ihrasko · 2025-11-24T12:05:14Z

features/pom.xml

+        <maven.install.skip>true</maven.install.skip>
+    </properties>
+
+    <modules>


feature-parent ... ...

ihrasko · 2025-11-24T12:05:44Z

pom.xml

        <module>lighty-modules</module>
        <module>lighty-resources</module>
        <module>lighty-tests-report</module>
+        <module>bnd-parent</module>


probably not needed as we will be using gnmi from ODL, from now build in karaf should do it all

ihrasko · 2025-11-24T12:06:05Z

...ty-rcgnmi-app-module/src/main/java/io/lighty/applications/rcgnmi/module/RcGnmiAppModule.java

        }
        if (this.gnmiSouthboundModule != null) {
-            success &= gnmiSouthboundModule.shutdown(lightyModuleTimeout, DEFAULT_LIGHTY_MODULE_TIME_UNIT);
+            gnmiSouthboundModule.close();


what about to update success result

This method is void

...hty-gnmi-sb/src/main/java/io/lighty/gnmi/southbound/schema/impl/SchemaContextHolderImpl.java

...-sb/src/test/java/io/lighty/gnmi/southbound/mountpoint/codecs/TestSchemaContextProvider.java

features/gnmi-feature/src/main/feature/feature.xml

ihrasko · 2025-12-03T08:57:45Z

...ighty-gnmi-sb/src/main/java/io/lighty/gnmi/southbound/lightymodule/GnmiSouthboundModule.java

+            encryptionService, parserFactory, xpathParserFactory, null);
+    }
+
+    public GnmiSouthboundModule(DataBroker dataBroker, RpcProviderService rpcProviderService,


GnmiSouthboundProvider expected to be provided a path to initial models from json configuration. Since we are no longer relying on json configuration, we need to provide them manually. Signed-off-by: tobias.pobocik <[email protected]>

Convert GnmiSouthboundModule as osgi component to allow it to run using karaf. Signed-off-by: tobias.pobocik <[email protected]>

We do not need this since GnmiSouthboundModule is now component Signed-off-by: tobias.pobocik <[email protected]>

The point of this rework is to not rely on other lighty modules to run gnmi. Let's rather use what is available from opendaylight instead. Signed-off-by: tobias.pobocik <[email protected]>

Introduce features to run the gnmi feature. Signed-off-by: tobias.pobocik <[email protected]>

Introduce bnd-parent as a substitute to lighty-app-parent. We are no longer depending on lighty-core, so we need to create our own parent. Signed-off-by: tobias.pobocik <[email protected]>

Just like all other ODL components, introduce parent for gnmi. Signed-off-by: tobias.pobocik <[email protected]>

Convert the gnmi module to rely on the previously created bnd-parent instead of lighty parent. Signed-off-by: tobias.pobocik <[email protected]>

Lighty.io does not have modernizer-maven-plugin and modernizer-maven-plugin so its code was not made with it in mind. Signed-off-by: tobias.pobocik <[email protected]>

Gnmi module no longer requires json configuration to start. The json configuration is used only to configure rcgnmi app which starts gnmi. Move all the code needed for json configuration to rcgnmi utils instead of being in gnmi module since it needs lighty- core dependencies. Signed-off-by: tobias.pobocik <[email protected]>

Introduce gnmi-karaf Signed-off-by: tobias.pobocik <[email protected]>

Karaf does not support using impl injection Signed-off-by: tobias.pobocik <[email protected]>

Lighty.io uses versions which are not supported by karaf, exclude them Signed-off-by: tobias.pobocik <[email protected]>

Fix simulator to generate fat zip and all resources just like it did when it had lighty-app-parent. Signed-off-by: tobias.pobocik <[email protected]>

Implement changes made in GnmiSouthboundModule into tests. Signed-off-by: tobias.pobocik <[email protected]>

Refactored `GnmiSouthboundModule` to support initialization via dependency injection (OSGi) or manual configuration (Standalone/Test). This change was necessary mostly for tests which are not running using karaf and thus rely on json configuration. Signed-off-by: tobias.pobocik <[email protected]>

Since this module no longer depends on lighty-core and its dependency management, we need to specify the dependencies and versions of pekko we want to use. Signed-off-by: tobias.pobocik <[email protected]>

Modernize our code in lighty-gnmi-sb with: - use orElseThrow instead of get - use java.nio.Path instead of Paths Signed-off-by: Ivan Hrasko <[email protected]>

Modernize our code in lighty-gnmi-device-simulator with: - use orElseThrow instead of get - use java.nio.Path instead of Paths Signed-off-by: Ivan Hrasko <[email protected]>

Modernize our code in lighty-gnmi-test with: - use orElseThrow instead of get - use java.nio.Path instead of Paths Signed-off-by: Ivan Hrasko <[email protected]>

We do not need this file since the correct feature.xml is generated according to pom.xml. Signed-off-by: Ivan Hrasko <[email protected]>

We are going to be an ODL project, rename our feature accordingly with human readable name as well. Signed-off-by: Ivan Hrasko <[email protected]>

Do not skip dependency check, instead fix used/unused dependencies, order them alphabetically and applied test scope. Signed-off-by: Ivan Hrasko <[email protected]>

Tobianas force-pushed the gnmi branch 9 times, most recently from 5122ebd to 53fde6b Compare October 29, 2025 09:45

Tobianas force-pushed the gnmi branch 2 times, most recently from 710eedc to ba5b31b Compare October 30, 2025 10:44

ihrasko reviewed Oct 31, 2025

View reviewed changes

lighty-modules/lighty-gnmi/lighty-gnmi-sb/pom.xml Show resolved Hide resolved

Tobianas force-pushed the gnmi branch 2 times, most recently from 1762ddd to 9801f2d Compare November 4, 2025 09:01

ihrasko reviewed Nov 4, 2025

View reviewed changes

Tobianas force-pushed the gnmi branch 5 times, most recently from 33839dc to 2d5fa35 Compare November 10, 2025 09:06

ihrasko requested changes Nov 10, 2025

View reviewed changes

Tobianas force-pushed the gnmi branch 3 times, most recently from d3ed735 to 1381fca Compare November 17, 2025 16:46

Tobianas force-pushed the gnmi branch 4 times, most recently from 5757572 to b5575a0 Compare November 20, 2025 18:34

ihrasko requested changes Nov 24, 2025

View reviewed changes

ihrasko self-requested a review December 3, 2025 08:04

ihrasko requested changes Dec 3, 2025

View reviewed changes

Tobianas added 18 commits December 3, 2025 10:03

Use openconfig models as initial

94c220f

GnmiSouthboundProvider expected to be provided a path to initial models from json configuration. Since we are no longer relying on json configuration, we need to provide them manually. Signed-off-by: tobias.pobocik <[email protected]>

Convert GnmiSouthboundModule to osgi component

a7e4a97

Convert GnmiSouthboundModule as osgi component to allow it to run using karaf. Signed-off-by: tobias.pobocik <[email protected]>

Remove GnmiSouthboundModuleBuilder

694aa00

We do not need this since GnmiSouthboundModule is now component Signed-off-by: tobias.pobocik <[email protected]>

Do not depend on lighty-aaa module

2b8ca7e

The point of this rework is to not rely on other lighty modules to run gnmi. Let's rather use what is available from opendaylight instead. Signed-off-by: tobias.pobocik <[email protected]>

Do not depend on Lighty core

e335263

The point of this rework is to not rely on other lighty modules to run gnmi. Let's rather use what is available from opendaylight instead. Signed-off-by: tobias.pobocik <[email protected]>

Introduce features parent

a4f6466

Introduce features to run the gnmi feature. Signed-off-by: tobias.pobocik <[email protected]>

Introduce bnd-parent

2ead237

Introduce bnd-parent as a substitute to lighty-app-parent. We are no longer depending on lighty-core, so we need to create our own parent. Signed-off-by: tobias.pobocik <[email protected]>

Introduce gnmi-parent

c623131

Just like all other ODL components, introduce parent for gnmi. Signed-off-by: tobias.pobocik <[email protected]>

Convert gnmi to bnd-parent

d1b1839

Convert the gnmi module to rely on the previously created bnd-parent instead of lighty parent. Signed-off-by: tobias.pobocik <[email protected]>

Do not fail on maven-dependency-plugin

386e6a6

Lighty.io does not have modernizer-maven-plugin and modernizer-maven-plugin so its code was not made with it in mind. Signed-off-by: tobias.pobocik <[email protected]>

Introduce karaf

966e9b6

Introduce gnmi-karaf Signed-off-by: tobias.pobocik <[email protected]>

Remove impl dependencies

12c6543

Karaf does not support using impl injection Signed-off-by: tobias.pobocik <[email protected]>

Exclude not supported versions from karaf

1454d64

Lighty.io uses versions which are not supported by karaf, exclude them Signed-off-by: tobias.pobocik <[email protected]>

Enable standalone execution by bundling all dependencies

c739022

Fix simulator to generate fat zip and all resources just like it did when it had lighty-app-parent. Signed-off-by: tobias.pobocik <[email protected]>

Implement GnmiSouthboundModule changes (tests)

090714b

Implement changes made in GnmiSouthboundModule into tests. Signed-off-by: tobias.pobocik <[email protected]>

Add dependency management for pekko

f5d6b3e

Since this module no longer depends on lighty-core and its dependency management, we need to specify the dependencies and versions of pekko we want to use. Signed-off-by: tobias.pobocik <[email protected]>

ihrasko force-pushed the gnmi branch from 806b47d to f5d6b3e Compare December 3, 2025 09:04

ihrasko added 3 commits December 3, 2025 12:36

Modernize lighty-gnmi-sb to be compliant with ODL

7b53c8a

Modernize our code in lighty-gnmi-sb with: - use orElseThrow instead of get - use java.nio.Path instead of Paths Signed-off-by: Ivan Hrasko <[email protected]>

Modernize lighty-gnmi-device-simulator code

b6520cf

Modernize our code in lighty-gnmi-device-simulator with: - use orElseThrow instead of get - use java.nio.Path instead of Paths Signed-off-by: Ivan Hrasko <[email protected]>

Modernize lighty-gnmi-test code

239e5f9

Modernize our code in lighty-gnmi-test with: - use orElseThrow instead of get - use java.nio.Path instead of Paths Signed-off-by: Ivan Hrasko <[email protected]>

ihrasko force-pushed the gnmi branch from deeea14 to 239e5f9 Compare December 3, 2025 11:37

ihrasko added 3 commits December 3, 2025 12:50

Delete needles feature.xml file

081727a

We do not need this file since the correct feature.xml is generated according to pom.xml. Signed-off-by: Ivan Hrasko <[email protected]>

Rename gnmi-feature to odl-gnmi

6f84c29

We are going to be an ODL project, rename our feature accordingly with human readable name as well. Signed-off-by: Ivan Hrasko <[email protected]>

Fix lighty-gnmi-sb dependencies

b013bf2

Do not skip dependency check, instead fix used/unused dependencies, order them alphabetically and applied test scope. Signed-off-by: Ivan Hrasko <[email protected]>

ihrasko force-pushed the gnmi branch from 9ffa0c6 to b013bf2 Compare December 4, 2025 08:33

ihrasko merged commit f69153a into PANTHEONtech:feat-gnmi Dec 4, 2025
6 checks passed

Transform GNMI module to ODL karaf feature #2435

Transform GNMI module to ODL karaf feature #2435

Uh oh!

Conversation

Tobianas commented Oct 21, 2025

Uh oh!

Uh oh!

ihrasko left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Tobianas commented Nov 20, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants