Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: ADR for data isolation for multi-tenancy #531

Merged
merged 5 commits into from
May 24, 2023
Merged

docs: ADR for data isolation for multi-tenancy #531

merged 5 commits into from
May 24, 2023

Conversation

yshyn-iohk
Copy link
Member

Overview

Fixes ATL-4363

Checklist

My PR contains...

  • No code changes (changes to documentation, CI, metadata, etc.)
  • Bug fixes (non-breaking change which fixes an issue)
  • Improvements (misc. changes to existing features)
  • Features (non-breaking change which adds functionality)

My changes...

  • are breaking changes
  • are not breaking changes
  • If yes to above: I have updated the documentation accordingly

Documentation

  • My changes do not require a change to the project documentation
  • My changes require a change to the project documentation
  • If yes to above: I have updated the documentation accordingly

Tests

  • My changes can not or do not need to be tested
  • My changes can and should be tested by unit and/or integration tests
  • If yes to above: I have added tests to cover my changes
  • If yes to above: I have taken care to cover edge cases in my tests

@yshyn-iohk yshyn-iohk requested a review from a user May 22, 2023 09:33
@yshyn-iohk yshyn-iohk requested a review from BS-IO as a code owner May 22, 2023 09:33
@github-actions
Copy link
Contributor

github-actions bot commented May 22, 2023 •
edited

Atala PRISM Test Results

  50 files  ±0    50 suites  ±0   32s ⏱️ ±0s
372 tests ±0  372 ✔️ ±0  0 💤 ±0  0 ❌ ±0 
373 runs  ±0  373 ✔️ ±0  0 💤 ±0  0 ❌ ±0 

Results for commit 4fef79f. ± Comparison against base commit 3e2a5aa.

♻️ This comment has been updated with latest results.

@github-actions
Copy link
Contributor

github-actions bot commented May 22, 2023 •
edited

Atala PRISM Code Coverage

File Coverage
All files 22% ✅

Minimum allowed coverage is 12%

Generated by 🐒 cobertura-action against 4fef79f

@github-actions
Copy link
Contributor

github-actions bot commented May 22, 2023 •
edited

E2E Test Results

10 files  ±0  10 suites  ±0   5m 28s ⏱️ -16s
19 tests ±0  19 ✔️ ±0  0 💤 ±0  0 ❌ ±0 
30 runs  ±0  30 ✔️ ±0  0 💤 ±0  0 ❌ ±0 

Results for commit 4fef79f. ± Comparison against base commit 3e2a5aa.

♻️ This comment has been updated with latest results.

BS-IO
BS-IO approved these changes May 22, 2023
View reviewed changes
Copy link

@BS-IO BS-IO left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Think this is a good approach - starting simple without limitations towards future escalation.

docs/decisions/20230518-data-isolation-for-multitenancy.md Show resolved Hide resolved
docs/decisions/20230518-data-isolation-for-multitenancy.md Show resolved Hide resolved
bvoiturier
bvoiturier approved these changes May 23, 2023
View reviewed changes
Copy link
Contributor

@bvoiturier bvoiturier left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice work @yshyn-iohk 👍

antonbaliasnikov
antonbaliasnikov reviewed May 23, 2023
View reviewed changes
docs/decisions/20230518-data-isolation-for-multitenancy.md Outdated Show resolved Hide resolved
docs/decisions/20230518-data-isolation-for-multitenancy.md

- Physical Separation - is not covered by this option

## Pros and Cons of the Options
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We go through many options, pros and cons, but what is the decision for short- and long-term?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Short-term - PostgreSQL with Row Security Policies
Long-term - depends on the client's needs. We would build a database sharding for a high number (up to 100MM) of tenants on top of RSP.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this comment reviewed and can be resolved?

@antonbaliasnikov
Copy link

@yshyn-iohk , when writing docs PRs, to not run unnecessary CI jobs, you could add [skip ci] tag at the end of your commits.

@yshyn-iohk yshyn-iohk merged commit dc54af8 into main May 24, 2023
8 checks passed
@yshyn-iohk yshyn-iohk deleted the ATL-4363-ADR-mulititenancy-data-isolation branch May 24, 2023 09:30
mkbreuningIOHK
mkbreuningIOHK reviewed Jun 9, 2023
View reviewed changes
Copy link
Contributor

@mkbreuningIOHK mkbreuningIOHK left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. ADR status to clarify
  2. One comment is not resolved

docs/decisions/20230518-data-isolation-for-multitenancy.md
@@ -0,0 +1,194 @@
# Data isolation for multi-tenancy

- Status: draft
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The status is 'draft' but the ATL-4363 is set to DONE. Please @yshyn-iohk clarify the status.

docs/decisions/20230518-data-isolation-for-multitenancy.md

- Physical Separation - is not covered by this option

## Pros and Cons of the Options
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this comment reviewed and can be resolved?

yshyn-iohk added a commit that referenced this pull request Aug 18, 2023
@yshyn-iohk
I, Yurii Shynbuiev hereby sign-off-by all of my past commits to this …
4538766 
…repo subject to the Developer Certificate of Origin (DCO), Version 1.1.

81a2ad9 docs: removed secret-storage from the Tutorials section. (#559) [skip-ci]
130abbd docs: fix secret storage documentation page (#556)
4f413a3 docs: add secret management documentation [skip-ci] (#542)
885870d Fix ATL-4830 verification policies update (#549)
f6d1fd4 docs: compose the ADR for DID-linked resources. ATL-3186 [skip-ci] (#518)
dc54af8 docs: ADR for data isolation for multi-tenancy (#531)
357273d docs: ADR for HD key derivation in the PRISM v2 (#529)
64b0a2a fix(prism-agent): Alight the error responses according to RFC7807. ATL-3962 (#480)
7fa2e1a fix(prism-agent) Align VerificationPolicy OAS ATL-3909 (#473)
8d42fb1 fix: update mercury to 0.21.0
979b609 chore: update mercury dependency to 0.21.0 (#458)
d3a8d15 feat(prism-agent) update schema logic - agent part. ATL-3164  (#452)
6e22bfc feat(pollux): update credential schema logic (#450) ATL-3164
68b8e4a docs: credential schema introduction, creation, update, and delete. ATL-3548 (#443)
91902ce feat(prism-agent): Add OAS specification to the schema registry endpoint. ATL-3164 (#438)
32f9e83 feat(prism-agent): CredentialSchema DAL, model, service and repositor… (#425)
79352f0 feat(pollux): CredentialSchema DAL, model, service and repository #2 (#424)
6e941da docs(pollux): add credential-schema.md to docusaurus (#407)
ffa5f7e feat(pollux): CredentialSchema service, repository and sql (#416)
c96f804 doc(pollux): verification policy documentation (#384)
1e47ba1 doc(pollux): add schema registry documentation. ATL-1334 (#296)
142ff55 feat(prism-agent): integrate VerificationPolicy DAL into the agent, update OAS and implement REST API for verification policies (#369)
b290a18 feat(pollux): implement the DAL for CRUD on the verifiable policy entity. ATL-2478 (#368)
edaab33 docs: ADR Quill library for sql statement generation (#318)
3d0c642 feat(prism-agent): implement DAL for the credential schema. ATL-1334
e0831e8 feat(pollux): fix the lookup count in the credential schema DAL (#315)
f43320f feat(pollux): add dal for the credential schema ATL-1342 (#298)
6903afa fix(prism-agent): switch datetime format to offsetdatetime. ATL-2723 (#243)
e13a1bd fix(connect): bump mercury version to 1.10.1 and touch README.md
ee27755 fix(pollux): upgrade mercury lib to 1.10.1
cdd4772 fix(castor): README.md is added to increase the version of the castor library
5ffb0cc fix(mercury): simple commit to increase the version of mercury library
403eb38 feat(prism-agent): verification policies pagination. ATL-1334 (#205)
726e2d9 feat(prism-agent): implement pagination with navigation for schema-registry (#195)
4528c57 feat(pollux): alight the OAS for schema registry (#189)
16d5fdb feat(pollux): cleanup the code of IssueCredentialApi
79170f8 feat(pollux): cleanup the OAS from Issue Credentials and other unused tags
d75b36b feat(pollux): schema registry lookup and verification policies REST API ATL-1334 (#168)
b3cf828 feat(apollo): add schema registry to the agent using Tapir library. ATL-1334  (#94)
8d8bf56 doc(adr): use Tapir library as a DLS for OAS (#51)
496337b ATL-1334 feat(pollux): add sandbox project to play with Tapir and schema-registry (#62)
95667ba doc(pollux): add JWT encoding and Present Proof endpoints (#37)
234bc06 [ATL-1388] doc(pollux): add Revocation Registry API, remove v1 from the path, apply changes after review (#14)
e47242c [ATL-1001] doc: add examples of OpenAPI specification of well-known competitors (#23)
22e37cf doc(pollux): add Pollux open-api specification (schema and issue-credentials) (#8)

Signed-off-by: Yurii Shynbuiev <yurii.shynbuiev@iohk.io>
@yshyn-iohk yshyn-iohk mentioned this pull request Aug 18, 2023
Merged
antonbaliasnikov pushed a commit that referenced this pull request Aug 21, 2023
@yshyn-iohk
I, Yurii Shynbuiev hereby sign-off-by all of my past commits to this …
cb8cd06 
…repo subject to the Developer Certificate of Origin (DCO), Version 1.1.

81a2ad9 docs: removed secret-storage from the Tutorials section. (#559) [skip-ci]
130abbd docs: fix secret storage documentation page (#556)
4f413a3 docs: add secret management documentation [skip-ci] (#542)
885870d Fix ATL-4830 verification policies update (#549)
f6d1fd4 docs: compose the ADR for DID-linked resources. ATL-3186 [skip-ci] (#518)
dc54af8 docs: ADR for data isolation for multi-tenancy (#531)
357273d docs: ADR for HD key derivation in the PRISM v2 (#529)
64b0a2a fix(prism-agent): Alight the error responses according to RFC7807. ATL-3962 (#480)
7fa2e1a fix(prism-agent) Align VerificationPolicy OAS ATL-3909 (#473)
8d42fb1 fix: update mercury to 0.21.0
979b609 chore: update mercury dependency to 0.21.0 (#458)
d3a8d15 feat(prism-agent) update schema logic - agent part. ATL-3164  (#452)
6e22bfc feat(pollux): update credential schema logic (#450) ATL-3164
68b8e4a docs: credential schema introduction, creation, update, and delete. ATL-3548 (#443)
91902ce feat(prism-agent): Add OAS specification to the schema registry endpoint. ATL-3164 (#438)
32f9e83 feat(prism-agent): CredentialSchema DAL, model, service and repositor… (#425)
79352f0 feat(pollux): CredentialSchema DAL, model, service and repository #2 (#424)
6e941da docs(pollux): add credential-schema.md to docusaurus (#407)
ffa5f7e feat(pollux): CredentialSchema service, repository and sql (#416)
c96f804 doc(pollux): verification policy documentation (#384)
1e47ba1 doc(pollux): add schema registry documentation. ATL-1334 (#296)
142ff55 feat(prism-agent): integrate VerificationPolicy DAL into the agent, update OAS and implement REST API for verification policies (#369)
b290a18 feat(pollux): implement the DAL for CRUD on the verifiable policy entity. ATL-2478 (#368)
edaab33 docs: ADR Quill library for sql statement generation (#318)
3d0c642 feat(prism-agent): implement DAL for the credential schema. ATL-1334
e0831e8 feat(pollux): fix the lookup count in the credential schema DAL (#315)
f43320f feat(pollux): add dal for the credential schema ATL-1342 (#298)
6903afa fix(prism-agent): switch datetime format to offsetdatetime. ATL-2723 (#243)
e13a1bd fix(connect): bump mercury version to 1.10.1 and touch README.md
ee27755 fix(pollux): upgrade mercury lib to 1.10.1
cdd4772 fix(castor): README.md is added to increase the version of the castor library
5ffb0cc fix(mercury): simple commit to increase the version of mercury library
403eb38 feat(prism-agent): verification policies pagination. ATL-1334 (#205)
726e2d9 feat(prism-agent): implement pagination with navigation for schema-registry (#195)
4528c57 feat(pollux): alight the OAS for schema registry (#189)
16d5fdb feat(pollux): cleanup the code of IssueCredentialApi
79170f8 feat(pollux): cleanup the OAS from Issue Credentials and other unused tags
d75b36b feat(pollux): schema registry lookup and verification policies REST API ATL-1334 (#168)
b3cf828 feat(apollo): add schema registry to the agent using Tapir library. ATL-1334  (#94)
8d8bf56 doc(adr): use Tapir library as a DLS for OAS (#51)
496337b ATL-1334 feat(pollux): add sandbox project to play with Tapir and schema-registry (#62)
95667ba doc(pollux): add JWT encoding and Present Proof endpoints (#37)
234bc06 [ATL-1388] doc(pollux): add Revocation Registry API, remove v1 from the path, apply changes after review (#14)
e47242c [ATL-1001] doc: add examples of OpenAPI specification of well-known competitors (#23)
22e37cf doc(pollux): add Pollux open-api specification (schema and issue-credentials) (#8)

Signed-off-by: Yurii Shynbuiev <yurii.shynbuiev@iohk.io>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@antonbaliasnikov antonbaliasnikov antonbaliasnikov left review comments

@mkbreuningIOHK mkbreuningIOHK mkbreuningIOHK left review comments

@BS-IO BS-IO BS-IO approved these changes

@bvoiturier bvoiturier bvoiturier approved these changes

@mineme0110 mineme0110 Awaiting requested review from mineme0110

@shotexa shotexa Awaiting requested review from shotexa

Assignees
No one assigned
Labels
Type: Documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
6 participants
@yshyn-iohk @antonbaliasnikov @BS-IO @bvoiturier @mkbreuningIOHK @atala-dev