namespace docker_handle¶

Overview¶

namespace docker_handle {

// classes

class NRPDockerHandle;

// global functions

(bool, str) container_put_archive(
    docker.models.containers.Container container,
    str archive_path,
    str container_path
);

(bool, str) container_get_archive(
    docker.models.containers.Container container,
    str archive_path,
    str host_path
);

} // namespace docker_handle

Detailed Documentation¶

Global Functions¶

(bool, str) container_put_archive(
    docker.models.containers.Container container,
    str archive_path,
    str container_path
)

Put archive in container from host filesystem

:param container: docker container where the archive will be put
:param archive_path archive path in the host filesystem
:param container_path path in the container where the archive will be extracted
:returns a bool indicating whether the operation succeed or not and an error msg if it didn't

(bool, str) container_get_archive(
    docker.models.containers.Container container,
    str archive_path,
    str host_path
)

Get archive from a container and extract it in the host filesystem

   :param container: docker container containing the archive to be retrieved
   :param archive_path archive path in the container
   :param host_path path in the host filesystem where the archive will be extracted
   :returns a bool indicating whether the operation succeed or not and an error msg if it didn't