DOCS: doc fix v1.5 (#16834)

* use 1.5 partial file

* use v1.5 images in docs
This commit is contained in:
harshsoni2024 2024-06-28 12:13:05 +05:30 committed by GitHub
parent 1b833e1a01
commit 56bc7e647c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
24 changed files with 75 additions and 75 deletions

View File

@ -10,7 +10,7 @@ Please follow the instructions below
{% stepVisualInfo %}
{% image
src="/images/v1.4/connectors/configure-metadata-ingestion-dashboard.png"
src="/images/v1.5/connectors/configure-metadata-ingestion-dashboard.png"
alt="Configure Metadata Ingestion"
caption="Configure Metadata Ingestion Page" /%}

View File

@ -9,7 +9,7 @@ This would only be required to handle advanced connectivity scenarios or customi
- **Connection Arguments (Optional)**: Enter the details for any additional connection arguments such as security or protocol configs that can be sent during the connection. These details must be added as Key-Value pairs.
{% image
src="/images/v1.4/connectors/advanced-configuration.png"
src="/images/v1.5/connectors/advanced-configuration.png"
alt="Advanced Configuration"
height="250px"
caption="Advanced Configuration" /%}

View File

@ -10,12 +10,12 @@ Please follow the instructions below
{% stepVisualInfo %}
{% image
src="/images/v1.4/connectors/configure-metadata-ingestion-database-1.png"
src="/images/v1.5/connectors/configure-metadata-ingestion-database-1.png"
alt="Configure Metadata Ingestion"
caption="Configure Metadata Ingestion Page - 1" /%}
{% image
src="/images/v1.4/connectors/configure-metadata-ingestion-database-2.png"
src="/images/v1.5/connectors/configure-metadata-ingestion-database-2.png"
alt="Configure Metadata Ingestion"
caption="Configure Metadata Ingestion Page - 2" /%}

View File

@ -20,7 +20,7 @@ pipeline.
{% stepVisualInfo %}
{% image
src="/images/v1.4/connectors/schedule.png"
src="/images/v1.5/connectors/schedule.png"
alt="Schedule the Workflow"
caption="Schedule the Ingestion Pipeline and Deploy" /%}
@ -40,7 +40,7 @@ Ingestion Pipeline running from the Service Page.
{% stepVisualInfo %}
{% image
src="/images/v1.4/connectors/view-ingestion-pipeline.png"
src="/images/v1.5/connectors/view-ingestion-pipeline.png"
alt="View Ingestion Pipeline"
caption="View the Ingestion Pipeline from the Service Page" /%}

View File

@ -10,7 +10,7 @@ Please follow the instructions below
{% stepVisualInfo %}
{% image
src="/images/v1.4/connectors/configure-metadata-ingestion-messaging.png"
src="/images/v1.5/connectors/configure-metadata-ingestion-messaging.png"
alt="Configure Metadata Ingestion"
caption="Configure Metadata Ingestion Page" /%}

View File

@ -15,7 +15,7 @@ Once a Service is created, it can be used to configure your ingestion workflows.
{% stepVisualInfo %}
{% image
src="/images/v1.4/connectors/visit-services-page.png"
src="/images/v1.5/connectors/visit-services-page.png"
alt="Visit Services Page"
caption="Select your Service Type and Add a New Service" /%}
@ -34,7 +34,7 @@ Click on _Add New Service_ to start the Service creation.
{% stepVisualInfo %}
{% image
src="/images/v1.4/connectors/create-new-service.png"
src="/images/v1.5/connectors/create-new-service.png"
alt="Create a new Service"
caption="Add a new Service from the Services page" /%}

View File

@ -10,7 +10,7 @@ Please follow the instructions below
{% stepVisualInfo %}
{% image
src="/images/v1.4/connectors/configure-metadata-ingestion-metadata.png"
src="/images/v1.5/connectors/configure-metadata-ingestion-metadata.png"
alt="Configure Metadata Ingestion"
caption="Configure Metadata Ingestion Page" /%}

View File

@ -10,7 +10,7 @@ Please follow the instructions below
{% stepVisualInfo %}
{% image
src="/images/v1.4/connectors/configure-metadata-ingestion-mlmodel.png"
src="/images/v1.5/connectors/configure-metadata-ingestion-mlmodel.png"
alt="Configure Metadata Ingestion"
caption="Configure Metadata Ingestion Page" /%}

View File

@ -10,7 +10,7 @@ Please follow the instructions below
{% stepVisualInfo %}
{% image
src="/images/v1.4/connectors/configure-metadata-ingestion-pipeline.png"
src="/images/v1.5/connectors/configure-metadata-ingestion-pipeline.png"
alt="Configure Metadata Ingestion"
caption="Configure Metadata Ingestion Page" /%}

View File

@ -10,7 +10,7 @@ Please follow the instructions below
{% stepVisualInfo %}
{% image
src="/images/v1.4/connectors/configure-metadata-ingestion-search.png"
src="/images/v1.5/connectors/configure-metadata-ingestion-search.png"
alt="Configure Metadata Ingestion"
caption="Configure Metadata Ingestion Page" /%}

View File

@ -10,7 +10,7 @@ Please follow the instructions below
{% stepVisualInfo %}
{% image
src="/images/v1.4/connectors/configure-metadata-ingestion-storage.png"
src="/images/v1.5/connectors/configure-metadata-ingestion-storage.png"
alt="Configure Metadata Ingestion"
caption="Configure Metadata Ingestion Page" /%}

View File

@ -9,7 +9,7 @@ Once the credentials have been added, click on _Test Connection_ and _Save_ the
{% stepVisualInfo %}
{% image
src="/images/v1.4/connectors/test-connection.png"
src="/images/v1.5/connectors/test-connection.png"
alt="Test Connection"
caption="Test the connection and save the Service" /%}

View File

@ -90,7 +90,7 @@ To send the metadata to OpenMetadata, it needs to be specified as `type: metadat
{% /codeInfo %}
{% partial file="/v1.4/connectors/yaml/workflow-config-def.md" /%}
{% partial file="/v1.5/connectors/yaml/workflow-config-def.md" /%}
{% /codeInfoContainer %}
@ -195,7 +195,7 @@ sink:
config: {}
```
{% partial file="/v1.4/connectors/yaml/workflow-config.md" /%}
{% partial file="/v1.5/connectors/yaml/workflow-config.md" /%}
{% /codeBlock %}

View File

@ -150,7 +150,7 @@ sink:
config: {}
```
{% partial file="/v1.4/connectors/yaml/workflow-config.md" /%}
{% partial file="/v1.5/connectors/yaml/workflow-config.md" /%}
{% /codeBlock %}

View File

@ -53,7 +53,7 @@ Note that the location is a directory that will be cleaned at the end of the ing
{% /codeInfo %}
{% partial file="/v1.4/connectors/yaml/workflow-config-def.md" /%}
{% partial file="/v1.5/connectors/yaml/workflow-config-def.md" /%}
{% /codeInfoContainer %}
@ -100,7 +100,7 @@ bulkSink:
filename: /tmp/athena_usage
```
{% partial file="/v1.4/connectors/yaml/workflow-config.md" /%}
{% partial file="/v1.5/connectors/yaml/workflow-config.md" /%}
{% /codeBlock %}
{% /codePreview %}

View File

@ -1,5 +1,5 @@
Go to `Settings` -> `{service entity}` -> `Pipelines`
{% image src="/images/v1.4/deployment/upgrade/redeploy.png" alt="redeploy" caption="Re-deploy" /%}
{% image src="/images/v1.5/deployment/upgrade/redeploy.png" alt="redeploy" caption="Re-deploy" /%}
Select the pipelines you want to Re Deploy click `Re Deploy`.

View File

@ -1,9 +1,9 @@
Go to `Settings` -> `Applications` -> `Search Indexing`
{% image src="/images/v1.4/deployment/upgrade/search-index-app.png" alt="search-index-app" caption="Reindex" /%}
{% image src="/images/v1.5/deployment/upgrade/search-index-app.png" alt="search-index-app" caption="Reindex" /%}
Click on `Run Now`.
In the configuration section, you can select the entities you want to reindex.
{% image src="/images/v1.4/deployment/upgrade/reindex-ES.png" alt="create-project" caption="Reindex" /%}
{% image src="/images/v1.5/deployment/upgrade/reindex-ES.png" alt="create-project" caption="Reindex" /%}

View File

@ -2,7 +2,7 @@
### Reindex
{% partial file="/v1.4/deployment/reindex.md" /%}
{% partial file="/v1.5/deployment/reindex.md" /%}
Since this is required after the upgrade, we want to reindex `All` the entities.
@ -29,7 +29,7 @@ pip install openmetadata-managed-apis==x.y.z
### Re Deploy Ingestion Pipelines
{% partial file="/v1.4/deployment/redeploy.md" /%}
{% partial file="/v1.5/deployment/redeploy.md" /%}
If you are seeing broken dags select all the pipelines from all the services and re deploy the pipelines.

View File

@ -14,7 +14,7 @@ This documentation provides a step-by-step guide on how to create a custom role
Search for `Roles` in your GCP console and select the first result under `IAM & Roles` section.
{% image
src="/images/v1.4/connectors/bigquery/create-role-1.png"
src="/images/v1.5/connectors/bigquery/create-role-1.png"
alt="Navigate to Roles"
caption="Navigate to Roles" /%}
@ -24,14 +24,14 @@ caption="Navigate to Roles" /%}
Below the search bar you should see a `Create Role` button click on that & navigate to create role page.
{% image
src="/images/v1.4/connectors/bigquery/create-role-2.png"
src="/images/v1.5/connectors/bigquery/create-role-2.png"
alt="Create Role Button"
caption="Create Role" /%}
Once You are on the create role page, you can edit the description & title of the role and finally you can click on `add permissions` to grant permissions to role.
{% image
src="/images/v1.4/connectors/bigquery/create-role-3.png"
src="/images/v1.5/connectors/bigquery/create-role-3.png"
alt="Create Role"
caption="Create Role" /%}
@ -56,14 +56,14 @@ You can search for the required permissions in the filter box and add them accor
| 14 | logging.operations.list | Incremental Metadata Ingestion |
{% image
src="/images/v1.4/connectors/bigquery/create-role-4.png"
src="/images/v1.5/connectors/bigquery/create-role-4.png"
alt="Add Permissions"
caption="Add Permissions" /%}
Once you have added all the required permissions, you can create the role by clicking on the create button.
{% image
src="/images/v1.4/connectors/bigquery/create-role-5.png"
src="/images/v1.5/connectors/bigquery/create-role-5.png"
alt="Add Permissions"
caption="Add Permissions" /%}
@ -74,7 +74,7 @@ caption="Add Permissions" /%}
Login to your GCP console and navigate to service accounts page.
{% image
src="/images/v1.4/connectors/bigquery/bq-service-account-search.png"
src="/images/v1.5/connectors/bigquery/bq-service-account-search.png"
alt="Navigate to Service Accounts"
caption="Navigate to Service Accounts" /%}
@ -84,21 +84,21 @@ caption="Navigate to Service Accounts" /%}
Once you are on service account page, click on `Create Service Account` button.
{% image
src="/images/v1.4/connectors/bigquery/bq-create-service-account.png"
src="/images/v1.5/connectors/bigquery/bq-create-service-account.png"
alt="Create Service Accounts"
caption="Create Service Accounts" /%}
Fill the service account details
{% image
src="/images/v1.4/connectors/bigquery/bq-create-service-account-1.png"
src="/images/v1.5/connectors/bigquery/bq-create-service-account-1.png"
alt="Create Service Accounts"
caption="Create Service Accounts" /%}
Grant a role to service account which has all the required permission to ingest BigQuery metadata in OpenMetadata checkout [this](/connectors/database/bigquery/roles) documentation for details on how to create a custom role with required permissions.
{% image
src="/images/v1.4/connectors/bigquery/bq-service-account-grant-role.png"
src="/images/v1.5/connectors/bigquery/bq-service-account-grant-role.png"
alt="Grant Role to Service Account"
caption="Grant Role to Service Account" /%}
@ -110,7 +110,7 @@ caption="Grant Role to Service Account" /%}
On service accounts page, look for the service account that you just created, click on the three dots menu and go to manage keys
{% image
src="/images/v1.4/connectors/bigquery/bq-service-account-manage-keys.png"
src="/images/v1.5/connectors/bigquery/bq-service-account-manage-keys.png"
alt="Service Account Manage Keys"
caption="Service Account Manage Keys" /%}
@ -120,12 +120,12 @@ caption="Service Account Manage Keys" /%}
Click on Add Key > New Key > Select Json and download the key.
{% image
src="/images/v1.4/connectors/bigquery/bq-create-service-account-key.png"
src="/images/v1.5/connectors/bigquery/bq-create-service-account-key.png"
alt="Create New Key"
caption="Create New Key" /%}
{% image
src="/images/v1.4/connectors/bigquery/bq-create-key-modal.png"
src="/images/v1.5/connectors/bigquery/bq-create-key-modal.png"
alt="Download json Key"
caption="Download json Key" /%}

View File

@ -25,7 +25,7 @@ Configure and schedule DBTCloud metadata and profiler workflows from the OpenMet
- [Troubleshooting](#troubleshooting)
- [Workflow Deployment Error](#workflow-deployment-error)
{% partial file="/v1.4/connectors/ingestion-modes-tiles.md" variables={yamlPath: "/connectors/pipeline/dbtcloud/yaml"} /%}
{% partial file="/v1.5/connectors/ingestion-modes-tiles.md" variables={yamlPath: "/connectors/pipeline/dbtcloud/yaml"} /%}
## Requirements
@ -49,12 +49,12 @@ To know more about permissions required refer [here](https://docs.getdbt.com/doc
## Metadata Ingestion
{% partial
file="/v1.4/connectors/metadata-ingestion-ui.md"
file="/v1.5/connectors/metadata-ingestion-ui.md"
variables={
connector: "DBTCloud",
selectServicePath: "/images/v1.4/connectors/dbtcloud/select-service.webp",
addNewServicePath: "/images/v1.4/connectors/dbtcloud/add-new-service.webp",
serviceConnectionPath: "/images/v1.4/connectors/dbtcloud/service-connection.webp",
selectServicePath: "/images/v1.5/connectors/dbtcloud/select-service.webp",
addNewServicePath: "/images/v1.5/connectors/dbtcloud/add-new-service.webp",
serviceConnectionPath: "/images/v1.5/connectors/dbtcloud/service-connection.webp",
}
/%}
@ -76,11 +76,11 @@ Make sure you have the necessary permissions on the token to run graphql queries
{% /extraContent %}
{% partial file="/v1.4/connectors/test-connection.md" /%}
{% partial file="/v1.5/connectors/test-connection.md" /%}
{% partial file="/v1.4/connectors/pipeline/configure-ingestion.md" /%}
{% partial file="/v1.5/connectors/pipeline/configure-ingestion.md" /%}
{% partial file="/v1.4/connectors/ingestion-schedule-and-deploy.md" /%}
{% partial file="/v1.5/connectors/ingestion-schedule-and-deploy.md" /%}
{% /stepsContainer %}
@ -92,12 +92,12 @@ Steps to retrieve and display the lineage information for a DBT Cloud service. N
By successfully completing these steps, the lineage information for the service will be displayed.
{% image
src="/images/v1.4/connectors/dbtcloud/lineage.webp"
src="/images/v1.5/connectors/dbtcloud/lineage.webp"
alt="DBT Cloud Lineage" /%}
{% partial file="/v1.4/connectors/troubleshooting.md" /%}
{% partial file="/v1.5/connectors/troubleshooting.md" /%}
### Missing Lineage
If lineage information is not displayed for a DBT Cloud service, follow these steps to diagnose the issue.

View File

@ -19,13 +19,13 @@ Configure and schedule DBTCloud metadata and profiler workflows from the OpenMet
- [Requirements](#requirements)
- [Metadata Ingestion](#metadata-ingestion)
{% partial file="/v1.4/connectors/external-ingestion-deployment.md" /%}
{% partial file="/v1.5/connectors/external-ingestion-deployment.md" /%}
## Requirements
### Python Requirements
{% partial file="/v1.4/connectors/python-requirements.md" /%}
{% partial file="/v1.5/connectors/python-requirements.md" /%}
## Metadata Ingestion
@ -82,11 +82,11 @@ Make sure you have the necessary permissions on the token to run graphql queries
{% /codeInfo %}
{% partial file="/v1.4/connectors/yaml/pipeline/source-config-def.md" /%}
{% partial file="/v1.5/connectors/yaml/pipeline/source-config-def.md" /%}
{% partial file="/v1.4/connectors/yaml/ingestion-sink-def.md" /%}
{% partial file="/v1.5/connectors/yaml/ingestion-sink-def.md" /%}
{% partial file="/v1.4/connectors/yaml/workflow-config-def.md" /%}
{% partial file="/v1.5/connectors/yaml/workflow-config-def.md" /%}
{% /codeInfoContainer %}
@ -117,14 +117,14 @@ source:
token: auth_token
```
{% partial file="/v1.4/connectors/yaml/pipeline/source-config.md" /%}
{% partial file="/v1.5/connectors/yaml/pipeline/source-config.md" /%}
{% partial file="/v1.4/connectors/yaml/ingestion-sink.md" /%}
{% partial file="/v1.5/connectors/yaml/ingestion-sink.md" /%}
{% partial file="/v1.4/connectors/yaml/workflow-config.md" /%}
{% partial file="/v1.5/connectors/yaml/workflow-config.md" /%}
{% /codeBlock %}
{% /codePreview %}
{% partial file="/v1.4/connectors/yaml/ingestion-cli.md" /%}
{% partial file="/v1.5/connectors/yaml/ingestion-cli.md" /%}

View File

@ -25,7 +25,7 @@ Configure and schedule Flink metadata from the OpenMetadata UI:
- [Troubleshooting](#troubleshooting)
- [Workflow Deployment Error](#workflow-deployment-error)
{% partial file="/v1.4/connectors/ingestion-modes-tiles.md" variables={yamlPath: "/connectors/pipeline/flink/yaml"} /%}
{% partial file="/v1.5/connectors/ingestion-modes-tiles.md" variables={yamlPath: "/connectors/pipeline/flink/yaml"} /%}
## Requirements
@ -38,12 +38,12 @@ The ingestion framework uses flink REST APIs to connect to the instance and perf
## Metadata Ingestion
{% partial
file="/v1.4/connectors/metadata-ingestion-ui.md"
file="/v1.5/connectors/metadata-ingestion-ui.md"
variables={
connector: "KafkaConnect",
selectServicePath: "/images/v1.4/connectors/flink/select-new-service.webp",
addNewServicePath: "/images/v1.4/connectors/flink/add-new-service.webp",
serviceConnectionPath: "/images/v1.4/connectors/flink/service-connection.webp",
selectServicePath: "/images/v1.5/connectors/flink/select-new-service.webp",
addNewServicePath: "/images/v1.5/connectors/flink/add-new-service.webp",
serviceConnectionPath: "/images/v1.5/connectors/flink/service-connection.webp",
}
/%}
@ -65,13 +65,13 @@ The ingestion framework uses flink REST APIs to connect to the instance and perf
{% /extraContent %}
{% partial file="/v1.4/connectors/test-connection.md" /%}
{% partial file="/v1.5/connectors/test-connection.md" /%}
{% partial file="/v1.4/connectors/pipeline/configure-ingestion.md" /%}
{% partial file="/v1.5/connectors/pipeline/configure-ingestion.md" /%}
{% partial file="/v1.4/connectors/ingestion-schedule-and-deploy.md" /%}
{% partial file="/v1.5/connectors/ingestion-schedule-and-deploy.md" /%}
{% /stepsContainer %}
{% partial file="/v1.4/connectors/troubleshooting.md" /%}
{% partial file="/v1.5/connectors/troubleshooting.md" /%}

View File

@ -19,13 +19,13 @@ Configure and schedule Flink metadata and profiler workflows from the OpenMetada
- [Requirements](#requirements)
- [Metadata Ingestion](#metadata-ingestion)
{% partial file="/v1.4/connectors/external-ingestion-deployment.md" /%}
{% partial file="/v1.5/connectors/external-ingestion-deployment.md" /%}
## Requirements
### Python Requirements
{% partial file="/v1.4/connectors/python-requirements.md" /%}
{% partial file="/v1.5/connectors/python-requirements.md" /%}
To run the Flink ingestion, you will need to install:
@ -68,11 +68,11 @@ This is a sample config for Flink:
{% /codeInfo %}
{% partial file="/v1.4/connectors/yaml/pipeline/source-config-def.md" /%}
{% partial file="/v1.5/connectors/yaml/pipeline/source-config-def.md" /%}
{% partial file="/v1.4/connectors/yaml/ingestion-sink-def.md" /%}
{% partial file="/v1.5/connectors/yaml/ingestion-sink-def.md" /%}
{% partial file="/v1.4/connectors/yaml/workflow-config-def.md" /%}
{% partial file="/v1.5/connectors/yaml/workflow-config-def.md" /%}
{% /codeInfoContainer %}
@ -100,14 +100,14 @@ source:
sslKey:
```
{% partial file="/v1.4/connectors/yaml/pipeline/source-config.md" /%}
{% partial file="/v1.5/connectors/yaml/pipeline/source-config.md" /%}
{% partial file="/v1.4/connectors/yaml/ingestion-sink.md" /%}
{% partial file="/v1.5/connectors/yaml/ingestion-sink.md" /%}
{% partial file="/v1.4/connectors/yaml/workflow-config.md" /%}
{% partial file="/v1.5/connectors/yaml/workflow-config.md" /%}
{% /codeBlock %}
{% /codePreview %}
{% partial file="/v1.4/connectors/yaml/ingestion-cli.md" /%}
{% partial file="/v1.5/connectors/yaml/ingestion-cli.md" /%}

View File

@ -7,7 +7,7 @@ slug: /deployment/ingestion/external
Any tool capable of running Python code can be used to configure the metadata extraction from your sources.
{% partial file="/v1.4/connectors/python-requirements.md" /%}
{% partial file="/v1.5/connectors/python-requirements.md" /%}
## 1. How does the Ingestion Framework work?