kopia lustrzana https://github.com/jupyterhub/repo2docker
describe ContainerEngine volume and port formats
rodzic
0e7e0f003e
commit
e32c7b02df
|
@ -80,7 +80,8 @@ class Container(ABC):
|
||||||
str : The status of the container.
|
str : The status of the container.
|
||||||
Values include `created` `running` `exited`.
|
Values include `created` `running` `exited`.
|
||||||
|
|
||||||
TODO: Does Docker have a fixed list of these?
|
Full list of statuses:
|
||||||
|
https://github.com/moby/moby/blob/v19.03.5/api/swagger.yaml#L4832
|
||||||
"""
|
"""
|
||||||
|
|
||||||
|
|
||||||
|
@ -182,12 +183,10 @@ class ContainerEngine(LoggingConfigurable):
|
||||||
|
|
||||||
custom_context : bool
|
custom_context : bool
|
||||||
If `True` fileobj is a Tar file object containing the build context
|
If `True` fileobj is a Tar file object containing the build context
|
||||||
TODO: Specific to Docker
|
|
||||||
dockerfile : str
|
dockerfile : str
|
||||||
Path to Dockerfile within the build context
|
Path to Dockerfile within the build context
|
||||||
fileobj : tarfile
|
fileobj : tarfile
|
||||||
A tar file-like object containing the build context
|
A tar file-like object containing the build context
|
||||||
TODO: Specific to Docker, other clients can untar this to a tempdir
|
|
||||||
path : str
|
path : str
|
||||||
path to the Dockerfile
|
path to the Dockerfile
|
||||||
|
|
||||||
|
@ -270,15 +269,14 @@ class ContainerEngine(LoggingConfigurable):
|
||||||
environment : list[str]
|
environment : list[str]
|
||||||
List of environment variables in the form `ENVVAR=value`
|
List of environment variables in the form `ENVVAR=value`
|
||||||
ports : dict
|
ports : dict
|
||||||
Container port bindings in the format expected by the engine
|
Container port bindings in the form generated by `repo2docker.utils.validate_and_generate_port_mapping`
|
||||||
TODO: Should we use a fixed format and convert to whatever's required by the engine?
|
https://github.com/jupyter/repo2docker/blob/0.11.0/repo2docker/utils.py#L95
|
||||||
publish_all_ports : bool
|
publish_all_ports : bool
|
||||||
If `True` publish all ports to host
|
If `True` publish all ports to host
|
||||||
remove : bool
|
remove : bool
|
||||||
If `True` delete container when it completes
|
If `True` delete container when it completes
|
||||||
volumes : dict
|
volumes : dict
|
||||||
Volume bindings in the format expected by the engine
|
Volume bindings in the form `{src : dest}`
|
||||||
TODO: Should we use a fixed format and convert to whatever's required by the engine?
|
|
||||||
|
|
||||||
Returns
|
Returns
|
||||||
-------
|
-------
|
||||||
|
|
Ładowanie…
Reference in New Issue