Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ISD-2551 update README for jenkins-agent-k8s #52

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 26 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,40 @@
# Jenkins-agent-k8s Operator

[![CharmHub Badge](https://charmhub.io/jenkins-agent-k8s/badge.svg)](https://charmhub.io/jenkins-agent-k8s)
[![Publish to edge](https://github.com/canonical/jenkins-agent-k8s-operator/actions/workflows/publish_charm.yaml/badge.svg)](https://github.com/canonical/jenkins-agent-k8s-operator/actions/workflows/publish_charm.yaml)
[![Promote charm](https://github.com/canonical/jenkins-agent-k8s-operator/actions/workflows/promote_charm.yaml/badge.svg)](https://github.com/canonical/jenkins-agent-k8s-operator/actions/workflows/promote_charm.yaml)
[![Discourse Status](https://img.shields.io/discourse/status?server=https%3A%2F%2Fdiscourse.charmhub.io&style=flat&label=CharmHub%20Discourse)](https://discourse.charmhub.io)

# Jenkins agent k8s operator
A [Juju](https://juju.is/) [charm](https://juju.is/docs/olm/charmed-operators) deploying and managing Jenkins agents on Kubernetes. It is configurable to integrate with a Jenkins charm deployed in another Juju model.

A [Juju](https://juju.is/) [charm](https://juju.is/docs/olm/charmed-operators) for deploying and managing [Jenkins](https://www.jenkins.io/) agents on Kubernetes, configurable to use a Jenkins charm deployed in another Juju model, or to connect to a standalone Jenkins instance.
This charm simplifies the deployment and operations of Jenkins Agent on Kubernetes.

This charm simplifies initial deployment and "day N" operations of Jenkins agent on Kubernetes. It allows for deployment on many different Kubernetes platforms, from [MicroK8s](https://microk8s.io) to [Charmed Kubernetes](https://ubuntu.com/kubernetes/charmed-k8s) and public cloud Kubernetes offerings.
As such, the charm makes it easy for those looking to take control of their own agents whilst keeping operations simple, and gives them the freedom to deploy on the platform of their choice.

As such, the charm makes it easy for those looking to take control of their own agents whilst keeping operations simple, and gives them the freedom to deploy on the Kubernetes platform of their choice.
For DevOps or SRE teams this charm will make operating Jenkins Agent simple and straightforward through Juju's clean interface. It will allow easy deployment into multiple environments for testing changes, and supports scaling out for enterprise deployments.

For DevOps or SRE teams this charm will make operating Jenkins agent simple and straightforward through Juju's clean interface. It will allow easy deployment into multiple environments for testing changes, and supports scaling out for enterprise deployments.
For information about how to deploy, integrate, and manage this charm, see the Official [jenkins-agent-k8s charm Documentation](https://charmhub.io/jenkins-agent-k8s/docs).

## Project and community
## Get started

To begin, refer to the [tutorial](https://charmhub.io/jenkins-agent-k8s/docs/tutorial-getting-started) for step-by-step instructions.

### Basic operations

#### Integrate with the Jenkins-k8s charm

The Jenkins agent 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.
* [Code of conduct](https://ubuntu.com/community/code-of-conduct)
* [Get support](https://discourse.charmhub.io/)
* [Join our online chat](https://app.element.io/#/room/#charmhub-charmdev:ubuntu.com)
* [Contribute](https://charmhub.io/jenkins-agent-k8s-operator/docs/how-to-contribute)
Thinking about using the Jenkins agent k8s operator for your next project?[Get in touch](https://app.element.io/#/room/#charmhub-charmdev:ubuntu.com)!
See the [deploy and integrate k8s agents](https://charmhub.io/jenkins-k8s/docs/tutorial-getting-started#deploy-and-integrate-k8s-agents) section in the jenkins-k8s-operator documentation.

## Learn more

- [Read more](https://charmhub.io/jenkins-agent-k8s/docs)
- [Troubleshooting](https://matrix.to/#/#charmhub-charmdev:ubuntu.com)

Thanhphan1147 marked this conversation as resolved.
Show resolved Hide resolved
## Project and community

---
The Jenkins-agent-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.

For further details,
[see the charm's detailed documentation](https://charmhub.io/jenkins-agent-k8s).
* [Issues](https://github.com/canonical/jenkins-agent-k8s-operator/issues) <!--Link to GitHub issues (if applicable)-->
* [Contributing](https://charmhub.io/jenkins-agent-k8s/docs/how-to-contribute) <!--Link to any contribution guides-->
- [Matrix](https://matrix.to/#/#charmhub-charmdev:ubuntu.com)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- [Matrix](https://matrix.to/#/#charmhub-charmdev:ubuntu.com)
* [Matrix](https://matrix.to/#/#charmhub-charmdev:ubuntu.com)

The rendering looks a little strange with the -


Loading