Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Expand docker installation guide #619

Merged
merged 2 commits into from
Nov 13, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 20 additions & 9 deletions docs/guides/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,12 +58,23 @@ Check out the [guide](../components/publishing_components.md) on publishing comp

To execute pipelines locally, you must
have [Docker compose](https://docs.docker.com/compose/install/) and Python >=3.8
installed on your system.

#### TODO: Modify/extend considerations for Docker-compose/desktop

For Apple M1/M2 ship users: <br>

- Make sure that Docker uses linux/amd64 platform and not arm64. <br>
- In Docker Dashboards’ Settings<Features in development, make sure to
uncheck `Use containerid for pulling and storing images`.
installed on your system. We only support Docker compose V2 and above. If you have an older version of
Docker compose, please upgrade to the latest version as described in the [Docker compose migration doc](https://docs.docker.com/compose/migrate/).

!!! note "IMPORTANT"
For **Apple M1/M2 ship users**: <br>

- Make sure that Docker uses linux/amd64 platform and not arm64. <br>

```bash
export DOCKER_DEFAULT_PLATFORM=linux/amd64
```

- In Docker Desktop Dashboards’ `Settings -> Features in development`, make sure to
uncheck `Use containerid for pulling and storing images`.

!!! note "IMPORTANT"
For **Windows** users: <br>

- We recommend installing and running docker on [WSL](https://learn.microsoft.com/en-us/windows/wsl/about).
Check out this [guide](https://docs.docker.com/desktop/wsl/) for more info on the installation. <br>.