diff --git a/openmetadata-docs/content/v1.5.x/how-to-guides/data-insights/metadata-cli.md b/openmetadata-docs/content/v1.5.x/how-to-guides/data-insights/metadata-cli.md deleted file mode 100644 index d8cd854b342..00000000000 --- a/openmetadata-docs/content/v1.5.x/how-to-guides/data-insights/metadata-cli.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -title: Run Data Insights using Metadata CLI -slug: /how-to-guides/data-insights/metadata-cli ---- - -# Run Data Insights using Metadata CLI - -## 1. Define the YAML Config - -This is a sample config for Data Insights: - -```yaml -source: - type: dataInsight - serviceName: OpenMetadata - sourceConfig: - config: - type: MetadataToElasticSearch -processor: - type: data-insight-processor - config: {} -sink: - type: elasticsearch - config: - es_host: localhost - es_port: 9200 - recreate_indexes: false -workflowConfig: - loggerLevel: DEBUG - openMetadataServerConfig: - hostPort: '' - authProvider: openmetadata - securityConfig: - jwtToken: '{bot_jwt_token}' -``` - -### Source Configuration - Source Config - -- To send the metadata to OpenMetadata, it needs to be specified as `type: MetadataToElasticSearch`. - -### Processor Configuration - -- To send the metadata to OpenMetadata, it needs to be specified as `type: data-insight-processor`. - -### Workflow Configuration - -The main property here is the `openMetadataServerConfig`, where you can define the host and security provider of your OpenMetadata installation. - -For a simple, local installation using our docker containers, this looks like: - -```yaml -workflowConfig: - openMetadataServerConfig: - hostPort: 'http://localhost:8585/api' - authProvider: openmetadata - securityConfig: - jwtToken: '{bot_jwt_token}' -``` - -We support different security providers. You can find their definitions [here](https://github.com/open-metadata/OpenMetadata/tree/main/openmetadata-spec/src/main/resources/json/schema/security/client). -You can find the different implementation of the ingestion below. - -## 2. Run with the CLI - -First, we will need to save the YAML file. Afterward, and with all requirements installed, we can run: - -```bash -metadata insight -c -``` diff --git a/openmetadata-docs/content/v1.5.x/menu.md b/openmetadata-docs/content/v1.5.x/menu.md index f9a9fb2e247..a8a2ae4328b 100644 --- a/openmetadata-docs/content/v1.5.x/menu.md +++ b/openmetadata-docs/content/v1.5.x/menu.md @@ -851,8 +851,6 @@ site_menu: url: /how-to-guides/data-insights/kpi - category: How-to Guides / Data Insights / Run Data Insights using Airflow SDK url: /how-to-guides/data-insights/airflow-sdk - - category: How-to Guides / Data Insights / Run Data Insights using Metadata CLI - url: /how-to-guides/data-insights/metadata-cli - category: How-to Guides / Data Insights / Run Elasticsearch Reindex using Airflow SDK url: /how-to-guides/data-insights/elasticsearch-reindex - category: How-to Guides / Data Insights / Data Insights Report diff --git a/openmetadata-docs/content/v1.6.x-SNAPSHOT/how-to-guides/data-insights/metadata-cli.md b/openmetadata-docs/content/v1.6.x-SNAPSHOT/how-to-guides/data-insights/metadata-cli.md deleted file mode 100644 index d8cd854b342..00000000000 --- a/openmetadata-docs/content/v1.6.x-SNAPSHOT/how-to-guides/data-insights/metadata-cli.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -title: Run Data Insights using Metadata CLI -slug: /how-to-guides/data-insights/metadata-cli ---- - -# Run Data Insights using Metadata CLI - -## 1. Define the YAML Config - -This is a sample config for Data Insights: - -```yaml -source: - type: dataInsight - serviceName: OpenMetadata - sourceConfig: - config: - type: MetadataToElasticSearch -processor: - type: data-insight-processor - config: {} -sink: - type: elasticsearch - config: - es_host: localhost - es_port: 9200 - recreate_indexes: false -workflowConfig: - loggerLevel: DEBUG - openMetadataServerConfig: - hostPort: '' - authProvider: openmetadata - securityConfig: - jwtToken: '{bot_jwt_token}' -``` - -### Source Configuration - Source Config - -- To send the metadata to OpenMetadata, it needs to be specified as `type: MetadataToElasticSearch`. - -### Processor Configuration - -- To send the metadata to OpenMetadata, it needs to be specified as `type: data-insight-processor`. - -### Workflow Configuration - -The main property here is the `openMetadataServerConfig`, where you can define the host and security provider of your OpenMetadata installation. - -For a simple, local installation using our docker containers, this looks like: - -```yaml -workflowConfig: - openMetadataServerConfig: - hostPort: 'http://localhost:8585/api' - authProvider: openmetadata - securityConfig: - jwtToken: '{bot_jwt_token}' -``` - -We support different security providers. You can find their definitions [here](https://github.com/open-metadata/OpenMetadata/tree/main/openmetadata-spec/src/main/resources/json/schema/security/client). -You can find the different implementation of the ingestion below. - -## 2. Run with the CLI - -First, we will need to save the YAML file. Afterward, and with all requirements installed, we can run: - -```bash -metadata insight -c -``` diff --git a/openmetadata-docs/content/v1.6.x-SNAPSHOT/menu.md b/openmetadata-docs/content/v1.6.x-SNAPSHOT/menu.md index 285228c8f9d..f6bc844f985 100644 --- a/openmetadata-docs/content/v1.6.x-SNAPSHOT/menu.md +++ b/openmetadata-docs/content/v1.6.x-SNAPSHOT/menu.md @@ -860,8 +860,6 @@ site_menu: url: /how-to-guides/data-insights/kpi - category: How-to Guides / Data Insights / Run Data Insights using Airflow SDK url: /how-to-guides/data-insights/airflow-sdk - - category: How-to Guides / Data Insights / Run Data Insights using Metadata CLI - url: /how-to-guides/data-insights/metadata-cli - category: How-to Guides / Data Insights / Run Elasticsearch Reindex using Airflow SDK url: /how-to-guides/data-insights/elasticsearch-reindex - category: How-to Guides / Data Insights / Data Insights Report