Skip to content

Commit

Permalink
fix: fix grammer
Browse files Browse the repository at this point in the history
  • Loading branch information
@yoonhyejin
yoonhyejin committed Sep 20, 2023
1 parent 492fdb0 commit 545e2fb
Show file tree
Hide file tree
Showing 3 changed files with 32 additions and 32 deletions.
24 changes: 12 additions & 12 deletions docs/quick-ingestion-guides/looker/configuration.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,23 +3,23 @@ title: Configuration
---
# Configuring Looker & LookML Connector

Now that you have created a DataHub specific API key with the relevant access in [the prior step](setup.md), it's now time to set up a connection via the DataHub UI.
Now that you have created a DataHub-specific API key with the relevant access in [the prior step](setup.md), it's time to set up a connection via the DataHub UI.

## Configure Secrets

You have to create two secrets to configure connection with Looker or LookerML.
You must create two secrets to configure a connection with Looker or LookerML.

* `LOOKER_CLIENT_ID`
* `LOOKER_CLIENT_SECRET`

On your DataHub instance, navigate to the **Ingestion** tab in the top, right corner of your screen.
On your DataHub instance, navigate to the **Ingestion** tab in your screen's top right corner.

<p align="center">
<img width="75%" alt="Navigate to the &quot;Ingestion Tab&quot;" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/guides/common/common_ingestion_ingestion_button.png"/>
</p>

:::note
If you do not see the Ingestion tab, please contact your DataHub admin to grant you the correct permissions
If you do not see the Ingestion tab, please get in touch with your DataHub admin to grant you the correct permissions.
:::

Navigate to the **Secrets** tab and click **Create new secret**.
Expand Down Expand Up @@ -85,7 +85,7 @@ Your recipe should look something like this:

### Schedule Execution

Now it's time to schedule a recurring ingestion pipeline to regularly extract metadata from your Looker instance.
Now, it's time to schedule a recurring ingestion pipeline to extract metadata from your Looker instance regularly.

Decide how regularly you want this ingestion to run-- day, month, year, hour, minute, etc. Select from the dropdown.

Expand Down Expand Up @@ -117,7 +117,7 @@ You will now find your new ingestion source running.

## Configure LookML Connector

Now that you have created a DataHub specific API key and Deploy Key with the relevant access in [the prior step](setup.md), it's now time to set up a connection via the DataHub UI.
Now that you have created a DataHub-specific API key and Deploy Key with the relevant access in [the prior step](setup.md), it's time to set up a connection via the DataHub UI.

### Configure Recipe

Expand All @@ -133,9 +133,9 @@ Choose `LooML`.
<img width="70%" alt="Select Looker from the options" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/guides/looker/lookml-choose-lookml.png"/>
</p>

Enter the details into the Looker Recipe. You need to set minimum 5 field in the recipe for this quick ingestion guide:
Enter the details into the Looker Recipe. You need to set a minimum 5 fields in the recipe for this quick ingestion guide:

* **GitHub Repository:** This is your github repository where LookML model are stored. You can provide full URL (example: https://gitlab.com/gitlab-org/gitlab) or organization/repo in this case connector assume it is GitHub repo
* **GitHub Repository:** This is your GitHub repository where LookML models are stored. You can provide the full URL (example: https://gitlab.com/gitlab-org/gitlab) or organization/repo; in this case, the connector assume it is a GitHub repo
* **GitHub Deploy Key:** Copy the content of `looker_datahub_deploy_key` and paste into this filed.
* **Looker Base URL:** This is your looker instance URL. (i.e. https://abc.cloud.looker.com)
* **Looker Client ID:** Use the secret LOOKER_CLIENT_ID with the format `${LOOKER_CLIENT_ID}`.
Expand All @@ -152,9 +152,9 @@ After completing the recipe, click **Next**.

### Schedule Execution

Now it's time to schedule a recurring ingestion pipeline to regularly extract metadata from your Looker instance.
Now, it's time to schedule a recurring ingestion pipeline to extract metadata from your Looker instance regularly.

Decide how regularly you want this ingestion to run-- day, month, year, hour, minute, etc. Select from the dropdown
Decide how regularly you want this ingestion to run-- day, month, year, hour, minute, etc. Select from the dropdown.

<p align="center">
<img width="75%" alt="schedule selector" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/guides/common/common_ingestion_set_execution_schedule.png"/>
Expand Down Expand Up @@ -188,7 +188,7 @@ View the latest status of ingestion runs on the Ingestion page.
<img width="75%" alt="ingestion succeeded" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/guides/looker/lookml-ingestion-succeeded.png"/>
</p>

Click the `+` sign to expand the full list of historical runs and outcomes; click **Details** to see the outcomes of a specific run.
Click the `+` sign to expand the complete list of historical runs and outcomes; click **Details** to see the results of a specific run.

<p align="center">
<img width="75%" alt="ingestion_details" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/guides/looker/lookml-ingestion-history.png"/>
Expand All @@ -209,4 +209,4 @@ Pick an entity from the list to manually validate if it contains the detail you

**Congratulations!** You've successfully set up Looker & LookML as an ingestion source for DataHub!

*Need more help? Join the conversation in [Slack](http://slack.datahubproject.io)!*
*Need more help? Join the conversation in [Slack](http://slack.datahubproject.io)!*
8 changes: 4 additions & 4 deletions docs/quick-ingestion-guides/looker/overview.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ title: Overview
## What You Will Get Out of This Guide

This guide will help you set up the Looker & LookML connectors to begin ingesting metadata into DataHub.
Upon completing this guide, you will have a recurring ingestion pipeline that will extract metadata from Looker & LookML and load it into DataHub.
Upon completing this guide, you will have a recurring ingestion pipeline to extract metadata from Looker & LookML and load it into DataHub.

### Looker

Expand All @@ -27,7 +27,7 @@ To get complete Looker metadata integration (including Looker views and lineage

### LookML

LookMl connector will include to following LookML asset types:
LookMl connector will include the following LookML asset types:

* [LookML views from model files in a project](https://cloud.google.com/looker/docs/reference/param-view-view)
* [Metadata for dimensions](https://cloud.google.com/looker/docs/reference/param-field-dimension)
Expand All @@ -41,12 +41,12 @@ To get complete Looker metadata integration (including Looker views and lineage
:::

## Next Steps
Continue to the [setup guide](setup.md), where we'll describe the prerequisites.
Please continue to the [setup guide](setup.md), where we'll describe the prerequisites.

### Reference

If you want to ingest metadata from Looker using the DataHub CLI, check out the following resources:
* Learn about CLI Ingestion in the [Introduction to Metadata Ingestion](../../../metadata-ingestion/README.md)
* [Looker Ingestion Source](https://datahubproject.io/docs/generated/ingestion/sources/Looker)

*Need more help? Join the conversation in [Slack](http://slack.datahubproject.io)!*
*Need more help? Join the conversation in [Slack](http://slack.datahubproject.io)!*
32 changes: 16 additions & 16 deletions docs/quick-ingestion-guides/looker/setup.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ title: Setup

## Looker Prerequisites

In order to configure ingestion from Looker, you'll first have to ensure you have an API key to access the Looker resources.
To configure ingestion from Looker, you'll first have to ensure you have an API key to access the Looker resources.

### Login To Looker Instance

Expand All @@ -30,7 +30,7 @@ On **Roles Panel**, click **New Permission Set**.
<img width="75%" alt="Looker new permission set" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/guides/looker/looker-new-permission-set-button.png"/>
</p>

Set name for the new permission set (e.g. *DataHub Connector Permission Set*) and select the following permissions.
Set a name for the new permission set (e.g., *DataHub Connector Permission Set*) and select the following permissions.

<details>
<summary>Permission List</summary>
Expand Down Expand Up @@ -61,13 +61,13 @@ After selecting all permissions mentioned above, click **New Permission Set** at

### Create A Role

On **Roles** Panel, click **New Role**.
On the **Roles** Panel, click **New Role**.

<p align="center">
<img width="75%" alt="Looker new role button" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/guides/looker/looker-new-role-button.png"/>
</p>

Set name for the new role (e.g. *DataHub Extractor*) and set following fields on this window.
Set the name for the new role (e.g., *DataHub Extractor*) and set the following fields on this window.

- Set **Permission Set** to permission set created in previous step (i.e *DataHub Connector Permission Set*)
- Set **Model Set** to `All`
Expand All @@ -80,7 +80,7 @@ Finally, click **New Role** at the bottom of the page.

### Create A New User

On **Admin** Panel, click **Users** to open users panel.
On the **Admin** Panel, click **Users** to open the users panel.

<p align="center">
<img width="75%" alt="Looker user search" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/guides/looker/looker-user-search.png"/>
Expand All @@ -92,7 +92,7 @@ Click **Add Users**.
<img width="75%" alt="Looker add user" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/guides/looker/looker-add-user-button.png"/>
</p>

On **Adding a new user**, set detail in following fields.
On **Adding a new user**, set details in the following fields.

- Add user's **Email Addresses**.
- Set **Roles** to the role created in previous step (e.g. *DataHub Extractor*)
Expand All @@ -105,52 +105,52 @@ Finally, click **Save**.

### Create An API Key

On **User** Panel, click on the newly created user.
On the **User** Panel, click on the newly created user.

<p align="center">
<img width="75%" alt="Looker user panel" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/guides/looker/looker-user-panel.png"/>
</p>

Click **Edit Keys** to open **API Key** Panel.
Click **Edit Keys** to open the **API Key** Panel.

<p align="center">
<img width="75%" alt="Looker user view" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/guides/looker/looker-user-view.png"/>
</p>

On **API Key** Panel, click **New API Key** to generate a new **Client Id** and **Client Secret**.
On the **API Key** Panel, click **New API Key** to generate a new **Client ID** and **Client Secret**.
<p align="center">
<img width="75%" alt="Looker new api key" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/guides/looker/looker-api-key.png"/>
</p>

## LookML Prerequisites

Follow below steps to create GitHub Deploy Key.
Follow the below steps to create the GitHub Deploy Key.

### Generate a private-public ssh key pair
### Generate a private-public SSH key pair

```bash
ssh-keygen -t rsa -f looker_datahub_deploy_key
```

This will typically generate two file like below.
This will typically generate two files like the one below.
* `looker_datahub_deploy_key` (private key)
* `looker_datahub_deploy_key.pub` (public key)


### Add Deploy Key to GitHub Repository

First, login to [GitHub](https://github.com).
First, log in to [GitHub](https://github.com).

Navigate to **GitHub Repository** -> **Settings** -> **Deploy Keys** and add public key (e.g. `looker_datahub_deploy_key.pub`) as deploy key with read access.
Navigate to **GitHub Repository** -> **Settings** -> **Deploy Keys** and add a public key (e.g. `looker_datahub_deploy_key.pub`) as deploy key with read access.

<p align="center">
<img width="75%" alt="Looker home page" src="http://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/guides/looker/lookml-deploy-key.png"/>
</p>

Make note of the private key file, you will need to paste the contents of the file into the GitHub Deploy Key field later while [configuring](./configuration.md) ingestion on DataHub Portal.
Make a note of the private key file. You must paste the file's contents into the GitHub Deploy Key field later while [configuring](./configuration.md) ingestion on the DataHub Portal.

## Next Steps

Once you've done all the above steps, it's time to move on to [configuring the actual ingestion source](configuration.md) within DataHub.

_Need more help? Join the conversation in [Slack](http://slack.datahubproject.io)!_
_Need more help? Join the conversation in [Slack](http://slack.datahubproject.io)!_

0 comments on commit 545e2fb

Please sign in to comment.