Skip to content

Commit

Permalink
A first version
Browse files Browse the repository at this point in the history
  • Loading branch information
YvesZelros authored and yyvess committed Jan 25, 2024
1 parent 8614a5d commit 1781867
Show file tree
Hide file tree
Showing 73 changed files with 11,072 additions and 80 deletions.
39 changes: 39 additions & 0 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
name: Release and sign module
on:
push:
tag: ['*'] # semver format

permissions:
contents: read # needed for checkout
packages: write # needed for GHCR access
id-token: write # needed for signing

jobs:
push:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Setup Cosign
uses: sigstore/cosign-installer@main
- name: Setup Timoni
uses: stefanprodan/timoni/actions/setup@main
- name: Login to GHCR
uses: docker/login-action@v2
with:
registry: ghcr.io
username: ${{ github.actor }}
password: ${{ secrets.GITHUB_TOKEN }}
- name: Vet module
run: |
timoni mod vet . -f test/minimum-values.cue
- name: Push and Sign
run: |
timoni mod push . \
oci://ghcr.io/${{ github.repository_owner }}/keycloak \
--version ${{ github.ref_name }} \
--sign=cosign \
--latest \
-a 'org.opencontainers.image.licenses=Apache-2.0' \
-a 'org.opencontainers.image.source=https://github.com/yyvess/keycloak-timoni' \
-a 'org.opencontainers.image.description=A Keycloakh module.' \
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
/keycloak-timoni.iml
21 changes: 6 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,30 +4,21 @@ A [timoni.sh](http://timoni.sh) module for deploying keycloak to Kubernetes clus

## Install

To create an instance using the default values:

```shell
timoni -n default apply keycloak oci://<container-registry-url>
```

To change the [default configuration](#configuration),
create one or more `values.cue` files and apply them to the instance.

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

```cue
values: {
resources: requests: {
cpu: "100m"
memory: "128Mi"
envs: {
KEYCLOAK_ADMIN_PASSWORD: "admin"
KC_HOSTNAME_STRICT: false
}
}
```

And apply the values with:

```shell
timoni -n default apply keycloak oci://<container-registry-url> \
timoni -n keycloak apply keycloak oci://ghcr.io/yyvess/keycloak \
--values ./my-values.cue
```

Expand All @@ -36,7 +27,7 @@ timoni -n default apply keycloak oci://<container-registry-url> \
To uninstall an instance and delete all its Kubernetes resources:

```shell
timoni -n default delete keycloak
timoni -n keycloak delete keycloak
```

## Configuration
Expand Down
Loading

0 comments on commit 1781867

Please sign in to comment.