Jenkins-k8s Documentation Overview

Jenkins-k8s Operator

A Juju charm deploying and managing Jenkins on Kubernetes. Jenkins is an open source automation server. Jenkins provides hundreds of plugins to support building, deploying and automating any project. It can be integrated with both k8s and machine (VM) agents for use.

This charm simplifies initial deployment and operations of Jenkins on Kubernetes, including integration with Jenkins agent instances, automatic patch updates and more. It allows for deployment on many different Kubernetes platforms, from MicroK8s to Charmed Kubernetes to public cloud Kubernetes offerings.

For DevOps or SRE teams this charm will make operating Jenkins simple and straightforward through Juju’s clean interface. It will allow easy deployment into multiple environments for testing of changes, and supports scaling out agents for enterprise deployments.

In this documentation

Tutorials
Get started - a hands-on introduction to using the charm for new users
How-to guides
Step-by-step guides covering key operations and common tasks
Reference
Technical information - specifications, APIs, architecture
Explanation
Concepts - discussion and clarification of key topics

Contributing to this documentation

Documentation is an important part of this project, and we take the same open-source approach to the documentation as the code. As such, we welcome community contributions, suggestions and constructive feedback on our documentation. Our documentation is hosted on the Charmhub forum to enable easy collaboration. Please use the “Help us improve this documentation” links on each documentation page to either directly change something you see that’s wrong, ask a question or make a suggestion about a potential change via the comments section.

If there’s a particular area of documentation that you’d like to see that’s missing, please file a bug.

Project and community

The Jenkins-k8s Operator is a member of the Ubuntu family. It’s an open source project that warmly welcomes community projects, contributions, suggestions, fixes and constructive feedback.

Thinking about using the Jenkins-k8s Operator for your next project? Get in touch!

Navigation

Level Path Navlink
1 tutorial Tutorial
2 tutorial-getting-started Getting Started
1 how-to How to
2 how-to-backup-and-restore-jenkins Backup and restore
2 how-to-configure-installable-plugins Configure installable plugins
2 how-to-configure-jenkins-memory-usage Configure Jenkins memory usage
2 how-to-configure-restart-time-range Configure restart-time-range
2 how-to-get-admin-password Get admin password
2 how-to-integrate-with-external-agents Integrate with external agents
2 how-to-integrate-with-iam Integrate with IAM
2 how-to-integrate-with-machine-agents Integrate with machine agents
2 how-to-redeploy Redeploy
2 how-to-resize-jenkins-storage Resize Jenkins storage
2 how-to-rotate-credentials Rotate credentials
1 reference Reference
2 reference-actions Actions
2 reference-configurations Configurations
2 reference-external-access External access
2 reference-integrations Integrations
1 explanation Explanation
2 explanation-agent-deprecated-relation Agent-deprecated relation