| 
									
										
										
										
											2024-06-18 15:53:06 +02:00
										 |  |  | --- | 
					
						
							|  |  |  | title: Run the Glue Pipeline Connector Externally | 
					
						
							| 
									
										
										
										
											2025-07-16 14:55:13 +05:30
										 |  |  | description: Use the YAML config for Glue pipeline ingestion to define metadata patterns, connection parameters, and lineage capture logic. | 
					
						
							| 
									
										
										
										
											2024-06-18 15:53:06 +02:00
										 |  |  | slug: /connectors/pipeline/glue-pipeline/yaml | 
					
						
							|  |  |  | --- | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | {% connectorDetailsHeader | 
					
						
							|  |  |  | name="Glue" | 
					
						
							|  |  |  | stage="PROD" | 
					
						
							|  |  |  | platform="OpenMetadata" | 
					
						
							| 
									
										
										
										
											2025-04-11 18:23:41 +05:30
										 |  |  | availableFeatures=["Pipelines", "Pipeline Status", "Usage", "Lineage"] | 
					
						
							|  |  |  | unavailableFeatures=["Owners", "Tags"] | 
					
						
							| 
									
										
										
										
											2024-06-18 15:53:06 +02:00
										 |  |  | / %} | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | In this section, we provide guides and references to use the Glue connector. | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | Configure and schedule Glue metadata and profiler workflows from the OpenMetadata UI: | 
					
						
							|  |  |  | - [Requirements](#requirements) | 
					
						
							|  |  |  | - [Metadata Ingestion](#metadata-ingestion) | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2025-07-02 12:45:38 +05:30
										 |  |  | {% partial file="/v1.7/connectors/external-ingestion-deployment.md" /%} | 
					
						
							| 
									
										
										
										
											2024-06-18 15:53:06 +02:00
										 |  |  | 
 | 
					
						
							|  |  |  | ## Requirements
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | The Glue connector ingests metadata through AWS [Boto3](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/glue.html) Client. | 
					
						
							|  |  |  | We will ingest Workflows, its jobs and their run status. | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | The user must have the following permissions for the ingestion to run successfully: | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | - `glue:ListWorkflows` | 
					
						
							|  |  |  | - `glue:GetWorkflow` | 
					
						
							|  |  |  | - `glue:GetJobRuns` | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | ### Python Requirements
 | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2025-07-02 12:45:38 +05:30
										 |  |  | {% partial file="/v1.7/connectors/python-requirements.md" /%} | 
					
						
							| 
									
										
										
										
											2024-06-18 15:53:06 +02:00
										 |  |  | 
 | 
					
						
							|  |  |  | To run the Glue ingestion, you will need to install: | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | ```bash | 
					
						
							|  |  |  | pip3 install "openmetadata-ingestion[glue]" | 
					
						
							|  |  |  | ``` | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | ## Metadata Ingestion
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | All connectors are defined as JSON Schemas. | 
					
						
							|  |  |  | [Here](https://github.com/open-metadata/OpenMetadata/blob/main/openmetadata-spec/src/main/resources/json/schema/entity/services/connections/database/glueConnection.json) | 
					
						
							|  |  |  | you can find the structure to create a connection to Glue. | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | In order to create and run a Metadata Ingestion workflow, we will follow | 
					
						
							|  |  |  | the steps to create a YAML configuration able to connect to the source, | 
					
						
							|  |  |  | process the Entities if needed, and reach the OpenMetadata server. | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | The workflow is modeled around the following | 
					
						
							|  |  |  | [JSON Schema](https://github.com/open-metadata/OpenMetadata/blob/main/openmetadata-spec/src/main/resources/json/schema/metadataIngestion/workflow.json) | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | ### 1. Define the YAML Config
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | This is a sample config for Glue: | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | {% codePreview %} | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | {% codeInfoContainer %} | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | #### Source Configuration - Service Connection
 | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2025-03-24 09:07:16 +05:30
										 |  |  | {% partial file="/v1.7/connectors/yaml/common/aws-config-def.md" /%} | 
					
						
							| 
									
										
										
										
											2024-06-18 15:53:06 +02:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2025-07-02 12:45:38 +05:30
										 |  |  | {% partial file="/v1.7/connectors/yaml/pipeline/source-config-def.md" /%} | 
					
						
							| 
									
										
										
										
											2024-06-18 15:53:06 +02:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2025-07-02 12:45:38 +05:30
										 |  |  | {% partial file="/v1.7/connectors/yaml/ingestion-sink-def.md" /%} | 
					
						
							| 
									
										
										
										
											2025-01-17 13:33:10 +05:30
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2025-07-02 12:45:38 +05:30
										 |  |  | {% partial file="/v1.7/connectors/yaml/workflow-config-def.md" /%} | 
					
						
							| 
									
										
										
										
											2024-06-18 15:53:06 +02:00
										 |  |  | 
 | 
					
						
							|  |  |  | {% /codeInfoContainer %} | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | {% codeBlock fileName="filename.yaml" %} | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | ```yaml {% isCodeBlock=true %} | 
					
						
							|  |  |  | source: | 
					
						
							| 
									
										
										
										
											2024-10-09 08:05:09 +05:30
										 |  |  |   type: gluepipeline  | 
					
						
							| 
									
										
										
										
											2024-06-18 15:53:06 +02:00
										 |  |  |   serviceName: local_glue | 
					
						
							|  |  |  |   serviceConnection: | 
					
						
							|  |  |  |     config: | 
					
						
							| 
									
										
										
										
											2024-10-09 08:05:09 +05:30
										 |  |  |       type: GluePipeline | 
					
						
							| 
									
										
										
										
											2024-06-18 15:53:06 +02:00
										 |  |  |       awsConfig: | 
					
						
							|  |  |  | ``` | 
					
						
							| 
									
										
										
										
											2025-03-24 09:07:16 +05:30
										 |  |  | {% partial file="/v1.7/connectors/yaml/common/aws-config.md" /%} | 
					
						
							| 
									
										
										
										
											2024-06-18 15:53:06 +02:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2025-07-02 12:45:38 +05:30
										 |  |  | {% partial file="/v1.7/connectors/yaml/pipeline/source-config.md" /%} | 
					
						
							| 
									
										
										
										
											2024-06-18 15:53:06 +02:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2025-07-02 12:45:38 +05:30
										 |  |  | {% partial file="/v1.7/connectors/yaml/ingestion-sink.md" /%} | 
					
						
							| 
									
										
										
										
											2024-06-18 15:53:06 +02:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2025-07-02 12:45:38 +05:30
										 |  |  | {% partial file="/v1.7/connectors/yaml/workflow-config.md" /%} | 
					
						
							| 
									
										
										
										
											2024-06-18 15:53:06 +02:00
										 |  |  | 
 | 
					
						
							|  |  |  | {% /codeBlock %} | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | {% /codePreview %} | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2025-07-02 12:45:38 +05:30
										 |  |  | {% partial file="/v1.7/connectors/yaml/ingestion-cli.md" /%} |