Skip to content

Commit

Permalink
Update docu 2.14.0 (#496)
Browse files Browse the repository at this point in the history
* Update docs for 2.14.0 release

* Add logs/GDPR docu
  • Loading branch information
p53 authored Jul 22, 2024
1 parent 2233d0b commit 3b5a07a
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 11 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,13 @@ Please remember to provide a good summary, description as well as steps to repro
To run Gatekeeper, you can build it using this command:

```bash
docker buildx build --platform linux/amd64,linux/arm64 -t quay.io/gogatekeeper/gatekeeper:2.13.0 .
docker buildx build --platform linux/amd64,linux/arm64 -t quay.io/gogatekeeper/gatekeeper:2.14.0 .
```

or you can use aleady existing Docker image by running:

```bash
docker run -it --rm quay.io/gogatekeeper/gatekeeper:2.13.0 \
docker run -it --rm quay.io/gogatekeeper/gatekeeper:2.14.0 \
--listen 127.0.0.1:8080 \
--upstream-url http://127.0.0.1:80 \
--discovery-url https://keycloak.example.com/realms/<REALM_NAME> \
Expand All @@ -44,16 +44,16 @@ Beside links to archives of binaries we provide also checksum file containing ch
for archives. You can download file gatekeeper-checksum.txt, it contains sha512 checksums e.g.:

```
324b34ece86b6214f835ba9fd79e185864a9005f514458796c22c053de63f428235d2d2a04864065a49c090ad81d2daeb45546544fdd9531a8dea1a43145b8f0 gatekeeper_2.13.0_windows_amd64.zip
38759e75a94d130758cd26958bd9a66b261be8d58a6c7a0fc04845157649aaf628d22a115c95285b405f8e4d6afa8bd78ca8677d1304faf06db93a0cbbc831a6 gatekeeper_2.13.0_linux_amd64.tar.gz
f5322e41b3d78017191246bdd54f99e9b3dd8d5ff9d224e7e81b678a952c1d5aae125ea4c251928969b0a0ea0dc59724308c918993c8227f384f61896f58cbd0 gatekeeper_2.13.0_macOS_amd64.tar.gz
324b34ece86b6214f835ba9fd79e185864a9005f514458796c22c053de63f428235d2d2a04864065a49c090ad81d2daeb45546544fdd9531a8dea1a43145b8f0 gatekeeper_2.14.0_windows_amd64.zip
38759e75a94d130758cd26958bd9a66b261be8d58a6c7a0fc04845157649aaf628d22a115c95285b405f8e4d6afa8bd78ca8677d1304faf06db93a0cbbc831a6 gatekeeper_2.14.0_linux_amd64.tar.gz
f5322e41b3d78017191246bdd54f99e9b3dd8d5ff9d224e7e81b678a952c1d5aae125ea4c251928969b0a0ea0dc59724308c918993c8227f384f61896f58cbd0 gatekeeper_2.14.0_macOS_amd64.tar.gz
```

After you download archive of binary you can calculate it's checksum by using e.g. sha512sum Linux utility:

```
sha512sum /my/path/gatekeeper_2.13.0_linux_amd64.tar.gz
38759e75a94d130758cd26958bd9a66b261be8d58a6c7a0fc04845157649aaf628d22a115c95285b405f8e4d6afa8bd78ca8677d1304faf06db93a0cbbc831a6 gatekeeper_2.13.0_linux_amd64.tar.g
sha512sum /my/path/gatekeeper_2.14.0_linux_amd64.tar.gz
38759e75a94d130758cd26958bd9a66b261be8d58a6c7a0fc04845157649aaf628d22a115c95285b405f8e4d6afa8bd78ca8677d1304faf06db93a0cbbc831a6 gatekeeper_2.14.0_linux_amd64.tar.g
```

As you can see output of command is checksum, you can compare it with the one in gatekeeper-checksum.txt.
Expand Down
11 changes: 9 additions & 2 deletions docs/content/userguide/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -470,7 +470,7 @@ in Keycloak, providing granular role controls over issue tokens.

``` yaml
- name: gatekeeper
image: quay.io/gogatekeeper/gatekeeper:2.13.0
image: quay.io/gogatekeeper/gatekeeper:2.14.0
args:
- --enable-forwarding=true
- --forwarding-username=projecta
Expand All @@ -497,7 +497,7 @@ Example setup client credentials grant:

``` yaml
- name: gatekeeper
image: quay.io/gogatekeeper/gatekeeper:2.13.0
image: quay.io/gogatekeeper/gatekeeper:2.14.0
args:
- --enable-forwarding=true
- --forwarding-domains=projecta.svc.cluster.local
Expand Down Expand Up @@ -1284,6 +1284,13 @@ by enabling `--enable-logging` and `--verbose` options. Also you can use `reques
and `enable-request-id` options, which will generate unique uuid and will inject in
header supplied in `request-id-header` option.

## Logs and GDPR

You can enable/disable logging by specifying `--enable-logging` option. This will log all
messages with info log level and higher. It will NOT log any personal sensitive information, like client IP or user email. When you would like to see debug messages you need to use `--verbose=true` option.

**IMPORTANT**: debug messages WILL contain personal information, for easier debugging

## Metrics

Assuming `--enable-metrics` has been set, a Prometheus endpoint can be
Expand Down
2 changes: 1 addition & 1 deletion e2e/k8s/manifest_test_forwardauth.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2626,7 +2626,7 @@ spec:
- -c
- "while true;do sleep 10;done"
- name: proxy
image: quay.io/gogatekeeper/gatekeeper:2.13.0
image: quay.io/gogatekeeper/gatekeeper:2.14.0
imagePullPolicy: Never
args:
- --client-id=test-client
Expand Down
2 changes: 1 addition & 1 deletion kube/reverse.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ spec:
secretName: tls
containers:
- name: proxy
image: quay.io/gogatekeeper/gatekeeper:2.13.0
image: quay.io/gogatekeeper/gatekeeper:2.14.0
imagePullPolicy: Always
args:
- --client-id=broker
Expand Down

0 comments on commit 3b5a07a

Please sign in to comment.