jenkins-trigger-polling_triglav

Description

Jenkins Plugin For Triglav.

Usage

• Job Id (ReadOnly): Job id on Triglav. Users cannot configure this value.
• Username: Username to authenticate to Triglav.
• Password: Password to authenticate to Triglav.
• Authenticator: Authentication method to Triglav. Now just supporting LOCAL which means using user database on Triglav.
• Api Key (Optional, Automatically Generated): API Key which Triglav publishes. Users cannot configure this value.
• Job Message Offset (ReadOnly): Job Message Offset which the job consumed. Users cannot configure this value.
• Time Zone: Time Zone of resources.
• Time Unit: Time Unit of resources.
• Alternative Execution Time: Optional time limit when the Jenkins Project will be built (without parameters from Triglav) if there has been no execution since the last period. Accepts mm format when Time Unit is hourly and HH:mm format when Time Unit is daily. It will be ignored if Time Unit is set to singular or if the format is not correct. The Project will be built again even after the time limit if Triglav triggers it.
• Logical Operator: Logical Operator for which Triglav uses in monitoring resources. and or or is available.
• Span In Days: Monitoring span in days. (Default: 32)
• Resources:
  • Id (ReadOnly): Resource id on Triglav. Users cannot configure this value.
  • URI: Resource URI. Available URI patterns are the below section.

Available Resource URI Pattern

Data Source	Pattern	Original Document
HDFS	hdfs://{namespace}/#{path}	triglav-agent-hdfs
Big Query	https://bigquery.cloud.google.com/table/#{project}:#{dataset}.#{table}	triglav-agent-bigquery
Vertica	vertica://#{host}:#{port}/#{db}/#{schema}/#{table}	triglav-agent-vertica

There is a Triglav Agent for each data source. There are options other than the URI pattern written above, so please refer to the Document of each Triglav Agent for detailed settings. And, see also Triglav Agent List.

Admin Settings

• Polling Span: Polling
• Username: Username to authenticate to Triglav.
• Password: Password to authenticate to Triglav.
• Authenticator: Authentication method to Triglav. Now just supporting LOCAL which means using user database on Triglav.
• Api Key (Optional, Automatically Generated): API Key which Triglav publishes. Users cannot configure this value.
• Max Job Enqueue Count: If lots of job messages are found, how many builds are enqueued.

Development

Prepare Dependencies

Require the below.

• triglav
• java

Build Jenkins for Debug

git clone git@github.com:civitaspo/jenkins-trigger-polling_triglav.git
cd jenkins-trigger-polling_triglav
git submodule update --init # for triglav-client-java
./run-debug-server.sh

Note: For Intellij IDEA Users

The feature of "break point" does not work on Intellij IDEA if you debug by Gradle Task Debugger (ref. https://github.com/jenkinsci/gradle-jpi-plugin). Use Remote Debugger instead.

Build Plugin

./gradlew jpi

This plugin is built into build/libs/jenkins-trigger-polling_triglav.hpi.

Release Plugin

TBD

TODO

• Remove Jobs & Resources correctly from Triglav.
• Write tests.
• Write Jenkins wiki
• Release to Public.

Reference

• Jenkins Plugin Development Reference
• Jenkins Unit Test
• Jenkins Mocking in Unit Test
• Jenkins Gradle JPI Plugin
• Triglav API Document
• Triglav Java Client Document