mirror of
https://github.com/open-metadata/OpenMetadata.git
synced 2025-12-12 07:48:14 +00:00
fix: docs error (#13245)
This commit is contained in:
karanh37
GitHub
parent
a268f2adf8
commit
1895fbde5c
@ -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.
|
||||
|
||||
## Docker Deployment Architecture
|
||||
|
||||
{% image src="/images/v1.1/deployment/docker/om_docker_architecture.png" alt="Docker Deployment Architecture" /%}
|
||||
|
||||
## 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.
|
||||
|
||||
|
||||
{% partial file="/v1.1/deployment/configure-external-orchestrator-for-ingestion-service.md" /%}
|
||||
|
||||
### 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.
|
||||
|
||||
To check what version of Docker you have, please use the following command.
|
||||
|
||||
```commandline
|
||||
docker --version
|
||||
```
|
||||
|
||||
If you need to install Docker, please visit [Get Docker](https://docs.docker.com/get-docker/).
|
||||
|
||||
### 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.
|
||||
|
||||
- **MacOS X**: Docker on MacOS X ships with compose already available in the Docker CLI.
|
||||
@ -53,30 +57,31 @@ 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
|
||||
|
||||
1. Run the following command to download the current stable release of Docker Compose
|
||||
```
|
||||
DOCKER_CONFIG=${DOCKER_CONFIG:-$HOME/.docker}
|
||||
|
||||
mkdir -p $DOCKER_CONFIG/cli-plugins
|
||||
curl -SL https://github.com/docker/compose/releases/download/v2.2.3/docker-compose-linux-x86_64 -o
|
||||
$DOCKER_CONFIG/cli-plugins/docker-compose
|
||||
```
|
||||
|
||||
```
|
||||
DOCKER_CONFIG=${DOCKER_CONFIG:-$HOME/.docker}
|
||||
|
||||
mkdir -p $DOCKER_CONFIG/cli-plugins
|
||||
curl -SL https://github.com/docker/compose/releases/download/v2.2.3/docker-compose-linux-x86_64 -o
|
||||
$DOCKER_CONFIG/cli-plugins/docker-compose
|
||||
```
|
||||
|
||||
This command installs Compose V2 for the active user under $HOME directory. To install Docker Compose for all users
|
||||
on your system, replace` ~/.docker/cli-plugins` with `/usr/local/lib/docker/cli-plugins`.
|
||||
|
||||
2. Apply executable permissions to the binary
|
||||
```
|
||||
chmod +x $DOCKER_CONFIG/cli-plugins/docker-compose
|
||||
```
|
||||
```
|
||||
chmod +x $DOCKER_CONFIG/cli-plugins/docker-compose
|
||||
```
|
||||
3. Test your installation
|
||||
```
|
||||
docker compose version
|
||||
> Docker Compose version v2.2.3
|
||||
```
|
||||
```
|
||||
docker compose version
|
||||
> Docker Compose version v2.2.3
|
||||
```
|
||||
|
||||
{% partial file="/v1.1/deployment/minimum-sizing-requirements.md" /%}
|
||||
|
||||
## Steps for Deploying OpenMetadata using Docker
|
||||
## Steps for Deploying OpenMetadata using Docker
|
||||
|
||||
### 1. Create a directory for OpenMetadata
|
||||
|
||||
@ -88,21 +93,21 @@ mkdir openmetadata-docker && cd openmetadata-docker
|
||||
|
||||
### 2. Download Docker Compose Files from GitHub Releases
|
||||
|
||||
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.
|
||||
|
||||
You can also run the below command to fetch the docker compose file directly from the terminal -
|
||||
|
||||
```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
|
||||
|
||||
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.
|
||||
|
||||
@ -191,22 +196,22 @@ CONTAINER ID IMAGE COMMAND
|
||||
|
||||
In a few seconds, you should be able to access the OpenMetadata UI at [http://localhost:8585](http://localhost:8585)
|
||||
|
||||
## Port Mapping / Port Forwarding
|
||||
## Port Mapping / Port Forwarding
|
||||
|
||||
We are shipping the OpenMetadata server and UI at container port and host port `8585`. You can change the host port number according to your requirement.
|
||||
As an example, You could update the ports to serve OpenMetadata Server and UI at port `80`
|
||||
We are shipping the OpenMetadata server and UI at container port and host port `8585`. You can change the host port number according to your requirement.
|
||||
As an example, You could update the ports to serve OpenMetadata Server and UI at port `80`
|
||||
|
||||
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.
|
||||
|
||||
```yaml
|
||||
...
|
||||
---
|
||||
ports:
|
||||
- "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
|
||||
|
||||
```commandline
|
||||
docker compose up --detach
|
||||
@ -235,14 +240,14 @@ server {
|
||||
|
||||
If you are running OpenMetadata in AWS, it is recommended to use [Amazon RDS](https://docs.aws.amazon.com/rds/index.html) and [Amazon OpenSearch Service](https://docs.aws.amazon.com/opensearch-service/?id=docs_gateway).
|
||||
|
||||
We support
|
||||
We support
|
||||
|
||||
- Amazon RDS (MySQL) engine version 8 or greater
|
||||
- Amazon OpenSearch (ElasticSearch) engine version up to 7.10 or Amazon OpenSearch engine version up to 1.3
|
||||
- Amazon RDS (PostgreSQL) engine version 12 or greater
|
||||
|
||||
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.
|
||||
|
||||
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.
|
||||
@ -314,7 +319,7 @@ RSA_PRIVATE_KEY_FILE_PATH="/etc/openmetadata/jwtkeys/private_key.der"
|
||||
...
|
||||
```
|
||||
|
||||
Once the changes are 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 changes are 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
|
||||
|
||||
```commandline
|
||||
docker compose up --detach
|
||||
@ -365,4 +370,4 @@ installation.
|
||||
1. Visit the [Features](/releases/features) overview page and explore the OpenMetadata UI.
|
||||
2. Visit the [Connectors](/connectors) documentation to see what services you can integrate with
|
||||
OpenMetadata.
|
||||
3. Visit the [API](/swagger.html) documentation and explore the rich set of OpenMetadata APIs.
|
||||
3. Visit the [API](/swagger.html) documentation and explore the rich set of OpenMetadata APIs.
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user