Add auth documentation #1133
Add auth documentation #1133
Conversation
|
Waiting on review by @smccarthy-ie before merging this. |
| @@ -45,3 +45,6 @@ endif::[] | |||
| * Compatibility with existing Confluent schema registry client applications | |||
|
|
|||
| * Operator-based installation of {registry} on OpenShift | |||
|
|
|||
| * Support for oidc based authentication | |||
|
|
|||
There was a problem hiding this comment.
Suggest spelling out the acronym:
"Support for OpenID Connect (OIDC) authentication"
| [id="registry-security"] | ||
|
|
||
| = Configuring {registry} with Authentication | ||
|
|
There was a problem hiding this comment.
Suggest lowercase "authentication" for consistency with sentence style headings
| This section explains how to configure authentication and authorization for {registry}. In order to configure the authentication the following environment variables should be used: | ||
|
|
||
| .Environment variables for {registry} authentication configuration. | ||
| //[%header,cols="5,5,2,5"] |
There was a problem hiding this comment.
Suggest removing full stop from heading
| |String | ||
| |`false` | ||
| |`KEYCLOAK_URL` | ||
| |The url of the auth server to be used. Must end with `/auth. |
There was a problem hiding this comment.
Suggest: Must end with /auth (add closing backtick)
|
|
||
|
|
||
| .Environment variables for {registry} authentication configuration. | ||
| //[%header,cols="5,5,2,5"] |
There was a problem hiding this comment.
Suggest heading such as:
Default user roles for {registry} authentication
There was a problem hiding this comment.
Copy-paste mistake, sorry.
| |String | ||
| | | ||
| |`KEYCLOAK_API_CLIENT_ID` | ||
| |The client id for the rest API. |
There was a problem hiding this comment.
Suggest "The client ID for the {registry} REST API."
| = Configuring {registry} with Authentication | ||
|
|
||
| This section explains how to configure authentication and authorization for {registry}. In order to configure the authentication the following environment variables should be used: | ||
|
|
There was a problem hiding this comment.
Suggest "This section explains how to configure authentication and authorization for {registry} based on OpenID Connect (OIDC)."
| |`KEYCLOAK_UI_CLIENT_ID` | ||
| |The client id to be used by the user interface | ||
| |String | ||
| |`apicurio-registry` |
There was a problem hiding this comment.
Suggest "The client ID for the {registry} user interface"
|
@carlesarnal All set on this? |
Yes, @smccarthy-ie comments addressed. |
No description provided.