Configuring and managing Apicurio Studio deployment

Configuring Apicurio Studio authentication and authorization with Keycloak

This section explains how to manually configure authentication and authorization options for Apicurio Studio and Keycloak.

TODO

Managing Apicurio Studio environment variables

TODO

Backing up Apicurio Studio PostgreSQL storage

When using storage in a PostgreSQL database, you must ensure that the data stored by Apicurio Studio is backed up regularly.

SQL Dump is a simple procedure that works with any PostgreSQL installation. This uses the pg_dump utility to generate a file with SQL commands that you can use to recreate the database in the same state that it was in at the time of the dump.

pg_dump is a regular PostgreSQL client application, which you can execute from any remote host that has access to the database. Like any other client, the operations that can perform are limited to the user permissions.

Procedure

  • Use the pg_dump command to redirect the output to a file:

     $ pg_dump dbname > dumpfile

    You can specify the database server that pg_dump connects to using the -h host and -p port options.

  • You can reduce large dump files using a compression tool, such as gzip, for example:

     $ pg_dump dbname | gzip > filename.gz
Additional resources

  • For details on client authentication, see the PostgreSQL documentation.

  • For details on importing and exporting Apicurio Studio content, see TODO.

Restoring Apicurio Studio PostgreSQL storage

You can restore SQL Dump files created by pg_dump using the psql utility.

Prerequisites
Procedure

  1. Enter the following command to create the database:

     $ createdb -T template0 dbname

  2. Enter the following command to restore the SQL dump

     $ psql dbname < dumpfile

  3. Run ANALYZE on each database so the query optimizer has useful statistics.