This plugin is in alpha stage and is not recommended for production instance
It's configuration might change in future releases
The plugin allows users to configure PostgreSQL for storing fingerprints.
Another plugin which supports storing fingerprints externally, but inside Redis instances is also available. Consider trying it out too! It is much more stable than this plugin at the moment, and also supports fingerprint cleanup, which is currently unsupported in this plugin.
Clone the repository
git clone https://github.com/jenkinsci/postgresql-fingerprint-storage-plugin cd postgresql-fingerprint-storage-plugin
To obtain the
postgresql-fingerprint-storage.jar files, run:
mvn clean install
They will be available inside
./plugin/target. (Note that docker is required for running tests. If Docker is not installed, consider skipping tests)
To run the plugin on a local instance, run:
cd plugin mvn hpi:run
Once the plugin has been installed, you can configure the PostgreSQL server details by following the steps below:
- Scroll to the section
PostgreSQL Fingerprint Storagefrom the dropdown for Fingerprint Storage Engine and fill in the required details:
Host- Enter hostname where PostgreSQL is running
Port- Specify the port on which PostgreSQL is running
Database Name- Specify the database name inside the PostgreSQL instance to be used. Please note that the database will not be created by the plugin, the user has to create the database.
SSL- Click if SSL is enabled
Connection Timeout- Set the connection timeout duration in seconds.
Socket Timeout- Set the socket timeout duration in seconds.
Credentials- Configure authentication using username and password to the PostgreSQL instance.
- Use the
Test PostgreSQL Connectionto verify that the details are correct and Jenkins is able to connect to the PostgreSQL instance.
- [IMPORTANT] When configuring the plugin for the first time, it is highly important to press the
Perform PostgreSQL Schema Initializationbutton. The button can also be used in the case the database is wiped out and schema needs to be recreated.
- Press the
- Now, all the fingerprints produced by this Jenkins instance should be saved in the configured PostgreSQL server!
- Use the
The plugin can also be configured using the configuration as code plugin but there is one caveat at the moment. The schema for the PostgreSQL instance has to be initialized by going to the configuration page, as mentioned in the previous section.
A sample YAML file is provided below for configuring this plugin using JCasC:
unclassified: fingerprints: storage: postgreSQL: host: "localhost" port: 6379 ssl: false databaseName: 0 connectionTimeout: 3000 socketTimeout: 3000 credentialsId: "foo"
We use Jenkins Jira to track issues. Feel free to file issues under
The source code includes
JettisonStaxWriter which have been taken from http://x-stream.github.io/.