README
¶
Jenkins Operator
What's the Jenkins Operator?
The Jenkins Operator is a Kubernetes Native Operator which manages operations for Jenkins on Kubernetes. It has been built with Immutability and declarative Configuration as Code in mind.
Preliminaries
Considering that this Operator is created for managing instances for Jenkins, it is important to understand what
- Jenkins Pipelines and
- CasC (Configuration as Code) are.
Jenkins Pipelines use Scripts written in Groovy which aid in the CasC aspect of Jenkins.
Jenkins uses plugins like CasC to extend it's solution space by carrying out Jobs of different kinds and providing a composable infrastructure for your CI/CD.
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
- 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:
- How it works
- Getting Started
- Security
- Troubleshooting
- Developer Guide
- FAQ
- Jenkins Custom Resource Definition Schema
Common Issues and Workarounds
- Multibranch Pipelines and Backup Issues: https://github.com/jenkinsci/kubernetes-operator/issues/104#issuecomment-554289768
Community
Main channel of communication on topics related to Jenkins Operator is Jenkins Operator Category on Jenkins Community Discourse.
Here you can ask questions about the project, discuss best practices on using it, and talk to other users of the Operator, contributors and project's maintainers.
We also have a gitter/matrix channel, come to say hi!
Snapshots between releases
We are trying our best to resolve issues quickly, but they have to wait to be released. If you can't wait for an official docker image release and acknowledge the risk, you can use our unofficial images, which are built nightly.
You can find the project's Quay.io repository here.
Look for the images with tag "{git-hash}", where {git-hash} is the hash of the master commit that interests you.
Contribution
Feel free to file issues or pull requests, but please consult CONTRIBUTING document beforehand.
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.
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
api
|
|
|
v1alpha2
Package v1alpha2 contains API Schema definitions for the jenkins.io v1alpha2 API group +k8s:deepcopy-gen=package,register +kubebuilder:object:generate=true +groupName=jenkins.io
|
Package v1alpha2 contains API Schema definitions for the jenkins.io v1alpha2 API group +k8s:deepcopy-gen=package,register +kubebuilder:object:generate=true +groupName=jenkins.io |
|
internal
|
|
|
pkg
|
|
|
client
Package client contains client for Jenkins API
|
Package client contains client for Jenkins API |
|
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 |
|
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 |
|
configuration/base/resources
Package resources contains Kubernetes resources required by Jenkins
|
Package resources contains Kubernetes resources required by Jenkins |
|
configuration/user
Package user implements Jenkins user configuration and reconciliation
|
Package user implements Jenkins user configuration and reconciliation |
|
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 |
|
configuration/user/seedjobs
Package seedjobs implements seed jobs configuration
|
Package seedjobs implements seed jobs configuration |
|
groovy
Package groovy implements groovy scripts execution via Jenkins Job
|
Package groovy implements groovy scripts execution via Jenkins Job |
|
test
|
|