jina.orchestrate.pods.container module

jina.orchestrate.pods.container.run(args, name, container_name, net_mode, runtime_ctrl_address, envs, is_started, is_shutdown, is_ready)[source]

Method to be run in a process that stream logs from a Container

This method is the target for the Pod’s thread or process

Note

run() is running in subprocess/thread, the exception can not be propagated to the main process. Hence, please do not raise any exception here.

Note

Please note that env variables are process-specific. Subprocess inherits envs from the main process. But Subprocess’s envs do NOT affect the main process. It does NOT mess up user local system envs.

  • Parameters

    • args (Namespace) – namespace args from the Pod

    • name (str) – name of the Pod to have proper logging

    • container_name (str) – name to set the Container to

    • net_mode (Optional[str]) – The network mode where to run the container

    • runtime_ctrl_address (str) – The control address of the runtime in the container

    • envs (Dict) – Dictionary of environment variables to be set in the docker image

    • is_started (Union[Event, Event]) – concurrency event to communicate runtime is properly started. Used for better logging

    • is_shutdown (Union[Event, Event]) – concurrency event to communicate runtime is terminated

    • is_ready (Union[Event, Event]) – concurrency event to communicate runtime is ready to receive messages

class jina.orchestrate.pods.container.ContainerPod(args)[source]

Bases: jina.orchestrate.pods.BasePod

ContainerPod starts a runtime of BaseRuntime inside a container. It leverages threading.Thread or multiprocessing.Process to manage the logs and the lifecycle of docker container object in a robust way.

  • daemon

    required here to set process/thread daemon

  • start()[source]

    Start the ContainerPod. This method calls start() in threading.Thread or multiprocesssing.Process. .. #noqa: DAR201

  • join(\args, **kwargs*)[source]

    Joins the Pod. This method calls join() in threading.Thread or multiprocesssing.Process.

    • Parameters

      • args – extra positional arguments to pass to join

      • kwargs – extra keyword arguments to pass to join