红帽全球峰会此内容没有您所选择的语言版本。
Installing and deploying Apicurio Registry on OpenShift
Install, deploy, and configure Apicurio Registry 3.0
Abstract
Preface
Providing feedback on Red Hat documentation
We appreciate your feedback on our documentation.
To propose improvements, open a Jira issue and describe your suggested changes. Provide as much detail as possible to enable us to address your request quickly.
Prerequisite
-
You have a Red Hat Customer Portal account. This account enables you to log in to the Red Hat Jira Software instance.
If you do not have an account, you will be prompted to create one.
Procedure
- Click the following link: Create issue.
- In the Summary text box, enter a brief description of the issue.
In the Description text box, provide the following information:
- The URL of the page where you found the issue.
-
A detailed description of the issue.
You can leave the information in any other fields at their default values.
- Click Create to submit the Jira issue to the documentation team.
Thank you for taking the time to provide feedback.
Chapter 1. Service Registry Operator quickstart
You can quickly install the Service Registry Operator on the command line by using Custom Resource Definitions (CRDs).
The quickstart example deploys your Service Registry instance with storage in an SQL database:
The recommended installation option for production environments is the OpenShift OperatorHub. The recommended storage option is an SQL database for performance, stability, and data management.
1.1. Quickstart Service Registry Operator installation
You can quickly install and deploy the Service Registry Operator on the command line, without the Operator Lifecycle Manager, by using a downloaded set of installation files and example CRDs.
Prerequisites
- You are logged in to an OpenShift cluster with administrator access.
-
You have the OpenShift
occommand-line client installed. For more details, see the OpenShift CLI documentation.
Procedure
-
Browse to Red Hat Software Downloads, select the product version, and download the examples in the Service Registry CRDs
.zipfile. -
Extract the downloaded CRDs
.zipfile and change to theapicurio-registry-install-examplesdirectory. Create an OpenShift project for the Service Registry Operator installation, for example:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow export NAMESPACE="apicurio-registry" oc new-project "$NAMESPACE"
export NAMESPACE="apicurio-registry" oc new-project "$NAMESPACE"Enter the following command to apply the example CRD in the
install/install.yamlfile:Copy to Clipboard Copied! Toggle word wrap Toggle overflow cat install/install.yaml | sed "s/apicurio-registry-operator-namespace/$NAMESPACE/g" | oc apply -f -
cat install/install.yaml | sed "s/apicurio-registry-operator-namespace/$NAMESPACE/g" | oc apply -f -Enter
oc get deploymentto check the readiness of the Service Registry Operator. For example, the output should be as follows:Copy to Clipboard Copied! Toggle word wrap Toggle overflow NAME READY UP-TO-DATE AVAILABLE AGE apicurio-registry-operator 1/1 1 1 XmYs
NAME READY UP-TO-DATE AVAILABLE AGE apicurio-registry-operator 1/1 1 1 XmYs
1.2. Quickstart Service Registry instance deployment
To create your Service Registry instance deployment, use the example CRs.
Prerequisites
- Ensure that the Service Registry Operator is installed.
- You have a PostgreSQL database that is reachable from your OpenShift cluster.
Procedure
-
Browse to Red Hat Software Downloads, select the product version, and download the examples in the Service Registry CRDs
.zipfile. - Choose an example deployment.
Enter the following commands to apply the updated
ApicurioRegistry3CR in the namespace with the Service Registry Operator, and wait for the Service Registry instance to deploy:Copy to Clipboard Copied! Toggle word wrap Toggle overflow oc project "$NAMESPACE" oc apply -f <example-yaml>
oc project "$NAMESPACE" oc apply -f <example-yaml>Enter
oc get deploymentto check the readiness of the Service Registry instance. For example, the output should be as follows:Copy to Clipboard Copied! Toggle word wrap Toggle overflow NAME READY UP-TO-DATE AVAILABLE AGE example-apicurioregistry-sql-deployment 1/1 1 1 XmYs
NAME READY UP-TO-DATE AVAILABLE AGE example-apicurioregistry-sql-deployment 1/1 1 1 XmYsEnter
oc get routesto get theHOST/PORTURL to launch the Service Registry web console in your browser. For example:Copy to Clipboard Copied! Toggle word wrap Toggle overflow example-apicurioregistry-sql.apicurio-registry.router-default.apps.mycluster.myorg.mycompany.com
example-apicurioregistry-sql.apicurio-registry.router-default.apps.mycluster.myorg.mycompany.com
Chapter 2. Installing Service Registry on OpenShift
This chapter explains how to install Service Registry on OpenShift Container Platform:
Prerequisites
- Read the introduction in the Service Registry User Guide.
2.1. Installing Service Registry from the OpenShift OperatorHub
You can install the Service Registry Operator on your OpenShift cluster from the OperatorHub. The OperatorHub is available from the OpenShift Container Platform web console and provides an interface for cluster administrators to discover and install Operators. For more details, see Understanding OperatorHub.
You can install more than one replica of Service Registry depending on your environment. The number of replicas depends on the number and type of artifacts stored in Service Registry and on your chosen storage option.
Prerequisites
- You must have cluster administrator access to an OpenShift cluster.
Procedure
- In the OpenShift Container Platform web console, log in using an account with cluster administrator privileges.
Create a new OpenShift project:
- In the left navigation menu, click Home, Project, and then Create Project.
-
Enter a project name, for example,
my-project, and click Create.
- In the left navigation menu, click Operators and then OperatorHub.
-
In the Filter by keyword text box, enter
registryto find the Red Hat build of Apicurio Registry 3 operator. - Read the information about the Operator, and click Install to display the Operator subscription page.
- Select your subscription settings, for example:
Select your subscription settings, for example:
- Update Channel: Select 3.x.
Installation Mode: Select one of the following:
- All namespaces on the cluster (default)
- A specific namespace on the cluster and then my-project
- Approval Strategy: Select Automatic or Manual
- Click Install, and wait a few moments until the Operator is ready for use.
Additional resources
Chapter 3. Service Registry configuration reference
This chapter provides reference information on the configuration options that are available for Service Registry.
Additional resources
- For details on migrating a 2.x Apicurio Registry deployment to 3.x see Section 3.2, “Service Registry version 2 to version 3 configuration changes”
-
For details on setting configuration options by using the Core Registry API, see the
/admin/config/propertiesendpoint in the Apicurio Registry REST API documentation. - For details on client configuration options for Kafka serializers and deserializers, see the Service Registry User Guide.
3.1. Service Registry configuration options
The following Service Registry configuration options are available for each component category:
== . configuration options
| Name | Type | Default | Available from | Description |
|---|---|---|---|---|
|
|
|
| ||
|
|
|
| ||
|
|
|
| ||
|
|
|
|
3.1.1. api
| Name | Type | Default | Available from | Description |
|---|---|---|---|---|
|
|
|
|
| Include stack trace in errors responses |
|
|
|
|
| API base href (URI) |
|
|
|
| Disable APIs |
3.1.2. auth
| Name | Type | Default | Available from | Description |
|---|---|---|---|---|
|
|
|
|
| Auth admin override claim |
|
|
|
|
| Auth admin override claim value |
|
|
|
|
| Auth admin override enabled |
|
|
|
|
| Auth admin override from |
|
|
|
|
| Auth admin override role |
|
|
|
|
| Auth admin override type |
|
|
|
|
| Auth admin override user name |
|
|
|
|
| Anonymous read access |
|
|
|
|
| Authenticated read access |
|
|
|
|
| Artifact owner-only authorization |
|
|
|
|
| Artifact group owner-only authorization |
|
|
|
|
| Enable role based authorization |
|
|
|
|
| Auth roles source |
|
|
|
| Header authorization name | |
|
|
|
|
| Auth roles admin |
|
|
|
|
| Auth roles developer |
|
|
|
|
| Auth roles readonly |
|
|
|
|
| Prefix used for application audit logging. |
|
|
|
|
| Default client credentials token expiration time in minutes. |
|
|
|
|
| Client credentials token expiration offset from JWT expiration, in seconds. |
|
|
|
|
| Enable basic auth client credentials |
|
|
|
| Client credentials scope. | |
|
|
|
|
| Enable basic auth |
|
|
|
| Client identifier used by the server for authentication. | |
|
|
|
| Client secret used by the server for authentication. | |
|
|
|
|
| Enable auth |
|
|
|
| Authentication server token endpoint. |
3.1.3. cache
| Name | Type | Default | Available from | Description |
|---|---|---|---|---|
|
|
|
|
| Registry cache enabled |
3.1.4. ccompat
| Name | Type | Default | Available from | Description |
|---|---|---|---|---|
|
|
|
|
| Enable group support via concatenation in subject (compatibility API) |
|
|
|
|
| Separator to use when group concatenation is enabled (compatibility API) |
|
|
|
|
| Legacy ID mode (compatibility API) |
|
|
|
|
| Maximum number of Subjects returned (compatibility API) |
|
|
|
|
| Canonical hash mode (compatibility API) |
3.1.5. download
| Name | Type | Default | Available from | Description |
|---|---|---|---|---|
|
|
|
|
| Download link expiry |
3.1.6. gitops
| Name | Type | Default | Available from | Description |
|---|---|---|---|---|
|
|
|
| Identifier of this Registry instance. Only data that references this identifier will be loaded. | |
|
|
|
|
| Name of the branch in the remote git repository containing data to be loaded. |
|
|
|
| URI of the remote git repository containing data to be loaded. | |
|
|
|
|
| Path to GitOps working directory, which is used to store the local git repository. |
3.1.7. health
| Name | Type | Default | Available from | Description |
|---|---|---|---|---|
|
|
|
| Ignored liveness errors | |
|
|
|
|
| Counter reset window duration of persistence liveness check |
|
|
|
|
| Error threshold of persistence liveness check |
|
|
|
|
| Disable logging of persistence liveness check |
|
|
|
|
| Status reset window duration of persistence liveness check |
|
|
|
|
| Error threshold of persistence readiness check |
|
|
|
|
| Timeout of persistence readiness check |
|
|
|
|
| Status reset window duration of persistence readiness check |
|
|
|
|
| Counter reset window duration of response liveness check |
|
|
|
|
| Counter reset window duration of persistence readiness check |
|
|
|
|
| Disable logging of response liveness check |
|
|
|
|
| Error threshold of response liveness check |
|
|
|
|
| Status reset window duration of response liveness check |
|
|
|
|
| Counter reset window duration of response readiness check |
|
|
|
|
| Error threshold of response readiness check |
|
|
|
|
| Timeout of response readiness check |
|
|
|
|
| Status reset window duration of response readiness check |
|
|
|
|
| Storage metrics cache check period |
3.1.8. import
| Name | Type | Default | Available from | Description |
|---|---|---|---|---|
|
|
|
|
| When set to true, content IDs from the import file will be used (otherwise new IDs will be generated). Defaults to 'true'. |
|
|
|
|
| When set to true, global IDs from the import file will be used (otherwise new IDs will be generated). Defaults to 'true'. |
|
|
|
|
| When set to true, importing data will only work when the registry is empty. Defaults to 'true'. |
|
|
|
| The import URL | |
|
|
|
| Temporary work directory to use when importing data. |
3.1.9. limits
| Name | Type | Default | Available from | Description |
|---|---|---|---|---|
|
|
|
|
| Max artifact labels |
|
|
|
|
| Max artifact properties |
|
|
|
|
| Max artifacts |
|
|
|
|
| Max artifact description length |
|
|
|
|
| Max artifact label size |
|
|
|
|
| Max artifact name length |
|
|
|
|
| Max artifact property key size |
|
|
|
|
| Max artifact property value size |
|
|
|
|
| Max artifact requests per second |
|
|
|
|
| Max schema size (bytes) |
|
|
|
|
| Max total schemas |
|
|
|
|
| Max versions per artifacts |
|
|
|
|
| Storage metrics cache max size. |
3.1.10. redirects
| Name | Type | Default | Available from | Description |
|---|---|---|---|---|
|
|
|
| Registry redirects | |
|
|
|
| Enable redirects | |
|
|
|
| Override the hostname used for generating externally-accessible URLs. The host and port overrides are useful when deploying Registry with HTTPS passthrough Ingress or Route. In cases like these, the request URL (and port) that is then re-used for redirection does not belong to actual external URL used by the client, because the request is proxied. The redirection then fails because the target URL is not reachable. | |
|
|
|
| Override the port used for generating externally-accessible URLs. |
3.1.11. rest
| Name | Type | Default | Available from | Description |
|---|---|---|---|---|
|
|
|
|
| Max size of the artifact allowed to be downloaded from URL |
|
|
|
|
| Skip SSL validation when downloading artifacts from URL |
|
|
|
|
| Enables artifact version deletion |
|
|
|
|
| Enables artifact deletion |
|
|
|
|
| Enables group deletion |
|
|
|
|
| Enables artifact version mutability |
|
|
|
|
| Max size of the labels (in bytes) per item from within search results |
3.1.12. semver
| Name | Type | Default | Available from | Description |
|---|---|---|---|---|
|
|
|
|
| If true, invalid versions will be coerced to Semantic Versioning 2 format (https://semver.org) if possible. |
|
|
|
|
| Automatically create or update branches for major ('A.x') and minor ('A.B.x') artifact versions. |
|
|
|
|
| Validate that all artifact versions conform to Semantic Versioning 2 format (https://semver.org). |
3.1.13. storage
| Name | Type | Default | Available from | Description |
|---|---|---|---|---|
|
|
|
|
| Gitops blue datasource db kind |
|
|
|
|
| Gitops blue datasource pool initial size |
|
|
|
|
| Gitops blue datasource pool max size |
|
|
|
|
| Gitops blue datasource pool minimum size |
|
|
|
|
| Gitops blue datasource jdbc url |
|
|
|
|
| Gitops blue datasource password |
|
|
|
|
| Gitops blue datasource username |
|
|
|
|
| Gitops green datasource db kind |
|
|
|
|
| Gitops green datasource pool initial size |
|
|
|
|
| Gitops green datasource pool max size |
|
|
|
|
| Gitops green datasource pool minimum size |
|
|
|
|
| Gitops green datasource jdbc url |
|
|
|
|
| Gitops green datasource password |
|
|
|
|
| Gitops green datasource username |
|
|
|
| Storage event topic | |
|
|
| Kafka sql storage bootstrap servers | ||
|
|
|
| Kafka sql storage prefix for consumer group name | |
|
|
|
| Kafka sql storage consumer poll timeout | |
|
|
|
| Kafka sql storage coordinator response timeout | |
|
|
| Kafka sql storage security protocol | ||
|
|
| Kafka sql storage sasl client identifier | ||
|
|
| Kafka sql storage sasl client secret | ||
|
|
|
| Kafka sql storage sasl enabled | |
|
|
| Kafka sql storage sasl login callback handler | ||
|
|
| Kafka sql storage sasl mechanism | ||
|
|
| Kafka sql storage sasl token endpoint | ||
|
|
| Kafka sql storage ssl truststore location | ||
|
|
| Kafka sql storage ssl truststore type | ||
|
|
|
|
| Kafka sql journal topic snapshot every |
|
|
|
|
| Kafka sql storage topic name |
|
|
| Kafka sql storage ssl key password | ||
|
|
| Kafka sql storage ssl keystore location | ||
|
|
| Kafka sql storage ssl keystore password | ||
|
|
| Kafka sql storage ssl keystore type | ||
|
|
| Kafka sql storage ssl truststore password | ||
|
|
|
| Kafka sql storage topic name | |
|
|
|
| Kafka sql storage topic auto create | |
|
|
|
|
| Database schema name (only needed when running two instances of Registry against the same database, in multiple schemas) |
|
|
|
|
| SQL init |
|
|
|
| Application storage variant, for example, sql, kafkasql, or gitops | |
|
|
|
|
| Enable Registry storage read-only mode |
|
|
|
|
| Kafka sql snapshots store location |
|
|
|
|
| Application datasource database type |
|
|
|
|
| Skip artifact versions with DISABLED state when retrieving latest artifact version |
3.1.14. ui
| Name | Type | Default | Available from | Description |
|---|---|---|---|---|
|
|
|
|
| The OIDC clientId |
|
|
|
|
| The OIDC logout URL |
|
|
|
|
| The OIDC redirectUri |
|
|
|
|
| UI auth OIDC scope value |
|
|
|
|
| Context path of the UI |
|
|
|
|
| URL of the Documentation component |
|
|
|
|
| Enabled to show breadcrumbs in the UI |
|
|
|
|
| Enabled to set the UI to read-only mode |
|
|
|
|
| Enabled to show the Settings tab in the UI |
|
|
|
|
| Navigation prefix for all UI paths |
3.2. Service Registry version 2 to version 3 configuration changes
Service Registry v3 has simplified the configuration options, removing duplicates and improving consistency. For most options, the only change is ssrenaming of the prefix from registry to apicurio, for example, changing registry.kafkasql.bootstrap.servers to apicurio.kafkasql.bootstrap.servers.
For each configuration property you can override the value by using the corresponding environment variable, for example, APICURIO_KAFKASQL_BOOTSTRAP_SERVERS.s
3.2.1. api
| Name | New Option |
|---|---|
|
|
|
|
|
|
3.2.2. auth
| Name | New Option |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
3.2.3. cache
| Name | New Option |
|---|---|
|
|
|
3.2.4. ccompat
| Name | New Option |
|---|---|
|
|
|
|
|
|
|
|
|
3.2.5. download
| Name | New Option |
|---|---|
|
|
|
3.2.6. events
| Name | New Option |
|---|---|
|
|
|
3.2.7. health
| Name | New Option |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
3.2.8. import
| Name | New Option |
|---|---|
|
|
|
3.2.9. kafka
| Name | New Option |
|---|---|
|
|
|
|
|
|
3.2.10. limits
| Name | New Option |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
3.2.11. redirects
| Name | New Option |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
3.2.12. rest
| Name | New Option |
|---|---|
|
|
|
|
|
|
|
|
|
3.2.13. store
| Name | New Option |
|---|---|
|
|
|
|
|
|
3.2.14. ui
| Name | New Option |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Appendix A. Using your subscription
Service Registry is provided through a software subscription. To manage your subscriptions, access your account at the Red Hat Customer Portal.
Accessing your account
- Go to access.redhat.com.
- If you do not already have an account, create one.
- Log in to your account.
Activating a subscription
- Go to access.redhat.com.
- Navigate to My Subscriptions.
- Navigate to Activate a subscription and enter your 16-digit activation number.
Downloading ZIP and TAR files
To access ZIP or TAR files, use the customer portal to find the relevant files for download. If you are using RPM packages, this step is not required.
- Open a browser and log in to the Red Hat Customer Portal Product Downloads page at access.redhat.com/downloads.
- Locate the Red Hat Integration entries in the Integration and Automation category.
- Select the desired Service Registry product. The Software Downloads page opens.
- Click the Download link for your component.
Revised on 2025-05-07 14:37:43 UTC
'%20d='M201.5%20305.5c-13.8%200-24.9-11.1-24.9-24.6%200-13.8%2011.1-24.9%2024.9-24.9%2013.6%200%2024.6%2011.1%2024.6%2024.9%200%2013.6-11.1%2024.6-24.6%2024.6zM504%20256c0%20137-111%20248-248%20248S8%20393%208%20256%20119%208%20256%208s248%20111%20248%20248zm-132.3-41.2c-9.4%200-17.7%203.9-23.8%2010-22.4-15.5-52.6-25.5-86.1-26.6l17.4-78.3%2055.4%2012.5c0%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.3%2024.9-24.9s-11.1-24.9-24.9-24.9c-9.7%200-18%205.8-22.1%2013.8l-61.2-13.6c-3-.8-6.1%201.4-6.9%204.4l-19.1%2086.4c-33.2%201.4-63.1%2011.3-85.5%2026.8-6.1-6.4-14.7-10.2-24.1-10.2-34.9%200-46.3%2046.9-14.4%2062.8-1.1%205-1.7%2010.2-1.7%2015.5%200%2052.6%2059.2%2095.2%20132%2095.2%2073.1%200%20132.3-42.6%20132.3-95.2%200-5.3-.6-10.8-1.9-15.8%2031.3-16%2019.8-62.5-14.9-62.5zM302.8%20331c-18.2%2018.2-76.1%2017.9-93.6%200-2.2-2.2-6.1-2.2-8.3%200-2.5%202.5-2.5%206.4%200%208.6%2022.8%2022.8%2087.3%2022.8%20110.2%200%202.5-2.2%202.5-6.1%200-8.6-2.2-2.2-6.1-2.2-8.3%200zm7.7-75c-13.6%200-24.6%2011.1-24.6%2024.9%200%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.1%2024.9-24.6%200-13.8-11-24.9-24.9-24.9z'/%3e%3c/svg%3e){kind=small}