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,
- 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
- 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.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file cdk8s_jenkins-0.0.606.tar.gz.
File metadata
- Download URL: cdk8s_jenkins-0.0.606.tar.gz
- Upload date:
- Size: 158.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.14.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4f8637fb2fda22d456f4097688ace8065d5fa1821fd44e8f08b7ce847aee4835
|
|
| MD5 |
8404e9ef2ad6ec49e28ec170d57957a0
|
|
| BLAKE2b-256 |
c316e6b8a82b56959d982d7c3f6e0b050a06813036bb414afc499f3c212034d9
|
Provenance
The following attestation bundles were made for cdk8s_jenkins-0.0.606.tar.gz:
Publisher:
release.yml on cdk8s-team/cdk8s-jenkins
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
cdk8s_jenkins-0.0.606.tar.gz -
Subject digest:
4f8637fb2fda22d456f4097688ace8065d5fa1821fd44e8f08b7ce847aee4835 - Sigstore transparency entry: 2340413291
- Sigstore integration time:
-
Permalink:
cdk8s-team/cdk8s-jenkins@666b8866de12fb18254fd57abe49f506a3876edc -
Branch / Tag:
refs/heads/main - Owner: https://github.com/cdk8s-team
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@666b8866de12fb18254fd57abe49f506a3876edc -
Trigger Event:
push
-
Statement type:
File details
Details for the file cdk8s_jenkins-0.0.606-py3-none-any.whl.
File metadata
- Download URL: cdk8s_jenkins-0.0.606-py3-none-any.whl
- Upload date:
- Size: 156.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.14.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ac148767e54d39f1bfb9769b01c1b6058df6a2cd61d90e7704e14f5c05ff0400
|
|
| MD5 |
36998407a1f6089f22f612c9fa9fa879
|
|
| BLAKE2b-256 |
ac469ad106092809057cf7043fda8f1e5c308e4b3d42dc6e5ed657b4e5e8ca82
|
Provenance
The following attestation bundles were made for cdk8s_jenkins-0.0.606-py3-none-any.whl:
Publisher:
release.yml on cdk8s-team/cdk8s-jenkins
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
cdk8s_jenkins-0.0.606-py3-none-any.whl -
Subject digest:
ac148767e54d39f1bfb9769b01c1b6058df6a2cd61d90e7704e14f5c05ff0400 - Sigstore transparency entry: 2340413285
- Sigstore integration time:
-
Permalink:
cdk8s-team/cdk8s-jenkins@666b8866de12fb18254fd57abe49f506a3876edc -
Branch / Tag:
refs/heads/main - Owner: https://github.com/cdk8s-team
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@666b8866de12fb18254fd57abe49f506a3876edc -
Trigger Event:
push
-
Statement type:
