https://github.com/yyvess/keycloak-timoni

A Timoni module designed for the efficient deployment of Keycloak on Kubernetes clusters.
https://github.com/yyvess/keycloak-timoni

Last synced: about 1 month ago
JSON representation

A Timoni module designed for the efficient deployment of Keycloak on Kubernetes clusters.

• Host: GitHub
• URL: https://github.com/yyvess/keycloak-timoni
• Owner: yyvess
• License: apache-2.0
• Created: 2024-01-23T15:09:50.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-02-04T15:32:19.000Z (about 1 year ago)
• Last Synced: 2024-11-16T15:36:13.210Z (3 months ago)
• Language: CUE
• Homepage:
• Size: 325 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Keycloak Timoni module 

[![Release](https://img.shields.io/github/v/release/yyvess/keycloak-timoni.svg)](https://github.com//yyvess/keycloak-timoni/releases)

[![timoni.sh](https://img.shields.io/badge/timoni.sh-v0.18.0-7e56c2)](https://timoni.sh)

[![kubernetes](https://img.shields.io/badge/kubernetes-v1.29.0-326CE5?logo=kubernetes&logoColor=white)](https://kubernetes.io)

[![License](https://img.shields.io/github/license/nalum/cert-manager-module)](https://github.com/nalum/cert-manager-module/blob/main/LICENSE)

* [Keycloak](https://www.keycloak.org/) is an Open Source Identity and Access Management

* [Timoni.sh](http://timoni.sh) is an alternative of Helm chart based on [CUE](https://cuelang.org/)

A [timoni.sh](http://timoni.sh) module for deploying [keycloak](https://www.keycloak.org/) to Kubernetes clusters.

> [!IMPORTANT]

> Note that module is on beta, any feedback and PR are welcome

## Install

To create a minimum instance, create a file `my-values.cue` with the following content:

```cue

values: {

	admin: {

		password: {value: "admin"}

	}

	extraEnvs: [

		{name: "KC_HOSTNAME_STRICT", value: "false"},

		{name: "KC_LOG_LEVEL", value:       "INFO"},

	]

}

```

And apply the values with:

```shell

timoni -n keycloak apply keycloak oci://ghcr.io/yyvess/keycloak \

--values ./my-values.cue

```

By default, the server uses the **dev-file** database on an empty volume! The dev-file database **is not suitable for production use-cases**, and must be replaced with an others database type on production.

## Uninstall

To uninstall an instance and delete all its Kubernetes resources:

```shell

timoni -n keycloak delete keycloak

```

## Configuration

Some configuration examples can be found on [samples](samples) directory.