V1PolyaxonSidecarContainer

polyaxon.auxiliaries.sidecar.V1PolyaxonSidecarContainer(image=None, image_tag=None, image_pull_policy=None, sleep_interval=None, sync_interval=None, monitor_logs=None, resources=None)

Polyaxon sidecar is a helper container that collects outputs, artifacts, and metadata about the main container.

Polyaxon CE and Polyaxon Agent are deployed with default values for the sidecar container, however if you need to control or update one or several aspects of how the sidecar container that gets injected, this guide walks through the possible options.

  • Args:
    • image: str, optional.
    • image_tag: str, optional.
    • image_pull_policy: str, optional.
    • resources: V1ResourceRequirements, optional.
    • sleep_interval: int, optional.
    • sync_interval: int, optional.

YAML usage

sidecar:
  image: polyaxon/polyaxon-sidecar
  imageTag: v1.x
  imagePullPolicy: IfNotPresent
  resources: requests:
    memory: "64Mi"
    cpu: "50m"
  sleepInterval: 5
  syncInterval: 60

Fields

image

The container image to use.

sidecar:
  image: polyaxon/polyaxon-sidecar

imageTag

The container image tag to use.

sidecar:
  imageTag: dev

imagePullPolicy

The image pull policy to use, it must be a valid policy supported by Kubernetes.

sidecar:
  imagePullPolicy: Always

resources

The resources requirements to allocate to the container.

sidecar:
  resources:
    memory: "64Mi"
    cpu: "50m"

sleepInterval

The interval between two consecutive checks, default 10s.

N.B.1: It's possible to alter this behaviour on per operation level using the sidecar plugin.

N.B.2: be careful of the trade-off between a large sleep interval and a short interval, you don't want the sidecar to overwhelm the API and Kuberenetes API, and you don't want also the sidecar to penalize your workload with additional latency.

sidecar:
  sleepInterval: 5

syncInterval

The interval between two consecutive archiving checks. default 10s.

N.B.1: It's possible to alter this behaviour on per operation level using the sidecar plugin.

N.B.2: Only changed files since a previous check are synced.

N.B.3: If you don't need to access intermediate artifacts while the workload is running, you might set this field to a high value, or -1 to only trigger this behavior when the workload is done.

sidecar:
  syncInterval: 5