Skip to main content

Jenkins construct for CDK8s

Project description

cdk8s-jenkins

cdk8s-jenkins is a library that lets you easily define a manifest for deploying a Jenkins instance to your Kubernetes cluster.

Prerequisites

This library uses a Custom Resource Definition provided by jenkins, and thus requires both the CRD and the operator to be installed on the cluster. You can set this up by,

  1. Apply the Custom Resource Definition(CRD) for jenkins on your Kubernetes cluster.
kubectl apply -f https://raw.githubusercontent.com/jenkinsci/kubernetes-operator/master/config/crd/bases/jenkins.io_jenkins.yaml
  1. Install the Jenkins Operator on your Kubernetes cluster.
kubectl apply -f https://raw.githubusercontent.com/jenkinsci/kubernetes-operator/master/deploy/all-in-one-v1alpha2.yaml

For more information regarding applying jenkins crd and installing jenkins operator, please refer jenkins official documentaion.

Usage

The library provides a high level Jenkins construct to provision a Jenkins instance. You can just instantiate the Jenkins instance and that would add a Jenkins resource to the kubernetes manifest.

The library provide a set of defaults, so provisioning a basic Jenkins instance requires no configuration:

import { Jenkins } from 'cdk8s-jenkins';

// inside your chart:
const jenkins = new Jenkins(this, 'my-jenkins');

The library also enables configuring the following parmeters for the Jenkins instance:

metadata

const jenkins = new Jenkins(this, 'my-jenkins', {
  metadata: {
    namespace: 'jenkins-namespace',
    labels: { customApp: 'my-jenkins' },
  },
});

disableCsrfProtection

This allows you to toggle CSRF Protection for Jenkins.

const jenkins = new Jenkins(this, 'my-jenkins', {
  disableCsrfProtection: true,
});

basePlugins

These are the plugins required by the jenkins operator.

const jenkins = new Jenkins(this, 'my-jenkins', {
  basePlugins: [{
    name: 'configuration-as-code',
    version: '1.55',
    }],
});

You can also utilize addBasePlugins function to add base plugins to jenkins configuration after initialization.

const jenkins = new Jenkins(this, 'my-jenkins');
jenkins.addBasePlugins([{
  name: 'workflow-api',
  version: '2.76',
}]);

plugins

These are the plugins that you can add to your jenkins instance.

const jenkins = new Jenkins(this, 'my-jenkins', {
  plugins: [{
    name: 'simple-theme-plugin',
    version: '0.7',
    }],
});

You can also utilize addPlugins function to add plugins to jenkins configuration after initialization.

const jenkins = new Jenkins(this, 'my-jenkins');
jenkins.addPlugins([{
  name: 'simple-theme-plugin',
  version: '0.7',
}]);

seedJobs

You can define list of jenkins seed job configurations here. For more info you can take look at jenkins documentation.

const jenkins = new Jenkins(this, 'my-jenkins', {
  seedJobs: [{
    id: 'jenkins-operator',
    targets: 'cicd/jobs/*.jenkins',
    description: 'Jenkins Operator repository',
    repositoryBranch: 'master',
    repositoryUrl: 'https://github.com/jenkinsci/kubernetes-operator.git',
    }],
});

You can also utilize addSeedJobs function to add seed jobs to jenkins configuration after initialization.

const jenkins = new Jenkins(this, 'my-jenkins');
jenkins.addSeedJobs([{
  id: 'jenkins-operator',
  targets: 'cicd/jobs/*.jenkins',
  description: 'Jenkins Operator repository',
  repositoryBranch: 'master',
  repositoryUrl: 'https://github.com/jenkinsci/kubernetes-operator.git',
}]);

Using escape hatches

You can utilize escape hatches to make changes to the configurations that are not yet exposed by the library.

For instance, if you would like to update the version of a base plugin:

const jenkins = new Jenkins(this, 'my-jenkins');
const jenkinsApiObject = ApiObject.of(jenkins);
jenkinsApiObject.addJsonPatch(JsonPatch.replace('/spec/master/basePlugins/1', {
  name: 'workflow-job',
  version: '3.00',
}));

For more information regarding escape hatches, take a look at cdk8s documentation.

Security

See CONTRIBUTING for more information.

License

This project is licensed under the Apache-2.0 License.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cdk8s_jenkins-0.0.454.tar.gz (159.2 kB view details)

Uploaded Source

Built Distribution

cdk8s_jenkins-0.0.454-py3-none-any.whl (157.6 kB view details)

Uploaded Python 3

File details

Details for the file cdk8s_jenkins-0.0.454.tar.gz.

File metadata

  • Download URL: cdk8s_jenkins-0.0.454.tar.gz
  • Upload date:
  • Size: 159.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.5

File hashes

Hashes for cdk8s_jenkins-0.0.454.tar.gz
Algorithm Hash digest
SHA256 12506cefeef681f97ec506dfd2d6e788b45d18d56b069ffecc45e343c116c2a7
MD5 1f0559015bf304dd92c296259643b1f9
BLAKE2b-256 2f4621f404a46671b922c2f6ea7a9211f4e41b05c44c58092720a66aebe65d87

See more details on using hashes here.

File details

Details for the file cdk8s_jenkins-0.0.454-py3-none-any.whl.

File metadata

File hashes

Hashes for cdk8s_jenkins-0.0.454-py3-none-any.whl
Algorithm Hash digest
SHA256 92cc071038e3876611d6050caa1a9849c0da44f0c89fbcfac27399a141257dcf
MD5 af1c06a8cbfe64a548dbe609e11736d5
BLAKE2b-256 4e8fd91a0712a9650ea5879587d18c10a208cb426630d3fde468778d366807e9

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page