-
Notifications
You must be signed in to change notification settings - Fork 308
docs: Add comprehensive Apicurio Registry Operator documentation #6914
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
f8e27c2 to
0a1e977
Compare
There was a problem hiding this 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
ApicurioRegistry3custom 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.
docs/modules/ROOT/pages/getting-started/assembly-registry-high-availability.adoc
Outdated
Show resolved
Hide resolved
docs/modules/ROOT/pages/getting-started/assembly-deploying-registry-operator.adoc
Outdated
Show resolved
Hide resolved
docs/modules/ROOT/pages/getting-started/assembly-registry-high-availability.adoc
Outdated
Show resolved
Hide resolved
docs/modules/ROOT/pages/getting-started/assembly-registry-high-availability.adoc
Outdated
Show resolved
Hide resolved
docs/modules/ROOT/pages/getting-started/assembly-deploying-registry-operator.adoc
Outdated
Show resolved
Hide resolved
docs/modules/ROOT/pages/getting-started/assembly-registry-high-availability.adoc
Outdated
Show resolved
Hide resolved
docs/modules/ROOT/pages/getting-started/assembly-deploying-registry-operator.adoc
Outdated
Show resolved
Hide resolved
docs/modules/ROOT/pages/getting-started/assembly-deploying-registry-operator.adoc
Show resolved
Hide resolved
|
|
||
| . 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 |
There was a problem hiding this comment.
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
26c7a3c to
d8916ef
Compare
…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.
d8916ef to
17c8a3a
Compare
jsenko
left a comment
There was a problem hiding this 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.
Summary
This PR adds comprehensive documentation for deploying and configuring Apicurio Registry using the Apicurio Registry Operator and the
ApicurioRegistry3custom resource.New Documentation Files
assembly-deploying-registry-operator.adoc - Complete deployment guide covering:
assembly-operator-config-reference.adoc - Complete API reference including:
Documentation Updates
nav.adocto include the new documentation in:Implementation Notes
The documentation follows:
Test plan