Skip to content

Commit

Permalink
docs: add Limitations section on README
Browse files Browse the repository at this point in the history
Add a section describing how this charm can only be used as an OIDC client when Dex and
Charmed Kubeflow are deployed in the model; otherwise it will fail, as there are multiple
parts of this charm's code that are tightly coupled to those.

Fixes #159
  • Loading branch information
DnPlas committed Jul 25, 2024
1 parent ba6d749 commit fc798d1
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,18 @@ This repository hosts the Kubernetes Python Operator for OIDC Gatekeeper

The OIDC Gatekeeper Operator may be deployed using the Juju command line as follows
```bash
juju deploy oidc-gatekeeper
juju config oidc-gatekeeper client-secret=<client-secret> public-url=http://<public-url>
juju deploy oidc-gatekeeper --trust
juju deploy dex-auth --trust
juju config oidc-gatekeeper client-secret=<client-secret, optional>
juju integrate dex-auth:dex-oidc-config oidc-gatekeeper:dex-oidc-config
```

Upstream documentation can be found at https://github.com/arrikto/oidc-authservice

## Limitations

This charm has been designed around Charmed Kubeflow and it will not work as an OIDC client outside of a model where `dex-auth` and Charmed Kubeflow are deployed. There are currently no plans to change this behaviour.

## Looking for a fully supported platform for MLOps?

Canonical [Charmed Kubeflow](https://charmed-kubeflow.io) is a state of the art, fully supported MLOps platform that helps data scientists collaborate on AI innovation on any cloud from concept to production, offered by Canonical - the publishers of [Ubuntu](https://ubuntu.com).
Expand Down

0 comments on commit fc798d1

Please sign in to comment.