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

Rename open lineage services and update component statuses #8034

Merged
merged 3 commits into from
Feb 4, 2024

Conversation

mandy-chessell
Copy link
Contributor

Description

This PR focuses on consistent naming and services for new users of Egeria.

  • It renames the open lineage services to lineage warehouse services and the open lineage janus connector to lineage warehouse janus connector. The aim is to avoid further confusion with the open lineage standard which we also support.
  • It renames the server classification of METADATA_SERVER to METADATA_ACCESS_STORE to match the docs.
  • It adds new admin services for working with the whole integration daemon services and engine host services sections of the configuration document.
  • It adds new admin services for configuring all engine services or all integration services in a single call.
  • It adds details of hosting server type, partner services/server to the getRegisteredXXXServices calls helping an administrator understand the services that need to be active in each type of server.
  • It updates the component status in the Enums and README.mds so they are consistent.

Here is an example of the new getRegisteredXXXServices calls for the governance server services. It shows the new properties returned for the server type and the new names for the open lineage server (lineage warehouse) and open lineage services (lineage warehouse services).

GET {{baseURL}}/open-metadata/platform-services/users/{{adminUserId}}/server-platform/registered-services/governance-services

{
    "class": "RegisteredOMAGServicesResponse",
    "relatedHTTPCode": 200,
    "services": [
        {
            "serviceId": 190,
            "serviceName": "Lineage Warehouse Services",
            "serviceDevelopmentStatus": "IN_DEVELOPMENT",
            "serviceURLMarker": "lineage-warehouse",
            "serviceDescription": "Store and query asset lineage",
            "serviceWiki": "https://egeria-project.org/services/lineage-warehouse-services/",
            "serverType": "Lineage Warehouse",
            "partnerServiceName": "Asset Lineage OMAS",
            "partnerServerType": "Metadata Access Server"
        },
        {
            "serviceId": 191,
            "serviceName": "Conformance Suite Services",
            "serviceDevelopmentStatus": "STABLE",
            "serviceURLMarker": "conformance-suite",
            "serviceDescription": "Run automated open metadata conformance suite services.",
            "serviceWiki": "https://egeria-project.org/guides/cts/overview/",
            "serverType": "Conformance Test Server"
        },
        {
            "serviceId": 192,
            "serviceName": "Data Engine Proxy Services",
            "serviceDevelopmentStatus": "IN_DEVELOPMENT",
            "serviceURLMarker": "data-engine-proxy",
            "serviceDescription": "Integrate Data Engines that are not self-capable of integrating directly with the Data Engine OMAS.",
            "serviceWiki": "https://egeria-project.org/services/data-engine-proxy-services/",
            "serverType": "Data Engine Proxy",
            "partnerServiceName": "Data Engine OMAS",
            "partnerServerType": "Metadata Access Server"
        },
        {
            "serviceId": 193,
            "serviceName": "Integration Daemon Services",
            "serviceDevelopmentStatus": "STABLE",
            "serviceURLMarker": "integration-daemon",
            "serviceDescription": "Hosts integration connectors that are exchanging metadata with third party technologies.",
            "serviceWiki": "https://egeria-project.org/services/integration-daemon-services/",
            "serverType": "Integration Daemon",
            "partnerServiceName": "Governance Engine OMAS",
            "partnerServerType": "Metadata Access Server"
        },
        {
            "serviceId": 194,
            "serviceName": "Engine Host Services",
            "serviceDevelopmentStatus": "STABLE",
            "serviceURLMarker": "engine-host",
            "serviceDescription": "Host one or more engine services that are actively managing governance of open metadata and the digital landscape.",
            "serviceWiki": "https://egeria-project.org/services/engine-host-services/",
            "serverType": "Engine Host Server",
            "partnerServiceName": "Governance Engine OMAS",
            "partnerServerType": "Metadata Access Server"
        }
    ]
}

Here is the server classification of the active-metadata-store showing the OMAG Server hierarchy matches the documentation https://egeria-project.org/concepts/omag-server/#types-of-omag-server

GET {{baseURL}}/open-metadata/admin-services/users/{{adminUserId}}/servers/{{server}}/server-type-classification

{
    "class": "ServerClassificationResponse",
    "relatedHTTPCode": 200,
    "serverTypeClassification": {
        "serverTypeName": "Metadata Access Store",
        "serverTypeDescription": "Server that is a metadata access server with its own native open metadata repository.",
        "serverSuperType": {
            "serverTypeName": "Metadata Access Server",
            "serverTypeDescription": "Server that provides specialist APIs for accessing and storing metadata inopen metadata repositories connected through one or more open metadata repository cohorts.",
            "serverSuperType": {
                "serverTypeName": "Cohort Member",
                "serverTypeDescription": "OMAG Server that is capable of joining one or more open metadata repository cohorts.",
                "serverSuperType": {
                    "serverTypeName": "Open Metadata and Governance (OMAG) Server",
                    "serverTypeDescription": "Generic name for a server that runs on the OMAG Platform.",
                    "serverTypeWiki": "https://egeria-project.org/concepts/omag-server/"
                },
                "serverTypeWiki": "https://egeria-project.org/concepts/cohort-member/"
            },
            "serverTypeWiki": "https://egeria-project.org/concepts/metadata-access-server/"
        },
        "serverTypeWiki": "https://egeria-project.org/concepts/metadata-access-store/"
    }
}

Related Issue(s)

Testing

Release Notes & Documentation

Additional notes

Signed-off-by: Mandy Chessell <mandy.e.chessell@gmail.com>
mandy-chessell and others added 2 commits February 4, 2024 18:06
Signed-off-by: Mandy Chessell <mandy.e.chessell@gmail.com>
@mandy-chessell mandy-chessell merged commit 46bd59b into odpi:main Feb 4, 2024
4 checks passed
@mandy-chessell mandy-chessell deleted the oak2024 branch February 4, 2024 18:30
@@ -225,7 +225,7 @@

if (platformGUID != null)
{
String serverGUID = deployServer(platformNetworkAddress, "TestServer", ServerTypeClassification.METADATA_SERVER.getServerTypeName());
String serverGUID = deployServer(platformNetworkAddress, "TestServer", ServerTypeClassification.METADATA_ACCESS_STORE.getServerTypeName());

Check notice

Code scanning / CodeQL

Unread local variable Note

Variable 'String serverGUID' is never read.
@@ -36,7 +37,8 @@
/**
* Instantiates the graph based on the configuration passed.
*/
public void initializeGraphDB(AuditLog auditLog) throws OpenLineageException {
public void initializeGraphDB(AuditLog auditLog) throws LineageWarehouseException

Check notice

Code scanning / CodeQL

Missing Override annotation Note

This method overrides
LineageWarehouseGraphConnector.initializeGraphDB
; it is advisable to add an Override annotation.

newEngineServiceConfig.setOMAGServerPlatformRootURL(requestBody.getOMAGServerPlatformRootURL());
newEngineServiceConfig.setOMAGServerName(requestBody.getOMAGServerName());
newEngineServiceConfig.setEngines(requestBody.getEngines());

Check notice

Code scanning / CodeQL

Deprecated method or constructor invocation Note

Invoking
EngineServiceConfig.setEngines
should be avoided because it has been deprecated.
serverConfig.setEngineHostServicesConfig(engineHostServicesConfig);
newEngineServiceConfig.setOMAGServerPlatformRootURL(requestBody.getOMAGServerPlatformRootURL());
newEngineServiceConfig.setOMAGServerName(requestBody.getOMAGServerName());
newEngineServiceConfig.setEngines(requestBody.getEngines());

Check notice

Code scanning / CodeQL

Deprecated method or constructor invocation Note

Invoking
EngineServiceConfig.setEngines
should be avoided because it has been deprecated.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant