docker#

Launch and configure Fluent in Docker or Podman containers.

The package provides ComposeBasedLauncher for launching Fluent with Docker Compose or Podman Compose, together with utilities for selecting Fluent container images and configuring gRPC launcher arguments in GitHub Actions.

Classes:

ComposeBasedLauncher(compose_config, ...)

Launch Fluent through docker or Podman compose.

Functions:

get_ghcr_fluent_image_name(image_tag)

Get the Fluent image name from GitHub registry based on the image tag.

get_grpc_launcher_args_for_gh_runs()

Get the gRPC launcher arguments for GitHub Actions runs based on the Fluent image tag.

class ansys.fluent.core.execution.docker.ComposeBasedLauncher(compose_config, container_dict, container_server_info_file)#

Bases: object

Launch Fluent through docker or Podman compose.

Methods:

__init__(compose_config, container_dict, ...)

check_image_exists()

Check if the image exists locally.

chown_server_info_file()

Change ownership of the server info file inside the container.

pull_image()

Pull a Docker image if it does not exist locally.

start()

Start the services.

stop()

Stop the services.

Attributes:

ports

Return the ports of the launched services.

__init__(compose_config, container_dict, container_server_info_file)#
check_image_exists()#

Check if the image exists locally.

chown_server_info_file()#

Change ownership of the server info file inside the container.

Raises:
RuntimeError

If the command fails.

property ports: list[str]#

Return the ports of the launched services.

pull_image()#

Pull a Docker image if it does not exist locally.

start()#

Start the services.

Raises:
subprocess.CalledProcessError

If the command fails.

stop()#

Stop the services.

Raises:
subprocess.CalledProcessError

If the command fails.

ansys.fluent.core.execution.docker.get_ghcr_fluent_image_name(image_tag)#

Get the Fluent image name from GitHub registry based on the image tag.

ansys.fluent.core.execution.docker.get_grpc_launcher_args_for_gh_runs()#

Get the gRPC launcher arguments for GitHub Actions runs based on the Fluent image tag.