KubernetesConnector

The Kubernetes connector can spawn complex, multi-container environments on a Kubernetes cluster. The deployment unit is a set of Kubernetes YAML files, which are deployed in the order they are written in the config section and undeployed in the reverse order. The binding unit is the single container in a Pod. StreamFlow requires each container in a Kubernetes namespace to have a unique name attribute, allowing an unambiguous identification. Finally, the scheduling unit is the single instance of a potentially replicated container in a ReplicaSet.

properties

files (required)

A list of yaml file to deploy. Files will be deployed in direct order and undeployed in reverse order

type

string[]

debug

Enable verbose output

type

boolean

inCluster

If true, the Kubernetes connector will use a ServiceAccount to connect to the cluster. This is useful when StreamFlow runs directly inside a Kubernetes Pod

type

boolean

default

False

kubeContext

Name of the kubeconfig context to use

type

string

kubeconfig

Absolute path of the kubeconfig file to be used

type

string

maxConcurrentConnections

Maximum number of concurrent connections to open for a single Kubernetes client

type

integer

default

4096

namespace

Namespace to deploy into

type

string

default

Current kube config namespace

locationsCacheSize

Available locations cache size

type

integer

default

10

locationsCacheTTL

Available locations cache TTL (in seconds). When such cache expires, the connector performs a new request to check locations availability

type

integer

default

10

resourcesCacheSize

(Deprecated. Use locationsCacheSize.) Available resources cache size

type

integer

default

10

resourcesCacheTTL

(Deprecated. Use locationsCacheTTL.) Available resources cache TTL (in seconds). When such cache expires, the connector performs a new request to check resources availability

type

integer

default

10

timeout

Time (in seconds) to wait for any individual Kubernetes operation

type

integer

default

60000

transferBufferSize

Buffer size allocated for local and remote data transfers

type

integer

default

32MiB - 1B

wait

If set, will wait until all Pods, PVCs, Services, and minimum number of Pods of a Deployment are in a ready state before marking the deployment as successful. It will wait for as long as timeout

type

boolean

default

True