This is an automated email from the ASF dual-hosted git repository.
potiuk pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/airflow.git
The following commit(s) were added to refs/heads/master by this push:
new a85d228 Update Breeze Documentation to have WSL 2 Instructions
instead of WSL 1 (#9057)
a85d228 is described below
commit a85d228c721f30cdbbba913b6d46aeb9d9be10d4
Author: Damian <[email protected]>
AuthorDate: Mon Jun 1 03:04:31 2020 -0400
Update Breeze Documentation to have WSL 2 Instructions instead of WSL 1
(#9057)
---
BREEZE.rst | 62 +++++++++++++++++++++++---------------
images/docker_expose_daemon.png | Bin 72072 -> 0 bytes
images/docker_wsl_integration.png | Bin 0 -> 36171 bytes
3 files changed, 37 insertions(+), 25 deletions(-)
diff --git a/BREEZE.rst b/BREEZE.rst
index 1e3f9ea..d2e27c3 100644
--- a/BREEZE.rst
+++ b/BREEZE.rst
@@ -78,36 +78,46 @@ Docker Compose
- **Permissions**: Configure to run the ``docker-compose`` command.
-Docker in WSL
--------------
+Docker in WSL 2
+---------------
+
+- **WSL 2 installation** :
+ Install WSL 2 and a Linux Distro (e.g. Ubuntu) see
+ `WSL 2 Installation Guide
<https://docs.microsoft.com/en-us/windows/wsl/install-win10>`_ for details.
-- **WSL installation** :
- `WSL Installation Guide
<https://docs.microsoft.com/en-us/windows/wsl/install-win10>`_ for details.
+- **Docker Desktop installation** :
+ Install Docker Desktop for Windows. For Windows Home follow the
+ `Docker Windows Home Installation Guide
<https://docs.docker.com/docker-for-windows/install-windows-home>`_.
+ For Windows Pro, Enterprise, or Education follow the
+ `Docker Windows Installation Guide
<https://docs.docker.com/docker-for-windows/install/>`_.
-- **Docker installation** :
- You should install docker in WSL.
- follow `Docker Installtion Guide
<https://docs.docker.com/install/linux/docker-ce/ubuntu/>`_
- only docker-ce without docker-ce-cli containerd.io.
- **Docker setting** :
- You should expose Docker daemon,
+ WSL integration needs to be enabled
-.. image:: images/docker_expose_daemon.png
+.. image:: images/docker_wsl_integration.png
:align: left
- :alt: Docker expose daemon
-
-and set env variable DOCKER_HOST.
-
-.. code-block:: bash
-
- echo "export DOCKER_HOST=tcp://localhost:2375" >> ~/.bashrc && source
~/.bashrc
-
-- **WSL problems** :
- There is a mounting problem in docker because docker could not recognize
``/mnt/c``, ``/mnt/d`` driver path.
- run this command in Windows Version 18.03+ and reboot Windows
-
-.. code-block:: bash
-
- printf '[automount]\nroot = /\n options = "metadata"\n' >> /etc/wsl.conf
+ :alt: Docker WSL2 integration
+
+- **WSL 2 Filesystem Performance** :
+ Accessing the host Windows filesystem incurs a performance penalty,
+ it is therefore recommended to do development on the Linux filesystem.
+ E.g. Run ``cd ~`` and create a development folder in your Linux distro home
+ and git pull the Airflow repo there.
+
+- **WSL 2 Memory Usage** :
+ WSL 2 can consume a lot of memory under the process name "Vmmem". To
reclaim
+ the memory after development you can:
+ * On the Linux distro clear cached memory: ``sudo sysctl -w
vm.drop_caches=3``
+ * If no longer using Docker you can quit Docker Desktop
+ (right click system try icon and select "Quit Docker Desktop")
+ * If no longer using WSL you can shut it down on the Windows Host
+ with the following command: ``wsl --shutdown``
+
+- **Developing in WSL 2** :
+ You can use all the standard Linux command line utilities to develop on
WSL 2.
+ Further VS Code supports developing in Windows but remotely executing in
WSL.
+ If VS Code is installed on the Windows host system then in the WSL Linux
Distro
+ you can run ``code .`` in the root directory of you Airflow repo to launch
VS Code.
Docker Images Used by Breeze
----------------------------
@@ -182,6 +192,8 @@ On macOS, 2GB of RAM are available for your Docker
containers by default, but mo
(4GB should be comfortable). For details see
`Docker for Mac - Advanced tab
<https://docs.docker.com/v17.12/docker-for-mac/#advanced-tab>`_.
+On Windows WSL 2 expect the Linux Disto and Docker containers to use 7 - 8 GB
of RAM.
+
Airflow Directory Structure inside Docker
-----------------------------------------
diff --git a/images/docker_expose_daemon.png b/images/docker_expose_daemon.png
deleted file mode 100755
index f10aa1e..0000000
Binary files a/images/docker_expose_daemon.png and /dev/null differ
diff --git a/images/docker_wsl_integration.png
b/images/docker_wsl_integration.png
new file mode 100644
index 0000000..fb037ac
Binary files /dev/null and b/images/docker_wsl_integration.png differ
