Step Deployment#

Deploys a CronJob which runs the commands defined in the commands deployment spec on the docker image defiend in the docker_image deployment spec on the schedule defined in schedule.

To deploy an octaistep the docker_image deployment spec should be an OctaiPipe image.

class StepDeployment

Kuberenetes Objects:

  • CronJob

Fields:

  • type: stepDeployment

  • name: string

    • required - unique name of deployment

  • template string

    • default: src/octaipipe/configs/cloud_deployment/cron_step_deployment_template.yml

  • kubernetes_namespace string

    • default: default

  • deployment_specs dict

    • See placeholders

Placeholders (deployment_specs or env variables):

  • deployment_name string

    • default = deployment’s name

  • container_name string

    • required

  • schedule string

    • default = * * * * *

  • concurrencyPolicy string

    • default = Forbid

  • docker_image string

    • Checks for OCTAIPIPE_IMAGE environment variable

    • default = ubuntu:20.04

  • imagePullPolicy string

    • default = Always

  • env_variables list of name/value pairs

    • default = []

    • e.g:

1env_variables:
2 - name: ENVIRONMENT
3   value: prod
4 - name: FOO
5   VALUES: bar

  • commands list

    • required

    • list of commands for the step to run.