From eda7222c9e75d3a8ff084b1df12f8ad1209830b9 Mon Sep 17 00:00:00 2001 From: Alberto Miorin <32617+amiorin@users.noreply.github.com> Date: Sun, 19 Dec 2021 19:30:55 +0100 Subject: [PATCH] Fix #1398: Provide a page in the manual for the Windows users (#1846) --- docs/install/run-openmetadata.md | 32 ++++++++++++++++++++++++++++---- 1 file changed, 28 insertions(+), 4 deletions(-) diff --git a/docs/install/run-openmetadata.md b/docs/install/run-openmetadata.md index d5d2eea34a2..ab6d32e9b07 100644 --- a/docs/install/run-openmetadata.md +++ b/docs/install/run-openmetadata.md @@ -6,7 +6,7 @@ description: >- # Run OpenMetadata -## Requirements +## Requirements (OSX and Linux) Please ensure your host system meets the requirements listed below. Then continue to the Procedure for installing OpenMetadata. @@ -51,7 +51,7 @@ Preferences -> Resources -> Advanced Create a new directory for OpenMetadata and navigate into that directory. ``` -mkdir openmetadata-docker; cd openmetadata-docker +mkdir openmetadata-docker && cd openmetadata-docker ``` ### 2. Create a Python virtual environment @@ -70,10 +70,16 @@ python3 -m venv env source env/bin/activate ``` +### 3.1 Upgrade pip and setuptools + +``` +pip install --upgrade pip setuptools +``` + ### 4. Install the OpenMetadata Python module using pip -```bash -pip3 install 'openmetadata-ingestion[docker]' +``` +pip3 install --upgrade 'openmetadata-ingestion[docker]' ``` ### 5. Ensure the module is installed and ready for use @@ -206,3 +212,21 @@ If you see the above when attempting to install OpenMetadata, this can be due to If you need support please get in touch on Slack: [https://slack.open-metadata.org/](https://slack.open-metadata.org). + +## Requirements (Windows) + +### WSL2, Ubuntu 20.04, and Docker for Windows +1. Install [WSL2](https://ubuntu.com/wsl) +2. Install [Ubuntu 20.04](https://www.microsoft.com/en-us/p/ubuntu-2004-lts) +3. Install [Docker for Windows](https://www.docker.com/products/docker-desktop) + +### In the Ubuntu terminal + +``` +cd ~ +sudo apt update +sudo apt upgrade +sudo apt install python3-pip python3-venv +``` + +Follow the [OSX instructions](run-openmetadata.md#1.-create-a-directory-for-openmetadata) \ No newline at end of file