Description
Description
List of all possible Keycloak options still grows as we're adding a lot of new things to Keycloak. It causes the inability to easily find requested options - like cache or DB settings.
We might improve it a little bit, as we could print only the requested options to the user. It'd be good to have a command help that would provide more way on how to add the necessary configuration. The default strategy for the help command (or even for the --help param) would be to show only a title of the category and then message suggesting to execute the command with param below that.
Before:
Database - additional datasources (Preview):
--db-active-<datasource> <true|false>
Preview: Deactivate specific named datasource <datasource>. Default: true.
--db-driver-<datasource> <driver>
Preview: Used for named <datasource>. The fully qualified class name of the
JDBC driver. If not set, a default driver is set accordingly to the chosen
database.
--db-kind-<datasource> <vendor>
Preview: Used for named <datasource>. The database vendor. In production mode
the default value of 'dev-file' is deprecated, you should explicitly
7022
specify
the db instead. Possible values are: dev-file, dev-mem, mariadb, mssql,
mysql, oracle, postgres. Default: dev-file.
--db-password-<datasource> <password>
Preview: Used for named <datasource>. The password of the database user.
--db-pool-initial-size-<datasource> <size>
Preview: Used for named <datasource>. The initial size of the connection pool.
--db-pool-max-size-<datasource> <size>
Preview: Used for named <datasource>. The maximum size of the connection pool.
Default: 100.
--db-pool-min-size-<datasource> <size>
Preview: Used for named <datasource>. The minimal size of the connection pool.
--db-schema-<datasource> <schema>
Preview: Used for named <datasource>. The database schema to be used.
--db-url-database-<datasource> <dbname>
Preview: Used for named <datasource>. Sets the database name of the default
JDBC URL of the chosen vendor. If the `db-url` option is set, this option is
ignored.
--db-url-full-<datasource> <jdbc-url>
Preview: Used for named <datasource>. The full database JDBC URL. If not
provided, a default URL is set based on the selected database vendor. For
instance, if using 'postgres', the default JDBC URL would be 'jdbc:
postgresql://localhost/keycloak'.
--db-url-host-<datasource> <hostname>
Preview: Used for named <datasource>. Sets the hostname of the default JDBC
URL of the chosen vendor. If the `db-url` option is set, this option is
ignored.
--db-url-port-<datasource> <port>
Preview: Used for named <datasource>. Sets the port of the default JDBC URL of
the chosen vendor. If the `db-url` option is set, this option is ignored.
--db-url-properties-<datasource> <properties>
Preview: Used for named <datasource>. Sets the properties of the default JDBC
URL of the chosen vendor. Make sure to set the properties accordingly to the
format expected by the database vendor, as well as appending the right
character at the beginning of this property value. If the `db-url` option is
set, this option is ignored.
--db-username-<datasource> <username>
Preview: Used for named <datasource>. The username of the database user.
After:
Database - additional datasources (Preview):
For listing options of this category, execute command: './kc.sh help datasources'
Some basic categories would be still shown, but the ones that are not used "everyday" might be fetched only via specifying the additional command.
Discussion
No response
Motivation
Improve UX when listing possible configuration options in CLI
Details
No response