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

doc: update the bots doc #13941

Merged
merged 1 commit into from
Nov 10, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -3,53 +3,50 @@ title: How to set up bots
slug: /how-to-guides/feature-configurations/bots
---

# How to set up bots when SSO is configured
# How to set up a bot

In the 0.12.1 version, `AIRFLOW_AUTH_PROVIDER` and `OM_AUTH_AIRFLOW_{AUTH_PROVIDER}` parameters are not needed to configure
how the ingestion is performed from Airflow when our OpenMetadata server is secured. This can be achieved directly from UI
through the _Bots_ configuration in the settings page.
The default account for any ingestion pipeline deployed from the UI is `ingestion-bot`. To configure `ingestion-bot` from the UI, go to the settings page, scroll down to the Integration section, and access the `Bots` tab.

By default, `ingestion-bot` is going to be the default account used for any ingestion pipeline deployed from the UI. To set
up the `ingestion-bot` from UI. Go to `Settings` > `Bots`. In the following example we are going to show how to configure it
for Google SSO, but it can apply to any SSO.

- Click on `ingestion-bot`:
{% image
src="/images/v1.1/how-to-guides/feature-configurations/bots/click-bot.png"
alt="click-bot"
caption="Click on 'ingestion-bot'" /%}

src="/images/v1.2/how-to-guides/feature-configurations/bots/bot-listing.png"
alt="bot-listing"
/%}

- In case you are configuring a bot with an SSO service account for the first time, please revoke first the default auto
generated JWT Token by clicking the "**Revoke**" button:
You can either create a new bot or update the existing `ingestion-bot`.

{% image
src="/images/v1.1/how-to-guides/feature-configurations/bots/revoke-jwt-token.png"
alt="revoke-jwt-toke"
caption="Revoke JWT Token" /%}
### Update `ingestion-bot`

Click on `ingestion-bot` and you will be redirected to it's details page, there you can

- Then, click on "**Generate New Token**":
- Revoke the token if already present
- Copy the generated token

{% image
src="/images/v1.1/how-to-guides/feature-configurations/bots/generate-new-token.png"
alt="generate-new-token"
caption="Generate New Token to edit" /%}
src="/images/v1.2/how-to-guides/feature-configurations/bots/bot-token-page.png"
alt="bot-listing"
/%}

- Generate new token

- Select your configured SSO from the list. In this case, `Google SSO`.
{% image
src="/images/v1.2/how-to-guides/feature-configurations/bots/generate-new-token.png"
alt="generate new token"
/%}

{% image src="/images/v1.1/how-to-guides/feature-configurations/bots/select-google-sso.png"
alt="select-google-sso"
caption="Select 'Google SSO'" /%}
{% image
src="/images/v1.2/how-to-guides/feature-configurations/bots/bot-token-generate.png"
alt="token generate page"
/%}

### Create a new bot

- Configure it with your SSO values. Ensure that the account email of your SSO matches the service account name of the
bot.
Click the `Add bot` button, and you will be directed to the bot creation page. Fill in the required details and then click on the `Create` button.

{% image
src="/images/v1.1/how-to-guides/feature-configurations/bots/configure-bot.png"
alt="configure-bot"
caption="Configure the ingestion-bot with your SSO values" /%}
src="/images/v1.2/how-to-guides/feature-configurations/bots/create-bot.png"
alt="create bot"
/%}


### Notes:

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file not shown.
Loading