Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
D
DataCatalog
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package registry
Container registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
eFlows4HPC WP2
DataCatalog
Commits
6ce6f6f6
Commit
6ce6f6f6
authored
4 years ago
by
Jedrzej Rybicki
Browse files
Options
Downloads
Patches
Plain Diff
archs
parent
e2754c05
No related branches found
No related tags found
No related merge requests found
Changes
1
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
arch/arch.adoc
+32
-3
32 additions, 3 deletions
arch/arch.adoc
with
32 additions
and
3 deletions
arch/arch.adoc
+
32
−
3
View file @
6ce6f6f6
...
@@ -30,6 +30,8 @@ Main features:
...
@@ -30,6 +30,8 @@ Main features:
| R1 | View data sources | View the list of data sources and details on particular ones (web page + api)
| R1 | View data sources | View the list of data sources and details on particular ones (web page + api)
| R2 | Register data sets | Authenticated users should be able register/change data sets with additional metadata
| R2 | Register data sets | Authenticated users should be able register/change data sets with additional metadata
| R3 | No schema MD | We don't impose a schema for the metadata (not know what is relevant)
| R4 | Documented API | Swagger/OpenAPI
|===
|===
=== Quality Goals
=== Quality Goals
...
@@ -38,9 +40,12 @@ Main features:
...
@@ -38,9 +40,12 @@ Main features:
|===
|===
| **ID** | **Prio**| **Quality**| **Explanation**
| **ID** | **Prio**| **Quality**| **Explanation**
| Q1 | 1 | Data Quality | Metadata
| Q1 | 1 | Extensibility | Possibility to add new metadata to existing rows
| Q2 | 2 | Interoperability | The service should work with Data Logistics
| Q3 | 2 | Deployability | Quick/automatic deployment
|===
|===
[[section-architecture-constraints]]
[[section-architecture-constraints]]
== Architecture Constraints
== Architecture Constraints
...
@@ -49,7 +54,10 @@ Main features:
...
@@ -49,7 +54,10 @@ Main features:
|===
|===
| **Constraint** | **Explanation**
| **Constraint** | **Explanation**
| Local orientation | Oor
| Authentication | There is no solution for that in the project yet, local authenticator?
| Deployment | We shall use CI/CD, the project will also be a playing field to setup this and test before the Data Logistics
| github vs. gitlab | Not sure if we can use our local gitlab
| Docker-based Deployment | This technology will be used in the project anyways
|===
|===
...
@@ -62,4 +70,25 @@ image:datacat.png["Business view"]
...
@@ -62,4 +70,25 @@ image:datacat.png["Business view"]
=== Technical Context
=== Technical Context
image:technical_context.png["Technical L1 view"]
// image:technical_context.png["Technical L1 view"]
**Mapping Input/Output to Channels**
User -> Data Catalog: simple (static?) web page view
Data Logistics -> Data catalog HTTP/API read-only
Admin -> Data Catalog: either a web page or CLI
[[section-solution-strategy]]
== Solution Strategy
=== Speed and flexibility
This product will not be very mission critical, we want to keep it simple. A solution even without a backend database would be possible. Probably we
will use some noSQL database for maximal flexibility. API with Swagger/OpenAPI (e.g. fastAPI). Frontend static page with JavaScript calls to the API.
=== Deployment with Jenkins
1. Jenkins instance in HDF Cloud to setup Pipelines,
2. Code in Github/Gitlab
3. Automatic deployment with Docker? Docker-compose
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment