README
¶
Jenkins Operator
Go to our documentation website for more information, with examples and guides.
What's the Jenkins Operator?
Jenkins operator is a Kubernetes native operator which fully manages Jenkins on Kubernetes. It was built with immutability and declarative configuration as code in mind.
Out of the box it provides:
- integration with Kubernetes (Jenkins kubernetes-plugin)
- pipelines as code (Jenkins pipelines)
- extensibility via groovy scripts (similar to Jenkins script console) or (configuration as code plugin)
- secure defaults and hardening (see the security section of the documentation)
Problem statement and goals
The main reason why we decided to implement the Jenkins Operator is the fact that we faced a lot of problems with standard Jenkins deployment. We want to make Jenkins more robust, suitable for dynamic and multi-tenant environments.
Some of the problems we want to solve:
- installing plugins with incompatible versions or security vulnerabilities
- better configuration as code
- security and hardening out of the box
- make errors more visible for end users
- backup and restore for jobs history
- orphaned jobs with no JNLP connection
- handle graceful shutdown properly
- proper end to end tests for Jenkins lifecycle
Documentation
Go to our documentation website for more information.
Selected content:
- Installation
- Getting Started
- How it works
- Security
- Developer Guide
- Jenkins Custom Resource Definition scheme
Common Jenkins issues and workarounds
- Multibranch pipelines and backup issues: https://github.com/jenkinsci/kubernetes-operator/issues/104#issuecomment-554289768
Community & Contribution
There is a dedicated channel #jenkins-operator on virtuslab-oss.slack.com (Invite form)
Feel free to file issues or pull requests.
Before any big pull request please consult the maintainers to ensure a common direction.
Presentations
About the authors
This project was originally developed by VirtusLab and the following CONTRIBUTORS.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
internal
|
|
|
pkg
|
|
|
apis/jenkins/v1alpha2
Package v1alpha2 contains API Schema definitions for the jenkins.io v1alpha2 API group +k8s:deepcopy-gen=package,register +groupName=jenkins.io Package v1alpha2 contains API Schema definitions for the jenkins.io v1alpha2 API group +k8s:deepcopy-gen=package,register +groupName=jenkins.io
|
Package v1alpha2 contains API Schema definitions for the jenkins.io v1alpha2 API group +k8s:deepcopy-gen=package,register +groupName=jenkins.io Package v1alpha2 contains API Schema definitions for the jenkins.io v1alpha2 API group +k8s:deepcopy-gen=package,register +groupName=jenkins.io |
|
controller/jenkins/client
Package client contains client for Jenkins API Package mock_client is a generated GoMock package.
|
Package client contains client for Jenkins API Package mock_client is a generated GoMock package. |
|
controller/jenkins/configuration/backuprestore
Package backuprestore is responsible for create Jenkins master backup and restore it
|
Package backuprestore is responsible for create Jenkins master backup and restore it |
|
controller/jenkins/configuration/base
Package base is responsible for create Jenkins master pod and it's base configuration
|
Package base is responsible for create Jenkins master pod and it's base configuration |
|
controller/jenkins/configuration/base/resources
Package resources contains Kubernetes resources required by Jenkins
|
Package resources contains Kubernetes resources required by Jenkins |
|
controller/jenkins/configuration/user
Package user implements Jenkins user configuration and reconciliation
|
Package user implements Jenkins user configuration and reconciliation |
|
controller/jenkins/configuration/user/casc
Package casc configures Jenkins with help Configuration as a code plugin
|
Package casc configures Jenkins with help Configuration as a code plugin |
|
controller/jenkins/configuration/user/seedjobs
Package seedjobs implements seed jobs configuration
|
Package seedjobs implements seed jobs configuration |
|
controller/jenkins/groovy
Package groovy implements groovy scripts execution via Jenkins Job
|
Package groovy implements groovy scripts execution via Jenkins Job |
|
test
|
|