2024-06-18 15:53:06 +02:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
								---
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								title: How to Set Up Bots
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								slug: /developers/bots
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								---
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								# How to Set Up Bots
  
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
									
										
										
										
											2024-07-02 10:35:54 +05:30 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								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 and access the `Bots`  tile.
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								{% image
							 
						 
					
						
							
								
									
										
										
										
											2024-12-05 12:09:36 +05:30 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								src="/images/v1.6/developers/settings-bot.png"
							 
						 
					
						
							
								
									
										
										
										
											2024-07-02 10:35:54 +05:30 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								alt="settings-bot"
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								/%}
							 
						 
					
						
							
								
									
										
										
										
											2024-06-18 15:53:06 +02:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								{% image
							 
						 
					
						
							
								
									
										
										
										
											2024-12-04 11:44:41 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								src="/images/v1.6/developers/bot-listing.png"
							 
						 
					
						
							
								
									
										
										
										
											2024-06-18 15:53:06 +02:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
								alt="bot-listing"
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								/%}
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								You can either create a new bot  or update the existing `ingestion-bot` .
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								### 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
							 
						 
					
						
							
								
									
										
										
										
											2024-12-04 11:44:41 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								src="/images/v1.6/developers/bot-token-page.png"
							 
						 
					
						
							
								
									
										
										
										
											2024-06-18 15:53:06 +02:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
								alt="bot-listing"
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								/%}
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								-  Generate new token 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								{% image
							 
						 
					
						
							
								
									
										
										
										
											2024-12-04 11:44:41 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								src="/images/v1.6/developers/generate-new-token.png"
							 
						 
					
						
							
								
									
										
										
										
											2024-06-18 15:53:06 +02:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
								alt="generate new token"
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								/%}
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								{% image
							 
						 
					
						
							
								
									
										
										
										
											2024-12-04 11:44:41 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								src="/images/v1.6/developers/bot-token-generate.png"
							 
						 
					
						
							
								
									
										
										
										
											2024-06-18 15:53:06 +02:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
								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
							 
						 
					
						
							
								
									
										
										
										
											2024-12-04 11:44:41 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								src="/images/v1.6/developers/create-bot.png"
							 
						 
					
						
							
								
									
										
										
										
											2024-06-18 15:53:06 +02:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
								alt="create bot"
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								/%}
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								### Notes:
  
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								**1. `ingestion-bot` **
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								The `ingestion-bot`  bot is created (or updated if it already exists) as a system bot that cannot be deleted, and
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								the credentials used for this bot, if they did not exist before, will be the ones present in the OpenMetadata configuration.
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								Otherwise, a JWT Token will be generated to be the default authentication mechanism of the `ingestion-bot` .
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								**2. JWT Token auth mechanism**
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								If you decide to configure a JWT Token for the authentication mechanism ensure that you have also the value `http://localhost:8585/api/v1/system/config/jwks` 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								in your `publicKeyUrls`  list:
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								-  For **bare metal**  configuration: 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								```yaml
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								authenticationConfiguration:
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								  provider: "google"
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								  publicKeyUrls:
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								    -  "https://www.googleapis.com/oauth2/v3/certs"
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								    -  "http://localhost:8585/api/v1/system/config/jwks"
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								```
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								-  For **docker**  configuration, the value to be updated is `AUTHENTICATION_PUBLIC_KEYS` : 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								```bash
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								AUTHENTICATION_PUBLIC_KEYS=[https://www.googleapis.com/oauth2/v3/certs, http://localhost:8585/api/v1/system/config/jwks]
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								```
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								-  In the case of **kubernetes** , you have to update `publicKeys`  values: 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								```yaml
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								openmetadata:
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								  config:
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								    authentication:
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								      publicKeys:
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								        -  "https://www.googleapis.com/oauth2/v3/certs"
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								        -  "http://localhost:8585/api/v1/system/config/jwks" 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								```
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								**3. Redeploying ingestion pipelines**
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								When the `ingestion-bot`  is updated, we must redeploy our ingestion pipelines since the credentials used by the bot have been updated,
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								and they will no longer be valid.