paralus/README.md

rcloud-base

This repository contains all the rcloud-system components that are the backbone for ztka and gitops.

Prerequisites

1. Postgres database
2. Ory Kratos - API for user management
3. We use Casbin - An authorization library that supports access control models like ACL, RBAC, ABAC

Setting up the database

You can use the bitnami charts for postgresql

Create the initial db/user

Scripts for admindb:

create database admindb;
CREATE ROLE admindbuser WITH LOGIN PASSWORD '<your_password>';
GRANT ALL PRIVILEGES ON DATABASE admindb to admindbuser;

Now in the newly created db:

CREATE EXTENSION IF NOT EXISTS "uuid-ossp";
grant execute on function uuid_generate_v4() to admindbuser;

Scripts for clusterdb:

create database clusterdb;
CREATE ROLE clusterdbuser WITH LOGIN PASSWORD '<your_password>';
GRANT ALL PRIVILEGES ON DATABASE clusterdb to clusterdbuser;

Now in the newly created db:

CREATE EXTENSION IF NOT EXISTS "uuid-ossp";
grant execute on function uuid_generate_v4() to clusterdbuser;

This will grant the necessary permission to the newly created user to run uuid_generate_v4()

Run application migrations

We use golang-migrate to perform migrations.

Install golang-migrate

go install -tags 'postgres' github.com/golang-migrate/migrate/v4/cmd/migrate@latest

-tags 'postgres' is important as otherwise it compiles without postgres support

You can refer to the guide for full details.

Run migrations

Example for admindb:

export POSTGRESQL_URL='postgres://<user>:<pass>@<host>:<port>/admindb?sslmode=disable'
migrate -path ./persistence/migrations/admindb -database "$POSTGRESQL_URL" up

See cli-usage for more info.

Development setup

Run following Docker Compose command to setup all requirements like Postgres db, Kratos etc. for the rcloud-base:

docker-compose up -d

Install Go dependencies:

go get

Start rcloud-base:

go run github.com/RafaySystems/rcloud-base