From 17171d530f98b0002483b3c377bba32057a6bf12 Mon Sep 17 00:00:00 2001 From: Phan Trung Thanh Date: Fri, 20 Dec 2024 15:55:19 +0100 Subject: [PATCH 1/8] Update README.md --- README.md | 40 ++++++++++++++++++++++++---------------- 1 file changed, 24 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 05c2f41..edd0cca 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,37 @@ +# 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) +[![Discourse Status](https://img.shields.io/discourse/status?server=https%3A%2F%2Fdiscourse.charmhub.io&style=flat&label=CharmHub%20Discourse)](https://discourse.charmhub.io)A [Juju](https://juju.is/) [charm](https://juju.is/docs/olm/charmed-operators) deploying and managing Jenkins agents on machines. It is configurable to integrate with a Jenkins charm deployed in another Juju model. -# Jenkins agent k8s operator +This charm simplifies initial deployment and "day N" operations of Jenkins Agent on Kubernetes. -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. +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. -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. +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. -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 information about how to deploy, integrate, and manage this charm, see the Official [jenkins-agent charm Documentation](https://charmhub.io/jenkins-agent-k8s/docs). -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. +## Get started -## Project and community +To begin, refer to the [Getting Started](https://charmhub.io/jenkins-agent-k8s/docs/tutorial-getting-started) tutorial 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) + +## 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) +* [Contributing](https://charmhub.io/jenkins-agent-k8s#contributing-to-this-documentation) +- [Matrix](https://matrix.to/#/#charmhub-charmdev:ubuntu.com) From 59bf83b0f93f7b09bf38dbe10b76c7bbfd21e217 Mon Sep 17 00:00:00 2001 From: Phan Trung Thanh Date: Fri, 20 Dec 2024 15:57:52 +0100 Subject: [PATCH 2/8] Update README.md --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index edd0cca..ef74b4a 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,9 @@ [![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)A [Juju](https://juju.is/) [charm](https://juju.is/docs/olm/charmed-operators) deploying and managing Jenkins agents on machines. It is configurable to integrate with a Jenkins charm deployed in another Juju model. +[![Discourse Status](https://img.shields.io/discourse/status?server=https%3A%2F%2Fdiscourse.charmhub.io&style=flat&label=CharmHub%20Discourse)](https://discourse.charmhub.io) + +A [Juju](https://juju.is/) [charm](https://juju.is/docs/olm/charmed-operators) deploying and managing Jenkins agents on machines. It is configurable to integrate with a Jenkins charm deployed in another Juju model. This charm simplifies initial deployment and "day N" operations of Jenkins Agent on Kubernetes. From 9e115ecb2279ef1517a9170c844f6eb985be7876 Mon Sep 17 00:00:00 2001 From: Phan Trung Thanh Date: Fri, 20 Dec 2024 15:58:07 +0100 Subject: [PATCH 3/8] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ef74b4a..e2662c8 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ As such, the charm makes it easy for those looking to take control of their own 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 charm Documentation](https://charmhub.io/jenkins-agent-k8s/docs). +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). ## Get started From fc2afcff2b27c6b0edb1153ec23f1dc42399f3a8 Mon Sep 17 00:00:00 2001 From: Phan Trung Thanh Date: Fri, 20 Dec 2024 16:16:57 +0100 Subject: [PATCH 4/8] Update README.md Co-authored-by: Erin Conley --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e2662c8..9330857 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ A [Juju](https://juju.is/) [charm](https://juju.is/docs/olm/charmed-operators) deploying and managing Jenkins agents on machines. It is configurable to integrate with a Jenkins charm deployed in another Juju model. -This charm simplifies initial deployment and "day N" operations of Jenkins Agent on Kubernetes. +This charm simplifies the deployment and operations of Jenkins Agent on Kubernetes. 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. From ad42e968e69f23a38c2adb2a305f0db7d185c837 Mon Sep 17 00:00:00 2001 From: Phan Trung Thanh Date: Fri, 20 Dec 2024 16:17:05 +0100 Subject: [PATCH 5/8] Update README.md Co-authored-by: Erin Conley --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 9330857..984823e 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ For information about how to deploy, integrate, and manage this charm, see the O ## Get started -To begin, refer to the [Getting Started](https://charmhub.io/jenkins-agent-k8s/docs/tutorial-getting-started) tutorial for step-by-step instructions. +To begin, refer to the [tutorial](https://charmhub.io/jenkins-agent-k8s/docs/tutorial-getting-started) for step-by-step instructions. ### Basic operations From a1afb4f76fe590a7066fddb51a3ceb1d2a9a64a6 Mon Sep 17 00:00:00 2001 From: Phan Trung Thanh Date: Fri, 20 Dec 2024 16:18:55 +0100 Subject: [PATCH 6/8] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 984823e..3554184 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ [![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) -A [Juju](https://juju.is/) [charm](https://juju.is/docs/olm/charmed-operators) deploying and managing Jenkins agents on machines. 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) deploying and managing Jenkins agents on Kubernetes. It is configurable to integrate with a Jenkins charm deployed in another Juju model. This charm simplifies the deployment and operations of Jenkins Agent on Kubernetes. From 3c64ebc642c9ae4720dbbe99d1e5e5bfc43f6c5e Mon Sep 17 00:00:00 2001 From: Phan Trung Thanh Date: Fri, 20 Dec 2024 16:19:41 +0100 Subject: [PATCH 7/8] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 3554184..d66167e 100644 --- a/README.md +++ b/README.md @@ -34,6 +34,6 @@ See the [deploy and integrate k8s agents](https://charmhub.io/jenkins-k8s/docs/t 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. * [Issues](https://github.com/canonical/jenkins-agent-k8s-operator/issues) -* [Contributing](https://charmhub.io/jenkins-agent-k8s#contributing-to-this-documentation) +* [Contributing](https://charmhub.io/jenkins-agent-k8s/docs/how-to-contribute) - [Matrix](https://matrix.to/#/#charmhub-charmdev:ubuntu.com) From 838d908b65101903b54b3059d1261c03435a04d6 Mon Sep 17 00:00:00 2001 From: Phan Trung Thanh Date: Fri, 20 Dec 2024 16:28:26 +0100 Subject: [PATCH 8/8] Update README.md --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index d66167e..9eee06a 100644 --- a/README.md +++ b/README.md @@ -28,6 +28,7 @@ See the [deploy and integrate k8s agents](https://charmhub.io/jenkins-k8s/docs/t ## Learn more - [Read more](https://charmhub.io/jenkins-agent-k8s/docs) +- [Troubleshooting](https://matrix.to/#/#charmhub-charmdev:ubuntu.com) ## Project and community