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.391.tar.gz (160.0 kB view details)

Uploaded Source

Built Distribution

cdk8s_jenkins-0.0.391-py3-none-any.whl (158.1 kB view details)

Uploaded Python 3

File details

Details for the file cdk8s-jenkins-0.0.391.tar.gz.

File metadata

  • Download URL: cdk8s-jenkins-0.0.391.tar.gz
  • Upload date:
  • Size: 160.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.5

File hashes

Hashes for cdk8s-jenkins-0.0.391.tar.gz
Algorithm Hash digest
SHA256 9d778af7df1f8a65833861f0def27633d6ae26dde5b09a0b97f086105d30af09
MD5 3e80caf32b2e51073749b47478f62d4f
BLAKE2b-256 8faaa5710fd02bb74637eda71eb8c8f58a557d7a3ea9950a7c4a429394ef6cf8

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cdk8s_jenkins-0.0.391-py3-none-any.whl
Algorithm Hash digest
SHA256 9d0f957ca5ae4f37831f8ba3be6e67b284d40ef825ba7a9c79ebff3406fa9f8a
MD5 f0ec0768787d79b53ae060d53322a768
BLAKE2b-256 82b3eaa2a74fe937300bccfa28bac226d62e3a126d313608d27b565cfbd47598

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