Chapter 1. Apicurio Registry Operator quickstart


This chapter explains how to quickly install Apicurio Registry Operator on the command line.

This quickstart example deploys Apicurio Registry using the SQL database storage option:

Note

The recommended installation option for production environments is using the OpenShift OperatorHub. The recommended storage option is SQL or Kafka.

You can quickly deploy the Apicurio Registry Operator on the command line, without the Operator Lifecycle Manager, by using a downloaded set of installation files and examples.

Prerequisites

Procedure

  1. Create a project for the installation, for example, service-registry:

    NAMESPACE="service-registry"
    oc new-project "$NAMESPACE"
    Copy to Clipboard Toggle word wrap
  2. Apply the file located in the install/ folder:

    cat install/install.yaml | sed "s/apicurio-registry-operator-namespace/$NAMESPACE/g" | oc apply -f -
    Copy to Clipboard Toggle word wrap

1.2. Quickstart Apicurio Registry deployment

To create a new Apicurio Registry deployment, use the SQL database storage option. This requires external PostgreSQL storage to be configured as a prerequisite.

Prerequisites

  • Ensure that the Apicurio Registry Operator is already installed.
  • You have a PostgreSQL database reachable from your OpenShift cluster.

Procedure

  1. Create an ApicurioRegistry custom resource (CR), with your database connection configured, for example:

    Example CR for SQL storage

    apiVersion: registry.apicur.io/v1
    kind: ApicurioRegistry
    metadata:
      name: example-apicurioregistry-sql
    spec:
      configuration:
        persistence: "sql"
        sql:
          dataSource:
            url: "jdbc:postgresql://<service name>.<namespace>.svc:5432/<database name>"
            userName: "postgres"
            password: "<password>" # Optional
    Copy to Clipboard Toggle word wrap

  2. Create the ApicurioRegistry CR in the same namespace that the Operator is deployed

    oc project "$NAMESPACE"
    oc apply -f ./examples/apicurioregistry_sql_cr.yaml
    Copy to Clipboard Toggle word wrap
Back to top
Red Hat logoGithubredditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust. Explore our recent updates.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

Theme

© 2026 Red Hat