Skip to content

Commit 1a44312

Browse files
authored
Update osdu-services-on-adme.md
Aligned descriptions of services with what is available in OSDU and reordered services in alphabetical order.
1 parent 693dc85 commit 1a44312

File tree

1 file changed

+34
-29
lines changed

1 file changed

+34
-29
lines changed
Lines changed: 34 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: OSDU Concepts - Available and Exclusive Services
2+
title: OSDU Concepts - Available and Unavailable Services
33
description: This article provides an overview of the OSDU services available on Azure Data Manager for Energy and the OSDU services that are exclusively available in the community version.
44
author: bananibrahim
55
ms.service: energy-data-services
@@ -10,47 +10,52 @@ ms.date: 06/14/2024
1010
ms.custom: template-concept
1111
---
1212

13-
# OSDU® concepts: available and exclusive services
13+
# OSDU® concepts: available and unavailable services
1414
Azure Data Manager for Energy is currently compliant with the M18 OSDU® milestone release.
1515
## OSDU® M18 services available on Azure Data Manager for Energy
1616
Below you'll find an overview of the OSDU® services that are currently available on Azure Data Manager for Energy. Note that this page will be regularly updated as service versions and availability evolve.
1717
### Core and helper services
18-
- **Indexer**: Provides an endpoint to create aliases for existing indices and features flag index extended properties.
19-
- **Indexer Queue**: Manages the queuing of indexing tasks and logs important identifiers.
20-
- **Schema**: Manages OSDU data definition deliverables, including new schemas and schema versions.
21-
- **Search**: Handles search functionality within the OSDU platform.
22-
- **Storage**: Manages the storage of records and includes a "Frame of Reference" header for batch records.
23-
- **Notification**: Manages global exception API responses and notifications within the OSDU platform.
24-
- **Register**: Handles the registration of entity types with consistent entityType regex patterns.
25-
- **Secret**: Manages secret names and handles unknown Secret Manager errors.
26-
- **File**: Manages file-related operations, including default TTL expiry time changes for downloadURL and uploadURL APIs.
27-
- **CRS Conversion**: Manages the conversion of coordinate reference systems.
28-
- **CRS Catalog**: Provides a comprehensive listing of coordinate reference systems for geospatial data management.
29-
- **Unit**: Manages units of measurement.
30-
- **Legal**: Managing legal tags associated with datasets.
31-
- **Partition**: Manages logical divisions of data for efficient access and governance.
18+
- **CRS Catalog**: Provides API endpoints to work with geodetic reference data, allowing developers to retrieve CRS definitions, select appropriate CRSs for data ingestion, and search for CRSs based on various constraints.
19+
- **CRS Conversion**: Enables the conversion of coordinates from one cooridante reference system (CRS) to another.
20+
- **CSV Parser DAG**: Helps in parsing CSV files into a format for ingestion and processing.
21+
- **Dataset**: Provides internal and external API endpoints to allow and application or user fetch storage/retrieval instructions for various types of datasets.
22+
- **Entitlements**: Used to enable authorization in OSDU Data Ecosystem. The service allows for the creation of groups. A group name defines a permission. Users who are added to that group obtain that permission. The main motivation for entitlements service is data authorization, but the functionality enables three use cases: Data groups used for data authorization, Service groups used for service authorization, User groups used for hierarchical grouping of user and service identities.
23+
- **File**: Provides internal and external API endpoints to let the application or user fetch any records from the system or request file location data.
24+
- **Indexer**: Provides a mechanism for indexing documents that contain structured or unstructured data. Documents and indices are saved in a separate persistent store optimized for search operations. The indexer API can index any number of documents.
25+
- **Indexer Queue**: Pprovides a set of APIs that help in forwarding the messages to and from storage service to indexer service.
26+
- **Legal**: Managing LegalTags associated with datasets. A LegalTag is the entity that represents the legal status of data in the Data Ecosystem. It is a collection of properties that governs how the data can be consumed and ingested.
27+
- **Notification**: Allows for interested consumers to subscribe to data and metadata changes using a publish/subscriber pattern.
28+
- **Partition**: Creates and retrieves the partition specific properties (secret and non-secret) on behalf of other services
3229
- **Python SDK**: Offers tools and libraries for developers to interact with OSDU services using Python.
33-
- **Dataset**: Supports various data operations.
34-
- **CSV Parser**: Helps in parsing CSV files into a format for ingestion and processing.
35-
- **Entitlements**: Enables authorization by allowing the creation and management of groups that define user permissions.
30+
- **Register**: Allow an application to register an action (the function to be triggered). It will expect data (context) to come from OSDU to enable the action, and the application can register a filter (enable/disable) to say what data can be used with this action.
31+
- **Schema**: Enables a centralized governance and management of schema in the Data Ecosystem. It offers an implementation of the schema standard. Schema Service provides all necessary APIs to Fetch, create, update and mark a schema obsolete.
32+
- **Search**: Provides a mechanism for searching indexes. Supports full-text search on string fields, range queries on dates, numeric or string fields, etc., along with geo-spatial search.
33+
- **Secret**: Facilitates the storage and retrieval of various types of secrets in a specified repository(ies) so that secrets can be secure, separated from the secrets in the infrastructure repository, and be managed easily be interfacing applications.
34+
- **Seismic File Metadata**: Manages metadata associated with seismic data. It annotates dimensions, value channels, and generic key/value pairs.
35+
- **Storage**: Provides a set of APIs to manage the entire metadata life-cycle such as ingestion (persistence), modification, deletion, versioning and data schema.
36+
- **Unit**: Provides dimension/measurement and unit definitions.
3637

3738
### Ingestion services
38-
- **Ingestion Workflow**: Manages the workflow for data ingestion, including user ID configuration.
39+
- **EDS DMS [[Preview]](how-to-enable-external-data-sources.md)**: Pulls specified data (metadata) from OSDU-compliant data sources via scheduled jobs while leaving associated dataset files (LAS, SEG-Y, etc.) stored at the external source for retrieval on demand.
40+
- **EDS Fetch & Ingest DAG**: Facilitates fetching data from external providers and ingesting it into the OSDU platform. It involves steps like registering with providers, creating data jobs, and triggering ingestion.
41+
- **EDS Scheduler**: Automates data fetching based on predefined schedules and sends emails to recipients as needed. It ensures data remains current without manual intervention
42+
- **Ingestion Workflow**: Initiates business processes within the system. During the prototype phase, it facilitates CRUD operations on workflow metadata and triggers workflows in Apache Airflow. Additionally, the service manages process startup records, acting as a wrapper around Airflow functions.
3943
- **osdu-airflow-lib**: A library that enables user context ingestion within the Airflow workflows.
4044
- **osdu-ingestion-lib**: A library that supports user context ingestion and includes various fixes related to Python versioning and authority replacement.
41-
- **Segy to Zgy Conversion**: Converts SEGY file formats to ZGY.
42-
- **Segy to oVDS Conversion**: Converts SEGY files to oVDS format.
43-
- **External Data Services [[Preview]](how-to-enable-external-data-sources.md)**: Pulls specified data (metadata) from OSDU-compliant data sources via scheduled jobs while leaving associated dataset files (LAS, SEG-Y, etc.) stored at the external source for retrieval on demand.
45+
- **SegY-to-oVDS DAG**: Converts SegY file formats to oVDS.
46+
- **SegY-to-oZGY DAG**: Converts SrgY file formats to ZGY.
4447

4548
### Domain data management services (DDMS)
4649
- **Seismic DDMS**: Enables secure access and efficient handling of seismic datasets.
4750
- **Wellbore DDMS**: Enables secure access and handling of wellbore-related data.
4851
- **Well Delivery DDMS**: Enables secure access, storage, and interaction of Well Delivery (planning and execution) data.
4952

50-
## OSDU® services exclusive to M18 community version
51-
NOTE: The following OSDU® services aren't currently available on Azure Data Manager for Energy.
52-
- **WITSML Parser**
53-
- **Reservoir DDMS**
54-
- **Policy Service**
53+
## OSDU® services unavailable on Azure Data Manager for Energy
54+
NOTE: The following OSDU® services are currently unavailable on Azure Data Manager for Energy.
55+
- **EDS Naturalization DAG**
56+
- **Energistics Parser DAG**
5557
- **Geospatial Consumption Zone**
56-
- **Manifest Ingestion by Reference**
58+
- **Manifest Ingestion by Reference DAG**
59+
- **Policy Service**
60+
- **Reservoir DDMS**
61+
- **WITSML Parser DAG**

0 commit comments

Comments
 (0)