docs icon indicating copy to clipboard operation
docs copied to clipboard

Explanation needed for plugin dependencies

Open g3nsvrv opened this issue 5 years ago • 6 comments

Describe the bug There's no mention in our documentation about install plugin dependencies on Rundeck; you can install them under $RDECK_BASE/server/lib or /var/lib/rundeck/lib depending on the installation method.

Source page https://docs.rundeck.com/docs/developer/01-plugin-development.html#build-dependencies

g3nsvrv avatar Jun 02 '20 20:06 g3nsvrv

e.g. https://github.com/inokappa/rundeck-fluentd-plugin

g3nsvrv avatar Jun 02 '20 20:06 g3nsvrv

If you need java dependencies it’s recommended to build a jar and include the dependencies inside the jar as documented under java plugin development. It may also be possible to use groovy @Grab mechanism but I haven’t tried it

gschueler avatar Jun 02 '20 21:06 gschueler

@gschueler probably is a good practice to precompile the dependencies with the plugin but this thing actually works, the dependencies can be uploaded on the /var/lib/rundeck/lib folder.

g3nsvrv avatar Jun 03 '20 01:06 g3nsvrv

Can we fix this page?

https://docs.rundeck.com/docs/developer/01-plugin-development.html#java-plugin-development

The correct path should be in this paragraph "If your Java classes require external libraries that are not included with the Rundeck runtime, you can include them in your .jar archive. (Look in $RDECK_BASE/tools/lib to see the set of third-party jars that are available for your classes by default at runtime)."

Replace "$RDECK_BASE/tools/lib" with "/var/lib/rundeck/lib"

pwonson avatar Aug 07 '20 03:08 pwonson

@chrismcg14 Let's fix @pwonson comment above. The prior discussion will require more decisions on how to document.

fdevans avatar Aug 09 '20 15:08 fdevans

Can we fix this page?

https://docs.rundeck.com/docs/developer/01-plugin-development.html#java-plugin-development

The correct path should be in this paragraph "If your Java classes require external libraries that are not included with the Rundeck runtime, you can include them in your .jar archive. (Look in $RDECK_BASE/tools/lib to see the set of third-party jars that are available for your classes by default at runtime)."

Replace "$RDECK_BASE/tools/lib" with "/var/lib/rundeck/lib"

@pwonson No need to replace, we need to included both methods, RDECK_BASE/tools/lib is for WAR, TOMCAT, and /var/lib/rundeck/lib is for RPM, DEB.

g3nsvrv avatar Oct 26 '20 13:10 g3nsvrv