Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kurtosis-tech/keycloak-package
A quick way to bootstrap a Keycloak server
https://github.com/kurtosis-tech/keycloak-package
kurtosis kurtosis-package
Last synced: about 2 months ago
JSON representation
A quick way to bootstrap a Keycloak server
- Host: GitHub
- URL: https://github.com/kurtosis-tech/keycloak-package
- Owner: kurtosis-tech
- Created: 2023-05-03T12:02:01.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-06-16T15:27:31.000Z (over 1 year ago)
- Last Synced: 2024-07-08T13:50:00.017Z (2 months ago)
- Topics: kurtosis, kurtosis-package
- Language: Starlark
- Homepage:
- Size: 12.7 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Keycloak Package
============
This is a [Kurtosis package][kurtosis-packages] for starting a Keycloak server with a preconfigured application. This package simplifies and automates the step described in [Keycloak getting started with the Docker version doc][keycloak-docker]
Run this package
----------------
If you have [Kurtosis installed][install-kurtosis], run:
```bash
kurtosis run github.com/kurtosis-tech/keycloak-package
```
When the package finishes initializing you will see a (green) message like this:
```bash
"Now you can use the realm's user credentials [ myuser | RealmPassword321 ] to login into the application already set through this URL: https://www.keycloak.org/app/#url=http://localhost:4770&realm=myrealm&client=myclient You can also use the admin credentials [ admin | admin ] to login into the admin panel throught this URL: http://localhost:4770"
```
Click on the first link to open the Keycloak application example. Using the credentials printed in the message, log in to see how this application is integrated with the Keycloak server that was created with this package.
If you don't have Kurtosis installed, [click here to run this package on the Kurtosis playground](https://gitpod.io/#KURTOSIS_PACKAGE_LOCATOR=https%3A%2F%2Fgithub.com%2Fkurtosis-tech%2Fkeycloak-package).
To blow away the created [enclave][enclaves-reference], run `kurtosis clean -a`.
#### Configuration
Click to see configuration
You can configure this package using the following JSON structure (though note that `//` lines aren't valid JSON, so you must remove them!). The default value each parameter will take if omitted is shown here:
```javascript
{
// The Docker image that will be run
"image": "quay.io/keycloak/keycloak:21.1.1",
// The name given to the service that gets added
"name": "keycloak-server",
// The name of the realm that will be created
"realm": "myrealm",
// The name of the realm's user that will be created
"realm-user": "myuser",
// The password given to the created realm's user
"realm-password": "RealmPassword321",
// The first name given to the created realm's user
"realm-user-first-name": "RealmUserFirstName",
// The last name given to the created realm's user
"realm-user-last-name": "RealmUserLastName",
// The client id used for configuring the application
"client-id": "myclient",
}
```
For example:
```bash
kurtosis run github.com/kurtosis-tech/postgres-package '{"realm": "myrealm", "realm-user": "myuser", "realm-password": "RealmPassword321"}'
```
How this package can growth?
----------------------------
1. Ingrate this package with [Postgres package][postgres-package] using [composability][composability-in-docs]
1. Include a configure an SSL certificate
1. Define your own app and connec it easily with Keycloak server
Develop on this package
-----------------------
1. [Install Kurtosis][install-kurtosis]
1. Clone this repo
1. For your dev loop, run `kurtosis clean -a && kurtosis run .` inside the repo directory
[kurtosis-packages]: https://docs.kurtosis.com/concepts-reference/packages
[install-kurtosis]: https://docs.kurtosis.com/install
[enclaves-reference]: https://docs.kurtosis.com/concepts-reference/enclaves
[keycloak-docker]: https://www.keycloak.org/getting-started/getting-started-docker
[postgres-package]: https://github.com/kurtosis-tech/postgres-package
[composability-in-docs]: https://docs.kurtosis.com/explanations/reusable-environment-definitions#what-does-a-reusable-solution-look-like