Skip to main content

Jenkins Pipelines & hamlet

Jenkins integration with hamlet offers comprehensive Product lifecycle management. This section documents best-practices and common approaches to their configuration.

Examples can be viewed here and the Shared Groovy Scripts provide additional ready-to-use hamlet utilities for Jenkins pipelines.

Below is the recommended approach to integrating hamlet and Jenkins. This configuration will grant comprehensive control of a hamlet Solution.

Properties files

hamlet Jenkins pipelines share a number of common environment variables and valid parameter values. To re-use this configuration easily, creating a properties file is recommended.

Jenkins Jobs

Keeping properties and pipelines within your Product CMDB under the following structure allows for separation of purpose, whilst ensuring they will always be available where your repository has been cloned down. Build pipelines are not shown as they should be committed to the root of the code repository for the code they build.

./pipelines/
├── deploy
│ ├── staging
│ │ └── deploy
│ │ └── Jenkinsfile
│ └── production
│ ├── accept
│ │ └── Jenkinsfile
│ ├── deploy
│ │ └── Jenkinsfile
│ ├── prepare
│ │ └── Jenkinsfile
│ └── promote
│ └── Jenkinsfile
├── manage
│ └── environment
│ └── Jenkinsfile
└── properties
└── product.properties

Build Pipelines

Create build artefacts and publish them to a Registry.

Build jobs should be configured in Jenkins as a multi-branch pipeline so as to provide feedback on new builds prior to merge.

Examples

Deploy Pipelines

Retrieve build artefacts from a Registry and sequentially promote them through environments.

Deploy pipelines for non-continuous-deployment environments use the following pattern (each is a separate pipeline):

  1. promote a release from the previous environment
  2. prepare the necessary templates to deploy the release into the current environment
  3. deploy the release into the current environment
  4. accept the release as successful/tested and ready to proceed to the next

After accepting a release, the pattern would begin again by promoting the release into the next environment.

The following exceptions to this approach should be considered:

  • environments intended for continuous deployment should deploy directly - an example is provided.
  • Production environments do not require an accept pipeline as there are no further environments.

Examples

Management Pipelines

Provide a single pipeline for performing environmental-level deployments. This includes performing a specific mode of deployment (update, stop, hibernate) against one or many deployment units.

Examples

Utility Pipelines

Perform ad-hoc and Solution-specific tasks