OpenMetadata/README.md

73 lines
4.1 KiB
Markdown
Raw Permalink Normal View History

2021-08-01 14:27:44 -07:00
<div align="center">
<img src="https://i.imgur.com/5VumwFS.png" align="center" alt="OpenMetadata" height="90"/>
<hr />
2021-08-13 15:55:03 +05:30
[![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)
[![Release](https://img.shields.io/github/release/open-metadata/OpenMetadata/all.svg)](https://github.com/open-metadata/OpenMetadata/releases)
[![Commit](https://img.shields.io/github/commit-activity/m/open-metadata/OpenMetadata)](Commit)
2021-08-01 14:27:44 -07:00
[![Twitter Follow](https://img.shields.io/twitter/follow/open_metadata?style=social)](https://twitter.com/intent/follow?screen_name=open_metadata)
2021-09-24 09:40:07 -07:00
<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>
2021-08-13 15:55:03 +05:30
[![License](https://img.shields.io/github/license/open-metadata/OpenMetadata.svg)](LICENSE)
2021-08-01 14:27:44 -07:00
</div>
- [What is OpenMetadata?](#what-is-openmetadata )
2021-08-13 15:21:08 -07:00
- [Try our Sandbox](#try-our-sandbox)
- [Install & Run](#install-and-run-openmetadata)
- [Roadmap](docs/roadmap.md)
2021-08-13 15:21:08 -07:00
- [Documentation and support](#documentation-and-support)
- [Contributors](#contributors)
2021-08-01 14:27:44 -07:00
- [License](#license)
# What is OpenMetadata?
[OpenMetadata](https://open-metadata.org/) is an Open Standard for Metadata. A Single place to Discover, Collaborate, and Get your data right.
2021-08-13 15:28:12 -07:00
<img src="https://user-images.githubusercontent.com/1417689/129423079-d21cbf3f-786f-4d4a-b6c3-b66feca234b8.png" width="800">
2021-08-13 15:13:21 -07:00
OpenMetadata includes the following:
2021-08-13 15:16:41 -07:00
- **Metadata schemas** - defines core abstractions and vocabulary for metadata with schemas for Types, Entities, Relationships between entities. This is the foundation of the Open Metadata Standard.
2021-08-13 15:13:21 -07:00
- **Metadata store** - stores metadata graph that connects data assets, user, and tool generated metadata.
2021-08-13 15:13:21 -07:00
2021-08-13 15:16:41 -07:00
- **Metadata APIs** - for producing and consuming metadata built on schemas for User Interfaces and Integration of tools, systems, and services.
2021-08-13 15:13:21 -07:00
2021-08-13 15:16:41 -07:00
- **Ingestion framework** - a pluggable framework for integrating tools and ingesting metadata to the metadata store. Ingestion framework already supports well know data warehouses - Google BigQuery, Snowflake, Amazon Redshift, and Apache Hive, and databases - MySQL, Postgres, Oracle, and MSSQL.
2021-08-13 15:13:21 -07:00
2021-08-13 15:16:41 -07:00
- **OpenMetadata User Interface** - one single place for users to discover, and collaborate on all data.
2021-08-01 14:27:44 -07:00
2021-08-13 15:18:48 -07:00
## Try our Sandbox
Visit our demo at [http://sandbox.open-metadata.org](http://sandbox.open-metadata.org)
## Install and run OpenMetadata
2021-08-08 17:41:30 -07:00
Get up and running in few mins
2021-08-01 14:27:44 -07:00
2021-08-08 17:41:30 -07:00
```sh
git clone https://github.com/open-metadata/OpenMetadata
cd OpenMetadata/docker/metadata
2021-08-08 17:41:30 -07:00
docker-compose up -d
2021-08-01 14:27:44 -07:00
```
2021-08-08 17:41:30 -07:00
Then visit [http://localhost:8585](http://localhost:8585)
2021-08-01 14:27:44 -07:00
2021-08-13 15:18:48 -07:00
For more details on running OpenMetadata on your local machine or in production, see our [Install Doc](https://docs.open-metadata.org/install/run-openmetadata).
2021-08-08 17:41:30 -07:00
## Documentation and Support
2021-08-01 14:27:44 -07:00
Check out [OpenMetadata documentation](https://docs.open-metadata.org/) for a complete description of OpenMetadata's features.
2021-09-24 08:52:26 -07:00
Join [our Slack Community](https://slack.open-metadata.org/) if you get stuck, want to chat, or are thinking of a new feature.
2021-08-08 17:41:30 -07:00
Or join the group at [https://groups.google.com/g/openmetadata-users](https://groups.google.com/g/openmetadata-users)
2021-08-08 17:41:30 -07:00
We're here to help - and make OpenMetadata even better!
## Contributors
We ❤️ all contributions, big and small!
2021-10-16 10:22:40 -07:00
Read [Build Code and Run Tests](https://docs.open-metadata.org/open-source-community/developer/build-code-run-tests) for how to setup your local development environment. Get started with our [Good first issues](https://github.com/open-metadata/OpenMetadata/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22).
2021-08-08 17:41:30 -07:00
2021-09-24 08:18:32 -07:00
If you want to, you can reach out via [Slack](https://openmetadata.slack.com/join/shared_invite/zt-wksh1bww-iQGk45NTw6Tp4Q9UZd6QOw#/shared-invite/email) or [email](mailto:dev@open-metadata.org) and we'll set up a pair programming session to get you started.
2021-08-08 17:41:30 -07:00
2021-08-01 14:27:44 -07:00
## License
2021-08-13 15:10:06 -07:00
OpenMetadata is released under [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0)