mirror of
https://github.com/open-metadata/OpenMetadata.git
synced 2025-08-19 22:49:00 +00:00
GitBook: [main] 8 pages and 9 assets modified
This commit is contained in:
Suresh Srinivas
gitbook-bot
parent
e0b73a430d
commit
a624c01418
|
Before Width: | Height: | Size: 111 KiB After Width: | Height: | Size: 111 KiB |
|
Before Width: | Height: | Size: 111 KiB After Width: | Height: | Size: 111 KiB |
|
Before Width: | Height: | Size: 111 KiB After Width: | Height: | Size: 111 KiB |
|
Before Width: | Height: | Size: 111 KiB After Width: | Height: | Size: 111 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 111 KiB |
@ -51,7 +51,6 @@
|
||||
* [Configure OpenMetadata Server](install/enable-security/okta-sso/okta-config.md)
|
||||
* [Create Service Account](install/enable-security/okta-sso/create-ingestion-service-account.md)
|
||||
* [Configure Ingestion](install/enable-security/okta-sso/configure-security-ingestion.md)
|
||||
|
||||
* [Metadata Ingestion](install/metadata-ingestion/README.md)
|
||||
* [Ingest Sample Data](install/metadata-ingestion/ingest-sample-data.md)
|
||||
* [Connectors](install/metadata-ingestion/connectors/README.md)
|
||||
|
||||
@ -1,9 +1,8 @@
|
||||
---
|
||||
description: >-
|
||||
This document describes OpenMetadata Server Configuration
|
||||
description: This document describes OpenMetadata Server Configuration
|
||||
---
|
||||
|
||||
# OpenMetadata Server Configuration
|
||||
# Configuration
|
||||
|
||||
```text
|
||||
swagger:
|
||||
@ -69,7 +68,6 @@ health:
|
||||
successAttempts: 1
|
||||
```
|
||||
|
||||
|
||||
## Server Port
|
||||
|
||||
```text
|
||||
@ -83,9 +81,7 @@ server:
|
||||
port: 8586
|
||||
```
|
||||
|
||||
By default OpenMetadata server runs on port 8585. It uses Jetty Server.
|
||||
The above config can be changed to make it run on a different port. Once you have updated the port details in config restart the server.
|
||||
|
||||
By default OpenMetadata server runs on port 8585. It uses Jetty Server. The above config can be changed to make it run on a different port. Once you have updated the port details in config restart the server.
|
||||
|
||||
## Database
|
||||
|
||||
@ -100,10 +96,7 @@ database:
|
||||
url: jdbc:mysql://localhost/openmetadata_db?useSSL=false&serverTimezone=UTC
|
||||
```
|
||||
|
||||
The above section is database connection details to MySQL database.
|
||||
We recommend you to create a MySQL user with strong password and update this section
|
||||
accordingly.
|
||||
|
||||
The above section is database connection details to MySQL database. We recommend you to create a MySQL user with strong password and update this section accordingly.
|
||||
|
||||
## ElasticSearch
|
||||
|
||||
@ -113,12 +106,10 @@ elasticsearch:
|
||||
port: 9200
|
||||
```
|
||||
|
||||
ElasticSearch is one of the pre-requisities to run OpenMetadata.
|
||||
Default configuration expects a single instance of ElasticSearch running on local machine.
|
||||
Please make sure you update it with your production elastic search.
|
||||
|
||||
ElasticSearch is one of the pre-requisities to run OpenMetadata. Default configuration expects a single instance of ElasticSearch running on local machine. Please make sure you update it with your production elastic search.
|
||||
|
||||
## EventHandlers
|
||||
|
||||
```text
|
||||
eventHandlerConfiguration:
|
||||
eventHandlerClassNames:
|
||||
@ -126,11 +117,7 @@ eventHandlerConfiguration:
|
||||
- "org.openmetadata.catalog.events.ElasticSearchEventHandler"
|
||||
```
|
||||
|
||||
EventHandler configuration is optional. It will update the AuditLog in MySQL DB
|
||||
and also ElasticSearch indexes whenever any entity is updated either through UI or
|
||||
API interactions.
|
||||
We recommend you to leave it there as it enhances the user experience.
|
||||
|
||||
EventHandler configuration is optional. It will update the AuditLog in MySQL DB and also ElasticSearch indexes whenever any entity is updated either through UI or API interactions. We recommend you to leave it there as it enhances the user experience.
|
||||
|
||||
## Healthcheck
|
||||
|
||||
@ -146,16 +133,12 @@ health:
|
||||
checkInterval: 2500ms
|
||||
downtimeInterval: 10s
|
||||
failureAttempts: 2
|
||||
successAttempts: 1
|
||||
successAttempts: 1
|
||||
```
|
||||
|
||||
Healthcheck api provides a API endpoint to check the OpenMetadata server health.
|
||||
We recommend in production settign to use this api to monitor the health of your
|
||||
OpenMetadata instance. Please tune the above configuration according to your production
|
||||
needs.
|
||||
|
||||
|
||||
Healthcheck api provides a API endpoint to check the OpenMetadata server health. We recommend in production settign to use this api to monitor the health of your OpenMetadata instance. Please tune the above configuration according to your production needs.
|
||||
|
||||
## Security
|
||||
|
||||
Please follow our [Enable Security Guide](/install/enable-security.md) guide to configure
|
||||
security for your OpenMetadata installation.
|
||||
|
||||
Please follow our [Enable Security Guide](https://github.com/open-metadata/OpenMetadata/tree/63c66391cf27d4d77c4b5c21750d9c09bfa44049/install/enable-security.md) guide to configure security for your OpenMetadata installation.
|
||||
|
||||
|
||||
@ -28,3 +28,4 @@ authorizerConfiguration:
|
||||
- "ingestion-bot"
|
||||
prinicipalDomain: "open-metadata.org"
|
||||
```
|
||||
|
||||
|
||||
@ -29,4 +29,3 @@ authorizerConfiguration:
|
||||
prinicipalDomain: "open-metadata.org"
|
||||
```
|
||||
|
||||
|
||||
|
||||
@ -1,12 +1,11 @@
|
||||
# Metadata Ingestion
|
||||
|
||||
OpenMetadata Ingesiton is a simple framework to build connectors and ingest metadata of various systems through [OpenMetadata APIs](https://docs.open-metadata.org/v/docs/openmetadata-apis/apis).
|
||||
It could be used in an orchestration framework(e.g. Apache Airflow) to ingest metadata.
|
||||
|
||||
OpenMetadata Ingesiton is a simple framework to build connectors and ingest metadata of various systems through [OpenMetadata APIs](https://docs.open-metadata.org/v/docs/openmetadata-apis/apis). It could be used in an orchestration framework\(e.g. Apache Airflow\) to ingest metadata.
|
||||
|
||||
## Guides
|
||||
|
||||
* [Ingest Sample Data](https://docs.open-metadata.org/v/docs/install/metadata-ingestion/ingest-sample-data)
|
||||
* [Explore Connectors & Install](https://docs.open-metadata.org/v/docs/install/metadata-ingestion/connectors/)
|
||||
* [Run Simple Scheduler](https://docs.open-metadata.org/v/docs/install/metadata-ingestion/scheduler)
|
||||
* [Configure Airflow](https://docs.open-metadata.org/v/docs/install/metadata-ingestion/airflow)
|
||||
* [Configure Airflow](https://docs.open-metadata.org/v/docs/install/metadata-ingestion/airflow)
|
||||
|
||||
|
||||
@ -47,7 +47,7 @@ Different Connectors require different dependencies, please go through [Connecto
|
||||
|
||||
Loads all the Json connectors inside the pipeline directory as cron jobs.
|
||||
|
||||
|
||||
|
||||
|
||||
### Custom run a job
|
||||
|
||||
|
||||
@ -1,13 +1,12 @@
|
||||
---
|
||||
description: >-
|
||||
This installation doc will help you start a OpenMetadata instances
|
||||
on your production.
|
||||
This installation doc will help you start a OpenMetadata instances on your
|
||||
production.
|
||||
---
|
||||
|
||||
# Run in Production
|
||||
|
||||
# Run in production
|
||||
|
||||
Please refer to the previous section [Run Openmetadata](install/run-openmetadata.md) for configuring OpenMetadata.
|
||||
Please refer to the previous section [Run Openmetadata](https://github.com/open-metadata/OpenMetadata/tree/63c66391cf27d4d77c4b5c21750d9c09bfa44049/docs/install/install/run-openmetadata.md) for configuring OpenMetadata.
|
||||
|
||||
{% hint style="info" %}
|
||||
**Prerequisites**
|
||||
@ -15,34 +14,26 @@ Please refer to the previous section [Run Openmetadata](install/run-openmetadata
|
||||
* MySQL >= 8.x
|
||||
* ElasticSearch >= 7.x
|
||||
* Airflow or other schedulers to run Ingestion Connectors
|
||||
|
||||
{% endhint %}
|
||||
|
||||
|
||||
## Start OpenMetadata
|
||||
|
||||
OpenMetadata release ships with ```./bin/openmetadata``` init.d style
|
||||
script.
|
||||
OpenMetadata release ships with `./bin/openmetadata` init.d style script.
|
||||
|
||||
```text
|
||||
cd openmetdata-0.3.0
|
||||
./bin/openmetdata start
|
||||
```
|
||||
|
||||
We recommend to configure serviced to monitor openmetadata command to restart
|
||||
incase of any failures.
|
||||
|
||||
We recommend to configure serviced to monitor openmetadata command to restart incase of any failures.
|
||||
|
||||
## Running with a load balancer
|
||||
|
||||
One or more OpenMetadata instances can be put behind a load balancer for reverse proxying,
|
||||
in that case appropriate OpenMetdata url must be mentioned in the load balancer's configuraiton file.
|
||||
One or more OpenMetadata instances can be put behind a load balancer for reverse proxying, in that case appropriate OpenMetdata url must be mentioned in the load balancer's configuraiton file.
|
||||
|
||||
For example, in case Apache mod proxy the VirtualHost tag in the configuration file should be
|
||||
edited out with the following
|
||||
For example, in case Apache mod proxy the VirtualHost tag in the configuration file should be edited out with the following
|
||||
|
||||
```text
|
||||
|
||||
<VirtualHost *:80>
|
||||
<Proxy balancer://mycluster>
|
||||
BalancerMember http://127.0.0.1:8585 <!-- First OpenMetadata server -->
|
||||
@ -54,5 +45,5 @@ edited out with the following
|
||||
ProxyPass / balancer://mycluster/
|
||||
ProxyPassReverse / balancer://mycluster/
|
||||
</VirtualHost>
|
||||
```
|
||||
|
||||
```
|
||||
|
||||
|
||||
@ -4,7 +4,9 @@ description: >-
|
||||
on your local machine.
|
||||
---
|
||||
|
||||
# Run Docker
|
||||
# Run OpenMetadata
|
||||
|
||||
## Run Docker
|
||||
|
||||
[Docker](https://docs.docker.com/get-started/overview/) is an open platform for developing, shipping, and running applications that enables you to separate your applications from your infrastructure so you can deliver software quickly using OS-level virtualization to deliver software in packages called containers.
|
||||
|
||||
@ -24,14 +26,13 @@ cd docker/metadata
|
||||
docker-compose up
|
||||
```
|
||||
|
||||
|
||||
# Run Manually
|
||||
## Run Manually
|
||||
|
||||
{% hint style="success" %}
|
||||
This is a quick start guide that will show you how to quickly start a standalone server.
|
||||
{% endhint %}
|
||||
|
||||
## Build from source or download the distribution
|
||||
### Build from source or download the distribution
|
||||
|
||||
**Prerequisites**
|
||||
|
||||
@ -78,13 +79,11 @@ unzip openmetadata-1.0.0-SNAPSHOT.zip
|
||||
cd openmetadata-1.0.0-SNAPSHOT
|
||||
```
|
||||
{% endtab %}
|
||||
|
||||
|
||||
{% endtabs %}
|
||||
|
||||
## Install on your local machine
|
||||
### Install on your local machine
|
||||
|
||||
### macOS
|
||||
#### macOS
|
||||
|
||||
1. Setup Database
|
||||
|
||||
@ -115,7 +114,7 @@ cd openmetadata-1.0.0-SNAPSHOT
|
||||
|
||||
```text
|
||||
cd openmetadata-0.3.0
|
||||
./boostrap/bootstrap-storage.sh migrate
|
||||
./bootstrap/bootstrap_storage.sh migrate
|
||||
```
|
||||
|
||||
3. Start the OpenMetadata Server
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user