charts/bitnami/jenkins

Jenkins

Jenkins is widely recognized as the most feature-rich CI available with easy configuration, continuous delivery and continuous integration support, easily test, build and stage your app, and more. It supports multiple SCM tools including CVS, Subversion and Git. It can execute Apache Ant and Apache Maven-based projects as well as arbitrary scripts.

TL;DR;

$ helm repo add bitnami https://charts.bitnami.com/bitnami
$ helm install my-release bitnami/jenkins

Introduction

This chart bootstraps a Jenkins deployment on a Kubernetes cluster using the Helm package manager.

Bitnami charts can be used with Kubeapps for deployment and management of Helm Charts in clusters. This Helm chart has been tested on top of Bitnami Kubernetes Production Runtime (BKPR). Deploy BKPR to get automated TLS certificates, logging and monitoring for your applications.

Prerequisites

• Kubernetes 1.12+
• Helm 2.11+ or Helm 3.0-beta3+
• PV provisioner support in the underlying infrastructure
• ReadWriteMany volumes for deployment scaling

Installing the Chart

To install the chart with the release name my-release:

$ helm repo add bitnami https://charts.bitnami.com/bitnami
$ helm install my-release bitnami/jenkins

These commands deploy Jenkins on the Kubernetes cluster in the default configuration. The Parameters section lists the parameters that can be configured during installation.

Tip

: List all releases using helm list

Uninstalling the Chart

To uninstall/delete the my-release deployment:

$ helm delete my-release

The command removes all the Kubernetes components associated with the chart and deletes the release.

Parameters

The following tables lists the configurable parameters of the Jenkins chart and their default values.

Parameter	Description	Default
global.imageRegistry	Global Docker image registry	nil
global.imagePullSecrets	Global Docker registry secret names as an array	[] (does not add image pull secrets to deployed pods)
global.storageClass	Global storage class for dynamic provisioning	nil
image.registry	Jenkins image registry	docker.io
image.repository	Jenkins Image name	bitnami/jenkins
image.tag	Jenkins Image tag	{TAG_NAME}
image.pullPolicy	Jenkins image pull policy	IfNotPresent
image.pullSecrets	Specify docker-registry secret names as an array	[] (does not add image pull secrets to deployed pods)
nameOverride	String to partially override jenkins.fullname template with a string (will prepend the release name)	nil
fullnameOverride	String to fully override jenkins.fullname template with a string	nil
jenkinsUser	User of the application	user
jenkinsPassword	Application password	random 10 character alphanumeric string
jenkinsHome	Jenkins home directory	/opt/bitnami/jenkins/jenkins_home
disableInitialization	Allows to disable the initial Bitnami configuration for Jenkins	no
javaOpts	Customize JVM parameters	nil
persistence.enabled	Enable persistence using PVC	true
persistence.storageClass	PVC Storage Class for Jenkins volume	nil (uses alpha storage class annotation)
persistence.accessMode	PVC Access Mode for Jenkins volume	ReadWriteOnce
persistence.size	PVC Storage Request for Jenkins volume	8Gi
resources	CPU/Memory resource requests/limits	requests: { cpu: "300m", memory: "512Mi" }
livenessProbe.enabled	Turn on and off liveness probe	true
livenessProbe.initialDelaySeconds	Delay before liveness probe is initiated	180
livenessProbe.periodSeconds	How often to perform the probe	10
livenessProbe.timeoutSeconds	When the probe times out	5
livenessProbe.successThreshold	Minimum consecutive successes for the probe	1
livenessProbe.failureThreshold	Minimum consecutive failures for the probe	6
readinessProbe.enabled	Turn on and off readiness probe	true
readinessProbe.initialDelaySeconds	Delay before readiness probe is initiated	30
readinessProbe.periodSeconds	How often to perform the probe	5
readinessProbe.timeoutSeconds	When the probe times out	3
readinessProbe.successThreshold	Minimum consecutive successes for the probe	1
readinessProbe.failureThreshold	Minimum consecutive failures for the probe	3
podAnnotations	Pod annotations	{}
affinity	Map of node/pod affinities	{} (The value is evaluated as a template)
nodeSelector	Node labels for pod assignment	{} (The value is evaluated as a template)
tolerations	Tolerations for pod assignment	[] (The value is evaluated as a template)
service.type	Kubernetes Service type	LoadBalancer
service.port	Service HTTP port	80
service.httpsPort	Service HTTPS port	443
service.nodePorts.http	Kubernetes http node port	""
service.nodePorts.https	Kubernetes https node port	""
service.externalTrafficPolicy	Enable client source IP preservation	Cluster
service.loadBalancerIP	LoadBalancer service IP address	""
ingress.enabled	Enable ingress controller resource	false
ingress.annotations	Ingress annotations	[]
ingress.certManager	Add annotations for cert-manager	false
ingress.hosts[0].name	Hostname to your jenkins installation	jenkins.local
ingress.hosts[0].path	Path within the url structure	/
ingress.hosts[0].tls	Utilize TLS backend in ingress	false
ingress.hosts[0].tlsHosts	Array of TLS hosts for ingress record (defaults to ingress.hosts[0].name if nil)	nil
ingress.hosts[0].tlsSecret	TLS Secret (certificates)	jenkins.local-tls-secret
ingress.secrets[0].name	TLS Secret Name	nil
ingress.secrets[0].certificate	TLS Secret Certificate	nil
ingress.secrets[0].key	TLS Secret Key	nil
metrics.enabled	Start a side-car Jenkins prometheus exporter	false
metrics.image.registry	Jenkins exporter image registry	docker.io
metrics.image.repository	Jenkins exporter image name	bitnami/jenkins-exporter
metrics.image.tag	Jenkins exporter image tag	{TAG_NAME}
metrics.image.pullPolicy	Image pull policy	IfNotPresent
metrics.image.pullSecrets	Specify docker-registry secret names as an array	[] (does not add image pull secrets to deployed pods)
metrics.podAnnotations	Additional annotations for Metrics exporter pod	{prometheus.io/scrape: "true", prometheus.io/port: "9118"}
metrics.resources	Exporter resource requests/limit	requests: { cpu: "256m", memory: "100Mi" }

The above parameters map to the env variables defined in bitnami/jenkins. For more information please refer to the bitnami/jenkins image documentation.

Specify each parameter using the --set key=value[,key=value] argument to helm install. For example,

$ helm install my-release \
  --set jenkinsUsername=admin,jenkinsPassword=password \
    bitnami/jenkins

The above command sets the Jenkins administrator account username and password to admin and password respectively.

Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example,

$ helm install my-release -f values.yaml bitnami/jenkins

Tip

: You can use the default values.yaml

Configuration and installation details

Rolling VS Immutable tags

It is strongly recommended to use immutable tags in a production environment. This ensures your deployment does not change automatically if the same tag is updated with a different image.

Bitnami will release a new chart updating its containers if a new version of the main container, significant changes, or critical vulnerabilities exist.

Persistence

The Bitnami Jenkins image stores the Jenkins data and configurations at the /bitnami/jenkins path of the container.

Persistent Volume Claims are used to keep the data across deployments. This is known to work in GCE, AWS, and minikube. See the Parameters section to configure the PVC or to disable persistence.

Upgrading

To 4.0.0

Helm performs a lookup for the object based on its group (apps), version (v1), and kind (Deployment). Also known as its GroupVersionKind, or GVK. Changing the GVK is considered a compatibility breaker from Kubernetes' point of view, so you cannot "upgrade" those objects to the new GVK in-place. Earlier versions of Helm 3 did not perform the lookup correctly which has since been fixed to match the spec.

In 4dfac075aa the apiVersion of the deployment resources was updated to apps/v1 in tune with the api's deprecated, resulting in compatibility breakage.

This major version signifies this change.

To 1.0.0

Backwards compatibility is not guaranteed unless you modify the labels used on the chart's deployments. Use the workaround below to upgrade from versions previous to 1.0.0. The following example assumes that the release name is jenkins:

$ kubectl patch deployment jenkins --type=json -p='[{"op": "remove", "path": "/spec/selector/matchLabels/chart"}]'