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

[Documentation] add notes about registries and architecture #3316

Merged
Changes from 1 commit
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
7 changes: 6 additions & 1 deletion docs/docs/setting-up/other-specifications/engines/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,9 @@ Engine:
WorkingDirectory: "/app"
```

In this example, the task will be executed inside an Ubuntu 20.04 Docker container. The entrypoint is overridden to execute a bash shell that runs an echo command. An environment variable MY_ENV_VAR is set with the value myvalue, and the working directory inside the container is set to /app.
In this example, the task will be executed inside an Ubuntu 20.04 Docker container. The entrypoint is overridden to execute a bash shell that runs an echo command. An environment variable MY_ENV_VAR is set with the value myvalue, and the working directory inside the container is set to /app.

## Notes

- Currently, only images published to public registries are supported. Make sure your image is available in one of them, for example DockerHub, ghcr. Locally hosted registries are not supported.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I misunderstood the question. It might be worth trying something like ..

Suggested change
- Currently, only images published to public registries are supported. Make sure your image is available in one of them, for example DockerHub, ghcr. Locally hosted registries are not supported.
- Currently, only images published to public registries are supported. Make sure your image is available in one of them, for example DockerHub, or ghcr. Private images can be retrieved from docker hub by [specifying your credentials](/running-node/quick-start-docker/#authenticate-with-docker-hub)

I've removed the bit about locally hosted registries because we haven't yet confirmed either way whether they work or not.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed

- Make sure that the architecture of your image matches the architecture of the nodes in your cluster. Also consider the possibility of using [multi-platform](https://docs.docker.com/build/building/multi-platform/) images.