85 lines
5.1 KiB
Markdown
85 lines
5.1 KiB
Markdown
# Jenkins Operator
|
|
|
|
[](https://github.com/jenkinsci/kubernetes-operator/releases/tag/v0.5.0)
|
|
[](https://travis-ci.org/jenkinsci/kubernetes-operator)
|
|
[](https://goreportcard.com/report/github.com/jenkinsci/kubernetes-operator)
|
|
[](https://hub.docker.com/r/virtuslab/jenkins-operator/tags)
|
|
|
|
|
|
|
|
## What's the Jenkins Operator?
|
|
|
|
The Jenkins Operator is a [Kubernetes Native Operator](https://kubernetes.io/docs/concepts/extend-kubernetes/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](https://jenkins.io/doc/book/pipeline/) and
|
|
- CasC ([Configuration as Code](https://github.com/jenkinsci/configuration-as-code-plugin)) are.
|
|
|
|
Jenkins Pipelines use Scripts written in [Groovy](https://groovy-lang.org/) which aid in the CasC aspect of Jenkins.
|
|
|
|
Jenkins uses [plugins](https://plugins.jenkins.io/) 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](https://github.com/jenkinsci/kubernetes-plugin))
|
|
- Pipelines as Code ([Jenkins pipelines](https://jenkins.io/doc/book/pipeline/))
|
|
- Extensibility via Groovy Scripts (similar to [Jenkins script console](https://wiki.jenkins.io/display/JENKINS/Jenkins+Script+Console)) or ([configuration as code plugin](https://github.com/jenkinsci/configuration-as-code-plugin))
|
|
- Secure Defaults and Hardening (see [the security section](https://jenkinsci.github.io/kubernetes-operator/docs/security/) 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](https://jenkinsci.github.io/kubernetes-operator/docs/getting-started/latest/customization/#install-plugins)
|
|
- [better configuration as code](https://jenkinsci.github.io/kubernetes-operator/docs/getting-started/latest/customization/)
|
|
- [security and hardening out of the box](https://jenkinsci.github.io/kubernetes-operator/docs/security/)
|
|
- [make errors more visible for end users](https://jenkinsci.github.io/kubernetes-operator/docs/getting-started/latest/diagnostics/)
|
|
- [backup and restore for jobs history](https://jenkinsci.github.io/kubernetes-operator/docs/getting-started/latest/configure-backup-and-restore/)
|
|
- orphaned jobs with no JNLP connection
|
|
- handle graceful shutdown properly
|
|
- proper end to end tests for Jenkins lifecycle
|
|
|
|
## Documentation
|
|
|
|
Go to [**our documentation website**](https://jenkinsci.github.io/kubernetes-operator/) for more information.
|
|
|
|
Selected content:
|
|
1. [Installation](https://jenkinsci.github.io/kubernetes-operator/docs/installation/)
|
|
2. [Getting Started](https://jenkinsci.github.io/kubernetes-operator/docs/getting-started/)
|
|
3. [How it works](https://jenkinsci.github.io/kubernetes-operator/docs/how-it-works/)
|
|
4. [Security](https://jenkinsci.github.io/kubernetes-operator/docs/security/)
|
|
5. [Developer Guide](https://jenkinsci.github.io/kubernetes-operator/docs/developer-guide/)
|
|
5. [Jenkins Custom Resource Definition scheme](https://jenkinsci.github.io/kubernetes-operator/docs/getting-started/latest/scheme/)
|
|
|
|
## Common Issues and Workarounds
|
|
|
|
- Multibranch Pipelines and Backup Issues: https://github.com/jenkinsci/kubernetes-operator/issues/104#issuecomment-554289768
|
|
|
|
## Community
|
|
|
|
We have a dedicated channel called `#jenkins-operator` on [virtuslab-oss.slack.com](https://virtuslab-oss.slack.com)
|
|
Fill out ([Invite form](https://forms.gle/X3X8qA1XMirdBuEH7)) and come say hi !
|
|
|
|
Every Thursday we have a community call at 16:30 CET on [Google Meet](https://meet.google.com/rsf-nhte-gnq). Feel free to join, ask questions and have fun :)
|
|
|
|
## Contribution
|
|
|
|
Feel free to file [issues](https://github.com/jenkinsci/kubernetes-operator/issues) or [pull requests](https://github.com/jenkinsci/kubernetes-operator/pulls).
|
|
|
|
Before any big pull request please consult the maintainers to ensure a common direction.
|
|
|
|
## Presentations
|
|
|
|
- [Jenkins World 2019 Lisbon](assets/Jenkins_World_Lisbon_2019%20-Jenkins_Kubernetes_Operator.pdf)
|
|
- [Jenkins Online Meetup 2020](assets/Jenkins_Online_Meetup-Jenkins_Kubernetes_Operator.pdf)
|
|
|
|
## About the authors
|
|
|
|
This project was originally developed by [VirtusLab](https://virtuslab.com/) and the following [CONTRIBUTORS](https://github.com/jenkinsci/kubernetes-operator/graphs/contributors).
|