diff --git a/openmetadata-docs/content/v1.2.x/how-to-guides/feature-configurations/bots.md b/openmetadata-docs/content/v1.2.x/how-to-guides/feature-configurations/bots.md index 00d64dc9615..d1caccce5c2 100644 --- a/openmetadata-docs/content/v1.2.x/how-to-guides/feature-configurations/bots.md +++ b/openmetadata-docs/content/v1.2.x/how-to-guides/feature-configurations/bots.md @@ -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. - -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'" /%} - - -- 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: +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. {% image -src="/images/v1.1/how-to-guides/feature-configurations/bots/revoke-jwt-token.png" -alt="revoke-jwt-toke" -caption="Revoke JWT Token" /%} +src="/images/v1.2/how-to-guides/feature-configurations/bots/bot-listing.png" +alt="bot-listing" +/%} +You can either create a new bot or update the existing `ingestion-bot`. -- Then, click on "**Generate New Token**": +### Update `ingestion-bot` + +Click on `ingestion-bot` and you will be redirected to it's details page, there you can + +- 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" +/%} - -- Select your configured SSO from the list. In this case, `Google SSO`. - -{% image src="/images/v1.1/how-to-guides/feature-configurations/bots/select-google-sso.png" -alt="select-google-sso" -caption="Select 'Google SSO'" /%} - -- Configure it with your SSO values. Ensure that the account email of your SSO matches the service account name of the -bot. +- Generate new token {% 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/generate-new-token.png" +alt="generate new token" +/%} + +{% image +src="/images/v1.2/how-to-guides/feature-configurations/bots/bot-token-generate.png" +alt="token generate page" +/%} + +### Create a new 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.2/how-to-guides/feature-configurations/bots/create-bot.png" +alt="create bot" +/%} + ### Notes: diff --git a/openmetadata-docs/images/v1.2/how-to-guides/feature-configurations/bots/bot-listing.png b/openmetadata-docs/images/v1.2/how-to-guides/feature-configurations/bots/bot-listing.png new file mode 100644 index 00000000000..583becbaa9d Binary files /dev/null and b/openmetadata-docs/images/v1.2/how-to-guides/feature-configurations/bots/bot-listing.png differ diff --git a/openmetadata-docs/images/v1.2/how-to-guides/feature-configurations/bots/bot-token-generate.png b/openmetadata-docs/images/v1.2/how-to-guides/feature-configurations/bots/bot-token-generate.png new file mode 100644 index 00000000000..04d3d9586aa Binary files /dev/null and b/openmetadata-docs/images/v1.2/how-to-guides/feature-configurations/bots/bot-token-generate.png differ diff --git a/openmetadata-docs/images/v1.2/how-to-guides/feature-configurations/bots/bot-token-page.png b/openmetadata-docs/images/v1.2/how-to-guides/feature-configurations/bots/bot-token-page.png new file mode 100644 index 00000000000..79b531f1062 Binary files /dev/null and b/openmetadata-docs/images/v1.2/how-to-guides/feature-configurations/bots/bot-token-page.png differ diff --git a/openmetadata-docs/images/v1.2/how-to-guides/feature-configurations/bots/click-bot.png b/openmetadata-docs/images/v1.2/how-to-guides/feature-configurations/bots/click-bot.png deleted file mode 100644 index 7dacf326a78..00000000000 Binary files a/openmetadata-docs/images/v1.2/how-to-guides/feature-configurations/bots/click-bot.png and /dev/null differ diff --git a/openmetadata-docs/images/v1.2/how-to-guides/feature-configurations/bots/configure-bot.png b/openmetadata-docs/images/v1.2/how-to-guides/feature-configurations/bots/configure-bot.png deleted file mode 100644 index a288a907bd7..00000000000 Binary files a/openmetadata-docs/images/v1.2/how-to-guides/feature-configurations/bots/configure-bot.png and /dev/null differ diff --git a/openmetadata-docs/images/v1.2/how-to-guides/feature-configurations/bots/create-bot.png b/openmetadata-docs/images/v1.2/how-to-guides/feature-configurations/bots/create-bot.png new file mode 100644 index 00000000000..ea680598a95 Binary files /dev/null and b/openmetadata-docs/images/v1.2/how-to-guides/feature-configurations/bots/create-bot.png differ diff --git a/openmetadata-docs/images/v1.2/how-to-guides/feature-configurations/bots/generate-new-token.png b/openmetadata-docs/images/v1.2/how-to-guides/feature-configurations/bots/generate-new-token.png index 501531ad5bb..48156ed524e 100644 Binary files a/openmetadata-docs/images/v1.2/how-to-guides/feature-configurations/bots/generate-new-token.png and b/openmetadata-docs/images/v1.2/how-to-guides/feature-configurations/bots/generate-new-token.png differ diff --git a/openmetadata-docs/images/v1.2/how-to-guides/feature-configurations/bots/revoke-jwt-token.png b/openmetadata-docs/images/v1.2/how-to-guides/feature-configurations/bots/revoke-jwt-token.png deleted file mode 100644 index 566967b31b4..00000000000 Binary files a/openmetadata-docs/images/v1.2/how-to-guides/feature-configurations/bots/revoke-jwt-token.png and /dev/null differ diff --git a/openmetadata-docs/images/v1.2/how-to-guides/feature-configurations/bots/select-google-sso.png b/openmetadata-docs/images/v1.2/how-to-guides/feature-configurations/bots/select-google-sso.png deleted file mode 100644 index 44a98dfde10..00000000000 Binary files a/openmetadata-docs/images/v1.2/how-to-guides/feature-configurations/bots/select-google-sso.png and /dev/null differ