scaffold.flyte.image_builder
============================

.. py:module:: scaffold.flyte.image_builder


Attributes
----------

.. autoapisummary::

   scaffold.flyte.image_builder.BUILD_TIMEOUT
   scaffold.flyte.image_builder.logger


Functions
---------

.. autoapisummary::

   scaffold.flyte.image_builder.build_image
   scaffold.flyte.image_builder.early_termination


Module Contents
---------------

.. py:function:: build_image(dockerfile: pathlib.Path, workdir_path: pathlib.Path, image_repo: str, image_tag: str, buildargs: Dict[str, str], secrets: Optional[List[str]] = None, push_image: bool = False, **kwargs: Dict[str, str]) -> str

   Build docker image with local docker engine.

   :param dockerfile: path to the dockerfile
   :type dockerfile: Path
   :param workdir_path: path to the working directory/docker context
   :type workdir_path: Path
   :param image_repo: fqn of the image repository, e.g. ``eu.gcr.io/<proj_name>/<repo>``
   :type image_repo: str
   :param image_tag: tag of the image, e.g. ``<commit-hash>-dev``
   :type image_tag: str
   :param buildargs: Build args for docker build command
   :type buildargs: Dict[str,str]
   :param secrets: List of secret names to be used in the build.
                   Example, to mount google credentials from the host machine to the build context,
                   you can pass ``secrets=["id=gcp-cred,src=<path-to-creds-file>"]``
   :type secrets: List[str]
   :param push_image: flag to push the image to remote repo. Defaults to False.
   :type push_image: bool, optional
   :param \*\*kwargs: Additional arguments for docker build CLI call
   :type \*\*kwargs: Dict[str,str]

   :returns: fqn:tag of the image
   :rtype: str


.. py:function:: early_termination(process, msg)

   Terminate a process early, raise with the provided error message


.. py:data:: BUILD_TIMEOUT
   :value: 1200


.. py:data:: logger