Automated Publishing of Documentation for Apicurio Registry

Author: apicurio-ci

registry/docs/apicurio-registry/3.1.x/getting-started/assembly-configuring-the-registry.html

@@ -667,10 +667,10 @@ <h3 id="_backwards_compatibility" class="discrete">Backwards compatibility</h3>
 <div class="ulist">
 <ul>
 <li>
-<p>The existing Prometheus metrics endpoint (<code>/q/metrics</code>) remains available and unchanged.</p>
+<p>The Prometheus metrics endpoint is available at <code>/metrics</code> on the management port (default 9000).</p>
 </li>
 <li>
-<p>Health check endpoints (<code>/q/health/*</code>) continue to work as before.</p>
+<p>Health check endpoints (<code>/health/ready</code>, <code>/health/live</code>) are served on the management port (default 9000).</p>
 </li>
 <li>
 <p>All existing Micrometer-based metrics continue to function.</p>
@@ -694,6 +694,9 @@ <h3 id="_backwards_compatibility" class="discrete">Backwards compatibility</h3>
 <div class="sect2">
 <h3 id="configuring-liveness-readiness-probes_registry"><a class="anchor" href="#configuring-liveness-readiness-probes_registry"></a>Configuring Apicurio Registry health checks on OpenShift</h3>
 <div class="paragraph _abstract">
+<p>Health check endpoints are served on the management interface (port 9000 by default), separate from the main application port (8080). Configure liveness and readiness probes to target port 9000.</p>
+</div>
+<div class="paragraph">
 <p>You can configure optional environment variables for liveness and readiness probes to monitor the health of the Apicurio Registry server on OpenShift:</p>
 </div>
 <div class="ulist">

registry/docs/apicurio-registry/3.1.x/getting-started/assembly-registry-high-availability.html

@@ -849,7 +849,7 @@ <h2 id="ha-monitoring_registry"><a class="anchor" href="#ha-monitoring_registry"
 <div class="sect2">
 <h3 id="_enabling_metrics"><a class="anchor" href="#_enabling_metrics"></a>Enabling metrics</h3>
 <div class="paragraph">
-<p>Metrics are enabled by default. Access the metrics endpoint at <code>/q/metrics</code>.</p>
+<p>Metrics are enabled by default. Access the metrics endpoint at <code>/metrics</code> on the management port (default 9000).</p>
 </div>
 </div>
 <div class="sect2">
@@ -896,10 +896,10 @@ <h3 id="_key_metrics_to_monitor"><a class="anchor" href="#_key_metrics_to_monito
 <div class="ulist">
 <ul>
 <li>
-<p>Readiness probe: <code>/q/health/ready</code></p>
+<p>Readiness probe: <code>/health/ready</code> (on management port 9000)</p>
 </li>
 <li>
-<p>Liveness probe: <code>/q/health/live</code></p>
+<p>Liveness probe: <code>/health/live</code> (on management port 9000)</p>
 </li>
 </ul>
 </div>
@@ -938,8 +938,8 @@ <h3 id="_configuring_servicemonitor_for_prometheus_operator"><a class="anchor" h
     matchLabels:
       app: apicurio-registry
   endpoints:
-    - port: http
-      path: /q/metrics
+    - port: management
+      path: /metrics
       interval: 30s</code></pre>
 </div>
 </div>
@@ -1054,6 +1054,49 @@ <h3 id="_safe_update_practices"><a class="anchor" href="#_safe_update_practices"
 </table>
 </div>
 </div>
+<div class="sect2">
+<h3 id="_upgrading_to_the_management_interface_port_9000"><a class="anchor" href="#_upgrading_to_the_management_interface_port_9000"></a>Upgrading to the management interface (port 9000)</h3>
+<div class="paragraph">
+<p>Starting with Apicurio Registry 3.x, health check and metrics endpoints are served on a dedicated management port (9000) instead of the main application port (8080). This is a <strong>breaking change</strong> that requires updates to your deployment configuration when upgrading from earlier versions.</p>
+</div>
+<div class="paragraph">
+<p>The following items must be updated:</p>
+</div>
+<div class="ulist">
+<ul>
+<li>
+<p><strong>Kubernetes liveness and readiness probes</strong> - Update probe definitions to target port <code>9000</code> instead of port <code>8080</code>. The endpoint paths (<code>/health/ready</code> and <code>/health/live</code>) remain the same.</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlightjs highlight"><code class="language-yaml hljs" data-lang="yaml"># Before (old configuration)
+livenessProbe:
+  httpGet:
+    path: /health/live
+    port: 8080
+
+# After (new configuration)
+livenessProbe:
+  httpGet:
+    path: /health/live
+    port: 9000</code></pre>
+</div>
+</div>
+</li>
+<li>
+<p><strong>Prometheus scrape targets</strong> - Update your Prometheus configuration or <code>ServiceMonitor</code> resources to scrape metrics from port <code>9000</code> at path <code>/metrics</code>.</p>
+</li>
+<li>
+<p><strong>Network policies</strong> - If you use Kubernetes <code>NetworkPolicy</code> resources, ensure that ingress traffic on port <code>9000</code> is allowed from your monitoring infrastructure and the kubelet (for health probes).</p>
+</li>
+<li>
+<p><strong>TLS considerations</strong> - The management interface runs as a separate HTTP server and is <strong>not affected</strong> by TLS configuration on the application port. Health probes should always use <code>scheme: HTTP</code> with port <code>9000</code>, even if TLS is enabled on the main application port (8443).</p>
+</li>
+<li>
+<p><strong>Apicurio Registry Operator managed deployments</strong> - If you are using the Apicurio Registry Operator, it will automatically configure the correct probe ports. No manual changes are required for operator-managed deployments.</p>
+</li>
+</ul>
+</div>
+</div>
 </div>
 </div>
 <div class="sect1">
@@ -1208,8 +1251,7 @@ <h3 id="_testing_backup_and_restore"><a class="anchor" href="#_testing_backup_an
 <p>For Kafka HA configuration with Strimzi, 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>.</p>
 </li>
 <li>
-<p>For health checks and metrics, see the
-<a href="/q/health">Health UI</a> and <a href="/q/metrics">Metrics endpoint</a> in your Apicurio Registry deployment.</p>
+<p>For health checks and metrics, see the health endpoint (<code>/health/ready</code> on management port 9000) and metrics endpoint (<code>/metrics</code> on management port 9000) in your Apicurio Registry deployment.</p>
 </li>
 </ul>
 </div>

registry/docs/search-index.js

@@ -2,126 +2,126 @@
 <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.6.x/assembly-operator-configuration.html</loc>
-<lastmod>2026-03-06T10:51:01.099Z</lastmod>
+<lastmod>2026-03-06T11:03:15.818Z</lastmod>
 </url>
 <url>
 <loc>https://www.apicur.io/registry/docs/apicurio-registry-operator/1.2.0-dev-v2.6.x/assembly-operator-installation.html</loc>
-<lastmod>2026-03-06T10:51:01.099Z</lastmod>
+<lastmod>2026-03-06T11:03:15.818Z</lastmod>
 </url>
 <url>
 <loc>https://www.apicur.io/registry/docs/apicurio-registry-operator/1.2.0-dev-v2.6.x/assembly-operator-quickstart.html</loc>
-<lastmod>2026-03-06T10:51:01.099Z</lastmod>
+<lastmod>2026-03-06T11:03:15.818Z</lastmod>
 </url>
 <url>
 <loc>https://www.apicur.io/registry/docs/apicurio-registry-operator/1.2.0-dev-v2.6.x/assembly-registry-maintenance.html</loc>
-<lastmod>2026-03-06T10:51:01.099Z</lastmod>
+<lastmod>2026-03-06T11:03:15.818Z</lastmod>
 </url>
 <url>
 <loc>https://www.apicur.io/registry/docs/apicurio-registry-operator/1.2.0-dev-v2.6.x/assembly-registry-storage.html</loc>
-<lastmod>2026-03-06T10:51:01.099Z</lastmod>
+<lastmod>2026-03-06T11:03:15.818Z</lastmod>
 </url>
 <url>
 <loc>https://www.apicur.io/registry/docs/apicurio-registry-operator/1.2.0-dev-v2.6.x/index.html</loc>
-<lastmod>2026-03-06T10:51:01.099Z</lastmod>
+<lastmod>2026-03-06T11:03:15.818Z</lastmod>
 </url>
 <url>
 <loc>https://www.apicur.io/registry/docs/apicurio-registry-operator/1.1.1-v2.5.9.final/assembly-operator-configuration.html</loc>
-<lastmod>2026-03-06T10:51:01.099Z</lastmod>
+<lastmod>2026-03-06T11:03:15.818Z</lastmod>
 </url>
 <url>
 <loc>https://www.apicur.io/registry/docs/apicurio-registry-operator/1.1.1-v2.5.9.final/assembly-operator-installation.html</loc>
-<lastmod>2026-03-06T10:51:01.099Z</lastmod>
+<lastmod>2026-03-06T11:03:15.818Z</lastmod>
 </url>
 <url>
 <loc>https://www.apicur.io/registry/docs/apicurio-registry-operator/1.1.1-v2.5.9.final/assembly-operator-quickstart.html</loc>
-<lastmod>2026-03-06T10:51:01.099Z</lastmod>
+<lastmod>2026-03-06T11:03:15.818Z</lastmod>
 </url>
 <url>
 <loc>https://www.apicur.io/registry/docs/apicurio-registry-operator/1.1.1-v2.5.9.final/assembly-registry-maintenance.html</loc>
-<lastmod>2026-03-06T10:51:01.099Z</lastmod>
+<lastmod>2026-03-06T11:03:15.818Z</lastmod>
 </url>
 <url>
 <loc>https://www.apicur.io/registry/docs/apicurio-registry-operator/1.1.1-v2.5.9.final/assembly-registry-storage.html</loc>
-<lastmod>2026-03-06T10:51:01.099Z</lastmod>
+<lastmod>2026-03-06T11:03:15.818Z</lastmod>
 </url>
 <url>
 <loc>https://www.apicur.io/registry/docs/apicurio-registry-operator/1.1.1-v2.5.9.final/index.html</loc>
-<lastmod>2026-03-06T10:51:01.099Z</lastmod>
+<lastmod>2026-03-06T11:03:15.818Z</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>2026-03-06T10:51:01.099Z</lastmod>
+<lastmod>2026-03-06T11:03:15.818Z</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>2026-03-06T10:51:01.099Z</lastmod>
+<lastmod>2026-03-06T11:03:15.818Z</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>2026-03-06T10:51:01.099Z</lastmod>
+<lastmod>2026-03-06T11:03:15.818Z</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>2026-03-06T10:51:01.099Z</lastmod>
+<lastmod>2026-03-06T11:03:15.818Z</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>2026-03-06T10:51:01.099Z</lastmod>
+<lastmod>2026-03-06T11:03:15.818Z</lastmod>
 </url>
 <url>
 <loc>https://www.apicur.io/registry/docs/apicurio-registry-operator/1.1.0-v2.4.12.final/index.html</loc>
-<lastmod>2026-03-06T10:51:01.099Z</lastmod>
+<lastmod>2026-03-06T11:03:15.818Z</lastmod>
 </url>
 <url>
 <loc>https://www.apicur.io/registry/docs/apicurio-registry-operator/1.0.0/assembly-operator-configuration.html</loc>
-<lastmod>2026-03-06T10:51:01.099Z</lastmod>
+<lastmod>2026-03-06T11:03:15.818Z</lastmod>
 </url>
 <url>
 <loc>https://www.apicur.io/registry/docs/apicurio-registry-operator/1.0.0/assembly-operator-installation.html</loc>
-<lastmod>2026-03-06T10:51:01.099Z</lastmod>
+<lastmod>2026-03-06T11:03:15.818Z</lastmod>
 </url>
 <url>
 <loc>https://www.apicur.io/registry/docs/apicurio-registry-operator/1.0.0/assembly-operator-quickstart.html</loc>
-<lastmod>2026-03-06T10:51:01.099Z</lastmod>
+<lastmod>2026-03-06T11:03:15.818Z</lastmod>
 </url>
 <url>
 <loc>https://www.apicur.io/registry/docs/apicurio-registry-operator/1.0.0/assembly-registry-maintenance.html</loc>
-<lastmod>2026-03-06T10:51:01.099Z</lastmod>
+<lastmod>2026-03-06T11:03:15.818Z</lastmod>
 </url>
 <url>
 <loc>https://www.apicur.io/registry/docs/apicurio-registry-operator/1.0.0/assembly-registry-storage.html</loc>
-<lastmod>2026-03-06T10:51:01.099Z</lastmod>
+<lastmod>2026-03-06T11:03:15.818Z</lastmod>
 </url>
 <url>
 <loc>https://www.apicur.io/registry/docs/apicurio-registry-operator/1.0.0/index.html</loc>
-<lastmod>2026-03-06T10:51:01.099Z</lastmod>
+<lastmod>2026-03-06T11:03:15.818Z</lastmod>
 </url>
 <url>
 <loc>https://www.apicur.io/registry/docs/apicurio-registry-operator/0.0.4/assembly-operator-configuration.html</loc>
-<lastmod>2026-03-06T10:51:01.099Z</lastmod>
+<lastmod>2026-03-06T11:03:15.818Z</lastmod>
 </url>
 <url>
 <loc>https://www.apicur.io/registry/docs/apicurio-registry-operator/0.0.4/assembly-operator-dev-quickstart-minikube.html</loc>
-<lastmod>2026-03-06T10:51:01.099Z</lastmod>
+<lastmod>2026-03-06T11:03:15.818Z</lastmod>
 </url>
 <url>
 <loc>https://www.apicur.io/registry/docs/apicurio-registry-operator/0.0.4/assembly-operator-installation.html</loc>
-<lastmod>2026-03-06T10:51:01.099Z</lastmod>
+<lastmod>2026-03-06T11:03:15.818Z</lastmod>
 </url>
 <url>
 <loc>https://www.apicur.io/registry/docs/apicurio-registry-operator/0.0.4/assembly-operator-quickstart.html</loc>
-<lastmod>2026-03-06T10:51:01.099Z</lastmod>
+<lastmod>2026-03-06T11:03:15.818Z</lastmod>
 </url>
 <url>
 <loc>https://www.apicur.io/registry/docs/apicurio-registry-operator/0.0.4/assembly-registry-maintenance.html</loc>
-<lastmod>2026-03-06T10:51:01.099Z</lastmod>
+<lastmod>2026-03-06T11:03:15.818Z</lastmod>
 </url>
 <url>
 <loc>https://www.apicur.io/registry/docs/apicurio-registry-operator/0.0.4/assembly-registry-storage.html</loc>
-<lastmod>2026-03-06T10:51:01.099Z</lastmod>
+<lastmod>2026-03-06T11:03:15.818Z</lastmod>
 </url>
 <url>
 <loc>https://www.apicur.io/registry/docs/apicurio-registry-operator/0.0.4/index.html</loc>
-<lastmod>2026-03-06T10:51:01.099Z</lastmod>
+<lastmod>2026-03-06T11:03:15.818Z</lastmod>
 </url>
 </urlset>