From ff804c52a3643a64e860fff1c8bf838f5cc95867 Mon Sep 17 00:00:00 2001 From: ali ugur Date: Wed, 18 Dec 2024 12:33:48 +0300 Subject: [PATCH 1/5] chore(doc): Update README --- README.md | 58 ++++++++++++++++++++++++++++++++++++++++++++++++------- 1 file changed, 51 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index f7ff107..8b73da7 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,56 @@ +[![CharmHub Badge](https://charmhub.io/httprequest-lego-provider/badge.svg)](https://charmhub.io/httprequest-lego-provider) +[![Publish to edge](https://github.com/canonical/httprequest-lego-provider/actions/workflows/publish_charm.yaml/badge.svg)](https://github.com/canonical/httprequest-lego-provider/actions/workflows/publish_charm.yaml) +[![Promote charm](https://github.com/canonical/httprequest-lego-provider/actions/workflows/promote_charm.yaml/badge.svg)](https://github.com/canonical/httprequest-lego-provider/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) + # HTTPRequest Lego Provider -A Django application implementing [HTTPRequest Lego Provider](https://go-acme.github.io/lego/dns/httpreq/). +A Juju charm deploying and managing [HTTP request Lego provider](https://go-acme.github.io/lego/dns/httpreq/) +on Kubernetes. HTTP request Lego provider is a web application implementing the [DNS HTTP request +provider as defined by ACME](https://go-acme.github.io/lego/dns/httpreq/) to manage DNS records. +HTTPRequest Lego Provider is a Let’s Encrypt client. It allows for deployment on +many different Kubernetes platforms, from [MicroK8s](https://microk8s.io) to +[Charmed Kubernetes](https://ubuntu.com/kubernetes) to public cloud Kubernetes +offerings. -## Project and community +Like any Juju charm, this charm supports one-line deployment, configuration, integration, scaling, and more. For Charmed HTTP request Lego provider, this includes: + - Scaling + - Integration with PostgreSQL + +For information about how to deploy, integrate, and manage this charm, see the Official [HTTP request Lego provider Documentation](https://charmhub.io/httprequest-lego-provider/docs). + + +## Get started + +You can follow the tutorial [here](https://charmhub.io/httprequest-lego-provider/docs/tutorial-deploy-the-deploy-the-httprequest-lego-provider-charm-for-the-first-time). + +### Basic operations -The HTTPRequest Lego Provider 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) +The following actions are available for this charm: + - allow-domains: Grant user access to domains. + - create-superuser: Create a new Django superuser account. + - create-user: Create a user for the services that will be requesting the domains. If it exists, the password will be updated. + - list-domains: List the domains an user has access to. + - revoke-domains: Revoke user access to domains. + - rotate-secret-key: Rotate the secret key. Users will be forced to log in again. This might be useful if a security breach occurs. ---- +You can check out the [full list of actions here](https://charmhub.io/httprequest-lego-provider/actions). + +## Integrations + +This charm can be integrated with other Juju charms and services: + + - [Loki](https://charmhub.io/loki-k8s): Loki is a horizontally scalable, highly available, multi-tenant log aggregation system inspired by Prometheus. + - [Postgresql](https://charmhub.io/postgresql-k8s): PostgreSQL is a powerful, open source object-relational database system. It has more than 15 years of active development and a proven architecture that has earned it a strong reputation for reliability, data integrity, and correctness. + +You can find the full list of integrations [here](https://charmhub.io/httprequest-lego-provider/integrations). + +## Learn more +* [Read more](https://charmhub.io/httprequest-lego-provider) +* [Developer documentation](https://go-acme.github.io/lego/dns/httpreq/) +* [Official webpage](https://go-acme.github.io/lego/dns/httpreq/) +* [Troubleshooting](https://matrix.to/#/#charmhub-charmdev:ubuntu.com) +## Project and community +* [Issues](https://github.com/canonical/httprequest-lego-provider/issues) +* [Contributing](https://charmhub.io/httprequest-lego-provider/docs/how-to-contribute) +* [Matrix](https://matrix.to/#/#charmhub-charmdev:ubuntu.com) From 89db56905a67833a9f237b4cb44af8dfbb9559f8 Mon Sep 17 00:00:00 2001 From: ali ugur Date: Wed, 18 Dec 2024 12:58:35 +0300 Subject: [PATCH 2/5] chore(doc): Apply comment --- README.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 8b73da7..ebd552d 100644 --- a/README.md +++ b/README.md @@ -5,10 +5,8 @@ # HTTPRequest Lego Provider -A Juju charm deploying and managing [HTTP request Lego provider](https://go-acme.github.io/lego/dns/httpreq/) -on Kubernetes. HTTP request Lego provider is a web application implementing the [DNS HTTP request -provider as defined by ACME](https://go-acme.github.io/lego/dns/httpreq/) to manage DNS records. -HTTPRequest Lego Provider is a Let’s Encrypt client. It allows for deployment on +A Juju charm deploying and managing [HTTP request Lego provider as defined by ACME](https://go-acme.github.io/lego/dns/httpreq/) +to manage DNS records. It allows for deployment on many different Kubernetes platforms, from [MicroK8s](https://microk8s.io) to [Charmed Kubernetes](https://ubuntu.com/kubernetes) to public cloud Kubernetes offerings. From 9ed9097c59cdf1e58b7f5f42f982d54fd3056f01 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ali=20U=C4=9EUR?= <39213991+alithethird@users.noreply.github.com> Date: Thu, 19 Dec 2024 06:05:49 +0300 Subject: [PATCH 3/5] 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 ebd552d..81ae4af 100644 --- a/README.md +++ b/README.md @@ -39,7 +39,7 @@ You can check out the [full list of actions here](https://charmhub.io/httpreques This charm can be integrated with other Juju charms and services: - [Loki](https://charmhub.io/loki-k8s): Loki is a horizontally scalable, highly available, multi-tenant log aggregation system inspired by Prometheus. - - [Postgresql](https://charmhub.io/postgresql-k8s): PostgreSQL is a powerful, open source object-relational database system. It has more than 15 years of active development and a proven architecture that has earned it a strong reputation for reliability, data integrity, and correctness. + - [PostgreSQL](https://charmhub.io/postgresql-k8s): PostgreSQL is a powerful, open source object-relational database system. You can find the full list of integrations [here](https://charmhub.io/httprequest-lego-provider/integrations). From 0c9a64ac9a635d2a5772a60ccc325cdf34960732 Mon Sep 17 00:00:00 2001 From: ali ugur Date: Thu, 19 Dec 2024 13:05:30 +0300 Subject: [PATCH 4/5] chore(trivy): Add go libraries ignore --- .trivyignore | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/.trivyignore b/.trivyignore index b4a632a..4f3a512 100644 --- a/.trivyignore +++ b/.trivyignore @@ -1,3 +1,5 @@ CVE-2022-40897 CVE-2024-6345 -CVE-2024-34156 # https://github.com/canonical/pebble/issues/498 \ No newline at end of file +CVE-2024-34156 # https://github.com/canonical/pebble/issues/498 +CVE-2024-45338 # golang.org/x/net +CVE-2024-45337 # golang.org/x/crypto From 280d297ebaae95fadb5c330184510a54a5566fc9 Mon Sep 17 00:00:00 2001 From: ali ugur Date: Thu, 9 Jan 2025 10:05:55 +0300 Subject: [PATCH 5/5] chore(): Addressed comments. --- .trivyignore | 2 +- README.md | 4 +--- 2 files changed, 2 insertions(+), 4 deletions(-) diff --git a/.trivyignore b/.trivyignore index 4f3a512..b3226a3 100644 --- a/.trivyignore +++ b/.trivyignore @@ -1,5 +1,5 @@ CVE-2022-40897 CVE-2024-6345 -CVE-2024-34156 # https://github.com/canonical/pebble/issues/498 +# statsd-exporter CVE-2024-45338 # golang.org/x/net CVE-2024-45337 # golang.org/x/crypto diff --git a/README.md b/README.md index 81ae4af..5b41435 100644 --- a/README.md +++ b/README.md @@ -25,12 +25,10 @@ You can follow the tutorial [here](https://charmhub.io/httprequest-lego-provider ### Basic operations The following actions are available for this charm: - - allow-domains: Grant user access to domains. - create-superuser: Create a new Django superuser account. - create-user: Create a user for the services that will be requesting the domains. If it exists, the password will be updated. - list-domains: List the domains an user has access to. - revoke-domains: Revoke user access to domains. - - rotate-secret-key: Rotate the secret key. Users will be forced to log in again. This might be useful if a security breach occurs. You can check out the [full list of actions here](https://charmhub.io/httprequest-lego-provider/actions). @@ -38,7 +36,7 @@ You can check out the [full list of actions here](https://charmhub.io/httpreques This charm can be integrated with other Juju charms and services: - - [Loki](https://charmhub.io/loki-k8s): Loki is a horizontally scalable, highly available, multi-tenant log aggregation system inspired by Prometheus. + - [COS](https://charmhub.io/topics/canonical-observability-stack): Canonical Observability Stack gathers, processes, visualizes, and alerts on telemetry signals generated by workloads running both within, and outside of, Juju. - [PostgreSQL](https://charmhub.io/postgresql-k8s): PostgreSQL is a powerful, open source object-relational database system. You can find the full list of integrations [here](https://charmhub.io/httprequest-lego-provider/integrations).