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

Add note on devcontainer building #304

Merged
merged 2 commits into from
Feb 5, 2025
Merged

Conversation

ThisIsntTheWay
Copy link
Contributor

Summary

  • Adds a small note in section "Getting started with devcontainers" that should help avoid some pitfalls we've encountered whilst building the devcontainer.

Checklist

  • Categorize the PR by setting a good title and adding one of the labels:
    bug, enhancement, documentation, change, breaking, dependency
    as they show up in the changelog

@ThisIsntTheWay ThisIsntTheWay added the documentation Improvements or additions to documentation label Feb 4, 2025
@ThisIsntTheWay ThisIsntTheWay self-assigned this Feb 4, 2025
@ThisIsntTheWay ThisIsntTheWay changed the title Add note on devcontainer provisioning Add note on devcontainer building Feb 4, 2025
@lieneluksika lieneluksika requested review from a team, Kidswiss, TheBigLee and wejdross and removed request for a team February 4, 2025 15:35
README.md Outdated
> On linux, Podman and rootless Docker have been found to cause issues.
> Ensure that you are using **rootful Docker** to save yourself loads of trouble.
>
> Additionally, on linux, you might encounter issues with `iptables`.
Copy link
Member

Choose a reason for hiding this comment

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

Some of the part is rather specific to Fedora. Probably best to mention that some of the stuff is specific to that.
E.g On Arch the iptables package is already the "legacy" one.
Afaik on Ubuntu the package is also called iptables-legacy.
There isn't a need to specify it for all flavors, just mention that the example you specified is specific to Fedora

README.md Outdated
Comment on lines 72 to 84
> On linux, Podman and rootless Docker have been found to cause issues.
> Ensure that you are using **rootful Docker** to save yourself loads of trouble.
>
> Additionally, on linux, you might encounter issues with `iptables`.
> Execute the following on the host prior to building the devcontainer:
> ```bash
> sudo dnf install -y iptables-legacy
> sudo modprobe ip_tables
> echo 'ip_tables' | sudo tee /etc/modules
> ```
>
> *To further debug dind, consult `/tmp/dockerd.log` in the container.*

Copy link
Member

@wejdross wejdross Feb 4, 2025

Choose a reason for hiding this comment

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

Suggested change
> On linux, Podman and rootless Docker have been found to cause issues.
> Ensure that you are using **rootful Docker** to save yourself loads of trouble.
>
> Additionally, on linux, you might encounter issues with `iptables`.
> Execute the following on the host prior to building the devcontainer:
> ```bash
> sudo dnf install -y iptables-legacy
> sudo modprobe ip_tables
> echo 'ip_tables' | sudo tee /etc/modules
> ```
>
> *To further debug dind, consult `/tmp/dockerd.log` in the container.*
> On linux, Podman and rootless Docker have been found to cause issues.
> (...)
> Please refer to official documentation under: https://docs.docker.com/engine/install/

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Addendum incorporated in 5025f5f

@ThisIsntTheWay ThisIsntTheWay merged commit aa52543 into master Feb 5, 2025
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants