yujunjun/OpenMetadata
1
0
Fork 0
mirror of https://github.com/open-metadata/OpenMetadata.git synced 2025-12-16 10:08:08 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix: docs error (#13245)

Browse Source
This commit is contained in:
karanh37 2023-09-18 18:00:05 +05:30 committed by GitHub
parent a268f2adf8
commit 1895fbde5c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 35 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
openmetadata-docs/content/v1.1.x/deployment/docker/index.md
View File

@ -9,6 +9,7 @@ This guide will help you set up the OpenMetadata Application using Docker Deploy
Before starting with the deployment make sure you follow all the below Prerequisites. Before starting with the deployment make sure you follow all the below Prerequisites.
## Docker Deployment Architecture ## Docker Deployment Architecture
{% image src="/images/v1.1/deployment/docker/om_docker_architecture.png" alt="Docker Deployment Architecture" /%} {% image src="/images/v1.1/deployment/docker/om_docker_architecture.png" alt="Docker Deployment Architecture" /%}
## Prerequisites ## Prerequisites
@ -17,19 +18,22 @@ Before starting with the deployment make sure you follow all the below Prerequis
For Production Deployment using Docker, we recommend bringing your own Databases and ElasticSearch Engine and not rely on quickstart packages. For Production Deployment using Docker, we recommend bringing your own Databases and ElasticSearch Engine and not rely on quickstart packages.
{% partial file="/v1.1/deployment/configure-external-orchestrator-for-ingestion-service.md" /%} {% partial file="/v1.1/deployment/configure-external-orchestrator-for-ingestion-service.md" /%}
### Docker (version 20.10.0 or greater) ### Docker (version 20.10.0 or greater)
[Docker](https://docs.docker.com/get-started/overview/) is an open-source platform for developing, shipping, and running applications. It enables you to separate your applications from your infrastructure, so you can deliver software quickly using OS-level virtualization. It helps deliver software in packages called Containers. [Docker](https://docs.docker.com/get-started/overview/) is an open-source platform for developing, shipping, and running applications. It enables you to separate your applications from your infrastructure, so you can deliver software quickly using OS-level virtualization. It helps deliver software in packages called Containers.
To check what version of Docker you have, please use the following command. To check what version of Docker you have, please use the following command.
```commandline ```commandline
docker --version docker --version
``` ```
If you need to install Docker, please visit [Get Docker](https://docs.docker.com/get-docker/). If you need to install Docker, please visit [Get Docker](https://docs.docker.com/get-docker/).
### Docker Compose (version v2.2.3 or greater) ### Docker Compose (version v2.2.3 or greater)
The Docker compose package enables you to define and run multi-container Docker applications. The compose command integrates compose functions into the Docker platform, making them available from the Docker command-line interface ( CLI). The Python packages you will install in the procedure below use compose to deploy OpenMetadata. The Docker compose package enables you to define and run multi-container Docker applications. The compose command integrates compose functions into the Docker platform, making them available from the Docker command-line interface ( CLI). The Python packages you will install in the procedure below use compose to deploy OpenMetadata.
- **MacOS X**: Docker on MacOS X ships with compose already available in the Docker CLI. - **MacOS X**: Docker on MacOS X ships with compose already available in the Docker CLI.
@ -53,6 +57,7 @@ Docker Compose version v2.2.3
Follow the instructions [here](https://docs.docker.com/compose/cli-command/#install-on-linux) to install docker compose version 2 Follow the instructions [here](https://docs.docker.com/compose/cli-command/#install-on-linux) to install docker compose version 2
1. Run the following command to download the current stable release of Docker Compose 1. Run the following command to download the current stable release of Docker Compose
``` ```
DOCKER_CONFIG=${DOCKER_CONFIG:-$HOME/.docker} DOCKER_CONFIG=${DOCKER_CONFIG:-$HOME/.docker}
@ -90,19 +95,19 @@ mkdir openmetadata-docker && cd openmetadata-docker
Download the Docker Compose files from the [Latest GitHub Releases](https://github.com/open-metadata/OpenMetadata/releases/latest). Download the Docker Compose files from the [Latest GitHub Releases](https://github.com/open-metadata/OpenMetadata/releases/latest).
The Docker compose file name will be `docker-compose-openmetadata-server.yml`. The Docker compose file name will be `docker-compose-openmetadata.yml`.
This docker compose file contains only the docker compose services for OpenMetadata Server. Bring up the dependencies as mentioned in the [prerequisites](#configure-openmetadata-to-use-external-database-and-search-engine) section. This docker compose file contains only the docker compose services for OpenMetadata Server. Bring up the dependencies as mentioned in the [prerequisites](#configure-openmetadata-to-use-external-database-and-search-engine) section.
You can also run the below command to fetch the docker compose file directly from the terminal - You can also run the below command to fetch the docker compose file directly from the terminal -
```bash ```bash
wget https://github.com/open-metadata/OpenMetadata/releases/download/1.1.5-release/docker-compose-openmetadata-server.yml wget https://github.com/open-metadata/OpenMetadata/releases/download/1.1.5-release/docker-compose-openmetadata.yml
``` ```
### 3. Update Environment Variables required for OpenMetadata Dependencies ### 3. Update Environment Variables required for OpenMetadata Dependencies
In the previous [step](#2-download-docker-compose-file-from-github-release-branch), we download two files, one is `docker-compose` and another is `environment file` required for docker compose. In the previous [step](#2-download-docker-compose-file-from-github-release-branch), we download the `docker-compose` file.
Identify and update the environment variables in the file to prepare openmetadata configurations. Identify and update the environment variables in the file to prepare openmetadata configurations.
@ -197,13 +202,13 @@ We are shipping the OpenMetadata server and UI at container port and host port `
As an example, You could update the ports to serve OpenMetadata Server and UI at port `80` As an example, You could update the ports to serve OpenMetadata Server and UI at port `80`
To achieve this - To achieve this -
- You just have to update the ports mapping of the openmetadata-server in the `docker-compose.yml` file under `openmetadata-server` docker service section. - You just have to update the ports mapping of the openmetadata-server in the `docker-compose.yml` file under `openmetadata-server` docker service section.
```yaml ```yaml
... ---
ports: ports:
- "80:8585" - "80:8585"
...
``` ```
- Once the port is updated if there are any containers running remove them first using `docker compose down` command and then recreate the containers once again by below command - Once the port is updated if there are any containers running remove them first using `docker compose down` command and then recreate the containers once again by below command
@ -242,7 +247,7 @@ We support
- Amazon RDS (PostgreSQL) engine version 12 or greater - Amazon RDS (PostgreSQL) engine version 12 or greater
Note:- Note:-
When using AWS Services the SearchType Configuration for elastic search should be `opensearch`, for both cases ElasticSearch and OpenSearch, When using AWS Services the SearchType Configuration for elastic search should be `opensearch`, for both cases ElasticSearch and OpenSearch,
as you can see in the ElasticSearch configuration example. as you can see in the ElasticSearch configuration example.
For Production Systems, we recommend Amazon RDS to be in Multiple Availability Zones. For Amazon OpenSearch (or ElasticSearch) Service, we recommend Multiple Availability Zones with minimum 3 Master Nodes. For Production Systems, we recommend Amazon RDS to be in Multiple Availability Zones. For Amazon OpenSearch (or ElasticSearch) Service, we recommend Multiple Availability Zones with minimum 3 Master Nodes.