mirror of
				https://github.com/moby/moby.git
				synced 2022-11-09 12:21:53 -05:00 
			
		
		
		
	Update API docs for "HostConfig.Binds"
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
This commit is contained in:
		
							parent
							
								
									beea098b97
								
							
						
					
					
						commit
						708892c403
					
				
					 8 changed files with 76 additions and 33 deletions
				
			
		| 
						 | 
				
			
			@ -230,10 +230,13 @@ Create a container
 | 
			
		|||
-   **ExposedPorts** - An object mapping ports to an empty object in the form of:
 | 
			
		||||
      `"ExposedPorts": { "<port>/<tcp|udp>: {}" }`
 | 
			
		||||
-   **HostConfig**
 | 
			
		||||
    -   **Binds** – A list of volume bindings for this container. Each volume binding is a string in one of these forms:
 | 
			
		||||
           + `container_path` to create a new volume for the container
 | 
			
		||||
           + `host_path:container_path` to bind-mount a host path into the container
 | 
			
		||||
           + `host_path:container_path:ro` to make the bind-mount read-only inside the container.
 | 
			
		||||
    -   **Binds** – A list of bind-mounts for this container. Each item is a string in one of these forms:
 | 
			
		||||
           + `host-src:container-dest` to bind-mount a host path into the
 | 
			
		||||
             container. Both `host-src`, and `container-dest` must be an
 | 
			
		||||
             _absolute_ path.
 | 
			
		||||
           + `host-src:container-dest:ro` to make the bind-mount read-only
 | 
			
		||||
             inside the container. Both `host-src`, and `container-dest` must be
 | 
			
		||||
             an _absolute_ path.
 | 
			
		||||
    -   **Links** - A list of links for the container. Each link entry should be
 | 
			
		||||
          in the form of `container_name:alias`.
 | 
			
		||||
    -   **LxcConf** - LXC specific configurations. These configurations only
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -235,10 +235,13 @@ Create a container
 | 
			
		|||
-   **ExposedPorts** - An object mapping ports to an empty object in the form of:
 | 
			
		||||
      `"ExposedPorts": { "<port>/<tcp|udp>: {}" }`
 | 
			
		||||
-   **HostConfig**
 | 
			
		||||
    -   **Binds** – A list of volume bindings for this container. Each volume binding is a string in one of these forms:
 | 
			
		||||
           + `container_path` to create a new volume for the container
 | 
			
		||||
           + `host_path:container_path` to bind-mount a host path into the container
 | 
			
		||||
           + `host_path:container_path:ro` to make the bind-mount read-only inside the container.
 | 
			
		||||
    -   **Binds** – A list of bind-mounts for this container. Each item is a string in one of these forms:
 | 
			
		||||
           + `host-src:container-dest` to bind-mount a host path into the
 | 
			
		||||
             container. Both `host-src`, and `container-dest` must be an
 | 
			
		||||
             _absolute_ path.
 | 
			
		||||
           + `host-src:container-dest:ro` to make the bind-mount read-only
 | 
			
		||||
             inside the container. Both `host-src`, and `container-dest` must be
 | 
			
		||||
             an _absolute_ path.
 | 
			
		||||
    -   **Links** - A list of links for the container. Each link entry should be
 | 
			
		||||
          in the form of `container_name:alias`.
 | 
			
		||||
    -   **LxcConf** - LXC specific configurations. These configurations only
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -237,10 +237,13 @@ Create a container
 | 
			
		|||
-   **ExposedPorts** - An object mapping ports to an empty object in the form of:
 | 
			
		||||
      `"ExposedPorts": { "<port>/<tcp|udp>: {}" }`
 | 
			
		||||
-   **HostConfig**
 | 
			
		||||
    -   **Binds** – A list of volume bindings for this container. Each volume binding is a string in one of these forms:
 | 
			
		||||
           + `container_path` to create a new volume for the container
 | 
			
		||||
           + `host_path:container_path` to bind-mount a host path into the container
 | 
			
		||||
           + `host_path:container_path:ro` to make the bind-mount read-only inside the container.
 | 
			
		||||
    -   **Binds** – A list of bind-mounts for this container. Each item is a string in one of these forms:
 | 
			
		||||
           + `host-src:container-dest` to bind-mount a host path into the
 | 
			
		||||
             container. Both `host-src`, and `container-dest` must be an
 | 
			
		||||
             _absolute_ path.
 | 
			
		||||
           + `host-src:container-dest:ro` to make the bind-mount read-only
 | 
			
		||||
             inside the container. Both `host-src`, and `container-dest` must be
 | 
			
		||||
             an _absolute_ path.
 | 
			
		||||
    -   **Links** - A list of links for the container. Each link entry should be
 | 
			
		||||
          in the form of `container_name:alias`.
 | 
			
		||||
    -   **LxcConf** - LXC specific configurations. These configurations only
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -248,11 +248,17 @@ Create a container
 | 
			
		|||
-   **StopSignal** - Signal to stop a container as a string or unsigned integer. `SIGTERM` by default.
 | 
			
		||||
-   **HostConfig**
 | 
			
		||||
    -   **Binds** – A list of volume bindings for this container. Each volume binding is a string in one of these forms:
 | 
			
		||||
           + `container_path` to create a new volume for the container
 | 
			
		||||
           + `host_path:container_path` to bind-mount a host path into the container
 | 
			
		||||
           + `host_path:container_path:ro` to make the bind-mount read-only inside the container.
 | 
			
		||||
           + `volume_name:container_path` to bind-mount a volume managed by a volume plugin into the container.
 | 
			
		||||
           + `volume_name:container_path:ro` to make the bind mount read-only inside the container.
 | 
			
		||||
           + `host-src:container-dest` to bind-mount a host path into the
 | 
			
		||||
             container. Both `host-src`, and `container-dest` must be an
 | 
			
		||||
             _absolute_ path.
 | 
			
		||||
           + `host-src:container-dest:ro` to make the bind-mount read-only
 | 
			
		||||
             inside the container. Both `host-src`, and `container-dest` must be
 | 
			
		||||
             an _absolute_ path.
 | 
			
		||||
           + `volume-name:container-dest` to bind-mount a volume managed by a
 | 
			
		||||
             volume driver into the container. `container-dest` must be an
 | 
			
		||||
             _absolute_ path.
 | 
			
		||||
           + `volume-name:container-dest:ro` to mount the volume read-only
 | 
			
		||||
             inside the container.  `container-dest` must be an _absolute_ path.
 | 
			
		||||
    -   **Links** - A list of links for the container. Each link entry should be
 | 
			
		||||
          in the form of `container_name:alias`.
 | 
			
		||||
    -   **LxcConf** - LXC specific configurations. These configurations only
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -351,10 +351,17 @@ Create a container
 | 
			
		|||
-   **StopSignal** - Signal to stop a container as a string or unsigned integer. `SIGTERM` by default.
 | 
			
		||||
-   **HostConfig**
 | 
			
		||||
    -   **Binds** – A list of volume bindings for this container. Each volume binding is a string in one of these forms:
 | 
			
		||||
           + `host_path:container_path` to bind-mount a host path into the container
 | 
			
		||||
           + `host_path:container_path:ro` to make the bind-mount read-only inside the container.
 | 
			
		||||
           + `volume_name:container_path` to bind-mount a volume managed by a volume plugin into the container.
 | 
			
		||||
           + `volume_name:container_path:ro` to make the bind mount read-only inside the container.
 | 
			
		||||
           + `host-src:container-dest` to bind-mount a host path into the
 | 
			
		||||
             container. Both `host-src`, and `container-dest` must be an
 | 
			
		||||
             _absolute_ path.
 | 
			
		||||
           + `host-src:container-dest:ro` to make the bind-mount read-only
 | 
			
		||||
             inside the container. Both `host-src`, and `container-dest` must be
 | 
			
		||||
             an _absolute_ path.
 | 
			
		||||
           + `volume-name:container-dest` to bind-mount a volume managed by a
 | 
			
		||||
             volume driver into the container. `container-dest` must be an
 | 
			
		||||
             _absolute_ path.
 | 
			
		||||
           + `volume-name:container-dest:ro` to mount the volume read-only
 | 
			
		||||
             inside the container.  `container-dest` must be an _absolute_ path.
 | 
			
		||||
    -   **Links** - A list of links for the container. Each link entry should be
 | 
			
		||||
          in the form of `container_name:alias`.
 | 
			
		||||
    -   **Memory** - Memory limit in bytes.
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -374,10 +374,17 @@ Create a container
 | 
			
		|||
-   **StopSignal** - Signal to stop a container as a string or unsigned integer. `SIGTERM` by default.
 | 
			
		||||
-   **HostConfig**
 | 
			
		||||
    -   **Binds** – A list of volume bindings for this container. Each volume binding is a string in one of these forms:
 | 
			
		||||
           + `host_path:container_path` to bind-mount a host path into the container
 | 
			
		||||
           + `host_path:container_path:ro` to make the bind-mount read-only inside the container.
 | 
			
		||||
           + `volume_name:container_path` to bind-mount a volume managed by a volume plugin into the container.
 | 
			
		||||
           + `volume_name:container_path:ro` to make the bind mount read-only inside the container.
 | 
			
		||||
           + `host-src:container-dest` to bind-mount a host path into the
 | 
			
		||||
             container. Both `host-src`, and `container-dest` must be an
 | 
			
		||||
             _absolute_ path.
 | 
			
		||||
           + `host-src:container-dest:ro` to make the bind-mount read-only
 | 
			
		||||
             inside the container. Both `host-src`, and `container-dest` must be
 | 
			
		||||
             an _absolute_ path.
 | 
			
		||||
           + `volume-name:container-dest` to bind-mount a volume managed by a
 | 
			
		||||
             volume driver into the container. `container-dest` must be an
 | 
			
		||||
             _absolute_ path.
 | 
			
		||||
           + `volume-name:container-dest:ro` to mount the volume read-only
 | 
			
		||||
             inside the container.  `container-dest` must be an _absolute_ path.
 | 
			
		||||
    -   **Links** - A list of links for the container. Each link entry should be
 | 
			
		||||
          in the form of `container_name:alias`.
 | 
			
		||||
    -   **Memory** - Memory limit in bytes.
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -391,10 +391,17 @@ Create a container
 | 
			
		|||
-   **StopSignal** - Signal to stop a container as a string or unsigned integer. `SIGTERM` by default.
 | 
			
		||||
-   **HostConfig**
 | 
			
		||||
    -   **Binds** – A list of volume bindings for this container. Each volume binding is a string in one of these forms:
 | 
			
		||||
           + `host_path:container_path` to bind-mount a host path into the container
 | 
			
		||||
           + `host_path:container_path:ro` to make the bind-mount read-only inside the container.
 | 
			
		||||
           + `volume_name:container_path` to bind-mount a volume managed by a volume plugin into the container.
 | 
			
		||||
           + `volume_name:container_path:ro` to make the bind mount read-only inside the container.
 | 
			
		||||
           + `host-src:container-dest` to bind-mount a host path into the
 | 
			
		||||
             container. Both `host-src`, and `container-dest` must be an
 | 
			
		||||
             _absolute_ path.
 | 
			
		||||
           + `host-src:container-dest:ro` to make the bind-mount read-only
 | 
			
		||||
             inside the container. Both `host-src`, and `container-dest` must be
 | 
			
		||||
             an _absolute_ path.
 | 
			
		||||
           + `volume-name:container-dest` to bind-mount a volume managed by a
 | 
			
		||||
             volume driver into the container. `container-dest` must be an
 | 
			
		||||
             _absolute_ path.
 | 
			
		||||
           + `volume-name:container-dest:ro` to mount the volume read-only
 | 
			
		||||
             inside the container.  `container-dest` must be an _absolute_ path.
 | 
			
		||||
    -   **Links** - A list of links for the container. Each link entry should be
 | 
			
		||||
          in the form of `container_name:alias`.
 | 
			
		||||
    -   **Memory** - Memory limit in bytes.
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -395,10 +395,17 @@ Create a container
 | 
			
		|||
-   **StopSignal** - Signal to stop a container as a string or unsigned integer. `SIGTERM` by default.
 | 
			
		||||
-   **HostConfig**
 | 
			
		||||
    -   **Binds** – A list of volume bindings for this container. Each volume binding is a string in one of these forms:
 | 
			
		||||
           + `host_path:container_path` to bind-mount a host path into the container
 | 
			
		||||
           + `host_path:container_path:ro` to make the bind-mount read-only inside the container.
 | 
			
		||||
           + `volume_name:container_path` to bind-mount a volume managed by a volume plugin into the container.
 | 
			
		||||
           + `volume_name:container_path:ro` to make the bind mount read-only inside the container.
 | 
			
		||||
           + `host-src:container-dest` to bind-mount a host path into the
 | 
			
		||||
             container. Both `host-src`, and `container-dest` must be an
 | 
			
		||||
             _absolute_ path.
 | 
			
		||||
           + `host-src:container-dest:ro` to make the bind-mount read-only
 | 
			
		||||
             inside the container. Both `host-src`, and `container-dest` must be
 | 
			
		||||
             an _absolute_ path.
 | 
			
		||||
           + `volume-name:container-dest` to bind-mount a volume managed by a
 | 
			
		||||
             volume driver into the container. `container-dest` must be an
 | 
			
		||||
             _absolute_ path.
 | 
			
		||||
           + `volume-name:container-dest:ro` to mount the volume read-only
 | 
			
		||||
             inside the container.  `container-dest` must be an _absolute_ path.
 | 
			
		||||
    -   **Links** - A list of links for the container. Each link entry should be
 | 
			
		||||
          in the form of `container_name:alias`.
 | 
			
		||||
    -   **Memory** - Memory limit in bytes.
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue