Skip to content

Latest commit

 

History

History
204 lines (167 loc) · 7.63 KB

README.md

File metadata and controls

204 lines (167 loc) · 7.63 KB
Raw

multi-tenant-persistence-for-saas

Go Report Card GitHub Actions Go Reference Code Coverage Daily

Overview

Multi-tenant Persistence for SaaS services acts as data abstraction layer for underlying data store (Postgres) and provide multi-tenancy capabilities along with ability to integrate with different IAM authorizers.

Introduction

This repo contains an implementation of a data access layer (DAL) that will be used by SaaS microservices. It is a Go library that could be used in other projects and supports data store backed by a Postgres database.

A sample use case for a multi-tenant application using this library to read VM information stored in a Postgres database:

sequenceDiagram
    actor C1 as Coke User (Americas)
    actor C2 as Coke User (Europe)
    actor P as Pepsi User (Americas)
    participant M as Multitenant Persistence
    participant A as Authorizer(+Instancer)
    participant DB as Postgres

    rect rgb(200, 225, 250)
    C1 ->>+ M: Find VM1
    M ->>+ A: GetOrgID
    A -->>- M: Coke
    M ->>+ A: GetInstanceID
    A -->>- M: Americas
    M ->>+ DB: set_config(org_id=Coke, instance_id=Americas)
    M ->>+ DB: SELECT * FROM VM WHERE ID=VM1
    DB -->>- M: | CokeWebServer1 | ID=VM1 | us-west-1|
    M -->>- C1: Return {Name=CokeWebServer1, region=us-west-1, ID=VM1}
    end

    rect rgb(225, 250, 250)
    C2 ->>+ M: Find VM1
    M ->>+ A: GetOrgID
    A -->>- M: Coke
    M ->>+ A: GetInstanceID
    A -->>- M: Europe
    M ->>+ DB: set_config(org_id=Coke, instance_id=Europe)
    M ->>+ DB: SELECT * FROM VM WHERE ID=VM1
    DB -->>- M: | CokeWebServer1 | ID=VM1 | eu-central-1 |
    M -->>- C2: Return {Name=CokeWebServer1, region=eu-central-1, ID=VM1}
    end

    rect rgb(200, 250, 225)
    P ->>+ M: Find VM1
    M ->>+ A: GetOrgID
    A -->>- M: Pepsi
    M ->>+ A: GetInstanceID
    A -->>- M: Americas
    M ->>+ DB: set_config(org_id=Pepsi, instance_id=Americas)
    M ->>+ DB: SELECT * FROM VM WHERE ID=VM1
    DB -->>- M: | PepsiWebServer1 | ID=VM1 | us-west-2 |
    M -->>- P: Return {Name=PepsiWebServer1, region=us-west-2, ID=VM1}
    end
Loading

Sample use case of the realization store where two threads T1, T2 that are parallelly realizing the resource that just got updated at two different enforcement points E1, E2 looks as follows,

sequenceDiagram
    actor T0
    actor T1
    actor T2
    participant E1
    participant E2
    participant RS as RealizationStore
    participant R as ResourceTable
    participant O as OverallStatusTable
    participant E as EnforcementStatusTable

    rect rgb(200,220,240)
    T0 ->>+ RS: PersistIntent P1
    RS -->> R: UPSERT ID=P1
    RS -->> O: Set OverallStatus ID=P1 Status=Pending
    RS ->>- T0: Done

    T0 ->>+ RS: GetOverallStatus P1
    RS -->> O: SELECT ID=P1
    O -->> RS: |P1|PENDING|
    RS ->>- T0: Return PENDING
    end

    rect rgb(220,240,260)
    note right of T1: T1 realizing P1 at E1
    T1 ->>+ RS: MarkPending P1 at E1
    RS -->> E: Set Status ID=P1 Enforcement=E1 Status=Pending
    RS -->> O: Set Status ID=P1 Status=Pending
    RS ->>- T1: Return

    T1 ->> E1: Realize Resource P1 at E1
    note right of T1: T1 SUCCEEDED realizing at E1
    T1 ->>+ RS: MarkSuccess P1 at E1
    RS -->> E: Set Status ID=P1 Enforcement=E1 Status=REALIZED
    RS -->> E: List Status ID=P1 Enforcement=*
    E -->> RS: |P1|E1|REALIZED|, |P1|E2|PENDING|
    RS -->> O: Set OverallStatus ID=P1 Status=Pending
    RS ->>- T1: Return
    note right of T1: T1 COMPLETED realizing P1 at E1
    end

    rect rgb(240,260,280)
    note right of T2: T2 realizing P1 at E2
    T2 ->>+ RS: MarkPending P1 at E2
    RS -->> E: Set Status ID=P1 Enforcement=E2 Status=Pending
    RS -->> O: Set OverallStatus ID=P1 Status=Pending
    RS ->>- T2: Return
    T2 ->> E2: Realize Resource P1 at E2
    end

    rect rgb(200,220,240)
    note right of T0: T0 Fetching OverallStatus of P1
    T0 ->>+ RS: GetOverallStatus P1
    RS -->> O: SELECT ID=P1
    O -->> RS: |P1|PENDING|
    RS ->>- T0: Return PENDING
    end

    rect rgb(240,260,280)
    note right of T2: T2 SUCCEEDED realizing at E2
    T2 ->>+  RS: MarkSuccess P1 at E2
    RS -->> E: Set Status ID=P1 Enforcement=E2 Status=REALIZED
    RS -->> E: List Status ID=P1 Enforcement=*
    E -->> RS: |P1|E1|REALIZED|, |P1|E2|REALIZED|
    RS -->> O: Set OverallStatus ID=P1 Status=REALIZED
    RS ->>- T2: Return
    note right of T2: T2 COMPLETED realizing P1 at E2
    end

    rect rgb(200,220,240)
    note right of T0: T0 Fetching OverallStatus of P1
    T0 ->>+ RS: GetOverallStatus P1
    RS -->> O: SELECT ID=P1
    O -->> RS: |P1|REALIZED|
    RS ->>- T0: Return REALIZED
    end
Loading

Note that in the scenarios above, it is not necessary for the consumers of IRealizationStore to be the same software component.

Features

Currently, following features are supported:

  • CRUD operations on persisted objects, where data is persisted in Postgres database

  • Multi-tenancy persistence is supported with org_id as the column used .for accessing data for different tenants using row-level security (RLS) feature of Postgres. A pluggable Authorizer interface to support multi-tenancy. User's with tenant-specific roles (TENANT_WRITER, TENANT_READER) will be able to access only their own tenant's data.

  • Role-based access control (RBAC) based on the role mappings from the .user to DBRole Mappings.

  • Metadata support like CreatedAt, UpdatedAt, DeletedAt (using gorm.Model)

  • Revisioning is supported if a record being persistent has a field named .revision. Among concurrent updates on same revision of the record only .one of the operations would succeed.

  • Multi-instance persistence is supported with instance_id as the column used for accessing data for different deployment instances using row-level security (RLS) feature of Postgres. Instancer interface is used to support multi-instances. .If instancer is not configured instance_id column doesnt have any special meaning .and treated as normal attribute.

Documentation

Refer to DOCUMENTATION.md for the interfaces exposed like Datastore, Authorizer, Protostore, Realization Store

Future Support

  • Support for services to subscribe for updates to tables.

Contributing

The multi-tenant-persistence-for-saas project team welcomes contributions from the community. Before you start working with multi-tenant-persistence-for-saas, please read our CONTRIBUTING.md. All contributions to this repository must be signed as described on that page. Your signature certifies that you wrote the patch or have the right to pass it on as an open-source patch. For more detailed information, refer to CONTRIBUTING.md.

License

Refer to LICENSE