AlmirKadric-Published / docker-tuntap-osx

A tuntap shim installer for "Docker for Mac"
MIT License
330 stars 65 forks source link

Create issue template to help users to provide a bit more information for support #11

Open AlmirKadric opened 6 years ago

AlmirKadric commented 6 years ago

Currently when users have troubles and open an issue, they do not provide enough information for support. To help reduce the amount of back and forth required we should create an issue template as per https://github.com/blog/2111-issue-and-pull-request-templates with the below contents:

Thank you for opening an issue!
Before we can help you please make sure you provide the following information about your issue

Description
------------
<A detailed explanation of what your problem was>

Information for Debugging
---------------------------
 - `ls -l /Applications/Docker.app/Contents/Resources/bin/` to make sure the shim was properly installed and configured
 - `ls -l /dev/tap*` to make sure docker has access to tap interface
 - `ifconfig` to make sure docker connected to the tap interface
 - `netstat -rn` to make sure routes were set to the containers over the tap interface
 - `docker run --rm --privileged --pid=host --net=host alpine ifconfig` to make docker created the target interface
 - `docker run --rm --privileged --pid=host debian nsenter -t 1 -m -u -n -i iptables-save` to make sure the docker host allows routing
 - `docker inspect <<Container_id>>` to make sure your container is configure to use all of the above