github.com/sijibomii/docker@v0.0.0-20231230191044-5cf6ca554647/docs/userguide/containers/networkingcontainers.md (about)

     1  <!--[metadata]>
     2  +++
     3  aliases = ["/engine/userguide/networkigncontainers/"]
     4  title = "Network containers"
     5  description = "How to network Docker containers."
     6  keywords = ["Examples, Usage, volume, docker, documentation, user guide, data,  volumes"]
     7  [menu.main]
     8  parent = "engine_learn"
     9  weight = -3
    10  +++
    11  <![end-metadata]-->
    12  
    13  
    14  # Network containers
    15  
    16  If you are working your way through the user guide, you just built and ran a
    17  simple application. You've also built in your own images. This section teaches
    18  you how to network your containers.
    19  
    20  ## Name a container
    21  
    22  You've already seen that each container you create has an automatically
    23  created name; indeed you've become familiar with our old friend
    24  `nostalgic_morse` during this guide. You can also name containers
    25  yourself. This naming provides two useful functions:
    26  
    27  *  You can name containers that do specific functions in a way
    28     that makes it easier for you to remember them, for example naming a
    29     container containing a web application `web`.
    30  
    31  *  Names provide Docker with a reference point that allows it to refer to other
    32     containers. There are several commands that support this and you'll use one in an exercise later.
    33  
    34  You name your container by using the `--name` flag, for example launch a new container called web:
    35  
    36      $ docker run -d -P --name web training/webapp python app.py
    37  
    38  Use the `docker ps` command to check the name:
    39  
    40      $ docker ps -l
    41      CONTAINER ID  IMAGE                  COMMAND        CREATED       STATUS       PORTS                    NAMES
    42      aed84ee21bde  training/webapp:latest python app.py  12 hours ago  Up 2 seconds 0.0.0.0:49154->5000/tcp  web
    43  
    44  You can also use `docker inspect` with the container's name.
    45  
    46      $ docker inspect web
    47      [
    48      {
    49          "Id": "3ce51710b34f5d6da95e0a340d32aa2e6cf64857fb8cdb2a6c38f7c56f448143",
    50          "Created": "2015-10-25T22:44:17.854367116Z",
    51          "Path": "python",
    52          "Args": [
    53              "app.py"
    54          ],
    55          "State": {
    56              "Status": "running",
    57              "Running": true,
    58              "Paused": false,
    59              "Restarting": false,
    60              "OOMKilled": false,
    61        ...
    62  
    63  Container names must be unique. That means you can only call one container
    64  `web`. If you want to re-use a container name you must delete the old container
    65  (with `docker rm`) before you can reuse the name with a new container. Go ahead and stop and remove your old `web` container.
    66  
    67      $ docker stop web
    68      web
    69      $ docker rm web
    70      web
    71  
    72  
    73  ## Launch a container on the default network
    74  
    75  Docker includes support for networking containers through the use of **network
    76  drivers**. By default, Docker provides two network drivers for you, the
    77  `bridge` and the `overlay` drivers. You can also write a network driver plugin so
    78  that you can create your own drivers but that is an advanced task.
    79  
    80  Every installation of the Docker Engine automatically includes three default networks. You can list them:
    81  
    82      $ docker network ls
    83      NETWORK ID          NAME                DRIVER
    84      18a2866682b8        none                null                
    85      c288470c46f6        host                host                
    86      7b369448dccb        bridge              bridge  
    87  
    88  The network named `bridge` is a special network. Unless you tell it otherwise, Docker always launches your containers in this network. Try this now:
    89  
    90      $ docker run -itd --name=networktest ubuntu
    91      74695c9cea6d9810718fddadc01a727a5dd3ce6a69d09752239736c030599741
    92  
    93  Inspecting the network is an easy way to find out the container's IP address.
    94  
    95  ```bash
    96  $ docker network inspect bridge
    97  [
    98      {
    99          "Name": "bridge",
   100          "Id": "f7ab26d71dbd6f557852c7156ae0574bbf62c42f539b50c8ebde0f728a253b6f",
   101          "Scope": "local",
   102          "Driver": "bridge",
   103          "IPAM": {
   104              "Driver": "default",
   105              "Config": [
   106                  {
   107                      "Subnet": "172.17.0.1/16",
   108                      "Gateway": "172.17.0.1"
   109                  }
   110              ]
   111          },
   112          "Containers": {
   113              "3386a527aa08b37ea9232cbcace2d2458d49f44bb05a6b775fba7ddd40d8f92c": {
   114                  "EndpointID": "647c12443e91faf0fd508b6edfe59c30b642abb60dfab890b4bdccee38750bc1",
   115                  "MacAddress": "02:42:ac:11:00:02",
   116                  "IPv4Address": "172.17.0.2/16",
   117                  "IPv6Address": ""
   118              },
   119              "94447ca479852d29aeddca75c28f7104df3c3196d7b6d83061879e339946805c": {
   120                  "EndpointID": "b047d090f446ac49747d3c37d63e4307be745876db7f0ceef7b311cbba615f48",
   121                  "MacAddress": "02:42:ac:11:00:03",
   122                  "IPv4Address": "172.17.0.3/16",
   123                  "IPv6Address": ""
   124              }
   125          },
   126          "Options": {
   127              "com.docker.network.bridge.default_bridge": "true",
   128              "com.docker.network.bridge.enable_icc": "true",
   129              "com.docker.network.bridge.enable_ip_masquerade": "true",
   130              "com.docker.network.bridge.host_binding_ipv4": "0.0.0.0",
   131              "com.docker.network.bridge.name": "docker0",
   132              "com.docker.network.driver.mtu": "9001"
   133          }
   134      }
   135  ]
   136  ```
   137  
   138  You can remove a container from a network by disconnecting the container. To do this, you supply both the network name and the container name. You can also use the container id. In this example, though, the name is faster.
   139  
   140      $ docker network disconnect bridge networktest
   141  
   142  While you can disconnect a container from a network, you cannot remove the  builtin `bridge` network named `bridge`. Networks are natural ways to isolate containers from other containers or other networks. So, as you get more experienced with Docker, you'll want to create your own networks.
   143  
   144  ## Create your own bridge network
   145  
   146  Docker Engine natively supports both bridge networks and overlay networks. A bridge network is limited to a single host running Docker Engine. An overlay network can include multiple hosts and is a more advanced topic. For this example, you'll create a bridge network:  
   147  
   148      $ docker network create -d bridge my-bridge-network
   149  
   150  The `-d` flag tells Docker to use the `bridge` driver for the new network. You could have left this flag off as `bridge` is the default value for this flag. Go ahead and list the networks on your machine:
   151  
   152      $ docker network ls
   153      NETWORK ID          NAME                DRIVER
   154      7b369448dccb        bridge              bridge              
   155      615d565d498c        my-bridge-network   bridge              
   156      18a2866682b8        none                null                
   157      c288470c46f6        host                host
   158  
   159  If you inspect the network, you'll find that it has nothing in it.
   160  
   161      $ docker network inspect my-bridge-network
   162      [
   163          {
   164              "Name": "my-bridge-network",
   165              "Id": "5a8afc6364bccb199540e133e63adb76a557906dd9ff82b94183fc48c40857ac",
   166              "Scope": "local",
   167              "Driver": "bridge",
   168              "IPAM": {
   169                  "Driver": "default",
   170                  "Config": [
   171                      {
   172                          "Subnet": "172.18.0.0/16",
   173                          "Gateway": "172.18.0.1/16"
   174                      }
   175                  ]
   176              },
   177              "Containers": {},
   178              "Options": {}
   179          }
   180      ]
   181  
   182  ## Add containers to a network
   183  
   184  To build web applications that act in concert but do so securely, create a
   185  network. Networks, by definition, provide complete isolation for containers. You
   186  can add containers to a network when you first run a container.
   187  
   188  Launch a container running a PostgreSQL database and pass it the `--net=my-bridge-network` flag to connect it to your new network:
   189  
   190      $ docker run -d --net=my-bridge-network --name db training/postgres
   191  
   192  If you inspect your `my-bridge-network` you'll see it has a container attached.
   193  You can also inspect your container to see where it is connected:
   194  
   195      $ docker inspect --format='{{json .NetworkSettings.Networks}}'  db
   196      {"my-bridge-network":{"NetworkID":"7d86d31b1478e7cca9ebed7e73aa0fdeec46c5ca29497431d3007d2d9e15ed99",
   197      "EndpointID":"508b170d56b2ac9e4ef86694b0a76a22dd3df1983404f7321da5649645bf7043","Gateway":"172.18.0.1","IPAddress":"172.18.0.2","IPPrefixLen":16,"IPv6Gateway":"","GlobalIPv6Address":"","GlobalIPv6PrefixLen":0,"MacAddress":"02:42:ac:11:00:02"}}
   198  
   199  Now, go ahead and start your by now familiar web application. This time leave off the `-P` flag and also don't specify a network.
   200  
   201      $ docker run -d --name web training/webapp python app.py
   202  
   203  Which network is your `web` application running under? Inspect the application and you'll find it is running in the default `bridge` network.
   204  
   205      $ docker inspect --format='{{json .NetworkSettings.Networks}}'  web
   206      {"bridge":{"NetworkID":"7ea29fc1412292a2d7bba362f9253545fecdfa8ce9a6e37dd10ba8bee7129812",
   207      "EndpointID":"508b170d56b2ac9e4ef86694b0a76a22dd3df1983404f7321da5649645bf7043","Gateway":"172.17.0.1","IPAddress":"172.17.0.2","IPPrefixLen":16,"IPv6Gateway":"","GlobalIPv6Address":"","GlobalIPv6PrefixLen":0,"MacAddress":"02:42:ac:11:00:02"}}
   208  
   209  Then, get the IP address of your `web`
   210  
   211      $ docker inspect --format='{{range .NetworkSettings.Networks}}{{.IPAddress}}{{end}}' web
   212      172.17.0.2
   213  
   214  Now, open a shell to your running `db` container:
   215  
   216      $ docker exec -it db bash
   217      root@a205f0dd33b2:/# ping 172.17.0.2
   218      ping 172.17.0.2
   219      PING 172.17.0.2 (172.17.0.2) 56(84) bytes of data.
   220      ^C
   221      --- 172.17.0.2 ping statistics ---
   222      44 packets transmitted, 0 received, 100% packet loss, time 43185ms
   223  
   224  After a bit, use `CTRL-C` to end the `ping` and you'll find the ping failed. That is because the two containers are running on different networks. You can fix that. Then, use the `exit` command to close the container.
   225  
   226  Docker networking allows you to attach a container to as many networks as you like. You can also attach an already running container. Go ahead and attach your running `web` app to the `my-bridge-network`.
   227  
   228      $ docker network connect my-bridge-network web
   229  
   230  Open a shell into the `db` application again and try the ping command. This time just use the container name `web` rather than the IP Address.
   231  
   232      $ docker exec -it db bash
   233      root@a205f0dd33b2:/# ping web
   234      PING web (172.18.0.3) 56(84) bytes of data.
   235      64 bytes from web (172.18.0.3): icmp_seq=1 ttl=64 time=0.095 ms
   236      64 bytes from web (172.18.0.3): icmp_seq=2 ttl=64 time=0.060 ms
   237      64 bytes from web (172.18.0.3): icmp_seq=3 ttl=64 time=0.066 ms
   238      ^C
   239      --- web ping statistics ---
   240      3 packets transmitted, 3 received, 0% packet loss, time 2000ms
   241      rtt min/avg/max/mdev = 0.060/0.073/0.095/0.018 ms
   242  
   243  The `ping` shows it is contacting a different IP address, the address on the `my-bridge-network` which is different from its address on the `bridge` network.
   244  
   245  ## Next steps
   246  
   247  Now that you know how to network containers, see [how to manage data in containers](dockervolumes.md).