From 99d4bf6ee894291d48c992ae670c87d53479f156 Mon Sep 17 00:00:00 2001 From: Motouom Victoire Date: Thu, 7 Nov 2024 10:32:28 +0100 Subject: [PATCH 1/4] Modify(doc): Edit the README file, added a table of content for easy navigation. --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/README.md b/README.md index f69688c84..428365504 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,30 @@ [![codecov](https://codecov.io/gh/adorsys/keycloak-config-cli/branch/main/graph/badge.svg)](https://codecov.io/gh/adorsys/keycloak-config-cli) [![GitHub license](https://img.shields.io/github/license/adorsys/keycloak-config-cli)](https://github.com/adorsys/keycloak-config-cli/blob/main/LICENSE.txt) +# Table of Contents + +1. [Config Files](#config-files) +2. [Variable Substitution](#variable-substitution) + - [Supported Substitutions](#supported-substitutions) +3. [Logging](#logging) + - [JSON Logging Support](#json-logging-support) + - [Log Level](#log-level) +4. [Supported Features](#supported-features) +5. [Compatibility with Keycloak](#compatibility-with-keycloak) +6. [Build this Project](#build-this-project) +7. [Run Integration Tests](#run-integration-tests) +8. [Run this Project](#run-this-project) +9. [Docker](#docker) +10. [Helm](#helm) +11. [Configuration](#configuration) + - [CLI Options / Environment Variables](#cli-options--environment-variables) + - [Keycloak Options](#keycloak-options) + - [Import Options](#import-options) + - [Spring Boot Options](#spring-boot-options) +12. [Perform Release](#perform-release) +13. [Commercial Support](#commercial-support) + + # keycloak-config-cli keycloak-config-cli is a Keycloak utility to ensure the desired configuration state for a realm based on a JSON/YAML file. The format of the JSON/YAML file based on the export realm format. Store and handle the configuration files inside git just like normal code. A Keycloak restart isn't required to apply the configuration. From 3cdcc1d4e1d3e62f5931035f92a7045105156694 Mon Sep 17 00:00:00 2001 From: Motouom Victoire Date: Thu, 7 Nov 2024 16:27:39 +0100 Subject: [PATCH 2/4] Enhancement(doc): Edit the README file, edited the log level config for better readability. --- README.md | 23 +++++++++++++++++++---- 1 file changed, 19 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 428365504..c8f0311ac 100644 --- a/README.md +++ b/README.md @@ -87,13 +87,28 @@ keycloak-config-cli supports logging in JSON format. To enable, set `SPRING_PROF ## Log level +## Log Level Configuration + +The following options allow you to configure the logging levels for different components of the `keycloak-config-cli`. Adjust these settings to control the verbosity of logs generated during execution. + | CLI Option | ENV Variable | Description | Default | |-------------------------------------|---------------------------------|--------------------------------------------------------------------------------------|-------------------------------| -| --logging.level.root | LOGGING_LEVEL_ROOT | define the root log level | `info` | -| --logging.level.keycloak-config-cli | LOGGING_LEVEL_KEYCLOAKCONFIGCLI | log level of keycloak-config-cli components | value of `logging.level.root` | -| --logging.level.http | LOGGING_LEVEL_HTTP | log level http requests between keycloak-config-cli and Keycloak | value of `logging.level.root` | -| --logging.level.realm-config | LOGGING_LEVEL_REALMCONFIG | if set to trace, the realm config including **sensitive information** will be logged | value of `logging.level.root` | +| `--logging.level.root` | `LOGGING_LEVEL_ROOT` | Define the root log level. This setting applies to all loggers unless overridden. | `info` | +| `--logging.level.keycloak-config-cli` | `LOGGING_LEVEL_KEYCLOAKCONFIGCLI` | Log level for keycloak-config-cli components. This can be set to `trace`, `debug`, `info`, `warn`, or `error`. | Value of `logging.level.root` | +| `--logging.level.http` | `LOGGING_LEVEL_HTTP` | Log level for HTTP requests between keycloak-config-cli and Keycloak. | Value of `logging.level.root` | +| `--logging.level.realm-config` | `LOGGING_LEVEL_REALMCONFIG` | If set to `trace`, logs detailed information about realm configuration, including **sensitive information**. | Value of `logging.level.root` | + +### Example Usage +To set the logging level for the Keycloak configuration CLI to debug, you can use the following command: + +```shell +java -jar ./target/keycloak-config-cli.jar \ + --logging.level.keycloak-config-cli=debug \ + --keycloak.url=http://localhost:8080 \ + --keycloak.user=admin \ + --keycloak.password=admin123 \ + --import.files.locations=./contrib/example-config/moped.json # Supported features See: [docs/FEATURES.md](./docs/FEATURES.md) From 86662174c07b98e7abbc9f744dd306f61b55f392 Mon Sep 17 00:00:00 2001 From: Motouom Victoire Date: Fri, 8 Nov 2024 10:29:19 +0100 Subject: [PATCH 3/4] Edit the documentation --- README.md | 57 ++++++++++++++++++++----------------------------------- 1 file changed, 21 insertions(+), 36 deletions(-) diff --git a/README.md b/README.md index c8f0311ac..f6eae8db5 100644 --- a/README.md +++ b/README.md @@ -7,26 +7,26 @@ # Table of Contents -1. [Config Files](#config-files) -2. [Variable Substitution](#variable-substitution) +- [Config Files](#config-files) +- [Variable Substitution](#variable-substitution) - [Supported Substitutions](#supported-substitutions) -3. [Logging](#logging) +- [Logging](#logging) - [JSON Logging Support](#json-logging-support) - [Log Level](#log-level) -4. [Supported Features](#supported-features) -5. [Compatibility with Keycloak](#compatibility-with-keycloak) -6. [Build this Project](#build-this-project) -7. [Run Integration Tests](#run-integration-tests) -8. [Run this Project](#run-this-project) -9. [Docker](#docker) -10. [Helm](#helm) -11. [Configuration](#configuration) - - [CLI Options / Environment Variables](#cli-options--environment-variables) - - [Keycloak Options](#keycloak-options) - - [Import Options](#import-options) - - [Spring Boot Options](#spring-boot-options) -12. [Perform Release](#perform-release) -13. [Commercial Support](#commercial-support) +- [Supported Features](#supported-features) +- [Compatibility with Keycloak](#compatibility-with-keycloak) +- [Build this Project](#build-this-project) +- [Run Integration Tests](#run-integration-tests) +- [Run this Project](#run-this-project) +- [Docker](#docker) +- [Helm](#helm) +- [Configuration](#configuration) + - [CLI Options / Environment Variables](#cli-options--environment-variables) + - [Keycloak Options](#keycloak-options) + - [Import Options](#import-options) + - [Spring Boot Options](#spring-boot-options) +- [Perform Release](#perform-release) +- [Commercial Support](#commercial-support) # keycloak-config-cli @@ -87,28 +87,13 @@ keycloak-config-cli supports logging in JSON format. To enable, set `SPRING_PROF ## Log level -## Log Level Configuration - -The following options allow you to configure the logging levels for different components of the `keycloak-config-cli`. Adjust these settings to control the verbosity of logs generated during execution. - | CLI Option | ENV Variable | Description | Default | |-------------------------------------|---------------------------------|--------------------------------------------------------------------------------------|-------------------------------| -| `--logging.level.root` | `LOGGING_LEVEL_ROOT` | Define the root log level. This setting applies to all loggers unless overridden. | `info` | -| `--logging.level.keycloak-config-cli` | `LOGGING_LEVEL_KEYCLOAKCONFIGCLI` | Log level for keycloak-config-cli components. This can be set to `trace`, `debug`, `info`, `warn`, or `error`. | Value of `logging.level.root` | -| `--logging.level.http` | `LOGGING_LEVEL_HTTP` | Log level for HTTP requests between keycloak-config-cli and Keycloak. | Value of `logging.level.root` | -| `--logging.level.realm-config` | `LOGGING_LEVEL_REALMCONFIG` | If set to `trace`, logs detailed information about realm configuration, including **sensitive information**. | Value of `logging.level.root` | - -### Example Usage +| --logging.level.root | LOGGING_LEVEL_ROOT | define the root log level | `info` | +| --logging.level.keycloak-config-cli | LOGGING_LEVEL_KEYCLOAKCONFIGCLI | log level of keycloak-config-cli components | value of `logging.level.root` | +| --logging.level.http | LOGGING_LEVEL_HTTP | log level http requests between keycloak-config-cli and Keycloak | value of `logging.level.root` | +| --logging.level.realm-config | LOGGING_LEVEL_REALMCONFIG | if set to trace, the realm config including **sensitive information** will be logged | value of `logging.level.root` | -To set the logging level for the Keycloak configuration CLI to debug, you can use the following command: - -```shell -java -jar ./target/keycloak-config-cli.jar \ - --logging.level.keycloak-config-cli=debug \ - --keycloak.url=http://localhost:8080 \ - --keycloak.user=admin \ - --keycloak.password=admin123 \ - --import.files.locations=./contrib/example-config/moped.json # Supported features See: [docs/FEATURES.md](./docs/FEATURES.md) From 01e5a6683213f8df26f15946d5cc6eea2593120d Mon Sep 17 00:00:00 2001 From: Motouom Victoire Date: Fri, 8 Nov 2024 10:30:31 +0100 Subject: [PATCH 4/4] Edit changelog --- CHANGELOG.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 03b86cd91..6bc5787e8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), ## [Unreleased] ### Added +- Add navigation to keycloak-config-cli README [#1185](https://github.com/adorsys/keycloak-config-cli/issues/1099) +### Added - improved logging for realm retrieval errors [#1010](https://github.com/adorsys/keycloak-config-cli/issues/1010) ### Fixed - Fix required action import handling for no-delete option [#834](https://github.com/adorsys/keycloak-config-cli/issues/834)