From 977977d54201d8ec9a776bc43eb6e633dffd7ebf Mon Sep 17 00:00:00 2001 From: Nikita Dementev Date: Thu, 16 Mar 2023 09:48:34 +0000 Subject: [PATCH] GITBOOK-29: No subject --- docs/SUMMARY.md | 4 +-- .../README.md => odd-platform.md} | 12 +++---- .../odd-platform/oddrn-generator.md | 33 ----------------- .../build-and-run-odd-platform.md | 2 +- docs/oddrn-generator.md | 36 ------------------- 5 files changed, 8 insertions(+), 79 deletions(-) rename docs/configuration-and-deployment/{odd-platform/README.md => odd-platform.md} (94%) delete mode 100644 docs/configuration-and-deployment/odd-platform/oddrn-generator.md delete mode 100644 docs/oddrn-generator.md diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 0820ee973..e161f9cd1 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -3,7 +3,6 @@ * [Overview](README.md) * [Architecture](Architecture.md) * [Features](Features.md) -* [ODDRN-Generator](oddrn-generator.md) * [Use cases](Use\_cases.md) * [Data compliance for Data Scientists](dc\_data\_compliance.md) * [Deprecation for Data Engineer \ Analyst](de\_deprecation.md) @@ -14,8 +13,7 @@ ## Configuration and Deployment * [Try locally](configuration-and-deployment/trylocally.md) -* [Configure ODD Platform](configuration-and-deployment/odd-platform/README.md) - * [ODDRN-Generator](configuration-and-deployment/odd-platform/oddrn-generator.md) +* [Configure ODD Platform](configuration-and-deployment/odd-platform.md) * [Enable security](configuration-and-deployment/enable-security/README.md) * [Authentication](configuration-and-deployment/enable-security/authentication/README.md) * [Disabled authentication](configuration-and-deployment/enable-security/authentication/disabled-authentication.md) diff --git a/docs/configuration-and-deployment/odd-platform/README.md b/docs/configuration-and-deployment/odd-platform.md similarity index 94% rename from docs/configuration-and-deployment/odd-platform/README.md rename to docs/configuration-and-deployment/odd-platform.md index 3477dd461..c09df2539 100644 --- a/docs/configuration-and-deployment/odd-platform/README.md +++ b/docs/configuration-and-deployment/odd-platform.md @@ -69,7 +69,7 @@ SPRING_DATASOURCE_PASSWORD={database_password} ## Security -Please follow [enable-security](../enable-security/ "mention") section for enabling security in ODD Platform. +Please follow [enable-security](enable-security/ "mention") section for enabling security in ODD Platform. ## Select session provider @@ -306,11 +306,11 @@ At the moment ODD Platform supports only Slack as a target messenger. It uses Sl Go to the [Slack apps](https://api.slack.com/apps) website and click on `Create New App -> From an app manifest` -

Creating an app

+

Creating an app

Select a workspace you want to add an application to and click `Next` -

Selecting a workspace to install application to

+

Selecting a workspace to install application to

Enter the following manifest into the YAML section, replace the `` with URL of your ODD Platform deployment and click `Next` @@ -339,11 +339,11 @@ settings: token_rotation_enabled: false ``` -

Inserting a YAML manifest

+

Inserting a YAML manifest

Review your application's scopes and permissions and click `Create` -

Reviewing scopes and permissions

+

Reviewing scopes and permissions

Proceed with Slack instructions on how to install application into workspace and you should be good to go. @@ -359,7 +359,7 @@ Following variables need to be defined: * `datacollaboration.slack-oauth-token`: Slack application OAuth token used for communicating with Slack. Can be retrieved in the `OAuth & Permissions` section of a Slack application.\ -

Retrieving OAuth Token

+

Retrieving OAuth Token

{% tabs %} {% tab title="YAML" %} diff --git a/docs/configuration-and-deployment/odd-platform/oddrn-generator.md b/docs/configuration-and-deployment/odd-platform/oddrn-generator.md deleted file mode 100644 index 078c93637..000000000 --- a/docs/configuration-and-deployment/odd-platform/oddrn-generator.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -description: ODDRN-Generator, what is it and why we are using it? ---- - -# ODDRN-Generator - -ODDRN generator- it is a resource, which helps us solve the problem of data loss, simplify the work of your system with metadata.\\ - -The creation of the ODDRN happens by the collector, in different collectors generators ODDRN are generated the same way, an ID number is assigned in these different collectors- one, the reason why the id number is the same is the path of metadata. We will tell you more about the path og metadata later, and also demonstrate that you have a complete understanding of the ODDRN generator and its work.\ -Due to the fact that, is the same ID number in the collectors, the data in the two collectors are combined and sent to the ODD Platform. - -### Important notice - -In order for the ODDRN generators to be created correctly, the next data is needed:\ -\ -\-Connection Info (for example: in the YAML config- host, port)\ -\-The names of the tables, jobs, entities (that we get at the time of the metadata request from the DataSource)\ -\ -We also recommend you indicate in the collector in the type connection- DNS in all collectors or the IP address also in all collectors, the choice of one type connection in the collectors is recommended for the correct work of the ODDRN generator - -### To summarize our recommendation - -All collectors with a DNS type connection or all collectors with an IP address type connection are recommended, collectors with a different type of connection are recommended not to use. - -### Metadata path and visual representation of the work ODDRN-Generator - -Let's see at circuitry, which will help you visually understand the work of the ODDRN-Generator and the system of the metadata path. - - - -We see two collectors, a data path, and also the information about collectors, which is transmitted directly to the ODD Platform.\ -"id" in "Collector GCP" will be the same with "dataset\_ids" in "Collector Tableau".\ -Also in the circuitry we demonstrated the finding of the ODDRN- Generator. diff --git a/docs/developer-guides/build-and-run/build-and-run-odd-platform.md b/docs/developer-guides/build-and-run/build-and-run-odd-platform.md index fd8a321b9..86dd0a93b 100644 --- a/docs/developer-guides/build-and-run/build-and-run-odd-platform.md +++ b/docs/developer-guides/build-and-run/build-and-run-odd-platform.md @@ -107,7 +107,7 @@ You'd need to install Python 3.8+ in order to run this. PLATFORM_HOST_URL=http://localhost:8080 APP_PATH=./docker/injector python docker/injector/inject.py ``` -Now you should have ODD Platform with demo metadata injected at your disposal at `http://localhost:8080`. If you want to reconfigure default settings, please take a look at [Configure ODD Platform](../../configuration-and-deployment/odd-platform/) page. +Now you should have ODD Platform with demo metadata injected at your disposal at `http://localhost:8080`. If you want to reconfigure default settings, please take a look at [Configure ODD Platform](../../configuration-and-deployment/odd-platform.md) page. ### Run ODD Platform as a frontend engineer diff --git a/docs/oddrn-generator.md b/docs/oddrn-generator.md deleted file mode 100644 index b0c40d76f..000000000 --- a/docs/oddrn-generator.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -description: ODDRN-Generator, what is it and why we are using it? ---- - -# ODDRN-Generator - -ODDRN generator- it is a resource, which helps us solve the problem of data loss, simplify the work of your system with metadata.\ - - -The creation of the ODDRN happens by the collector, in different collectors generators ODDRN are generated the same way, an ID number is assigned in these different collectors- one, the reason why the id number is the same is the path of metadata. We will tell you more about the path og metadata later, and also demonstrate that you have a complete understanding of the ODDRN generator and its work.\ -Due to the fact that, is the same ID number in the collectors, the data in the two collectors are combined and sent to the ODD Platform. - -### Important notice - -In order for the ODDRN generators to be created correctly, the next data is needed:\ -\ -\-Connection Info (for example: in the YAML config- host, port)\ -\-The names of the tables, jobs, entities (that we get at the time of the metadata request from the DataSource)\ -\ -We also recommend you indicate in the collector in the type connection- DNS in all collectors or the IP address also in all collectors, the choice of one type connection in the collectors is recommended for the correct work of the ODDRN generator - - - -### To summarize our recommendation - -All collectors with a DNS type connection or all collectors with an IP address type connection are recommended, collectors with a different type of connection are recommended not to use. - -### Metadata path and visual representation of the work ODDRN-Generator - -Let's see at circuitry, which will help you visually understand the work of the ODDRN-Generator and the system of the metadata path. - -
- -We see two collectors, a data path, and also the information about collectors, which is transmitted directly to the ODD Platform.\ -"id" in "Collector GCP" will be the same with "dataset\_ids" in "Collector Tableau".\ -Also in the circuitry we demonstrated the finding of the ODDRN- Generator.