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.

Sign up for GitHub

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

MINOR: Update README.md #14411

Merged
merged 17 commits into from
Dec 20, 2023
Merged

MINOR: Update README.md #14411

Changes from all commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
fa915ec
Update README.md
ayush-shah Dec 15, 2023
91dcd2f
Update README.md
ayush-shah Dec 15, 2023
1307798
Update README.md
ayush-shah Dec 15, 2023
38102b9
Update README.md
ayush-shah Dec 15, 2023
f78d342
Update README.md
ayush-shah Dec 16, 2023
3d5039d
Update README.md
ayush-shah Dec 17, 2023
c365fb4
Update README.md
ayush-shah Dec 17, 2023
81af764
Update README.md
ayush-shah Dec 17, 2023
93e9c86
Update README.md
ayush-shah Dec 17, 2023
a1db64f
Update README.md
ayush-shah Dec 17, 2023
7a83000
Update README.md
ayush-shah Dec 18, 2023
628d5bd
Update README.md
ayush-shah Dec 19, 2023
7c18237
Update README.md
ayush-shah Dec 19, 2023
8a81b66
Update README.md
ayush-shah Dec 19, 2023
c41c4a9
Update README.md
ShilpaVernekar Dec 19, 2023
54dbfa0
Update README.md
ShilpaVernekar Dec 19, 2023
05e2d0b
Update README.md
ayush-shah Dec 19, 2023
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
112 changes: 59 additions & 53 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,83 +1,83 @@
<br /><br />
<p align="center">
<a href="https://open-metadata.org">
<img alt="Logo" src="https://github.com/open-metadata/OpenMetadata/assets/40225091/e794ced8-7220-4393-8efc-3faf93bfb503" width="49%">
</a>
</p>

<p align="center"><b>Empower your Data Journey with OpenMetadata</b></p>

<div align="center">

![Commit Activity](https://img.shields.io/github/commit-activity/m/open-metadata/OpenMetadata?style=for-the-badge)
[![Release](https://img.shields.io/github/release/open-metadata/OpenMetadata/all.svg?style=for-the-badge)](https://github.com/open-metadata/OpenMetadata/releases)

</div>

## What is OpenMetadata?
[OpenMetadata](https://open-metadata.org/) is a unified platform for discovery, observability, and governance powered by a central metadata repository, in-depth lineage, and seamless team collaboration. It is one of the fastest-growing open-source projects with a vibrant community and adoption by a diverse set of companies in a variety of industry verticals. Based on Open Metadata Standards and APIs, supporting connectors to a wide range of data services, OpenMetadata enables end-to-end metadata management, giving you the freedom to unlock the value of your data assets.
<div align="center">
<img src="./openmetadata-docs/readme/openmetadata-banner.png" align="center" alt="OpenMetadata" height="350"/>
<hr />

[![Build Status](https://github.com/open-metadata/OpenMetadata/actions/workflows/maven-build.yml/badge.svg?event=push)](https://github.com/open-metadata/OpenMetadata/actions/workflows/maven-build.yml)
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=open-metadata_OpenMetadata&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=open-metadata_OpenMetadata)
[![Release](https://img.shields.io/github/release/open-metadata/OpenMetadata/all.svg)](https://github.com/open-metadata/OpenMetadata/releases)
![GitHub commit activity](https://img.shields.io/github/commit-activity/m/open-metadata/OpenMetadata)
[![Twitter Follow](https://img.shields.io/twitter/follow/open_metadata?style=social)](https://twitter.com/intent/follow?screen_name=open_metadata)
<a href="https://slack.open-metadata.org/"><img src="https://img.shields.io/badge/slack-join-E01E5A?logo=slack" alt="Join us on Slack" height="22"/></a>
[![License](https://img.shields.io/github/license/open-metadata/OpenMetadata.svg)](LICENSE)
[![openmetadata](https://img.shields.io/endpoint?url=https://cloud.cypress.io/badge/simple/a9yxci/main&style=social&logo=cypress)](https://cloud.cypress.io/projects/a9yxci/runs)
<img src="https://github.com/open-metadata/OpenMetadata/assets/40225091/ebfb4ec5-f0a2-4d58-8ce5-a082b5cf0f76" width=800>
</div>

- [What is OpenMetadata?](#what-is-openmetadata )
- [Features](#features)
<br />
Contents:

- [Features](#key-features-of-openmetadata)
- [Try our Sandbox](#try-our-sandbox)
- [Install & Run](#install-and-run-openmetadata)
- [Roadmap](https://docs.open-metadata.org/releases/roadmap)
- [Documentation and support](#documentation-and-support)
- [Documentation and Support](#documentation-and-support)
- [Contributors](#contributors)
- [License](#license)

# What is OpenMetadata?
[OpenMetadata](https://open-metadata.org/) is an all-in-one platform for data discovery, data lineage, data quality, observability, governance, and team collaboration. It is one of the fastest growing open-source projects with a vibrant community and adoption by a diverse set of companies in a variety of industry verticals. Powered by a centralized metadata store based on Open Metadata Standards/APIs, supporting connectors to a wide range of data services, OpenMetadata enables end-to-end metadata management, giving you the freedom to unlock the value of your data assets.

<img src="./openmetadata-docs/readme/components.png" width="800">

OpenMetadata includes the following:
- **Metadata Schemas** - Defines core abstractions and vocabulary for metadata with schemas for Types, Entities, and Relationships between entities. This is the foundation of the Open Metadata Standard. Also supports the extensibility of entities and types with custom properties.

- **Metadata Store** - Stores metadata graph that connects data assets, user, and tool-generated metadata.

- **Metadata APIs** - For producing and consuming metadata built on schemas for User Interfaces and Integration of tools, systems, and services.
OpenMetadata Consists of Four Main Components:
- **Metadata Schemas**: These are the core definitions and vocabulary for metadata, based on common abstractions and types. They also allow for custom extensions and properties to suit different use cases and domains.
- **Metadata Store**: This is the central repository for storing and managing the metadata graph, which connects data assets, users, and tool-generated metadata in a unified way.
- **Metadata APIs**: These are the interfaces for producing and consuming metadata, built on top of the metadata schemas. They enable seamless integration of user interfaces and tools, systems, and services with the metadata store.
- **Ingestion Framework**: This is a pluggable framework for ingesting metadata from various sources and tools to the metadata store. It supports about 75+ connectors for data warehouses, databases, dashboard services, messaging services, pipeline services, and more.

- **Ingestion Framework** - A pluggable framework for integrating tools and ingesting metadata to the metadata store, supporting about 55 connectors. The ingestion framework supports well known data warehouses like Google BigQuery, Snowflake, Amazon Redshift, and Apache Hive; databases like MySQL, Postgres, Oracle, and MSSQL; dashboard services like Tableau, Superset, and Metabase; messaging services like Kafka, Redpanda; and pipeline services like Airflow, Glue, Fivetran, Dagster, and many more.
## Key Features of OpenMetadata:

- **OpenMetadata User Interface** - A single place for users to discover and collaborate on all data.
![12](https://github.com/open-metadata/OpenMetadata/assets/40225091/0dbd2746-c93d-4a47-8d3e-ceb3ae01436f)
- **Data Discovery**: This feature enables you to find and explore data assets and metadata entities using various strategies, such as keyword search, data associations, and advanced queries. You can search across tables, topics, dashboards, pipelines, and services.

## Features
Here are some of the supported features in a nutshell:
- **Data Collaboration** - Get event notifications with Activity feeds. Send alerts & notifications using webhooks. Add Announcements to notify the team of upcoming changes. Add Tasks to request descriptions or glossary term approval workflows. Add user mentions and collaborate using conversation threads.
![11](https://github.com/open-metadata/OpenMetadata/assets/40225091/7df29e12-8a29-44b7-9466-42474823783f)
- **Data Collaboration**: This feature enables you to communicate and cooperate with other users and teams on data assets and metadata entities. You can get event notifications, send alerts, add announcements, create tasks, and use conversation threads.

- **Data Quality and Profiler** - Standardized tests and data quality metadata. Groups related tests as Test Suites. Supports custom SQL data quality tests. Has an interactive dashboard to drill down to the details.
![8](https://github.com/open-metadata/OpenMetadata/assets/40225091/6b330827-cc2d-4d06-abf0-a4d42ce532ba)
- **Data Quality and Profiler**: This feature enables you to measure and monitor the quality and characteristics of your data assets. You can define and run data quality tests, group them into test suites, and view the results in an interactive dashboard.

- **Data Lineage** - Supports rich column-level lineage. Effectively filters queries to extract lineage. Edit lineage manually as required and connect the entities with a no-code editor.
![10](https://github.com/open-metadata/OpenMetadata/assets/40225091/f7384a71-6b58-44ad-983f-e302718ee3f1)
- **Data Governance**: This feature enables you to enforce data policies and standards across your organization. You can define data domains and data products, assign owners and stakeholders, and classify data assets using tags and terms.

- **Comprehensive Roles and Policies** - Handles complex access control use cases and hierarchical teams.
![9](https://github.com/open-metadata/OpenMetadata/assets/40225091/61fc2f65-2436-4fc9-9434-c27ee9b25183)
- **Data Insights and KPIs**: OpenMetadata offers a suite of reports providing platform analytics around specific areas. Data Insight allows admins to take an active approach in their metadata management. Data Insight provides a single-pane view of all the key metrics to best reflect the state of your data. Admins can define the Key Performance Indicators (KPIs) and set goals within OpenMetadata to work towards better documentation, ownership, and tiering. Alerts can be set against the KPIs to be received on a specified schedule.

- **Webhooks** - Supports webhook integrations. Integrate with Slack, Microsoft Teams and Google Chat.

- **Connectors** - Supports 55 connectors to various databases, dashboards, pipelines, and messaging services.

- **Glossary** - Add a Controlled Vocabulary to describe important concepts and terminologies within your organization. Add Glossaries, Terms, Tags, Descriptions, and Reviewers.

- **Data Security** - Supports Google, Okta, custom OIDC, Auth0, Azure, Amazon Cognito, and OneLogin as identity providers for SSO. Also, supports SAML-based authentication for AWS SSO and Google.

- **Secrets Manager Interface** - Communicates with any key management store.

- **And lots more...**

Check out for more [here](https://docs.open-metadata.org/features) ✨

![](https://docs.open-metadata.org/images/v1.2/features/all-your-data-in-one-place.gif)
- **Data Lineage**: This feature enables you to track and visualize the origin and transformation of your data assets. You can view column-level lineage, filter queries, and edit lineage manually using a no-code editor.

- **Data Documentation**: You can document your data assets and metadata entities using rich text, images, and links. You can also add comments and annotations, and generate data dictionaries and data catalogs.

- **Data Observability**: This feature enables you to monitor the health and performance of your data assets and pipelines. You can view metrics such as data freshness, data volume, data quality, and data latency. You can also set up alerts and notifications for any anomalies or failures.

- **Data Security**: You can secure your data and metadata using various authentication and authorization mechanisms. You can integrate with different identity providers for single sign-on, and define roles and policies for access control.

- **Webhooks**: You can integrate with external applications and services using webhooks. You can register URLs to receive metadata event notifications, and integrate with Slack, Microsoft Teams, and Google Chat.

- **Connectors**: You can ingest metadata from various sources and tools using connectors. OpenMetadata supports about 75+ connectors for data warehouses, databases, dashboard services, messaging services, pipeline services, and more.

## Try our Sandbox

Take a look and play with sample data at [http://sandbox.open-metadata.org](http://sandbox.open-metadata.org)

[<img src="./openmetadata-docs/readme/demo-button.png" height="50"/>](http://sandbox.open-metadata.org)


## Install and Run OpenMetadata
Get up and running in a few minutes. See the OpenMetadata documentation for [installation instructions](https://docs.open-metadata.org/quick-start/local-docker-deployment).

## Documentation and Support

Check out [OpenMetadata documentation](https://docs.open-metadata.org/) for a complete description of OpenMetadata's features.

Join [our Slack Community](https://slack.open-metadata.org/) to get in touch with us, want to chat, need help, or want to discuss about a new feature requirement.
Join our [Slack Community](https://slack.open-metadata.org/) to get in touch with us, want to chat, need help, or want to discuss about a new feature requirement.

Or join the group at [https://groups.google.com/g/openmetadata-users](https://groups.google.com/g/openmetadata-users)

Expand All @@ -91,7 +91,13 @@ Don't want to miss anything? Give the project a ⭐ 🚀

A HUGE THANK YOU to all our supporters!

[![Stargazers repo roster for @open-metadata/OpenMetadata](https://reporoster.com/stars/open-metadata/OpenMetadata)](https://github.com/open-metadata/OpenMetadata/stargazers)
<a href="https://github.com/open-metadata/OpenMetadata/graphs/contributors">
<img src="https://contrib.rocks/image?repo=open-metadata/OpenMetadata&max=4000&columns=30" />
</a>

## Stargazers

[![Stargazers of @open-metadata/OpenMetadata repo](http://reporoster.com/stars/open-metadata/OpenMetadata)](https://github.com/open-metadata/OpenMetadata/stargazers)

## License
OpenMetadata is released under [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0)
Loading