Skip to content

Commit

Permalink
Points to lib V4
Browse files Browse the repository at this point in the history
  • Loading branch information
saltiyazan committed Oct 10, 2024
1 parent 784ea23 commit 5726d19
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions interfaces/tls_certificates/v1/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,15 @@

## Usage

This relation interface describes the expected behavior of any charm claiming to be able to provide
This relation interface describes the expected behavior of any charm claiming to be able to provide
or consume TLS certificates.

In most cases, this will be accomplished using the [tls_certificates_interface library V4](https://github.com/canonical/tls-certificates-interface/blob/main/lib/charms/tls_certificates_interface/v4/tls_certificates.py), although charm developers are free to provide alternative libraries as long as they fulfil the behavioural and schematic requirements described in this document.

## Direction

As all Juju relations, the `tls-certificates` interface consists of a provider and a requirer.
One of these, in this case the `provider`, will be expected to create TLS certificates where the
As all Juju relations, the `tls-certificates` interface consists of a provider and a requirer.
One of these, in this case the `provider`, will be expected to create TLS certificates where the
`requirer` will be able to consume and use them for TLS communications.

```mermaid
Expand All @@ -19,7 +21,7 @@ flowchart

## Behavior

Both the requirer and the provider need to adhere to a certain set of criteria to be considered
Both the requirer and the provider need to adhere to a certain set of criteria to be considered
compatible with the interface.

### Requirer
Expand Down Expand Up @@ -66,7 +68,7 @@ The requirer specifies a set of certificate signing requests (CSR's).

[\[JSON Schema\]](./schemas/provider.json)

The provider replies with a certificate, a CA Certificate and a CA chain for each of the
The provider replies with a certificate, a CA Certificate and a CA chain for each of the
Certificate Signing Requests requested by the requirer.

#### Example
Expand Down

0 comments on commit 5726d19

Please sign in to comment.