Chapter 1. Apicurio Registry Operator quickstart

Procedure

1. Browse to Red Hat Software Downloads, select the product version, and download the examples in the Apicurio Registry CRDs .zip file.
2. Extract the downloaded CRDs .zip file and change to the apicurio-registry-install-examples directory.

3. Create an OpenShift project for the Apicurio Registry Operator installation, for example:

   export NAMESPACE="apicurio-registry"
   oc new-project "$NAMESPACE"

   Copy to Clipboard Toggle word wrap

4. Enter the following command to apply the example CRD in the install/install.yaml file:

   cat install/install.yaml | sed "s/apicurio-registry-operator-namespace/$NAMESPACE/g" | oc apply -f -

   Copy to Clipboard Toggle word wrap

5. Enter oc get deployment to check the readiness of the Apicurio Registry Operator. For example, the output should be as follows:

   NAME                     	READY   UP-TO-DATE  AVAILABLE   AGE
   apicurio-registry-operator  1/1 	1        	1       	XmYs

   Copy to Clipboard Toggle word wrap

Procedure

1. Open the examples/apicurioregistry_sql_cr.yaml file in an editor and view the ApicurioRegistry custom resource (CR):

   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. In the dataSource section, replace the example settings with your database connection details. For example:

   dataSource:
       url: "jdbc:postgresql://postgresql.apicurio-registry.svc:5432/registry"
       userName: "pgadmin"
       password: "pgpass"

   Copy to Clipboard Toggle word wrap

3. Enter the following commands to apply the updated ApicurioRegistry CR in the namespace with the Apicurio Registry Operator, and wait for the Apicurio Registry instance to deploy:

   oc project "$NAMESPACE"
   oc apply -f ./examples/apicurioregistry_sql_cr.yaml

   Copy to Clipboard Toggle word wrap

4. Enter oc get deployment to check the readiness of the Apicurio Registry instance. For example, the output should be as follows:

   NAME                     	        READY UP-TO-DATE AVAILABLE AGE
   example-apicurioregistry-sql-deployment 1/1   1          1         XmYs

   Copy to Clipboard Toggle word wrap

5. Enter oc get routes to get the HOST/PORT URL to launch the Apicurio Registry web console in your browser. For example:

   example-apicurioregistry-sql.apicurio-registry.router-default.apps.mycluster.myorg.mycompany.com

   Copy to Clipboard Toggle word wrap