Module Expr Str Import alias Import alias Import alias Import alias Import alias Import alias ImportFrom alias ImportFrom alias alias alias alias ImportFrom alias ImportFrom alias alias alias alias Assign NameStore Call AttributeLoad NameLoad attr NameLoad ClassDef bases NameLoad body Expr Str FunctionDef arguments args NameParam defaults body Assign AttributeStore NameLoad attr ListLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Str Return AttributeLoad NameLoad attr decorator_list NameLoad FunctionDef arguments args NameParam NameParam defaults body Assign AttributeStore NameLoad attr NameLoad decorator_list AttributeLoad NameLoad attr decorator_list ClassDef bases NameLoad body Expr Str FunctionDef arguments args NameParam defaults body Assign AttributeStore NameLoad attr Call NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam defaults body Expr Str TryExcept body With Call NameLoad Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad NameLoad NameStore body Expr Call AttributeLoad NameLoad attr Str NameLoad Call AttributeLoad NameLoad attr handlers ExceptHandler type TupleLoad NameLoad NameLoad name NameStore body Expr Call AttributeLoad NameLoad attr Str NameLoad Raise Call NameLoad BinOpMod Str NameLoad If UnaryOpNot Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad body Expr Call AttributeLoad NameLoad attr Str NameLoad Raise Call NameLoad BinOpMod Str NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam defaults NameLoad body Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad NameLoad With Call NameLoad NameLoad Str NameStore body Assign NameStore Call AttributeLoad NameLoad attr NameLoad Assign NameStore Call NameLoad SubscriptLoad NameLoad Index Str keyword NameLoad If CompareEq AttributeLoad NameLoad attr Str body Expr Call AttributeLoad NameLoad attr Str AttributeLoad NameLoad attr NameLoad Expr Call AttributeLoad NameLoad attr Expr Call AttributeLoad NameLoad attr Str NameLoad Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad Assign SubscriptStore SubscriptLoad NameLoad Index Str Index Str BinOpAdd Str Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad NameLoad With Call NameLoad NameLoad Str NameStore body Expr Call AttributeLoad NameLoad attr NameLoad NameLoad decorator_list FunctionDef arguments args defaults body Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr Dict Str Dict Str Str Str Str If BoolOpAnd NameLoad CompareGt Call NameLoad Call AttributeLoad SubscriptLoad NameLoad Index Num attr Str Num CompareEq SubscriptLoad Call AttributeLoad SubscriptLoad NameLoad Index Num attr Str Index Num Str body Return NameLoad Return NameLoad decorator_list NameLoad FunctionDef arguments args NameParam NameParam NameParam defaults body Expr Str Expr Call AttributeLoad NameLoad attr Str NameLoad Expr Call AttributeLoad NameLoad attr NameLoad NameLoad Expr Call AttributeLoad NameLoad attr NameLoad NameLoad If UnaryOpNot Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad body Expr Call AttributeLoad NameLoad attr Str NameLoad Raise Call NameLoad BinOpMod Str NameLoad Assign NameStore Dict NameLoad NameLoad Dict Str NameLoad Dict Str NameLoad If Call AttributeLoad NameLoad attr body Assign SubscriptStore SubscriptLoad NameLoad Index NameLoad Index Str Str Assign SubscriptStore SubscriptLoad NameLoad Index NameLoad Index Str Str orelse Assign SubscriptStore SubscriptLoad NameLoad Index NameLoad Index Str NameLoad Assign SubscriptStore SubscriptLoad NameLoad Index NameLoad Index Str NameLoad Expr Call AttributeLoad NameLoad attr Str Call AttributeLoad Call NameLoad Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad NameLoad attr Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr Call AttributeLoad NameLoad attr NameLoad keyword Dict Str ListLoad NameLoad NameLoad keyword Dict Str Str NameLoad NameLoad Return NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam defaults body Expr Str Expr Call AttributeLoad NameLoad attr Str NameLoad Expr Call AttributeLoad NameLoad attr NameLoad NameLoad Expr Call AttributeLoad NameLoad attr NameLoad NameLoad Assign NameStore Dict NameLoad Dict Str NameLoad If Call AttributeLoad NameLoad attr body Assign SubscriptStore SubscriptLoad NameLoad Index NameLoad Index Str Str orelse Assign SubscriptStore SubscriptLoad NameLoad Index NameLoad Index Str NameLoad Expr Call AttributeLoad NameLoad attr Str Call AttributeLoad Call NameLoad Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad NameLoad attr Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr Call AttributeLoad NameLoad attr NameLoad keyword Dict Str ListLoad NameLoad keyword Dict Str Str NameLoad NameLoad Return NameLoad decorator_list decorator_list ClassDef bases NameLoad body FunctionDef arguments args NameParam NameParam NameParam defaults NameLoad Num kwarg body Expr Str Expr Call AttributeLoad Call NameLoad NameLoad NameLoad attr NameLoad Assign NameStore Dict If NameLoad body Assign SubscriptStore NameLoad Index Str NameLoad orelse If Call AttributeLoad AttributeLoad NameLoad attr attr Str body Assign SubscriptStore NameLoad Index Str SubscriptLoad AttributeLoad NameLoad attr Index Str If Call NameLoad NameLoad Str body Assign SubscriptStore NameLoad Index Str Str Assign AttributeStore NameLoad attr Call AttributeLoad NameLoad attr keyword NameLoad NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam NameParam NameParam NameParam defaults NameLoad NameLoad NameLoad body Expr Str Expr Call AttributeLoad NameLoad attr Str NameLoad NameLoad TryExcept body Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr keyword NameLoad keyword Call AttributeLoad NameLoad attr keyword NameLoad keyword UnaryOpNot NameLoad keyword NameLoad keyword NameLoad handlers ExceptHandler type NameLoad body Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr keyword NameLoad keyword Call AttributeLoad NameLoad attr keyword NameLoad keyword UnaryOpNot NameLoad keyword NameLoad Return NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam NameParam NameParam NameParam NameParam NameParam defaults NameLoad NameLoad NameLoad NameLoad NameLoad body Expr Str Expr Call AttributeLoad NameLoad attr Str NameLoad NameLoad NameLoad Expr Call AttributeLoad NameLoad attr Str NameLoad Assign NameStore Call AttributeLoad NameLoad attr Assign NameStore NameLoad TryFinally body Expr Call NameLoad NameLoad NameLoad NameLoad Assign TupleStore NameStore NameStore Call NameLoad NameLoad NameLoad If NameLoad body Expr Call AttributeLoad NameLoad attr NameLoad NameLoad Assign NameStore Call AttributeLoad NameLoad attr NameLoad NameLoad keyword NameLoad keyword NameLoad finalbody TryExcept body Expr Call AttributeLoad NameLoad attr NameLoad handlers ExceptHandler type TupleLoad NameLoad NameLoad name NameStore body Expr Call AttributeLoad NameLoad attr Str NameLoad NameLoad Expr Call AttributeLoad NameLoad attr Str Return NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam NameParam NameParam defaults NameLoad NameLoad NameLoad body Expr Str Expr Call AttributeLoad NameLoad attr Str NameLoad Assign NameStore BoolOpOr NameLoad Dict Assign NameStore BoolOpOr NameLoad Dict Expr Call AttributeLoad NameLoad attr Str NameLoad NameLoad NameLoad NameLoad If Call NameLoad NameLoad NameLoad body Assign NameStore Call AttributeLoad NameLoad attr Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad keyword NameLoad NameLoad Assign NameStore SubscriptLoad NameLoad Index Str Expr Call AttributeLoad NameLoad attr Str NameLoad Expr Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad NameLoad Return NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam NameParam defaults NameLoad NameLoad body Expr Str Expr Call AttributeLoad NameLoad attr Str NameLoad Expr Call AttributeLoad NameLoad attr Str NameLoad NameLoad NameLoad Assign NameStore NameLoad If NameLoad body Assign NameStore AttributeLoad NameLoad attr Assign NameStore Call AttributeLoad NameLoad attr keyword NameLoad Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad keyword NameLoad keyword NameLoad keyword NameLoad Expr Call AttributeLoad NameLoad attr Str NameLoad TryExcept body Return SubscriptLoad NameLoad Index Str handlers ExceptHandler type NameLoad body Expr Call AttributeLoad NameLoad attr Str Raise Call NameLoad Str decorator_list FunctionDef arguments args NameParam NameParam defaults body Expr Str Expr Call AttributeLoad NameLoad attr Str NameLoad Expr Call AttributeLoad NameLoad attr Str NameLoad Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr TryExcept body Assign NameStore SubscriptLoad ListComp NameLoad comprehension NameStore NameLoad CompareEq SubscriptLoad NameLoad Index Str NameLoad Index Num handlers ExceptHandler type NameLoad body Expr Call AttributeLoad NameLoad attr Str Return NameLoad orelse Return NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam defaults NameLoad body Expr Str Expr Call AttributeLoad NameLoad attr Str NameLoad Expr Call AttributeLoad NameLoad attr Str NameLoad Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr keyword Call AttributeLoad NameLoad attr keyword NameLoad If NameLoad body For NameStore NameLoad body If CompareIn Call AttributeLoad NameLoad attr keyword NameLoad SubscriptLoad NameLoad Index Str body Expr Call AttributeLoad NameLoad attr Str NameLoad Return ListLoad NameLoad Assign NameStore ListLoad Expr Call AttributeLoad NameLoad attr Str Call NameLoad NameLoad Return NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam defaults NameLoad body Expr Str Expr Call AttributeLoad NameLoad attr Str NameLoad Expr Call AttributeLoad NameLoad attr Str NameLoad NameLoad TryExcept body Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr Call AttributeLoad NameLoad attr keyword NameLoad keyword AttributeLoad NameLoad attr keyword NameLoad keyword NameLoad handlers ExceptHandler type NameLoad body Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr Call AttributeLoad NameLoad attr keyword NameLoad keyword AttributeLoad NameLoad attr keyword NameLoad Assign NameStore Call NameLoad NameLoad Assign AttributeStore NameLoad attr AttributeLoad NameLoad attr Return Call AttributeLoad NameLoad attr decorator_list FunctionDef arguments args NameParam NameParam NameParam NameParam defaults NameLoad body Expr Str Expr Call AttributeLoad NameLoad attr Str NameLoad NameLoad Expr Call AttributeLoad NameLoad attr Str NameLoad NameLoad If UnaryOpNot Call NameLoad NameLoad NameLoad body Assign NameStore Call AttributeLoad NameLoad attr NameLoad If CompareNotEq NameLoad NameLoad body Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr Call AttributeLoad NameLoad attr Call AttributeLoad NameLoad attr keyword NameLoad keyword AttributeLoad NameLoad attr keyword NameLoad If UnaryOpNot NameLoad body Expr Call AttributeLoad NameLoad attr Str Raise Call NameLoad BinOpMod Str Call AttributeLoad NameLoad attr NameLoad orelse Expr Call AttributeLoad NameLoad attr Str Return Call AttributeLoad NameLoad attr decorator_list FunctionDef arguments args NameParam NameParam NameParam defaults NameLoad body Expr Str Expr Call AttributeLoad NameLoad attr Str NameLoad Expr Call AttributeLoad NameLoad attr Str NameLoad NameLoad TryExcept body Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr Call AttributeLoad NameLoad attr keyword NameLoad keyword AttributeLoad NameLoad attr keyword NameLoad keyword NameLoad handlers ExceptHandler type NameLoad body Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr Call AttributeLoad NameLoad attr keyword NameLoad keyword AttributeLoad NameLoad attr keyword NameLoad Assign NameStore Call NameLoad NameLoad Assign AttributeStore NameLoad attr AttributeLoad NameLoad attr If Call AttributeLoad NameLoad attr body Raise Call NameLoad BinOpMod Str NameLoad Return AttributeLoad NameLoad attr decorator_list FunctionDef arguments args NameParam NameParam NameParam NameParam NameParam defaults NameLoad NameLoad body Expr Str Expr Call AttributeLoad NameLoad attr Str NameLoad NameLoad Expr Call AttributeLoad NameLoad attr Str NameLoad NameLoad Expr Call AttributeLoad NameLoad attr NameLoad NameLoad keyword NameLoad Return Call AttributeLoad NameLoad attr NameLoad keyword NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults body Expr Str Expr Call AttributeLoad NameLoad attr Str NameLoad Expr Call AttributeLoad NameLoad attr Str NameLoad If Call NameLoad NameLoad NameLoad body Assign NameStore Call AttributeLoad NameLoad attr Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad Return NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam NameParam defaults NameLoad NameLoad body Expr Str Expr Call AttributeLoad NameLoad attr Str NameLoad Expr Call AttributeLoad NameLoad attr Str NameLoad If Call NameLoad NameLoad NameLoad body Assign NameStore Call AttributeLoad NameLoad attr Expr Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad keyword NameLoad keyword NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam defaults NameLoad body Expr Str Expr Call AttributeLoad NameLoad attr Str NameLoad Expr Call AttributeLoad NameLoad attr Str NameLoad Expr Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad keyword NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam NameParam defaults NameLoad NameLoad body Expr Str Expr Call AttributeLoad NameLoad attr Str NameLoad Expr Call AttributeLoad NameLoad attr Str NameLoad NameLoad Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad keyword NameLoad keyword NameLoad keyword NameLoad If UnaryOpNot NameLoad body Assign NameStore Call AttributeLoad NameLoad attr Str Assign NameStore ListComp NameLoad comprehension NameStore Call AttributeLoad NameLoad attr Str NameLoad Return NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults body Expr Str Expr Call AttributeLoad NameLoad attr Str NameLoad Expr Call AttributeLoad NameLoad attr Str NameLoad Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad Expr Call AttributeLoad NameLoad attr Str NameLoad Return NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults body Expr Str Expr Call AttributeLoad NameLoad attr Str NameLoad Expr Call AttributeLoad NameLoad attr Str NameLoad TryExcept body Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad handlers ExceptHandler type NameLoad name NameStore body Expr Call AttributeLoad NameLoad attr Call NameLoad NameLoad Assign NameStore NameLoad orelse Assign NameStore CompareIsNot NameLoad NameLoad Expr Call AttributeLoad NameLoad attr Str NameLoad Return NameLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Str Return Call AttributeLoad AttributeLoad NameLoad attr attr decorator_list FunctionDef arguments args NameParam defaults body Expr Str Return Call AttributeLoad AttributeLoad NameLoad attr attr decorator_list decorator_list
N/A N/A 
Copyright (c) 2015 Red Hat, Inc
All rights reserved.

This software may be modified and distributed under the terms
of the BSD license. See the LICENSE file for details.


Naming Conventions
==================

registry.somewhere/namespace/image_name:tag
|-----------------|                          registry, reg_uri
                  |---------|                namespace
|--------------------------------------|     repository
                  |--------------------|     image name
                                        |--| tag
                  |------------------------| image
|------------------------------------------| image

I've tried to be as much consistent (man pages were source) with docker as possible


 N/A os N/A shutil N/A logging N/A tempfile N/A json N/A docker docker.errors APIError atomic_reactor.constants CONTAINER_SHARE_PATH CONTAINER_SHARE_SOURCE_SUBDIR BUILD_JSON DOCKER_SOCKET_PATH atomic_reactor.source get_source_instance_for atomic_reactor.util ImageName wait_for_command clone_git_repo figure_out_dockerfile N/A logger N/A N/A logging getLogger __name__ LastLogger N/A object N/A N/A 
    provide method for getting last log
     __init__ N/A N/A self N/A N/A N/A N/A self _last_logs N/A N/A last_logs N/A N/A self N/A N/A N/A  logs from last operation  N/A N/A self _last_logs N/A property last_logs N/A N/A self value N/A N/A N/A N/A self _last_logs value N/A N/A last_logs setter N/A BuildContainerFactory N/A object N/A N/A 
    set of methods for building images inside containers
     __init__ N/A N/A self N/A N/A N/A N/A self tasker N/A DockerTasker N/A _check_build_input N/A N/A self image args_path N/A N/A N/A 
        Internal method, validate provided args.

        :param image: str
        :param args_path: str, path dir which is mounter inside container
        :return: None
        :raises RuntimeError
         N/A N/A N/A N/A open N/A N/A N/A os path join args_path BUILD_JSON json_args N/A N/A N/A N/A logger debug build input: image = '%s', args = '%s' image N/A N/A json_args read N/A N/A N/A N/A IOError OSError N/A ex N/A N/A N/A N/A logger error unable to open json arguments: %r ex N/A N/A RuntimeError N/A Unable to open json arguments: %r ex N/A N/A N/A N/A N/A self tasker image_exists image N/A N/A N/A N/A logger error provided build image doesn't exist: '%s' image N/A N/A RuntimeError N/A Provided build image doesn't exist: '%s' image N/A _obtain_source_from_path_if_needed N/A N/A self local_path container_path N/A CONTAINER_SHARE_PATH N/A N/A build_json_path N/A N/A N/A os path join local_path BUILD_JSON N/A N/A open build_json_path r fp N/A N/A build_json N/A N/A json load fp N/A source N/A get_source_instance_for N/A build_json N/A source tmpdir local_path N/A N/A N/A source provider path N/A N/A N/A N/A logger debug copying source from %s to %s N/A source schemeless_path local_path N/A N/A N/A source get N/A N/A N/A logger debug verifying that %s exists: %s local_path N/A N/A N/A os path exists local_path N/A N/A N/A build_json N/A source N/A uri N/A file:// N/A N/A N/A os path join container_path CONTAINER_SHARE_SOURCE_SUBDIR N/A N/A open build_json_path w fp N/A N/A N/A N/A json dump build_json fp N/A _volume_bind_understands_mode N/A N/A N/A N/A N/A bind N/A N/A N/A docker utils convert_volume_binds N/A /a/ N/A bind mode /b/ ro,Z N/A N/A bind N/A N/A len N/A N/A N/A bind N/A 0 split : 2 N/A N/A N/A N/A N/A bind N/A 0 split : N/A 2 ro,Z N/A N/A True N/A False N/A staticmethod build_image_dockerhost N/A N/A self build_image json_args_path N/A N/A N/A 
        Build docker image inside privileged container using docker from host
        (mount docker socket inside container).
        There are possible races here. Use wisely.

        This operation is asynchronous and you should wait for container to finish.

        :param build_image: str, name of image where build is performed
        :param json_args_path: str, this dir is mounted inside build container and used
                               as a way to transport data between host and buildroot; there
                               has to be a file inside this dir with name atomic_reactor.BUILD_JSON which
                               is used to feed build
        :return: str, container id
         N/A N/A N/A logger info building image '%s' in container using docker from host build_image N/A N/A N/A self _check_build_input build_image json_args_path N/A N/A N/A self _obtain_source_from_path_if_needed json_args_path CONTAINER_SHARE_PATH N/A N/A N/A N/A N/A os path exists DOCKER_SOCKET_PATH N/A N/A N/A N/A logger error looks like docker is not running because there is no socket at: %s DOCKER_SOCKET_PATH N/A N/A RuntimeError N/A docker socket not found: %s DOCKER_SOCKET_PATH N/A volume_bindings N/A DOCKER_SOCKET_PATH json_args_path N/A bind DOCKER_SOCKET_PATH N/A bind CONTAINER_SHARE_PATH N/A N/A N/A self _volume_bind_understands_mode N/A N/A N/A N/A volume_bindings N/A DOCKER_SOCKET_PATH N/A mode ro N/A N/A N/A volume_bindings N/A json_args_path N/A mode rw,Z N/A N/A N/A N/A volume_bindings N/A DOCKER_SOCKET_PATH N/A ro True N/A N/A N/A volume_bindings N/A json_args_path N/A rw True N/A N/A N/A logger debug build json mounted in container: %s N/A N/A N/A open N/A N/A N/A os path join json_args_path BUILD_JSON read N/A container_id N/A N/A N/A self tasker run N/A N/A ImageName parse build_image create_kwargs N/A volumes N/A DOCKER_SOCKET_PATH json_args_path start_kwargs N/A binds privileged volume_bindings True N/A container_id N/A build_image_privileged_container N/A N/A self build_image json_args_path N/A N/A N/A 
        Build image inside privileged container: this will run another docker instance inside

        This operation is asynchronous and you should wait for container to finish.

        :param build_image: str, name of image where build is performed
        :param json_args_path: str, this dir is mounted inside build container and used
                               as a way to transport data between host and buildroot; there
                               has to be a file inside this dir with name atomic_reactor.BUILD_JSON which
                               is used to feed build
        :return: dict, keys container_id and stream
         N/A N/A N/A logger info building image '%s' inside privileged container build_image N/A N/A N/A self _check_build_input build_image json_args_path N/A N/A N/A self _obtain_source_from_path_if_needed json_args_path CONTAINER_SHARE_PATH N/A volume_bindings N/A json_args_path N/A bind CONTAINER_SHARE_PATH N/A N/A N/A self _volume_bind_understands_mode N/A N/A N/A N/A volume_bindings N/A json_args_path N/A mode rw,Z N/A N/A N/A N/A volume_bindings N/A json_args_path N/A rw True N/A N/A N/A logger debug build json mounted in container: %s N/A N/A N/A open N/A N/A N/A os path join json_args_path BUILD_JSON read N/A container_id N/A N/A N/A self tasker run N/A N/A ImageName parse build_image create_kwargs N/A volumes N/A json_args_path start_kwargs N/A binds privileged volume_bindings True N/A container_id N/A N/A DockerTasker N/A LastLogger N/A __init__ N/A N/A self base_url timeout N/A None 120 kwargs N/A N/A 
        Constructor

        :param base_url: str, docker connection URL
        :param timeout: int, timeout for docker client
         N/A N/A N/A N/A super DockerTasker self __init__ kwargs N/A client_kwargs N/A N/A base_url N/A N/A N/A client_kwargs N/A base_url base_url N/A N/A N/A N/A N/A os environ get DOCKER_CONNECTION N/A N/A N/A client_kwargs N/A base_url N/A N/A os environ N/A DOCKER_CONNECTION N/A N/A hasattr docker AutoVersionClient N/A N/A N/A client_kwargs N/A version auto N/A N/A self d N/A N/A docker Client timeout timeout client_kwargs N/A build_image_from_path N/A N/A self path image stream use_cache remove_im N/A False False True N/A N/A 
        build image from provided path and tag it

        this operation is asynchronous and you should consume returned generator in order to wait
        for build to finish

        :param path: str
        :param image: ImageName, name of the resulting image
        :param stream: bool, True returns generator, False returns str
        :param use_cache: bool, True if you want to use cache
        :param remove_im: bool, remove intermediate containers produced during docker build
        :return: generator
         N/A N/A N/A logger info building image '%s' from path '%s' image path N/A N/A N/A response N/A N/A N/A self d build path path tag N/A N/A image to_str stream stream nocache N/A use_cache rm remove_im pull False N/A N/A N/A TypeError N/A N/A response N/A N/A N/A self d build path path tag N/A N/A image to_str stream stream nocache N/A use_cache rm remove_im N/A response N/A build_image_from_git N/A N/A self url image git_path git_commit copy_dockerfile_to stream use_cache N/A None None None False False N/A N/A 
        build image from provided url and tag it

        this operation is asynchronous and you should consume returned generator in order to wait
        for build to finish

        :param url: str
        :param image: ImageName, name of the resulting image
        :param git_path: str, path to dockerfile within gitrepo
        :param copy_dockerfile_to: str, copy dockerfile to provided path
        :param stream: bool, True returns generator, False returns str
        :param use_cache: bool, True if you want to use cache
        :return: generator
         N/A N/A N/A logger info building image '%s' from git repo '%s' specified as URL '%s' image git_path url N/A N/A N/A logger info will copy Dockerfile to '%s' copy_dockerfile_to N/A temp_dir N/A N/A tempfile mkdtemp N/A response None N/A N/A N/A N/A clone_git_repo url temp_dir git_commit N/A N/A df_path df_dir N/A figure_out_dockerfile temp_dir git_path N/A copy_dockerfile_to N/A N/A N/A N/A shutil copyfile df_path copy_dockerfile_to N/A response N/A N/A self build_image_from_path df_dir image stream stream use_cache use_cache N/A N/A N/A N/A N/A N/A shutil rmtree temp_dir N/A N/A N/A N/A IOError OSError N/A ex N/A N/A N/A N/A logger warning Failed to remove dir '%s': %r temp_dir ex N/A N/A N/A logger info build finished N/A response N/A run N/A N/A self image command create_kwargs start_kwargs N/A None None None N/A N/A 
        create container from provided image and start it

        for more info, see documentation of REST API calls:
         * containers/{}/start
         * container/create

        :param image: ImageName or string, name or id of the image
        :param command: str
        :param create_kwargs: dict, kwargs for docker.create_container
        :param start_kwargs: dict, kwargs for docker.start
        :return: str, container id
         N/A N/A N/A logger info creating container from image '%s' and running it image N/A create_kwargs N/A create_kwargs N/A N/A start_kwargs N/A start_kwargs N/A N/A N/A N/A logger debug image = '%s', command = '%s', create_kwargs = '%s', start_kwargs = '%s' image command create_kwargs start_kwargs N/A N/A isinstance image ImageName N/A N/A image N/A N/A image to_str N/A container_dict N/A N/A N/A self d create_container image command command create_kwargs N/A container_id N/A container_dict N/A Id N/A N/A N/A logger debug container_id = '%s' container_id N/A N/A N/A N/A self d start container_id start_kwargs N/A container_id N/A commit_container N/A N/A self container_id image message N/A None None N/A N/A 
        create image from provided container

        :param container_id: str
        :param image: ImageName
        :param message: str
        :return: image_id
         N/A N/A N/A logger info committing container '%s' container_id N/A N/A N/A logger debug container_id = '%s', image = '%s', message = '%s' container_id image message N/A tag None N/A image N/A N/A tag N/A image tag N/A image N/A N/A image to_str tag False N/A response N/A N/A N/A self d commit container_id repository image tag tag message message N/A N/A N/A logger debug response = '%s' response N/A N/A N/A N/A response N/A Id N/A N/A N/A KeyError N/A N/A N/A N/A logger error ID missing from commit response N/A N/A RuntimeError ID missing from commit response N/A get_image_info_by_image_id N/A N/A self image_id N/A N/A N/A 
        using `docker images`, provide information about an image

        :param image_id: str, hash of image to get info
        :return: str or None
         N/A N/A N/A logger info getting info about provided image specified by image_id '%s' image_id N/A N/A N/A logger debug image_id = '%s' image_id N/A images N/A N/A N/A self d images N/A N/A N/A image_dict N/A N/A i N/A i images N/A N/A i N/A Id image_id N/A 0 N/A N/A N/A IndexError N/A N/A N/A N/A logger info image not found N/A None N/A N/A image_dict N/A get_image_info_by_image_name N/A N/A self image exact_tag N/A True N/A N/A 
        using `docker images`, provide information about an image

        :param image: ImageName, name of image
        :param exact_tag: bool, if false then return info for all images of the
                          given name regardless what their tag is
        :return: list of dicts
         N/A N/A N/A logger info getting info about provided image specified by name '%s' image N/A N/A N/A logger debug image_name = '%s' image N/A images N/A N/A N/A self d images name N/A N/A image to_str tag False N/A exact_tag N/A N/A found_image images N/A N/A N/A N/A N/A image to_str explicit_tag True N/A found_image N/A RepoTags N/A N/A N/A N/A logger debug image '%s' found image N/A N/A found_image N/A images N/A N/A N/A N/A logger debug %d matching images found N/A len images N/A images N/A pull_image N/A N/A self image insecure N/A False N/A N/A 
        pull provided image from registry

        :param image_name: ImageName, image to pull
        :param insecure: bool, allow connecting to registry over plain http
        :return: str, image (reg.om/img:v1)
         N/A N/A N/A logger info pulling image '%s' from registry image N/A N/A N/A logger debug image = '%s', insecure = '%s' image insecure N/A N/A N/A logs_gen N/A N/A N/A self d pull N/A N/A image to_str tag False tag N/A image tag insecure_registry insecure stream True N/A N/A N/A TypeError N/A N/A logs_gen N/A N/A N/A self d pull N/A N/A image to_str tag False tag N/A image tag stream True N/A command_result N/A wait_for_command logs_gen N/A N/A self last_logs N/A command_result logs N/A N/A N/A image to_str N/A tag_image N/A N/A self image target_image force N/A False N/A N/A 
        tag provided image with specified image_name, registry and tag

        :param image: str or ImageName, image to tag
        :param target_image: ImageName, new name for the image
        :param force: bool, force tag the image?
        :return: str, image (reg.om/img:v1)
         N/A N/A N/A logger info tagging image '%s' as '%s' image target_image N/A N/A N/A logger debug image = '%s', target_image_name = '%s' image target_image N/A N/A N/A isinstance image ImageName N/A N/A image N/A N/A ImageName parse image N/A N/A image target_image N/A N/A response N/A N/A N/A self d tag N/A N/A image to_str N/A N/A target_image to_str tag False tag N/A target_image tag force force N/A N/A response N/A N/A N/A N/A logger error failed to tag image N/A N/A RuntimeError N/A Failed to tag image '%s': target_image = '%s' N/A N/A image to_str target_image N/A N/A N/A N/A logger debug image already tagged correctly, nothing to do N/A N/A N/A target_image to_str N/A push_image N/A N/A self image insecure N/A False N/A N/A 
        push provided image to registry

        :param image: ImageName
        :param insecure: bool, allow connecting to registry over plain http
        :return: str, logs from push
         N/A N/A N/A logger info pushing image '%s' image N/A N/A N/A logger debug image: '%s', insecure: '%s' image insecure N/A N/A N/A logs N/A N/A N/A self d push N/A N/A image to_str tag False tag N/A image tag insecure_registry insecure stream True N/A N/A N/A TypeError N/A N/A logs N/A N/A N/A self d push N/A N/A image to_str tag False tag N/A image tag stream True N/A command_result N/A wait_for_command logs N/A N/A self last_logs N/A command_result logs N/A N/A N/A command_result is_failed N/A N/A N/A RuntimeError N/A Failed to push image %s image N/A N/A command_result parsed_logs N/A tag_and_push_image N/A N/A self image target_image insecure force N/A False False N/A N/A 
        tag provided image and push it to registry

        :param image: str or ImageName, image id or name
        :param target_image: ImageName, img
        :param insecure: bool, allow connecting to registry over plain http
        :param force: bool, force the tag?
        :return: str, image (reg.com/img:v1)
         N/A N/A N/A logger info tagging and pushing image '%s' as '%s' image target_image N/A N/A N/A logger debug image = '%s', target_image = '%s' image target_image N/A N/A N/A self tag_image image target_image force force N/A N/A N/A self push_image target_image insecure insecure N/A inspect_image N/A N/A self image_id N/A N/A N/A 
        return detailed metadata about provided image (see 'man docker-inspect')

        :param image_id: str or ImageName, id or name of the image
        :return: dict
         N/A N/A N/A logger info inspecting image '%s' image_id N/A N/A N/A logger debug image_id = '%s' image_id N/A N/A isinstance image_id ImageName N/A N/A image_id N/A N/A image_id to_str N/A image_metadata N/A N/A N/A self d inspect_image image_id N/A image_metadata N/A remove_image N/A N/A self image_id force noprune N/A False False N/A N/A 
        remove provided image from filesystem

        :param image_id: str or ImageName
        :param noprune: bool, keep untagged parents?
        :param force: bool, force remove -- just trash it no matter what
        :return: None
         N/A N/A N/A logger info removing image '%s' from filesystem image_id N/A N/A N/A logger debug image_id = '%s' image_id N/A N/A isinstance image_id ImageName N/A N/A image_id N/A N/A image_id to_str N/A N/A N/A N/A self d remove_image image_id force force noprune noprune N/A remove_container N/A N/A self container_id force N/A False N/A N/A 
        remove provided container from filesystem

        :param container_id: str
        :param force: bool, remove forcefully?
        :return: None
         N/A N/A N/A logger info removing container '%s' from filesystem container_id N/A N/A N/A logger debug container_id = '%s' container_id N/A N/A N/A N/A self d remove_container container_id force force N/A logs N/A N/A self container_id stderr stream N/A True True N/A N/A 
        acquire output (stdout, stderr) from provided container

        :param container_id: str
        :param stderr: True, False
        :param stream: if True, return as generator
        :return: either generator, or list of strings
         N/A N/A N/A logger info getting stdout of container '%s' container_id N/A N/A N/A logger debug container_id = '%s', stream = '%s' container_id stream N/A response N/A N/A N/A self d logs container_id stdout True stderr stderr stream stream N/A N/A stream N/A N/A response N/A N/A response decode utf-8 N/A response N/A line N/A line N/A N/A response split line N/A response N/A wait N/A N/A self container_id N/A N/A N/A 
        wait for container to finish the job (may run infinitely)

        :param container_id: str
        :return: int, exit code
         N/A N/A N/A logger info waiting for container '%s' to finish container_id N/A N/A N/A logger debug container = '%s' container_id N/A response N/A N/A N/A self d wait container_id N/A N/A N/A logger debug container finished with exit code %s response N/A response N/A image_exists N/A N/A self image_id N/A N/A N/A 
        does provided image exists?

        :param image_id: str or ImageName
        :return: True if exists, False if not
         N/A N/A N/A logger info checking whether image '%s' exists image_id N/A N/A N/A logger debug image_id = '%s' image_id N/A N/A N/A response N/A N/A N/A self d inspect_image image_id N/A N/A N/A APIError N/A ex N/A N/A N/A N/A logger warning N/A repr ex N/A response False N/A N/A response N/A response None N/A N/A N/A logger debug image exists: %s response N/A response N/A get_info N/A N/A self N/A N/A N/A 
        get info about used docker environment

        :return: dict, json output of `docker info`
         N/A N/A N/A N/A self d info N/A get_version N/A N/A self N/A N/A N/A 
        get version of used docker environment

        :return: dict, json output of `docker version`
         N/A N/A N/A N/A self d version N/A N/A