poiesis.core.ports package

Submodules

poiesis.core.ports.kubernetes module

Container orchestrator port.

class poiesis.core.ports.kubernetes.KubernetesPort

Bases: ABC

Container orchestrator port.

abstractmethod async create_job(job)

Create a Kubernetes Job.

Parameters:

job (V1Job) – The Kubernetes Job object.

Return type:

str

abstractmethod async create_pod(pod)

Create a task execution pod.

Parameters:

pod (V1Pod) – The pod object.

Return type:

str

abstractmethod async create_pvc(pvc)

Create a Persistent Volume Claim.

Parameters:

pvc (V1PersistentVolumeClaim) – The Persistent Volume Claim object.

Return type:

str

abstractmethod async delete_pvc(name)

Delete a Persistent Volume Claim.

Parameters:

name (str) – The name of the Persistent Volume Claim.

Return type:

None

abstractmethod async get_job(name)

Get a Kubernetes Job.

Parameters:

name (str) – The name of the Job.

Return type:

V1Job

abstractmethod async get_pod(name)

Get a specific pod.

Parameters:

name (str) – The name of the pod.

Return type:

V1Pod

abstractmethod async get_pod_log(name)

Get log of a pod.

Parameters:

name (str) – The name of the pod.

Return type:

str

abstractmethod async get_pods(label_selector)

Get all pods matching the label selector.

Parameters:

label_selector (str) – The label selector.

Return type:

list[V1Pod]

poiesis.core.ports.message_broker module

Messaging/Eventing ports.

class poiesis.core.ports.message_broker.Message(message, status=<factory>, timestamp=<factory>)

Bases: object

Base message class for all messages in the system.

message: str

status: MessageStatus

timestamp: datetime

to_json()

Convert to json string.

Return type:

str

class poiesis.core.ports.message_broker.MessageBroker

Bases: ABC

Abstract base class for message broker implementations.

abstractmethod close()

Close the message broker.

Return type:

None

abstractmethod publish(channel, message)

Publish a message to a specific channel.

Parameters:

• channel (str) – The channel/topic to publish to

• message (Message) – The message to publish

Return type:

None

abstractmethod subscribe(channel)

Subscribe to a channel and yield messages as they arrive.

Parameters:

channel (str) – The channel/topic to subscribe to

Return type:

Iterator[Message]

Returns:

Iterator yielding messages as they arrive

class poiesis.core.ports.message_broker.MessageStatus(*values)

Bases: Enum

Status of K8s job sent via message broker.

ERROR = 'ERROR'

SUCCESS = 'SUCCESS'

Module contents

Ports for the core components.