From 6e4b0ff1791823b5771c2c55c2780bfb826f8cf2 Mon Sep 17 00:00:00 2001 From: SravanThotakura05 <83568543+SravanThotakura05@users.noreply.github.com> Date: Thu, 14 Mar 2024 19:52:05 +0530 Subject: [PATCH] Documentation update --- .../ROOT/pages/includes/quarkus-solace.adoc | 32 +++++++++++++++++++ docs/modules/ROOT/pages/index.adoc | 24 ++++++++++++-- 2 files changed, 54 insertions(+), 2 deletions(-) diff --git a/docs/modules/ROOT/pages/includes/quarkus-solace.adoc b/docs/modules/ROOT/pages/includes/quarkus-solace.adoc index b5eedf9..9a9ec4d 100644 --- a/docs/modules/ROOT/pages/includes/quarkus-solace.adoc +++ b/docs/modules/ROOT/pages/includes/quarkus-solace.adoc @@ -193,4 +193,36 @@ endif::add-copy-button-to-env-var[] --|`Map` | +a| [[quarkus-solace_quarkus.solace-oidc-client-name]]`link:#quarkus-solace_quarkus.solace-oidc-client-name[quarkus.solace.oidc.client-name]` + + +[.description] +-- +Optional value to configure client name provided in oidc client configuration in extension. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SOLACE_OIDC_CLIENT-NAMEL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SOLACE_OIDC_CLIENT-NAME+++` +endif::add-copy-button-to-env-var[] +--|`Map` +| + +a| [[quarkus-solace_quarkus.solace-oidc-refresh-interval]]`link:#quarkus-solace_quarkus.solace-oidc-refresh-interval[quarkus.solace.oidc.refresh.interval]` + + +[.description] +-- +Interval in seconds to fetch new access token by extension and update current solace session. This interval should be less than access token expiry time. For example if access token expires in 60s then refresh interval should be configured to 50s. The interval time should make sure that extension has sufficient time to fetch and update access token. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SOLACE_OIDC_REFRESH_INTERVAL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SOLACE_OIDC_REFRESH_INTERVAL+++` +endif::add-copy-button-to-env-var[] +--|`Map` +| + |=== \ No newline at end of file diff --git a/docs/modules/ROOT/pages/index.adoc b/docs/modules/ROOT/pages/index.adoc index ebbd2fc..04a677b 100644 --- a/docs/modules/ROOT/pages/index.adoc +++ b/docs/modules/ROOT/pages/index.adoc @@ -101,7 +101,7 @@ quarkus.solace.tls.trust-store-type= quarkus.solace.tls.trust-store-password= ---- -{empty}3. Connecting to a standalone broker with TLS, trust store and client certificate authentication. In case of client certificate authentication broker will read from configured username source(ex: Common Name, Subject Alt Name etc...). Refer to https://docs.solace.com/Security/Configuring-Client-Authentication.htm#Client-Cert[Solace Client Certificate Authentication]. +{empty}4. Connecting to a standalone broker with TLS, trust store and client certificate authentication. In case of client certificate authentication broker will read from configured username source(ex: Common Name, Subject Alt Name etc...). Refer to https://docs.solace.com/Security/Configuring-Client-Authentication.htm#Client-Cert[Solace Client Certificate Authentication]. [source,yaml] ---- quarkus.solace.host=tcps://localhost:55443 @@ -115,7 +115,27 @@ quarkus.solace.authentication.client-cert.keystore-password= quarkus.solace.authentication.client-cert.keystore-format= ---- -{empty}4. Connecting to a HA broker. Here you can configure both active and standby URL and the client will switch connectivity based on availability. +{empty}5. Connecting to a standalone broker with OAUTH authentication scheme. +[source,yaml] +---- +quarkus.solace.host=tcp://localhost:55555 +quarkus.solace.vpn=default +quarkus.solace.authentication.scheme=AUTHENTICATION_SCHEME_OAUTH2 +quarkus.solace.oidc.client-name=solace +quarkus.solace.oidc.refresh.interval=50s + +quarkus.oidc-client.solace.auth-server-url=http://localhost:7777/auth/realms/master +quarkus.oidc-client.solace.client-id= +quarkus.oidc-client.solace.credentials.secret= +# 'client' is a shortcut for `client_credentials` +quarkus.oidc-client.solace.grant.type=client +---- + +For more details on Quarkus OIDC client supported configuration please refer to https://quarkus.io/guides/security-openid-connect-client-reference[OPENID CONNECT (OIDC) AND OAUTH2 CLIENT AND FILTERS] + +NOTE: The current version is tested with client_credentials grant type where Solace broker is configured as Resource Server. + +{empty}6. Connecting to a HA broker. Here you can configure both active and standby URL and the client will switch connectivity based on availability. Remaining configurations and authentication mechanisms can be used as-is. [source,yaml] ---- quarkus.solace.host=tcp://active-host-name:55555,tcp://standby-host-name:55555