GitBook: [#201] Added Local Docker documentation

This commit is contained in:
Ayush Shah 2021-10-18 18:25:46 +00:00 committed by gitbook-bot
parent f01ee150e1
commit 6f2b14c1d2
No known key found for this signature in database
GPG Key ID: 07D2180C7B12D0FF
2 changed files with 43 additions and 18 deletions

View File

@ -6,7 +6,7 @@ description: >-
# Run OpenMetadata
## Run Docker
## Run Docker (Latest Release)
[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.
@ -14,7 +14,7 @@ description: >-
**Prerequisites**
* Docker >= 20.10.x
* Minimum allocated memory to Docker >= 4GB (Preferences -> Advanced -> Resources)
* Minimum allocated memory to Docker >= 4GB (Preferences -> Advanced -> Resources)
{% endhint %}
```bash
@ -26,24 +26,36 @@ docker-compose up
### Next Steps
1. Docker for OpenMetadata will depend on Mysql Container to be up, It may take few seconds to run.
2. Once OpenMetadata UI is accessible, Go to Scheduler UI -[ http://localhost:7777](http://localhost:7777), to invoke the pipelines to ingest data.
![Scheduler UI (http://localhost:7777)](../.gitbook/assets/localhost\_7777\_.png)
![Invoking a Pipeline for Ingestion](../.gitbook/assets/localhost\_7777\_-1-.png)
2. Once OpenMetadata UI is accessible, Go to [Airflow UI](http://localhost:8080) to invoke the pipelines to ingest data.
The above command brings up all the necessary services
1. MySQL
2. ElasticSearch
3. OpenMetadata Sever
4. Ingestion with SimpleScheduler
4. Ingestion with Airflow
To access the OpenMetadata
Open [http://localhost:8585](http://localhost:8585) in your browser
Scheduler UI available at [http://localhost:7777](http://localhost:7777)
Airflow UI available at [http://localhost:8080](http://localhost)
## Run Docker (Local Server)
{% hint style="info" %}
This Docker will enable users to access the Local OpenMetadata Server and Ingestion.
**Prerequisites**
* Docker >= 20.10.x
* Minimum allocated memory to Docker >= 4GB (Preferences -> Advanced -> Resources)
{% endhint %}
```
cd OpenMetadata/docker/local-metadata
docker-compose up
```
## Run Manually
@ -68,10 +80,10 @@ Download the latest binary release from [OpenMetadata](https://github.com/open-m
```bash
# untar it
tar -zxvf openmetadata-0.4.0.tar.gz
tar -zxvf openmetadata-0.5.0.tar.gz
# navigate to directory containing the launcher scripts
cd openmetadata-0.4.0
cd openmetadata-0.5.0
```
{% endtab %}
{% endtabs %}
@ -104,13 +116,13 @@ cd openmetadata-0.4.0
2. Run bootstrap scripts to initialize the database and tables
```
cd openmetadata-0.4.0
cd openmetadata-0.5.0
./bootstrap/bootstrap_storage.sh migrate
```
3. Start the OpenMetadata Server
```
cd openmetadata-0.4.0
cd openmetadata-0.5.0
./bin/openmetadata.sh start
```

View File

@ -2,13 +2,26 @@
This document summarizes information relevant to OpenMetadata committers and contributors. It includes information about the development processes and policies as well as the tools we use to facilitate those.
{% page-ref page="ux-style-guide.md" %}
{% content-ref url="how-to-contribute.md" %}
[how-to-contribute.md](how-to-contribute.md)
{% endcontent-ref %}
{% page-ref page="coding-style.md" %}
{% content-ref url="coding-style.md" %}
[coding-style.md](coding-style.md)
{% endcontent-ref %}
{% page-ref page="build-code-run-tests.md" %}
{% page-ref page="run-integration-tests.md" %}
{% content-ref url="build-code-run-tests.md" %}
[build-code-run-tests.md](build-code-run-tests.md)
{% endcontent-ref %}
{% content-ref url="build-a-connector/" %}
[build-a-connector](build-a-connector/)
{% endcontent-ref %}
{% content-ref url="run-integration-tests.md" %}
[run-integration-tests.md](run-integration-tests.md)
{% endcontent-ref %}
{% content-ref url="ux-style-guide.md" %}
[ux-style-guide.md](ux-style-guide.md)
{% endcontent-ref %}