Skip to content

Commit 2a59fc1

Browse files
committed
update templating, add deps
1 parent 4b323ee commit 2a59fc1

8 files changed

Lines changed: 857 additions & 170 deletions

File tree

haproxy_spoe_auth_operator/README.md

Lines changed: 4 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -6,62 +6,22 @@ A Juju charm that deploys and manages HAProxy SPOE Auth on machines.
66

77
HAProxy SPOE Auth is a Stream Processing Offload Engine (SPOE) agent for HAProxy that provides authentication capabilities. This charm simplifies the deployment and management of the agent.
88

9-
## Features
10-
11-
- **OAuth Authentication**: Support for OAuth-based authentication
12-
- **Snap-based Deployment**: Uses the haproxy-spoe-auth snap for easy installation and updates
13-
- **Configuration Management**: Automated configuration file management via Jinja2 templates
149

1510
## Usage
1611

1712
Deploy the charm:
1813

1914
```bash
20-
juju deploy ./haproxy_spoe_auth_operator
21-
```
22-
23-
Configure the SPOE address:
24-
25-
```bash
26-
juju config haproxy-spoe-auth spoe-address="127.0.0.1:3000"
15+
juju deploy haproxy_spoe_auth_operator --channel=latest/edge
2716
```
2817

2918
Integrate with an OAuth provider:
3019

3120
```bash
32-
juju integrate haproxy-spoe-auth oauth-provider
33-
```
34-
35-
## Configuration
36-
37-
- `spoe-address`: Address for SPOE agent to listen on (default: "127.0.0.1:3000")
38-
39-
## Relations
40-
41-
- `oauth` (requires): OAuth authentication provider integration
42-
43-
## Development
44-
45-
This charm is part of the haproxy-operator monorepo.
46-
47-
### Testing
48-
49-
Run unit tests:
50-
```bash
51-
tox -e unit
21+
juju relate haproxy-spoe-auth oauth-provider
5222
```
5323

54-
Run integration tests:
24+
Integrate with haproxy
5525
```bash
56-
tox -e integration
26+
juju relate haproxy-spoe-auth haproxy
5727
```
58-
59-
Run linting:
60-
```bash
61-
tox -e lint
62-
```
63-
64-
## Project Information
65-
66-
- [Source Code](https://github.com/canonical/haproxy-operator)
67-
- [Issue Tracker](https://github.com/canonical/haproxy-operator/issues)

haproxy_spoe_auth_operator/charmcraft.yaml

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -47,13 +47,18 @@ requires:
4747
oauth:
4848
interface: oauth
4949
description: OAuth authentication provider integration
50+
provides:
51+
spoe-auth:
52+
interface: spoe-auth
53+
description: Relation to provide authentication proxy to HAProxy.
54+
limit: 1
5055

5156
config:
52-
options:
53-
spoe-address:
54-
default: "127.0.0.1:3000"
55-
type: string
56-
description: Address for SPOE agent to listen on
57+
hostname:
58+
type: string
59+
description: |
60+
Public hostname of the agent. Used to store client credentials
61+
and to build the redirect URI
5762
5863
charm-libs:
5964
- lib: hydra.oauth

0 commit comments

Comments
 (0)