Skip to content

Commit

Permalink
Address review comments
Browse files Browse the repository at this point in the history
  • Loading branch information
ghislainbourgeois committed May 2, 2023
1 parent 3926158 commit 02f8317
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 6 deletions.
13 changes: 11 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,9 @@

## Description

Let's Encrypt certificates in the Juju ecosystem for answering the DNS-01
challenge through the HTTP Request plugin.
ACME operator implementing the provider side of the `tls-certificates`
interface to get signed certificates from the `Let's Encrypt` ACME server
using the HTTP Request plugin for DNS-01 challenge.

# Pre-requisites

Expand All @@ -17,6 +18,7 @@ Create a YAML configuration file with the following fields:
```yaml
httpreq-acme-operator:
email: <Account email address>
httpreq_endpoint: <HTTP/HTTPS URL>
```

Deploy `httpreq-acme-operator`:
Expand All @@ -36,10 +38,17 @@ juju relate httpreq-acme-operator:certificates <tls-certificates-requirer>
### Required configuration properties

- email: Let's Encrypt email address
- httpreq_endpoint: HTTP/HTTPS URL to the service implementing the HTTPREQ API
### Optional configuration properties
- server: Let's Encrypt server to use (default: `https://acme-v02.api.letsencrypt.org/directory`)
- httpreq_http_timeout: API request timeout
- httpreq_mode: "'RAW' or None"
- httpreq_password: Basic authentication password
- httpreq_polling_interval: Time between DNS propagation checks
- httpreq_propagation_timeout: Maximum waiting time for DNS propagation
- httpreq_username: Basic authentication username

## Relations

Expand Down
4 changes: 0 additions & 4 deletions src/charm.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,6 @@
class HTTPReqAcmeOperatorCharm(AcmeClient):
"""Main class that is instantiated every time an event occurs."""

REQUIRED_CONFIG = [
"HTTPREQ_ENDPOINT",
]

def __init__(self, *args):
"""Uses the acme_client library to manage events."""
super().__init__(*args, plugin="httpreq")
Expand Down

0 comments on commit 02f8317

Please sign in to comment.