Skip to content

Commit

Permalink
Automated update of Apicurio Registry documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@apicurio-ci
apicurio-ci committed Jan 29, 2024
1 parent 2ad422d commit 31c5c41
Show file tree
Hide file tree
Showing 5 changed files with 159 additions and 153 deletions.
34 changes: 20 additions & 14 deletions registry/docs/apicurio-registry/2.5.x/getting-started/assembly-configuring-the-registry.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -382,12 +382,12 @@ <h2 id="registry-security_registry"><a class="anchor" href="#registry-security_r
<li>
<p>In your Apicurio Registry deployment on OpenShift, set the following Apicurio Registry environment variables to configure authentication using Keycloak:</p>
<table class="tableblock frame-all grid-all stretch table-expandable">
<caption class="title">Table 1. Configuration for Apicurio Registry authentication</caption>
<caption class="title">Table 1. Configuration for Apicurio Registry authentication with Keycloak</caption>
<colgroup>
<col style="width: 31.25%;">
<col style="width: 31.25%;">
<col style="width: 12.5%;">
<col style="width: 25%;">
<col style="width: 29.4117%;">
<col style="width: 35.2941%;">
<col style="width: 11.7647%;">
<col style="width: 23.5295%;">
</colgroup>
<thead>
<tr>
Expand All @@ -400,27 +400,33 @@ <h2 id="registry-security_registry"><a class="anchor" href="#registry-security_r
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>AUTH_ENABLED</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">If set to <code>true</code>, the environment variables that follow are required.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Enables authentication for Apicurio Registry. When set to <code>true</code>, the environment variables that follow are required for authentication using Keycloak.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>KEYCLOAK_URL</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The URL of the Keycloak authentication server to use.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">None</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>KEYCLOAK_REALM</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The URL of the Keycloak authentication server. For example, <code>http://localhost:8080</code>.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">-</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">The Keycloak realm used for authentication.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>KEYCLOAK_REALM</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The Keycloak realm for authentication. For example, <code>registry.</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>registry</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>KEYCLOAK_API_CLIENT_ID</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">-</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>KEYCLOAK_API_CLIENT_ID</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The client ID for the Apicurio Registry REST API.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>registry-api</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>KEYCLOAK_UI_CLIENT_ID</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The client ID for the Apicurio Registry web console.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>apicurio-registry</code></p></td>
</tr>
</tbody>
</table>
Expand Down Expand Up @@ -636,7 +642,7 @@ <h3 id="registry-security-authn-keycloak" class="discrete">Apicurio Registry aut
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>AUTH_ENABLED</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Enables authentication in Apicurio Registry. When set to <code>true</code>, the environment variables that follow are required for authentication in Keycloak.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Enables authentication for Apicurio Registry. When set to <code>true</code>, the environment variables that follow are required for authentication using Keycloak.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td>
</tr>
Expand All @@ -648,7 +654,7 @@ <h3 id="registry-security-authn-keycloak" class="discrete">Apicurio Registry aut
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>KEYCLOAK_REALM</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The Keycloak realm for authentication. For example,<code>registry.</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The Keycloak realm for authentication. For example, <code>registry.</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">-</p></td>
</tr>
Expand Down
4 changes: 2 additions & 2 deletions ...icurio-registry/2.5.x/getting-started/assembly-installing-registry-storage-openshift.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -346,7 +346,7 @@ <h2 id="installing-kafka-streams-operatorhub_registry"><a class="anchor" href="#
<p><a href="https://docs.openshift.com/container-platform/latest/operators/admin/olm-adding-operators-to-cluster.html">Adding Operators to an OpenShift cluster</a></p>
</li>
<li>
<p><a href="https://access.redhat.com/documentation/en-us/red_hat_amq_streams/2.5/html-single/deploying_and_managing_amq_streams_on_openshift/index">Deploying and Managing AMQ Streams on OpenShift</a></p>
<p><a href="https://access.redhat.com/documentation/en-us/red_hat_amq_streams/2.6/html-single/deploying_and_managing_amq_streams_on_openshift/index">Deploying and Managing AMQ Streams on OpenShift</a></p>
</li>
</ul>
</div>
Expand Down Expand Up @@ -400,7 +400,7 @@ <h2 id="setting-up-kafka-streams-storage_registry"><a class="anchor" href="#sett
<i class="fa icon-warning" title="Warning"></i>
</td>
<td class="content">
The default example creates a cluster with 3 Zookeeper nodes and 3 Kafka nodes with <code>ephemeral</code> storage. This temporary storage is suitable for development and testing only, and not for production. For more details, see <a href="https://access.redhat.com/documentation/en-us/red_hat_amq_streams/2.5/html-single/deploying_and_managing_amq_streams_on_openshift/index">Deploying and Managing AMQ Streams on OpenShift</a>.
The default example creates a cluster with 3 Zookeeper nodes and 3 Kafka nodes with <code>ephemeral</code> storage. This temporary storage is suitable for development and testing only, and not for production. For more details, see <a href="https://access.redhat.com/documentation/en-us/red_hat_amq_streams/2.6/html-single/deploying_and_managing_amq_streams_on_openshift/index">Deploying and Managing AMQ Streams on OpenShift</a>.
</td>
</tr>
</table>
Expand Down
2 changes: 1 addition & 1 deletion registry/docs/search-index.js
View file

Large diffs are not rendered by default.

50 changes: 25 additions & 25 deletions registry/docs/sitemap-apicurio-registry-operator.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,102 +2,102 @@
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>https://www.apicur.io/registry/docs/apicurio-registry-operator/1.2.0-dev-v2.x/index.html</loc>
<lastmod>2024-01-02T12:57:31.749Z</lastmod>
<lastmod>2024-01-29T16:20:03.824Z</lastmod>
</url>
<url>
<loc>https://www.apicur.io/registry/docs/apicurio-registry-operator/1.2.0-dev-v2.x/assembly-registry-maintenance.html</loc>
<lastmod>2024-01-02T12:57:31.749Z</lastmod>
<lastmod>2024-01-29T16:20:03.824Z</lastmod>
</url>
<url>
<loc>https://www.apicur.io/registry/docs/apicurio-registry-operator/1.2.0-dev-v2.x/assembly-operator-quickstart.html</loc>
<lastmod>2024-01-02T12:57:31.749Z</lastmod>
<lastmod>2024-01-29T16:20:03.824Z</lastmod>
</url>
<url>
<loc>https://www.apicur.io/registry/docs/apicurio-registry-operator/1.2.0-dev-v2.x/assembly-operator-installation.html</loc>
<lastmod>2024-01-02T12:57:31.749Z</lastmod>
<lastmod>2024-01-29T16:20:03.824Z</lastmod>
</url>
<url>
<loc>https://www.apicur.io/registry/docs/apicurio-registry-operator/1.2.0-dev-v2.x/assembly-operator-configuration.html</loc>
<lastmod>2024-01-02T12:57:31.749Z</lastmod>
<lastmod>2024-01-29T16:20:03.824Z</lastmod>
</url>
<url>
<loc>https://www.apicur.io/registry/docs/apicurio-registry-operator/1.2.0-dev-v2.x/assembly-registry-storage.html</loc>
<lastmod>2024-01-02T12:57:31.749Z</lastmod>
<lastmod>2024-01-29T16:20:03.824Z</lastmod>
</url>
<url>
<loc>https://www.apicur.io/registry/docs/apicurio-registry-operator/1.1.0-v2.4.12.final/assembly-registry-storage.html</loc>
<lastmod>2024-01-02T12:57:31.749Z</lastmod>
<lastmod>2024-01-29T16:20:03.824Z</lastmod>
</url>
<url>
<loc>https://www.apicur.io/registry/docs/apicurio-registry-operator/1.1.0-v2.4.12.final/assembly-operator-configuration.html</loc>
<lastmod>2024-01-02T12:57:31.749Z</lastmod>
<lastmod>2024-01-29T16:20:03.824Z</lastmod>
</url>
<url>
<loc>https://www.apicur.io/registry/docs/apicurio-registry-operator/1.1.0-v2.4.12.final/assembly-operator-installation.html</loc>
<lastmod>2024-01-02T12:57:31.749Z</lastmod>
<lastmod>2024-01-29T16:20:03.824Z</lastmod>
</url>
<url>
<loc>https://www.apicur.io/registry/docs/apicurio-registry-operator/1.1.0-v2.4.12.final/assembly-operator-quickstart.html</loc>
<lastmod>2024-01-02T12:57:31.749Z</lastmod>
<lastmod>2024-01-29T16:20:03.824Z</lastmod>
</url>
<url>
<loc>https://www.apicur.io/registry/docs/apicurio-registry-operator/1.1.0-v2.4.12.final/assembly-registry-maintenance.html</loc>
<lastmod>2024-01-02T12:57:31.749Z</lastmod>
<lastmod>2024-01-29T16:20:03.824Z</lastmod>
</url>
<url>
<loc>https://www.apicur.io/registry/docs/apicurio-registry-operator/1.1.0-v2.4.12.final/index.html</loc>
<lastmod>2024-01-02T12:57:31.749Z</lastmod>
<lastmod>2024-01-29T16:20:03.824Z</lastmod>
</url>
<url>
<loc>https://www.apicur.io/registry/docs/apicurio-registry-operator/1.0.0/index.html</loc>
<lastmod>2024-01-02T12:57:31.749Z</lastmod>
<lastmod>2024-01-29T16:20:03.824Z</lastmod>
</url>
<url>
<loc>https://www.apicur.io/registry/docs/apicurio-registry-operator/1.0.0/assembly-operator-configuration.html</loc>
<lastmod>2024-01-02T12:57:31.749Z</lastmod>
<lastmod>2024-01-29T16:20:03.824Z</lastmod>
</url>
<url>
<loc>https://www.apicur.io/registry/docs/apicurio-registry-operator/1.0.0/assembly-operator-installation.html</loc>
<lastmod>2024-01-02T12:57:31.749Z</lastmod>
<lastmod>2024-01-29T16:20:03.824Z</lastmod>
</url>
<url>
<loc>https://www.apicur.io/registry/docs/apicurio-registry-operator/1.0.0/assembly-operator-quickstart.html</loc>
<lastmod>2024-01-02T12:57:31.749Z</lastmod>
<lastmod>2024-01-29T16:20:03.824Z</lastmod>
</url>
<url>
<loc>https://www.apicur.io/registry/docs/apicurio-registry-operator/1.0.0/assembly-registry-maintenance.html</loc>
<lastmod>2024-01-02T12:57:31.749Z</lastmod>
<lastmod>2024-01-29T16:20:03.824Z</lastmod>
</url>
<url>
<loc>https://www.apicur.io/registry/docs/apicurio-registry-operator/1.0.0/assembly-registry-storage.html</loc>
<lastmod>2024-01-02T12:57:31.749Z</lastmod>
<lastmod>2024-01-29T16:20:03.824Z</lastmod>
</url>
<url>
<loc>https://www.apicur.io/registry/docs/apicurio-registry-operator/0.0.4/assembly-operator-dev-quickstart-minikube.html</loc>
<lastmod>2024-01-02T12:57:31.749Z</lastmod>
<lastmod>2024-01-29T16:20:03.824Z</lastmod>
</url>
<url>
<loc>https://www.apicur.io/registry/docs/apicurio-registry-operator/0.0.4/index.html</loc>
<lastmod>2024-01-02T12:57:31.749Z</lastmod>
<lastmod>2024-01-29T16:20:03.824Z</lastmod>
</url>
<url>
<loc>https://www.apicur.io/registry/docs/apicurio-registry-operator/0.0.4/assembly-registry-storage.html</loc>
<lastmod>2024-01-02T12:57:31.749Z</lastmod>
<lastmod>2024-01-29T16:20:03.824Z</lastmod>
</url>
<url>
<loc>https://www.apicur.io/registry/docs/apicurio-registry-operator/0.0.4/assembly-registry-maintenance.html</loc>
<lastmod>2024-01-02T12:57:31.749Z</lastmod>
<lastmod>2024-01-29T16:20:03.824Z</lastmod>
</url>
<url>
<loc>https://www.apicur.io/registry/docs/apicurio-registry-operator/0.0.4/assembly-operator-quickstart.html</loc>
<lastmod>2024-01-02T12:57:31.749Z</lastmod>
<lastmod>2024-01-29T16:20:03.824Z</lastmod>
</url>
<url>
<loc>https://www.apicur.io/registry/docs/apicurio-registry-operator/0.0.4/assembly-operator-installation.html</loc>
<lastmod>2024-01-02T12:57:31.749Z</lastmod>
<lastmod>2024-01-29T16:20:03.824Z</lastmod>
</url>
<url>
<loc>https://www.apicur.io/registry/docs/apicurio-registry-operator/0.0.4/assembly-operator-configuration.html</loc>
<lastmod>2024-01-02T12:57:31.749Z</lastmod>
<lastmod>2024-01-29T16:20:03.824Z</lastmod>
</url>
</urlset>
Loading

0 comments on commit 31c5c41

Please sign in to comment.