These steps should be completed after receiving access to a Trainy k8s cluster.

Installation

We maintain a nightly build of our latest client on PyPi konduktor-nightly

$ pip install konduktor-nightly

(Optional) Setup Cloud Storage Credentials

We currently support the following cloud object stores for syncing files —> workloads with more incoming!

  • Google Cloud Storage gs - Supported ✅
  • Amazon S3 s3 - Supported ✅
  • Cloudflare R2 r2 - Coming soon 🚧

Google Cloud Storage Requirements

  1. Install with pip install konduktor-nightly

  2. Check that your GCP user or service account has the minimal GCP permissions.

  3. Ensure that ~/.konduktor/config.yaml is configured correctly for GS:

allowed_clouds:
  - gs
  1. Use local credentials OR set env variables: Coming soon 🚧

  2. Confirm your GS credentials and setup with:

$ konduktor check gs

Amazon S3 Requirements

  1. Install with pip install konduktor-nightly[s3]

  2. Check that your AWS user has the minimal AWS user permissions.

  3. Ensure that ~/.konduktor/config.yaml is configured correctly for S3:

allowed_clouds:
  - s3
  1. Use local ~/.aws/ credentials OR set env variables:

~/.aws/config

[default]
region = us-east-1

~/.aws/credentials

[default]
aws_access_key_id=ASIAIOSFODNN7EXAMPLE
aws_secret_access_key=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY

OR

$ export AWS_ACCESS_KEY_ID="ASIAIOSFODNN7EXAMPLE"
$ export AWS_SECRET_ACCESS_KEY="wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"
$ export AWS_DEFAULT_REGION="us-east-1"
  1. Confirm your S3 credentials and setup with:
$ konduktor check s3

(Optional) Setup Private Container Registry Credentials

To have your Trainy jobs use images from private container registries (k8s docs), work with your Trainy administrator to set your registry credentials and set the following in ~/.konduktor/config.yaml

kubernetes:
  pod_config:
    spec:
      imagePullSecrets:
        - name: regcred