Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat, docs: merge KF-5546-oidc-provider-dev-branch into main #168

Merged
merged 2 commits into from
Jul 26, 2024
Merged

feat, docs: merge KF-5546-oidc-provider-dev-branch into main #168

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
81318ad
docs: add Limitations section on README (#166)
DnPlas Jul 26, 2024
2b39ad0
feat: integrate with dex-oidc-config interface and remove `public-url…
DnPlas Jul 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions README.md
View file
Open in desktop
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
1 change: 1 addition & 0 deletions charmcraft.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,4 @@ bases:
parts:
charm:
charm-python-packages: [setuptools, pip]
build-packages: [cargo, rustc, pkg-config, libffi-dev, libssl-dev]
6 changes: 1 addition & 5 deletions config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,6 @@ options:
type: string
default: ''
description: OpenID Connect client secret
public-url:
type: string
default: ''
description: Publicly-accessible endpoint for cluster
oidc-scopes:
type: string
default: 'profile email groups'
Expand All @@ -41,4 +37,4 @@ options:
userid-claim:
type: string
default: 'email'
description: OpenID Connect claim whose value will be used as the userid.
description: OpenID Connect claim whose value will be used as the userid.
Loading
Loading