Skip to content

Conversation

@EricWittmann
Copy link
Member

Summary

This PR adds comprehensive documentation for deploying and configuring Apicurio Registry using the Apicurio Registry Operator and the ApicurioRegistry3 custom resource.

New Documentation Files

  • assembly-deploying-registry-operator.adoc - Complete deployment guide covering:

    • Operator overview and custom resource structure
    • Deployment with in-memory storage (development/testing)
    • Deployment with PostgreSQL storage (production)
    • Deployment with MySQL storage (production)
    • Deployment with KafkaSQL storage (production) with TLS and SASL authentication examples
    • Authentication and authorization configuration (OIDC, role-based access control, admin override)
    • Ingress and networking configuration
    • Feature flags (resource deletion, version mutability)
    • UI component configuration
    • Advanced configuration options (replicas, PodDisruptionBudget, custom PodTemplateSpec, etc.)
  • assembly-operator-config-reference.adoc - Complete API reference including:

    • Custom resource structure
    • All configuration fields for app and ui components
    • Storage configuration (SQL and KafkaSQL with all options)
    • Authentication and authorization configuration
    • Ingress configuration
    • Field descriptions, types, defaults, and examples

Documentation Updates

  • Updated nav.adoc to include the new documentation in:
    • Installation section (deployment guide)
    • Reference section (configuration reference)

Implementation Notes

The documentation follows:

  • Existing AsciiDoc formatting conventions used throughout the project
  • Strimzi operator documentation structure for consistency
  • Real-world examples from the apicurio-testing repository
  • Complete coverage of all CRD fields and options

Test plan

  • Build and review generated documentation for formatting
  • Verify all examples are syntactically correct
  • Confirm navigation links work properly
  • Cross-reference with actual CRD and model classes

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR adds comprehensive documentation for deploying and configuring Apicurio Registry using the Apicurio Registry Operator and the ApicurioRegistry3 custom resource. The documentation follows existing AsciiDoc conventions and provides complete coverage for operators, developers, and administrators.

Key changes:

  • New comprehensive operator deployment guide with examples for all storage types (in-memory, PostgreSQL, KafkaSQL)
  • Complete API reference documentation for the ApicurioRegistry3 custom resource
  • New high availability deployment guide covering architecture, scaling, monitoring, and backup/restore procedures

Reviewed changes

Copilot reviewed 12 out of 13 changed files in this pull request and generated 6 comments.

Show a summary per file
File Description
operator/model/src/main/java/io/apicurio/registry/operator/api/v1/spec/DataSourceSpec.java Removes trailing whitespace from JsonPropertyDescription annotation
docs/modules/ROOT/partials/shared/attributes.adoc Adds new operator-related attributes and removes deprecated v1 version attributes
docs/modules/ROOT/pages/index.adoc Updates operator reference to use new {operator} attribute
docs/modules/ROOT/pages/getting-started/assembly-registry-high-availability.adoc New comprehensive HA guide covering deployment, storage, monitoring, and DR procedures
docs/modules/ROOT/pages/getting-started/assembly-operator-config-reference.adoc New complete API reference for ApicurioRegistry3 CR configuration
docs/modules/ROOT/pages/getting-started/assembly-deploying-registry-operator.adoc New deployment guide with examples for all storage backends and configuration scenarios
docs/modules/ROOT/pages/getting-started/assembly-managing-registry-artifacts-ui.adoc Updates terminology to use {operator} attribute consistently
docs/modules/ROOT/pages/getting-started/assembly-intro-to-the-registry.adoc Updates operator references in distribution tables
docs/modules/ROOT/pages/getting-started/assembly-installing-registry-storage-openshift.adoc Removes extra blank lines
docs/modules/ROOT/pages/getting-started/assembly-installing-registry-openshift.adoc Updates operator installation references to use {operator} attribute
docs/modules/ROOT/pages/getting-started/assembly-configuring-the-registry.adoc Updates operator terminology for consistency
docs/modules/ROOT/pages/getting-started/assembly-configuring-registry-security.adoc Updates operator documentation link reference
docs/modules/ROOT/nav.adoc Adds new documentation pages to navigation structure

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.


. In the {kubernetes} web console, log in using an account with cluster administrator privileges.

. Change to the {kubernetes-namespace} in which the {operator} is installed. For example, from the
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that's confusing

@jsenko jsenko force-pushed the task/operator-documentation branch 6 times, most recently from 26c7a3c to d8916ef Compare November 26, 2025 14:40
EricWittmann and others added 9 commits November 26, 2025 17:34
…ntation

This adds detailed documentation for deploying and configuring Apicurio Registry instances using the
ApicurioRegistry3 custom resource with the Apicurio Registry Operator.

The new documentation includes:
- Deployment guide covering all storage options (in-memory, PostgreSQL, MySQL, KafkaSQL)
- Authentication and authorization configuration with OIDC
- Ingress and networking configuration
- Feature flags and UI component configuration
- Advanced configuration with PodTemplateSpec customization
- Complete API reference for all custom resource fields

The documentation follows the existing AsciiDoc conventions and is organized similar to the Strimzi
operator documentation structure.
@jsenko jsenko force-pushed the task/operator-documentation branch from d8916ef to 17c8a3a Compare November 26, 2025 16:34
Copy link
Member

@jsenko jsenko left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Appended a couple of fixes found because of failing tests. It seemed easier than creating a separate PR.

@jsenko jsenko enabled auto-merge (rebase) November 26, 2025 16:36
@jsenko jsenko merged commit 160a3d7 into main Nov 26, 2025
21 of 22 checks passed
@jsenko jsenko deleted the task/operator-documentation branch November 26, 2025 17:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants