Quick Start

This section goes through how to get a local Katalogue environment up and running quickly with Docker compose. This deployment is only for demo and testing purposes, as there will be security issues and potential data loss.

For a production scenario, read up on the Deployment options.

Requirements

• Docker Desktop In order to run Katalogue locally you need Docker installed on your computer (https://www.docker.com/products/docker-desktop).

• GIT The Katalogue code is located at https://github.com/kayentaconsulting/katalogue, get a local copy of the main branch. Note that this is a private repo and you need an invite from Kayenta in order to access it.

Setup Local Katalogue Instance

1. Download the Katalogue source code from GitHub
2. Open a command prompt and cd to the folder where you saved the Katalogue source code. You should see a file called docker-compose.yml
3. In that folder, type docker-compose build and hit enter
4. It will take a minute or two but once the build is complete you should be back at the prompt and see something like this

< TODO: IMG >

Start Local Katalogue Instance

1. Now type “docker-compose up``` and hit enter
2. Open the Docker Desktop application and after a minute or two you should see this under Containers/Apps:

< TODO: IMG >

1. If everything is green you should now be able to open a browser and go to http://localhost and see the Katalogue login screen

< TODO: IMG >

1. Login with these credentials:

• Username: admin
• Password: admin

Stop Local Katalogue Instance

If you want to stop the Katalogue instance, you can either write docker-compose down in your command prompt or click the stop icon in Docker Desktop. Once the Katalogue instance is stopped, it will turn grey in Containers/Apps in the Docker Dekstop GUI. You can restart it by pressing Play on the Container again or typing docker-compose up in your terminal.

Data in Katalogue will normally be persisted when stopping the Katalogue Instance but it will be lost if the katalogue_db container is deleted or re-created.

Data in the Local Katalogue Instance

Danger

Do not use this in a production scenario, it is not secure and high risk for data loss. Use this for quick, internal demo and testing purposes only.

If you keep the container in Docker Desktop, it will keep all data you’ve added to Katalogue. Data such as datasources, field descriptions, business glossarys etc. If you remove the Container and rebuild it, your local data will be gone.

Guide - Adding Data to Katalogue

We’ve added a postgres demo database to our postgres instance to make it easy to showcase how to import information to the Katalogue. More information on this database can be found here: https://www.postgresqltutorial.com/postgresql-sample-database/

The database has a couple of tables and views. The table structure looks like this: < TODO: IMG >

Creating a System

In order to access this database in Katalogue we must add a System, lets call it DVD Rental Demo and give it a type of Database. Click +ADD.

Creating a Connection

Click the newly created DVD Rental Demo, go to the Connections tab and glick +ADD a Connection.

Give it a name DVD Rental choose “Datasource Type” to be PostgreSQL, click connection and add the connection settings.

Hostname to connect to our local postgres database is db.

Test the connection to make sure it works and then click ADD.

To make Katalogue get data from the dvdrental database we need a sync task that uses the connection.

Creating a Datasource Sync Task

Click Tasks in the left menu and then ADD+ Give it a name like DVD Rentals sync choose TaskType “Datasource Sync”, Datasource “DVD Rentals” and klick ADD. To run the task you either mark it in the list and click RUN or click the name DVD Rentals sync and click the run button there: In this screen you’ll see the log of each sync as well.

Browsing the Datasource

If you go back to Datasets and click DVD Rental Demo / DVD Rental you will see that the dataset group (schema) public is synced with all tables and views from the database.