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.

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

Terminus docs #123

Draft
wants to merge 39 commits into
base: main
Choose a base branch
from
Draft
Changes from 1 commit
Commits
Show all changes
39 commits
Select commit Hold shift + click to select a range
cabd80f
Terminus docs WIP
Sep 12, 2022
11e2f68
wip
Sep 13, 2022
ebac72d
docs wip
Sep 14, 2022
7657dac
env variables refactor
Sep 14, 2022
89f037d
tweaks and adding sections
Sep 15, 2022
8c799aa
diagram added
Sep 20, 2022
f0a30b5
docs WIP
Sep 21, 2022
1c74189
Blockly UI assets for proxy documentation
Sep 21, 2022
4a90fca
WIP
Sep 22, 2022
47bbbc6
proxy documentation
Sep 22, 2022
689e73e
refined
Sep 22, 2022
569b126
updated warning
Sep 23, 2022
5548f1c
documentation for vault service and persistence layer
Sep 23, 2022
2fc9b3d
api links
Oct 3, 2022
0e291d8
encryption section written and updates
Oct 4, 2022
8338caa
links updated
Oct 4, 2022
1dbd058
Merge branch 'release' into terminus_docs
deepakprabhakara Oct 13, 2022
4d7d1d5
formatting, fixed typos
deepakprabhakara Oct 13, 2022
f8b438b
fixed typo
deepakprabhakara Oct 13, 2022
be31b64
removed BYOD until we have more dbs supported
deepakprabhakara Oct 13, 2022
47abe87
formatting
deepakprabhakara Oct 13, 2022
5c4604b
deploy wip
Oct 14, 2022
5dd1c10
- non docker compose deployment
Oct 17, 2022
9fce162
Merge branch 'main' into terminus_docs
Nov 7, 2022
1370df4
updated with multitenant and multimodel information
Nov 7, 2022
4e43ea5
KEK -> DEK
Nov 7, 2022
3a3683a
Proxy AES Key is now the default KEK
Nov 7, 2022
536ee20
updated
Nov 7, 2022
4a1600c
Merge branch 'release' into terminus_docs
deepakprabhakara Feb 15, 2024
a77156e
Merge branch 'main' into terminus_docs
deepakprabhakara Feb 25, 2024
8b1846b
formatting
deepakprabhakara Feb 25, 2024
2db6319
fixed typos
deepakprabhakara Feb 26, 2024
28814ab
Merge branch 'main' into terminus_docs
deepakprabhakara Feb 26, 2024
3c54bd3
Merge branch 'tweak/images' into terminus_docs
deepakprabhakara Feb 26, 2024
09cb6aa
Merge branch 'main' into terminus_docs
deepakprabhakara Aug 20, 2024
b15f9a1
Merge commit '689a3bc8a2188b2efa98096e3d8405091dba3fd2' into terminus…
deepakprabhakara Aug 20, 2024
f6f9ddb
fixes
deepakprabhakara Aug 20, 2024
70efdde
Merge branch 'main' into terminus_docs
deepakprabhakara Oct 3, 2024
106f3d9
Merge branch 'main' into terminus_docs
deepakprabhakara Oct 16, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
docs WIP
  • Loading branch information
David Costa Faidella committed Sep 21, 2022

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
commit f0a30b5d5083c984fd44724977a0f2aea722bcc6
23 changes: 22 additions & 1 deletion docs/terminus/architecture/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,27 @@
# Architecture

Block diagrams, parts. Configurations. Go lang, cue, blockly.
Terminus can be generally represented as the following:

![General Diagran](./general.png)
---------------

Terminus is by design, a multicomponent decupled systems where data is protected from each of the components. Nothing travels in the clear unless explicitly set, thus enabling the implementation of the most stringent data privacy and data segregation policies. The data stored in the vault is encrypted as specified in the proxy and has no visibility on it

From an architectural point of view, Terminus is made of the following components having the following responsibilities:

- [Proxy Service](./proxy):
- Exposes a public facing API for storage and retrieval of data
- Via no code UI, allows the setup and configuration of the business data models to be encrypted and masked
- Implements the access control policies (ACP), including authentication, authorisation, role mapping and granular access
- Performs the relevant encryption/decryption/masking operations
- Interacts with external KMSs enabling BYOK models

- [Vault Service](./vaultservice):
- Exposes a primitive private API for the proxy to store and retrieve data
- Enables an additional layer of encryption. Anything that travels to the vault, beyhond the business encryption policies gets encrypted at the vault level
- It has no knowledge or understanding of business models, treating the incoming and outgoing data completely transparently

- [Persistence vault](./vault)
- Stores and retrieves data
- Has no knowledge of whatever payloads are stored internally

1 change: 1 addition & 0 deletions docs/terminus/architecture/proxy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Proxy Service
1 change: 1 addition & 0 deletions docs/terminus/architecture/vault.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Persistence Vault
1 change: 1 addition & 0 deletions docs/terminus/architecture/vaultservice.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Vault Service
18 changes: 18 additions & 0 deletions sidebars.js
Original file line number Diff line number Diff line change
@@ -88,6 +88,24 @@ module.exports = {
label: 'Architecture',
link: { type: 'doc', id: 'terminus/architecture/index' },
items: [
{
type: 'category',
label: 'Proxy Service',
link: { type: 'doc', id: 'terminus/architecture/proxy' },
items: [],
},
{
type: 'category',
label: 'Vault Service',
link: { type: 'doc', id: 'terminus/architecture/vaultservice' },
items: [],
},
{
type: 'category',
label: 'Persistent Vault',
link: { type: 'doc', id: 'terminus/architecture/vault' },
items: [],
},
{
type: 'category',
label: 'Encryption',