This project is archived. Its data is
read-only
.
Changes
Page history
Update Core Services Overview
authored
May 31, 2022
by
Kateryna Kurach (EPAM)
Show whitespace changes
Inline
Side-by-side
Core-Services-Overview.md
View page @
c77e325b
The Essence of Common Code
==========================
# The Essence of Common Code
OSDU Data Platform
=======================
These are the data platform services for OSDU that form the core set of services for all OSDU data workflows.
# OSDU Data Platform
These are the data platform services for OSDU that form the core set of services for all OSDU data workflows.
## The structure of a repository
)
## Core Services and APIs
|
**Service**
|
**Open API Spec**
|
**Documentation**
|
**Code Repository**
|
**AWS**
|
**Azure**
|
**GCP**
|
**IBM**
| ------- | ------- | -------- | ------ | -------- | -------- |-------- |-------- |
|
**Service**
|
**Open API Spec**
|
**Documentation**
|
**Code Repository**
|
**AWS**
|
**Azure**
|
**GCP**
|
**IBM**
|
|-------------|-------------------|-------------------|---------------------|---------|-----------|---------|---------|
| Legal |
[
API
](
https://community.opengroup.org/osdu/platform/security-and-compliance/legal/-/blob/master/docs/api/compliance_openapi.yaml
)
|
[
How To
](
https://community.opengroup.org/osdu/platform/security-and-compliance/legal/-/blob/master/docs/tutorial/ComplianceService.md
)
|
[
Legal
](
https://community.opengroup.org/osdu/platform/security-and-compliance/legal
)
| |
[
Azure Legal
](
https://community.opengroup.org/osdu/platform/security-and-compliance/legal/-/tree/master/provider/legal-azure
)
| | |
| Entitlements (Deprecated)
|
[
~~API~~
](
/Releases/R2.0/Services/Entitlements/Swagger
)
|
[
~~How To~~
](
/Releases/R2.0/Services/Entitlements/Tutorial
)
| ~~Entitlements is Cloud Specific~~ |
[
~~AWS Entitlements~~
](
https://community.opengroup.org/osdu/platform/security-and-compliance/entitlements-aws
)
|
[
~~Azure Entitlements~~
](
https://community.opengroup.org/osdu/platform/security-and-compliance/entitlements-azure
)
|
[
~~GCP Entitlements Repo~~
](
https://community.opengroup.org/osdu/platform/security-and-compliance/entitlements-gcp
)
|
[
~~IBM Entitlements~~
](
https://community.opengroup.org/osdu/platform/security-and-compliance/entitlements-ibm
)
| Entitlements v2 |
[
API
](
https://community.opengroup.org/osdu/platform/security-and-compliance/entitlements/-/blob/master/docs/api/entitlements_openapi.yaml
)
|
[
How To
](
https://community.opengroup.org/osdu/platform/security-and-compliance/entitlements/-/tree/master/docs/tutorial
)
|
[
Entitlement v2
](
https://community.opengroup.org/osdu/platform/security-and-compliance/entitlements
)
Work in progress | | | |
| Policy (E&O) |
| |
[
Policy service
](
https://community.opengroup.org/osdu/platform/security-and-compliance/policy
)
| | |
|
| Indexer | Not a Public Service |
[
How To
](
https://community.opengroup.org/osdu/platform/system/indexer-service/-/blob/master/docs/tutorial/IndexerService.md
)
|
[
Indexer
](
https://community.opengroup.org/osdu/platform/system/indexer-service
)
<br
/>
[
Indexer Queue
](
https://community.opengroup.org/osdu/platform/system/indexer-queue
)
| |
[
Azure Indexer
](
https://community.opengroup.org/osdu/platform/system/indexer-service/-/tree/master/provider/indexer-azure
)
<br
/>
[
Azure Indexer Queue
](
https://community.opengroup.org/osdu/platform/system/indexer-queue/-/tree/master/indexer-queue-azure
)
| | |
| Storage
|
[
API
](
https://community.opengroup.org/osdu/platform/system/storage/-/blob/master/docs/api/storage_openapi.yaml
)
|
[
How To
](
https://community.opengroup.org/osdu/platform/system/storage/-/blob/master/docs/tutorial/StorageService.md
)
|
[
Storage
](
https://community.opengroup.org/osdu/platform/system/storage
)
| |
[
Azure Storage
](
https://community.opengroup.org/osdu/platform/system/storage/-/tree/master/provider/storage-azure
)
| Entitlements (Deprecated) |
[
~~API~~
](
/Releases/R2.0/Services/Entitlements/Swagger
)
|
[
~~How To~~
](
/Releases/R2.0/Services/Entitlements/Tutorial
)
| ~~Entitlements is Cloud Specific~~ |
[
~~AWS Entitlements~~
](
https://community.opengroup.org/osdu/platform/security-and-compliance/entitlements-aws
)
|
[
~~Azure Entitlements~~
](
https://community.opengroup.org/osdu/platform/security-and-compliance/entitlements-azure
)
|
[
~~GCP Entitlements Repo~~
](
https://community.opengroup.org/osdu/platform/security-and-compliance/entitlements-gcp
)
|
[
~~IBM Entitlements~~
](
https://community.opengroup.org/osdu/platform/security-and-compliance/entitlements-ibm
)
|
| Entitlements v2 |
[
API
](
https://community.opengroup.org/osdu/platform/security-and-compliance/entitlements/-/blob/master/docs/api/entitlements_openapi.yaml
)
|
[
How To
](
https://community.opengroup.org/osdu/platform/security-and-compliance/entitlements/-/tree/master/docs/tutorial
)
|
[
Entitlement v2
](
https://community.opengroup.org/osdu/platform/security-and-compliance/entitlements
)
Work in progress | | |
|
|
| Policy (E&O) | | |
[
Policy service
](
https://community.opengroup.org/osdu/platform/security-and-compliance/policy
)
|
| | |
|
| Indexer | Not a Public Service |
[
How To
](
https://community.opengroup.org/osdu/platform/system/indexer-service/-/blob/master/docs/tutorial/IndexerService.md
)
|
[
Indexer
](
https://community.opengroup.org/osdu/platform/system/indexer-service
)
<br
>
[
Indexer Queue
](
https://community.opengroup.org/osdu/platform/system/indexer-queue
)
|
|
[
Azure Indexer
](
https://community.opengroup.org/osdu/platform/system/indexer-service/-/tree/master/provider/indexer-azure
)
<br
>
[
Azure Indexer Queue
](
https://community.opengroup.org/osdu/platform/system/indexer-queue/-/tree/master/indexer-queue-azure
)
| | |
| Storage |
[
API
](
https://community.opengroup.org/osdu/platform/system/storage/-/blob/master/docs/api/storage_openapi.yaml
)
|
[
How To
](
https://community.opengroup.org/osdu/platform/system/storage/-/blob/master/docs/tutorial/StorageService.md
)
|
[
Storage
](
https://community.opengroup.org/osdu/platform/system/storage
)
| |
[
Azure Storage
](
https://community.opengroup.org/osdu/platform/system/storage/-/tree/master/provider/storage-azure
)
| | |
| Search |
[
API
](
https://community.opengroup.org/osdu/platform/system/search-service/-/blob/master/docs/api/search_openapi.yaml
)
|
[
How To
](
https://community.opengroup.org/osdu/platform/system/search-service/-/blob/master/docs/tutorial/SearchService.md
)
|
[
Search
](
https://community.opengroup.org/osdu/platform/system/search-service
)
| |
[
Azure Search
](
https://community.opengroup.org/osdu/platform/system/search-service/-/tree/master/provider/search-azure
)
| | |
|Delivery (Deprecated) | ~~
[
API
](
https://community.opengroup.org/osdu/platform/system/legacy_delivery/-/blob/master/docs/api/delivery.yaml
)
~~
| ~~
[
Notes
](
https://community.opengroup.org/osdu/documentation/-/wikis/OSDU-(C
)
/Design-and-Implementation/Ingestion-and-Enrichment-Detail/R2-Delivery)
~~
| ~~
[
Delivery
](
https://community.opengroup.org/osdu/platform/system/legacy_delivery/-/tree/master
)
~~
|
|
~~
[
Azure Delivery
](
https://community.opengroup.org/osdu/platform/system/legacy_delivery/-/tree/master/provider/delivery-azure
)
~~
|
|
|
|
Delivery (Deprecated) |
[
~~API
~~
](
https://community.opengroup.org/osdu/platform/system/legacy_delivery/-/blob/master/docs/api/delivery.yaml
)
|
[
~~Notes
~~
](
https://community.opengroup.org/osdu/documentation/-/wikis/OSDU-(C
)
/Design-and-Implementation/Ingestion-and-Enrichment-Detail/R2-Delivery) |
[
~~Delivery
~~
](
https://community.opengroup.org/osdu/platform/system/legacy_delivery/-/tree/master
)
| |
[
~~Azure Delivery
~~
](
https://community.opengroup.org/osdu/platform/system/legacy_delivery/-/tree/master/provider/delivery-azure
)
| | |
| File |
[
API
](
https://community.opengroup.org/osdu/platform/system/file/-/blob/master/docs/file-service_openapi.yaml
)
|
[
How to
](
https://community.opengroup.org/osdu/platform/system/file/-/blob/master/README.md
)
|
[
File
](
https://community.opengroup.org/osdu/platform/system/file
)
| |
[
File Azure
](
https://community.opengroup.org/osdu/platform/system/file/-/tree/master/provider/file-azure
)
| | |
| Dataset |
[
API
](
https://community.opengroup.org/osdu/platform/system/dataset/-/blob/master/docs/dataset.swagger.yaml
)
|
[
How to
](
https://community.opengroup.org/osdu/platform/system/dataset/-/tree/master
)
|
[
Dataset
](
https://community.opengroup.org/osdu/platform/system/dataset
)
| | | | |
Schema|
[
API
](
https://community.opengroup.org/osdu/platform/system/schema-service/-/blob/master/docs/api/schema_openapi.yaml
)
|
[
How to
](
https://community.opengroup.org/osdu/platform/system/schema-service/-/blob/master/docs/SchemaService-OSDU.md
)
|
[
Schema
](
https://community.opengroup.org/osdu/platform/system/schema-service
)
|
|
[
Schema Azure
](
https://community.opengroup.org/osdu/platform/system/schema-service/-/tree/master/provider/schema-azure
)
|
|
|
Partition|
[
API
](
https://community.opengroup.org/osdu/platform/system/partition/-/blob/master/docs/api/partition_openapi.yaml
)
|
[
How to
](
https://community.opengroup.org/osdu/platform/system/partition/-/blob/master/docs/tutorial/Partition.md
)
|
[
Partition
](
https://community.opengroup.org/osdu/platform/system/partition
)
|
|
[
Partition Azure
](
)
|
|
|
Register|
[
API
](
https://community.opengroup.org/osdu/platform/system/register/-/blob/master/docs/api/register_openapi.yaml
)
|
[
How to
](
https://community.opengroup.org/osdu/platform/system/register/-/tree/master/docs/tutorial
)
|
[
Register
](
https://community.opengroup.org/osdu/platform/system/register
)
|
|
[
Register Azure
](
)
|
|
|
Notification|
[
API
](
https://community.opengroup.org/osdu/platform/system/notification/-/blob/master/docs/api/notification_openapi.yaml
)
|
[
How to
](
https://community.opengroup.org/osdu/platform/system/notification/-/blob/master/docs/tutorial/DataNotification.md
)
|
[
Notification
](
https://community.opengroup.org/osdu/platform/system/notification
)
|
|
[
Notification Azure
](
)
|
|
|
|
Schema
|
[
API
](
https://community.opengroup.org/osdu/platform/system/schema-service/-/blob/master/docs/api/schema_openapi.yaml
)
|
[
How to
](
https://community.opengroup.org/osdu/platform/system/schema-service/-/blob/master/docs/SchemaService-OSDU.md
)
|
[
Schema
](
https://community.opengroup.org/osdu/platform/system/schema-service
)
|
|
[
Schema Azure
](
https://community.opengroup.org/osdu/platform/system/schema-service/-/tree/master/provider/schema-azure
)
|
|
|
|
Partition
|
[
API
](
https://community.opengroup.org/osdu/platform/system/partition/-/blob/master/docs/api/partition_openapi.yaml
)
|
[
How to
](
https://community.opengroup.org/osdu/platform/system/partition/-/blob/master/docs/tutorial/Partition.md
)
|
[
Partition
](
https://community.opengroup.org/osdu/platform/system/partition
)
|
|
[
Partition Azure
](
)
|
|
|
|
Register
|
[
API
](
https://community.opengroup.org/osdu/platform/system/register/-/blob/master/docs/api/register_openapi.yaml
)
|
[
How to
](
https://community.opengroup.org/osdu/platform/system/register/-/tree/master/docs/tutorial
)
|
[
Register
](
https://community.opengroup.org/osdu/platform/system/register
)
|
|
[
Register Azure
](
)
|
|
|
|
Notification
|
[
API
](
https://community.opengroup.org/osdu/platform/system/notification/-/blob/master/docs/api/notification_openapi.yaml
)
|
[
How to
](
https://community.opengroup.org/osdu/platform/system/notification/-/blob/master/docs/tutorial/DataNotification.md
)
|
[
Notification
](
https://community.opengroup.org/osdu/platform/system/notification
)
|
|
[
Notification Azure
](
)
|
|
|
## Data Flow Services and APIs
|
**Service**
|
**Open API Spec**
|
**Documentation**
|
**Code Repository**
|
|
-------
|
-------
|
--------
|
------
|
|
-----
-------
-|------------
-------
|
--------
-----------|---------------
------
|
| Ingestion Workflow Service |
[
API
](
https://community.opengroup.org/osdu/platform/data-flow/ingestion/ingestion-workflow/-/blob/master/docs/api/openapi.workflow.yaml
)
|
[
Service Intro
](
https://community.opengroup.org/osdu/platform/data-flow/ingestion/ingestion-workflow/-/blob/master/README.md
)
|
[
Ingestion Workflow
](
https://community.opengroup.org/osdu/platform/data-flow/ingestion/ingestion-workflow
)
|
|
- CSV Ingestion | | |
[
CSV Parser
](
https://community.opengroup.org/osdu/platform/data-flow/ingestion/csv-parser/csv-parser
)
|
|
- Manifest Ingestion | | |
[
Manifest ingestion
](
https://community.opengroup.org/osdu/platform/data-flow/ingestion/ingestion-dags
)
|
|
- WITSML Ingestion | | |
[
WITSML parser
](
https://community.opengroup.org/osdu/platform/data-flow/ingestion/energistics-osdu-integration
)
|
| Ingestion Service (
[
Deprecated
](
https://community.opengroup.org/osdu/platform/data-flow/ingestion/ingestion-service/-/issues/35
)
) | ~~
[
Service Intro
](
https://community.opengroup.org/osdu/platform/data-flow/ingestion/ingestion-service/-/blob/master/README.md
)
~~ | ~~
[
Service Intro
](
https://community.opengroup.org/osdu/platform/data-flow/ingestion/ingestion-service/-/blob/master/README.md
)
~~ | ~~
[
Ingestion
](
https://community.opengroup.org/osdu/platform/data-flow/ingestion/ingestion-service
)
~~ |
| - CSV Ingestion | | |
[
CSV Parser
](
https://community.opengroup.org/osdu/platform/data-flow/ingestion/csv-parser/csv-parser
)
|
| - Manifest Ingestion | | |
[
Manifest ingestion
](
https://community.opengroup.org/osdu/platform/data-flow/ingestion/ingestion-dags
)
|
| - WITSML Ingestion | | |
[
WITSML parser
](
https://community.opengroup.org/osdu/platform/data-flow/ingestion/energistics-osdu-integration
)
|
| Ingestion Service (
[
Deprecated
](
https://community.opengroup.org/osdu/platform/data-flow/ingestion/ingestion-service/-/issues/35
"ADR: Deprecate Ingestion Framework for R3"
)
) |
[
~~Service Intro~~
](
https://community.opengroup.org/osdu/platform/data-flow/ingestion/ingestion-service/-/blob/master/README.md
)
|
[
~~Service Intro~~
](
https://community.opengroup.org/osdu/platform/data-flow/ingestion/ingestion-service/-/blob/master/README.md
)
|
[
~~Ingestion~~
](
https://community.opengroup.org/osdu/platform/data-flow/ingestion/ingestion-service
)
|
## Reference Systems Services and APIs
|
**Service**
|
**Open API Spec**
|
**Documentation**
|
**Code Repository**
|
**AWS**
|
**Azure**
|
**GCP**
|
**IBM**
|
-------
| ------- |
--------
|
------
|
--------
|
--------
|--------
|--------
|
|
**Service**
|
**Open API Spec**
|
**Documentation**
|
**Code Repository**
|
**AWS**
|
**Azure**
|
**GCP**
|
**IBM**
|
|
------
-------
|-------------------|-----------
--------
|
------
---------------|-
--------
|
--------
---
|--------
-
|--------
-
|
| CRS Conversion |
[
API
](
https://community.opengroup.org/osdu/platform/system/reference/crs-conversion-service/-/tree/master/docs
)
|
[
API Doc
](
https://community.opengroup.org/osdu/platform/system/reference/crs-conversion-service/-/tree/master/docs
)
|
[
CRS Conversion Service
](
https://community.opengroup.org/osdu/platform/system/reference/crs-conversion-service
)
| |
[
CRS Conversion Azure
](
https://community.opengroup.org/osdu/platform/system/reference/crs-conversion-service/-/tree/master/provider/crs-converter-azure/crs-converter-aks
)
| | |
CRS Catalog|
[
API
](
https://community.opengroup.org/osdu/platform/system/reference/crs-catalog-service/-/tree/master/docs/api_spec
)
|
[
API Doc
](
https://community.opengroup.org/osdu/platform/system/reference/crs-catalog-service/-/tree/master/docs
)
|
[
CRS Catalog Service
](
https://community.opengroup.org/osdu/platform/system/reference/crs-catalog-service
)
| |
[
CRS Catalog Azure
](
https://community.opengroup.org/osdu/platform/system/reference/crs-catalog-service/-/tree/master/provider/crs-catalog-azure/crs-catalog-aks
)
|
|
|
Unit|
[
API
](
https://community.opengroup.org/osdu/platform/system/reference/unit-service/-/tree/master/docs
)
|
[
API Doc
](
https://community.opengroup.org/osdu/platform/system/reference/unit-service/-/tree/master/docs
)
|
[
Unit Service
](
https://community.opengroup.org/osdu/platform/system/reference/unit-service
)
| |
[
Unit Azure
](
https://community.opengroup.org/osdu/platform/system/reference/unit-service/-/tree/master/provider/unit-azure/unit-aks
)
|
|
|
|
CRS Catalog
|
[
API
](
https://community.opengroup.org/osdu/platform/system/reference/crs-catalog-service/-/tree/master/docs/api_spec
)
|
[
API Doc
](
https://community.opengroup.org/osdu/platform/system/reference/crs-catalog-service/-/tree/master/docs
)
|
[
CRS Catalog Service
](
https://community.opengroup.org/osdu/platform/system/reference/crs-catalog-service
)
| |
[
CRS Catalog Azure
](
https://community.opengroup.org/osdu/platform/system/reference/crs-catalog-service/-/tree/master/provider/crs-catalog-azure/crs-catalog-aks
)
| |
|
|
Unit
|
[
API
](
https://community.opengroup.org/osdu/platform/system/reference/unit-service/-/tree/master/docs
)
|
[
API Doc
](
https://community.opengroup.org/osdu/platform/system/reference/unit-service/-/tree/master/docs
)
|
[
Unit Service
](
https://community.opengroup.org/osdu/platform/system/reference/unit-service
)
| |
[
Unit Azure
](
https://community.opengroup.org/osdu/platform/system/reference/unit-service/-/tree/master/provider/unit-azure/unit-aks
)
| |
|
## Domain Data Management Services
| Domain | Open API Spec | Documentation | Code repo |
|--------|---------------
---------------------------------------------------------------------------------------------------------------------------------------------------|----------------|--------------------------------------------------------------------------------------
-----------|
|--------|---------------
|---------------|
-----------|
| Seismic |
[
API
](
https://community.opengroup.org/osdu/platform/domain-data-mgmt-services/seismic/seismic-dms-suite/seismic-store-service/-/blob/master/app/sdms/docs/api/openapi.osdu.yaml
)
|
[
Documentation
](
https://community.opengroup.org/osdu/platform/domain-data-mgmt-services/seismic/home/-/tree/master/docs
)
|
[
Seismic DDMS
](
https://community.opengroup.org/osdu/platform/domain-data-mgmt-services/seismic
)
|
| Wellbore |
[
API
](
https://community.opengroup.org/osdu/platform/domain-data-mgmt-services/wellbore/wellbore-domain-services/-/blob/master/docs/api/openapi.json
)
|
[
Documentation
](
https://community.opengroup.org/osdu/platform/domain-data-mgmt-services/wellbore/wellbore-domain-services/-/tree/master/docs
)
|
[
Wellbore DDMS
](
https://community.opengroup.org/osdu/platform/domain-data-mgmt-services/wellbore
)
|
| Well Delivery (WIP) |
[
API
](
https://community.opengroup.org/osdu/platform/domain-data-mgmt-services/well-delivery/well-delivery/-/blob/master/docs/api/swagger.yaml
)
|
[
Documentation
](
https://community.opengroup.org/osdu/platform/domain-data-mgmt-services/well-delivery/well-delivery/-/tree/master/docs
)
|
[
Well delivery DDMS
](
https://community.opengroup.org/osdu/platform/domain-data-mgmt-services/well-delivery/well-delivery
)
|
...
...
@@ -60,12 +55,11 @@ Unit| [API](https://community.opengroup.org/osdu/platform/system/reference/unit-
## Consumption Apps
|
**Apps**
|
**Open API Spec**
|
**Documentation**
|
**Code Repository**
|
|
-------
| ------- | -------- | ------ |
|
---
-------
|-------------------|-------------------|---------------------|
| Admin UI | | |
[
Code repo
](
https://community.opengroup.org/osdu/ui/admin-ui/-/tree/master/OSDUApp
)
|
# OSDU Data Platform Libraries
OSDU Data Platform Libraries
=======================
These are the convenience libraries that the data platform uses across different services. There is a core set of libraries (common behavior) as well as cloud platform specific versions that facilitate integration in their environment:
-
[
GitLab Core Common
](
https://community.opengroup.org/osdu/platform/system/lib/core/os-core-common
)
...
...
...
...
