Skip to content

Commit

Permalink
fix(docs): correct formatting in keycloak page (#245)
Browse files Browse the repository at this point in the history
  • Loading branch information
shini4i authored Jan 30, 2024
1 parent 30e02f6 commit 9ff0d9c
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 3 deletions.
4 changes: 4 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,9 @@ build:
tools:
python: "3.11"

python:
install:
- requirements: docs/requirements.txt

mkdocs:
configuration: mkdocs.yml
8 changes: 6 additions & 2 deletions docs/keycloak.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Keycloak integration

## Keycloak

As a prerequisites, we need to have a fully configured realm. Keycloak configuration itself is out of scope of this documentation.

The main requirement is the content of the token. We expect the token to contain `groups` field.
Expand All @@ -9,6 +10,7 @@ Argo-Watcher will compare it with the pre-configured priveleged groups to unders
## Argo-Watcher

The following environment variables are required to enable Keycloak integration:

- `KEYCLOAK_URL` - the url of Keycloak instance, it will enable Keycloak integration
- `KEYCLOAK_REALM` - the name of the realm
- `KEYCLOAK_CLIENT_ID` - the name of the client
Expand All @@ -20,6 +22,8 @@ The usage is quite simple, with enabled Keycloak integration, Argo-Watcher will
Additionally, if the user is in the group listed in `KEYCLOAK_PRIVILEGED_GROUPS`, Argo-Watcher will show the redeploy button on the task details page.

## Roadmap

Currently, we have a very limited configuration options for Keycloak integration. Eventually, we plan to implement the following features:
- [ ] Keycloak token validation on the backend side, to remove the necessity to pass the deploy token in the UI
- [ ] Add RBAC support to restrict redeploy support on a per-application basis

- [x] Keycloak token validation on the backend side, to remove the necessity to pass the deploy token in the UI
- [ ] Add RBAC support to restrict redeploy support on a per-application basis
3 changes: 3 additions & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
mkdocs-material==9.5.6
mkdocs-material-extensions==1.3.1
pymdown-extensions==10.7
6 changes: 5 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,15 @@ site_description: Documentation for Argo-Watcher project
site_author: Vadim Gedz

theme:
name: 'readthedocs'
name: 'material'

nav:
- Home: 'index.md'
- Installation: 'installation.md'
- Git Integration: 'git-integration.md'
- Development: "development.md"
- Keycloak: "keycloak.md"

markdown_extensions:
- pymdownx.tasklist:
custom_checkbox: true

0 comments on commit 9ff0d9c

Please sign in to comment.