Browse Source

add some detail around data entitlements

Mark deVilliers 2 years ago
parent
commit
44474ec5bd
1 changed files with 21 additions and 4 deletions
  1. 21 4
      README.md

+ 21 - 4
README.md

@@ -1,7 +1,7 @@
1 1
 # decode-prototype-da
2 2
 
3 3
 This repository contains an early stage prototype working demonstrator which is capable of:
4
-- private IoT data
4
+- retaining private IoT data
5 5
 - search
6 6
 - data entitlement
7 7
 - decentralised data access
@@ -11,6 +11,19 @@ The architectural context for the prototype is based around the discussions in t
11 11
 
12 12
 The purpose of the prototype is to demonstrate the concepts from the DECODE project grounded in an IoT usecase.
13 13
 
14
+Data Entitlement
15
+----------------
16
+
17
+An introduction to concepts of data entitlements as well as a review of prior art was completed as part of the DECODE project.
18
+This document can be found [here](https://desk.dyne.org/s/7gHFaUIoNEFB1Wx#pdfviewer).
19
+
20
+For the purposes of the prototype we have defined any singular piece of  data in our system as being in one of three logical states -
21
+- owner-only - the data is not discoverable or accessible.
22
+- can-discover - the data is discoverable and there will be made available for search. The data is not accessible.
23
+- can-access - the data is accessible and by default discoverable.
24
+
25
+It is important to note that the prototype does not, by design, implement authentication and as such all entitlements once given are applied globally.
26
+
14 27
 Architecture
15 28
 ------------
16 29
 
@@ -21,7 +34,11 @@ An overview of a single node system.
21 34
 
22 35
 ![single node overview]( docs/single-node.png)
23 36
 
24
-In this diagram two IoT devices logically direct their data to the node service. The node service owns an instance of the storage service. 
37
+In this diagram two IoT devices logically direct their data to the node service.
38
+As a convenience we have included fake IoT devices as part of the prototype.
39
+The output of these fake devices correspond to the output of the [device-hub](https://github.com/thingful/device-hub) component as developed by (thingful)[https://thingful.net].
40
+
41
+The node service owns an instance of the storage service.
25 42
 The node has a relationship with the metadata service.
26 43
 
27 44
 The node service is responsible for:
@@ -32,7 +49,7 @@ The node service is responsible for:
32 49
 The node service has a storage service which is responsible for:
33 50
 - maintaining any saved data points
34 51
 
35
-The node service corresponds to the concept of the DECODE node in the DECODE Architecture whitepaper. 
52
+The node service corresponds to the concept of the DECODE node in the DECODE Architecture whitepaper.
36 53
 Please note this has not been made public yet.
37 54
 
38 55
 The metadata service is responsible for:
@@ -115,7 +132,7 @@ The prototype should then be available at the following urls
115 132
 'storage' swagger api - http://localhost:8083/apidocs
116 133
 
117 134
 
118
-To stop the application components via docker compose you can either type Ctrl-C or from another window issue the command 
135
+To stop the application components via docker compose you can either type Ctrl-C or from another window issue the command
119 136
 
120 137
 ```
121 138
 docker-compose down