| 
									
										
										
										
											2021-08-01 14:27:44 -07:00
										 |  |  | # Table of contents
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | * [Introduction](README.md) | 
					
						
							| 
									
										
										
										
											2021-08-17 15:45:52 +00:00
										 |  |  | * [Try OpenMetadata](take-it-for-a-spin.md) | 
					
						
							| 
									
										
										
										
											2021-09-07 13:01:45 -07:00
										 |  |  | * [Roadmap](roadmap.md) | 
					
						
							| 
									
										
										
										
											2021-08-01 14:27:44 -07:00
										 |  |  | 
 | 
					
						
							|  |  |  | ## OpenMetadata APIs
 | 
					
						
							| 
									
										
										
										
											2021-08-11 17:17:55 +00:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2021-08-01 14:27:44 -07:00
										 |  |  | * [Schemas](openmetadata-apis/schemas/README.md) | 
					
						
							| 
									
										
										
										
											2021-08-17 15:45:52 +00:00
										 |  |  |   * [JSON Schema](openmetadata-apis/schemas/schema-language.md) | 
					
						
							| 
									
										
										
										
											2021-08-13 20:12:38 +00:00
										 |  |  |   * [Schema Concepts](openmetadata-apis/schemas/overview.md) | 
					
						
							| 
									
										
										
										
											2021-08-12 17:28:54 +00:00
										 |  |  |   * [OpenMetadata Types](openmetadata-apis/schemas/types/README.md) | 
					
						
							| 
									
										
										
										
											2021-08-15 03:30:53 +00:00
										 |  |  |     * [Basic Types](openmetadata-apis/schemas/types/basic.md) | 
					
						
							| 
									
										
										
										
											2021-08-26 13:33:44 +05:30
										 |  |  |     * [Audit Log](openmetadata-apis/schemas/types/auditlog.md) | 
					
						
							|  |  |  |     * [Daily Count](openmetadata-apis/schemas/types/dailycount.md) | 
					
						
							| 
									
										
										
										
											2021-10-12 14:28:29 +05:30
										 |  |  |     * [Entity Lineage](openmetadata-apis/schemas/types/entitylineage.md) | 
					
						
							| 
									
										
										
										
											2021-08-26 13:33:44 +05:30
										 |  |  |     * [Entity Reference](openmetadata-apis/schemas/types/entityreference.md) | 
					
						
							|  |  |  |     * [Entity Usage](openmetadata-apis/schemas/types/entityusage.md) | 
					
						
							|  |  |  |     * [Jdbc Connection](openmetadata-apis/schemas/types/jdbcconnection.md) | 
					
						
							| 
									
										
										
										
											2021-09-19 08:43:31 +05:30
										 |  |  |     * [Paging](openmetadata-apis/schemas/types/paging.md) | 
					
						
							| 
									
										
										
										
											2021-08-09 19:20:15 -07:00
										 |  |  |     * [Profile](openmetadata-apis/schemas/types/profile.md) | 
					
						
							|  |  |  |     * [Schedule](openmetadata-apis/schemas/types/schedule.md) | 
					
						
							| 
									
										
										
										
											2021-08-26 13:33:44 +05:30
										 |  |  |     * [Tag Label](openmetadata-apis/schemas/types/taglabel.md) | 
					
						
							|  |  |  |     * [Usage Details](openmetadata-apis/schemas/types/usagedetails.md) | 
					
						
							| 
									
										
										
										
											2021-08-12 17:28:54 +00:00
										 |  |  |   * [OpenMetadata Entities](openmetadata-apis/schemas/entities/README.md) | 
					
						
							| 
									
										
										
										
											2021-08-11 17:17:55 +00:00
										 |  |  |     * [Bot](openmetadata-apis/schemas/entities/bot.md) | 
					
						
							| 
									
										
										
										
											2021-09-19 08:43:31 +05:30
										 |  |  |     * [Chart](openmetadata-apis/schemas/entities/chart.md) | 
					
						
							| 
									
										
										
										
											2021-08-11 17:17:55 +00:00
										 |  |  |     * [Dashboard](openmetadata-apis/schemas/entities/dashboard.md) | 
					
						
							| 
									
										
										
										
											2021-09-19 08:43:31 +05:30
										 |  |  |     * [Dashboard Service](openmetadata-apis/schemas/entities/dashboardservice.md) | 
					
						
							| 
									
										
										
										
											2021-08-11 17:17:55 +00:00
										 |  |  |     * [Database](openmetadata-apis/schemas/entities/database.md) | 
					
						
							| 
									
										
										
										
											2021-08-26 13:33:44 +05:30
										 |  |  |     * [Database Service](openmetadata-apis/schemas/entities/databaseservice.md) | 
					
						
							|  |  |  |     * [Messaging Service](openmetadata-apis/schemas/entities/messagingservice.md) | 
					
						
							| 
									
										
										
										
											2021-08-11 17:17:55 +00:00
										 |  |  |     * [Feed](openmetadata-apis/schemas/entities/thread.md) | 
					
						
							|  |  |  |     * [Metrics](openmetadata-apis/schemas/entities/metrics.md) | 
					
						
							| 
									
										
										
										
											2021-10-12 14:28:29 +05:30
										 |  |  |     * [Model](openmetadata-apis/schemas/entities/model.md) | 
					
						
							| 
									
										
										
										
											2021-08-11 17:17:55 +00:00
										 |  |  |     * [Pipeline](openmetadata-apis/schemas/entities/pipeline.md) | 
					
						
							| 
									
										
										
										
											2021-10-12 14:28:29 +05:30
										 |  |  |     * [Pipeline Service](openmetadata-apis/schemas/entities/pipelineservice.md) | 
					
						
							| 
									
										
										
										
											2021-08-11 17:17:55 +00:00
										 |  |  |     * [Report](openmetadata-apis/schemas/entities/report.md) | 
					
						
							|  |  |  |     * [Table](openmetadata-apis/schemas/entities/table.md) | 
					
						
							| 
									
										
										
										
											2021-10-12 14:28:29 +05:30
										 |  |  |     * [Tag Category](openmetadata-apis/schemas/entities/tagcategory.md) | 
					
						
							|  |  |  |     * [Task](openmetadata-apis/schemas/entities/task.md) | 
					
						
							| 
									
										
										
										
											2021-08-11 17:17:55 +00:00
										 |  |  |     * [Team](openmetadata-apis/schemas/entities/team.md) | 
					
						
							| 
									
										
										
										
											2021-08-26 13:33:44 +05:30
										 |  |  |     * [Topic](openmetadata-apis/schemas/entities/topic.md) | 
					
						
							| 
									
										
										
										
											2021-08-11 17:17:55 +00:00
										 |  |  |     * [User](openmetadata-apis/schemas/entities/user.md) | 
					
						
							| 
									
										
										
										
											2021-08-01 14:27:44 -07:00
										 |  |  | * [APIs](openmetadata-apis/apis/README.md) | 
					
						
							|  |  |  |   * [Overview](openmetadata-apis/apis/overview.md) | 
					
						
							| 
									
										
										
										
											2021-08-15 01:39:19 +00:00
										 |  |  |   * [API Organization](openmetadata-apis/apis/api-organization.md) | 
					
						
							| 
									
										
										
										
											2021-08-12 17:37:06 +00:00
										 |  |  |   * [Implementation notes](openmetadata-apis/apis/implementation-notes.md) | 
					
						
							| 
									
										
										
										
											2021-09-07 13:01:45 -07:00
										 |  |  |    | 
					
						
							| 
									
										
										
										
											2021-08-01 14:27:44 -07:00
										 |  |  | 
 | 
					
						
							|  |  |  | ## Install
 | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2021-08-12 11:39:56 -07:00
										 |  |  | * [Run OpenMetadata](install/run-openmetadata.md) | 
					
						
							| 
									
										
										
										
											2021-08-12 12:24:29 -07:00
										 |  |  | * [Run in Production](install/run-in-production.md) | 
					
						
							| 
									
										
										
										
											2021-08-12 12:37:05 -07:00
										 |  |  | * [Configuration](install/configuration.md) | 
					
						
							| 
									
										
										
										
											2021-08-12 12:24:29 -07:00
										 |  |  | * [Enable Security](install/enable-security/README.md) | 
					
						
							|  |  |  |   * [Google SSO](install/enable-security/google-sso/README.md) | 
					
						
							|  |  |  |     * [Create Server Credentials](install/enable-security/google-sso/google-server-creds.md) | 
					
						
							|  |  |  |     * [Create Service Account](install/enable-security/google-sso/create-ingestion-service-account.md) | 
					
						
							| 
									
										
										
										
											2021-08-12 12:37:05 -07:00
										 |  |  |     * [Configure OpenMetadata Server](install/enable-security/google-sso/google-config.md) | 
					
						
							| 
									
										
										
										
											2021-08-12 12:24:29 -07:00
										 |  |  |     * [Configure Ingestion](install/enable-security/google-sso/configure-security-ingestion.md) | 
					
						
							|  |  |  |   * [Okta SSO](install/enable-security/okta-sso/README.md) | 
					
						
							|  |  |  |     * [Create Server Credentials](install/enable-security/okta-sso/okta-server-creds.md) | 
					
						
							| 
									
										
										
										
											2021-08-12 12:37:05 -07:00
										 |  |  |     * [Configure OpenMetadata Server](install/enable-security/okta-sso/okta-config.md) | 
					
						
							| 
									
										
										
										
											2021-08-12 12:24:29 -07:00
										 |  |  |     * [Create Service Account](install/enable-security/okta-sso/create-ingestion-service-account.md) | 
					
						
							|  |  |  |     * [Configure Ingestion](install/enable-security/okta-sso/configure-security-ingestion.md) | 
					
						
							| 
									
										
										
										
											2021-08-31 10:17:23 +05:30
										 |  |  |   * [Auth0 SSO](install/enable-security/auth0-sso/README.md) | 
					
						
							|  |  |  |     * [Create Server Credentials](install/enable-security/auth0-sso/auth0-server-creds.md) | 
					
						
							|  |  |  |     * [Create Service Account](install/enable-security/auth0-sso/create-ingestion-service-account.md) | 
					
						
							|  |  |  |     * [Configure OpenMetadata Server](install/enable-security/auth0-sso/auth0-config.md) | 
					
						
							|  |  |  |     * [Configure Ingestion](install/enable-security/auth0-sso/configure-security-ingestion.md) | 
					
						
							| 
									
										
										
										
											2021-08-01 14:27:44 -07:00
										 |  |  | * [Metadata Ingestion](install/metadata-ingestion/README.md) | 
					
						
							|  |  |  |   * [Ingest Sample Data](install/metadata-ingestion/ingest-sample-data.md) | 
					
						
							|  |  |  |   * [Connectors](install/metadata-ingestion/connectors/README.md) | 
					
						
							| 
									
										
										
										
											2021-09-19 08:43:31 +05:30
										 |  |  |     * [Dashboard Services](install/metadata-ingestion/connectors/dashboard-services/README.md) | 
					
						
							|  |  |  |       * [Looker](install/metadata-ingestion/connectors/dashboard-services/looker.md) | 
					
						
							| 
									
										
										
										
											2021-09-20 10:57:50 +05:30
										 |  |  |       * [Salesforce](install/metadata-ingestion/connectors/database-services/salesforce.md) | 
					
						
							| 
									
										
										
										
											2021-09-19 08:43:31 +05:30
										 |  |  |       * [Superset](install/metadata-ingestion/connectors/dashboard-services/superset.md) | 
					
						
							|  |  |  |       * [Tableau](install/metadata-ingestion/connectors/dashboard-services/tableau.md) | 
					
						
							|  |  |  |     * [Database Services](install/metadata-ingestion/connectors/database-services/README.md) | 
					
						
							|  |  |  |       * [Athena](install/metadata-ingestion/connectors/database-services/athena.md) | 
					
						
							|  |  |  |       * [BigQuery](install/metadata-ingestion/connectors/database-services/bigquery.md) | 
					
						
							|  |  |  |       * [ElasticSearch](install/metadata-ingestion/connectors/database-services/elastic-search.md) | 
					
						
							|  |  |  |       * [MSSQL](install/metadata-ingestion/connectors/database-services/mssql.md) | 
					
						
							|  |  |  |       * [MySQL](install/metadata-ingestion/connectors/database-services/mysql.md) | 
					
						
							|  |  |  |       * [Hive](install/metadata-ingestion/connectors/database-services/hive.md) | 
					
						
							|  |  |  |       * [Oracle](install/metadata-ingestion/connectors/database-services/oracle.md) | 
					
						
							|  |  |  |       * [Postgres](install/metadata-ingestion/connectors/database-services/postgres.md) | 
					
						
							|  |  |  |       * [Presto](install/metadata-ingestion/connectors/database-services/presto.md) | 
					
						
							| 
									
										
										
										
											2021-10-07 11:15:34 -07:00
										 |  |  |       * [Trino](install/metadata-ingestion/connectors/database-services/trino.md) | 
					
						
							| 
									
										
										
										
											2021-09-19 08:43:31 +05:30
										 |  |  |       * [Redshift](install/metadata-ingestion/connectors/database-services/redshift.md) | 
					
						
							|  |  |  |       * [Redshift Usage](install/metadata-ingestion/connectors/database-services/redshift-usage.md) | 
					
						
							|  |  |  |       * [Snowflake](install/metadata-ingestion/connectors/database-services/snowflake.md) | 
					
						
							|  |  |  |       * [Snowflake Usage](install/metadata-ingestion/connectors/database-services/snowflake-usage.md) | 
					
						
							|  |  |  |     * [Messaging Services](install/metadata-ingestion/connectors/messaging-services/README.md) | 
					
						
							|  |  |  |       * [Kafka](install/metadata-ingestion/connectors/messaging-services/kafka.md) | 
					
						
							| 
									
										
										
										
											2021-08-01 14:27:44 -07:00
										 |  |  |   * [Scheduler](install/metadata-ingestion/scheduler.md) | 
					
						
							|  |  |  |   * [Airflow](install/metadata-ingestion/airflow.md) | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | ## Open Source Community
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | * [Community](open-source-community/community.md) | 
					
						
							|  |  |  | * [Developer](open-source-community/developer/README.md) | 
					
						
							| 
									
										
										
										
											2021-08-18 10:47:35 -07:00
										 |  |  |   * [How to Contribute](open-source-community/developer/how-to-contribute.md) | 
					
						
							| 
									
										
										
										
											2021-08-01 14:27:44 -07:00
										 |  |  |   * [Coding Style](open-source-community/developer/coding-style.md) | 
					
						
							|  |  |  |   * [Build the code & run tests](open-source-community/developer/build-code-run-tests.md) | 
					
						
							| 
									
										
										
										
											2021-08-16 15:43:09 -07:00
										 |  |  |   * [Build a Connector](open-source-community/developer/build-a-connector/README.md) | 
					
						
							| 
									
										
										
										
											2021-08-17 15:45:52 +00:00
										 |  |  |     * [Source](open-source-community/developer/build-a-connector/source.md) | 
					
						
							|  |  |  |     * [Processor](open-source-community/developer/build-a-connector/processor.md) | 
					
						
							|  |  |  |     * [Sink](open-source-community/developer/build-a-connector/sink.md) | 
					
						
							|  |  |  |     * [Stage](open-source-community/developer/build-a-connector/stage.md) | 
					
						
							|  |  |  |     * [BulkSink](open-source-community/developer/build-a-connector/bulksink.md) | 
					
						
							| 
									
										
										
										
											2021-08-01 14:27:44 -07:00
										 |  |  |   * [Run Integration Tests](open-source-community/developer/run-integration-tests.md) | 
					
						
							| 
									
										
										
										
											2021-08-15 22:21:43 +00:00
										 |  |  |   * [UX Style Guide](open-source-community/developer/ux-style-guide.md) | 
					
						
							| 
									
										
										
										
											2021-08-01 14:27:44 -07:00
										 |  |  | 
 |