terraform-provider-jenkins

README

Terraform Provider

• Website: https://www.terraform.io
• 
• Mailing list: Google Groups

This is a community provider and is not supported by Hashicorp.

Installation

This provider has been published to the Terraform Registry at https://registry.terraform.io/providers/taiidani/jenkins. Please visit the registry for documentation and installation instructions.

Contributors

This repository is actively maintained as free time allows for me to work on it. I am accepting Issues and Pull Requests and if you are interested in helping as a maintainer I am open to the possibility. Please allow for 2-3 weeks of turnaround time on your contributions.

The scope of the provider covers the entire (extendable) Jenkins API provided that the https://github.com/bndr/gojenkins client library supports it. I accept submissions for functionality outside of Jenkins Core but expect that the plugin(s) required are clearly stated in the documentation. See jenkins_credential_vault_approle for an example of this. I can only support these extensions as much as my own ability to test them allows -- Your Mileage May Vary.

Developing the Provider

Working on this provider requires the following:

• Terraform 0.14+
• Go (version requirements documented in the go.mod file)
• Docker Engine 20.10+ (for running acceptance tests)

You will also need to correctly setup a GOPATH, as well as adding ${GOPATH}/bin to your $PATH.

To compile the provider, run make. This will install the provider into your GOPATH and print instructions on registering it into your system.

In order to test the provider, you can simply run make test.

$ make test

In order to run the full suite of Acceptance tests, run make testacc. These tests require Docker to be installed on the machine that runs them, and do not create any remote resources.

$ make testacc

Attribution

This provider design was originally inspired from the work at dihedron/terraform-provider-jenkins.

Documentation

Overview

Package main defines the Jenkins Terraform Provider entrypoint.

This file and the folder structure within the `jenkins/` subfolder conform to the Terraform provider expectations and best practices at https://www.terraform.io/docs/extend/. Please see the generated documentation at https://registry.terraform.io/providers/taiidani/jenkins for how to use the provider within Terraform itself.