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 in-memory storage option:

The recommended installation option for production environments is Installing Apicurio Registry Operator using the OperatorHub. The recommended storage option is SQL or Kafka.

Apicurio Registry Operator quickstart

You can quickly deploy the Apicurio Registry Operator on the command line, without the Operator Lifecycle Manager, by executing a single command.

Procedure

  1. Choose the $NAMESPACE to use:

    export NAMESPACE="default"

  2. Get the installation file and apply it to your cluster:

    curl -sSL "https://raw.githubusercontent.com/Apicurio/apicurio-registry-operator/v1.0.0/docs/resources/install.yaml" |
sed "s/{NAMESPACE}/$NAMESPACE/g" | kubectl apply -f - -n $NAMESPACE
If you want to deploy an older release of the Operator, follow the documentation for that version.
If you are deploying to OpenShift, use oc with the same arguments.

Quickstart Apicurio Registry deployment

To quickly create a new Apicurio Registry deployment, use the in-memory storage option, which does not require an external storage to be configured as a prerequisite.

Prerequisites

  • Ensure that the Apicurio Registry Operator is already installed.

Procedure

  1. Use a $NAMESPACE where the Apicurio Registry Operator is deployed:

    export NAMESPACE="default"

  2. Create an ApicurioRegistry custom resource (CR):

    kubectl apply -f https://raw.githubusercontent.com/Apicurio/apicurio-registry-operator/v1.0.0/docs/modules/ROOT/examples/apicurioregistry_mem_cr.yaml -n $NAMESPACE
    If you want to deploy an older release of the Operator, follow the documentation for that version.
    If you are deploying to OpenShift, use oc with the same arguments.
    Example CR for in-memory storage
    apiVersion: registry.apicur.io/v1
kind: ApicurioRegistry
metadata:
  name: example-apicurioregistry-mem
spec:
  configuration:
    persistence: "mem" # Optional (default value)
    # NOTE: No additional configuration required for *dev* deployment

Apicurio Registry Operator Distribution Bundle

Since version 1.0.0, Apicurio Registry Operator project is distributed with an additional archive file containing installation files for the operator, with example ApicurioRegistry custom resource files. In addition, full Operator documentation and license information is also included. Docker images for the Operator and the Operand are distributed using a public registry.

For released versions, you can find this file in the Apicurio Registry Operator releases page. Visit the Apicurio Registry Operator GitHub repository for information about how to build the bundle for development versions.