TeamCity Kotlin DSL/jetbrains.buildServer.configs.kotlin.projectFeatures/KubernetesExecutor

KubernetesExecutor

open class KubernetesExecutor : ProjectFeature

fun ProjectFeatures.kubernetesExecutor(init: KubernetesExecutor.() -> Unit): KubernetesExecutor

The default "agentless" Kubernetes integration that allows TeamCity to offload all building tasks to a K8S cluster.

Example. Adds new Kubernetes executor that allows TeamCity to offload builds to Kubernetes

project {
    // Other Project settings ...
    features {
        // Other Project Features ...
        kubernetesExecutor {
          id = "PROJECT_EXT_32"
          connectionId = "PROJECT_EXT_14"
          profileName = "executor"
          templateName = "executors-template"
        }
Content copied to clipboard
    }
}

Example. Adds new Kubernetes executor that allows TeamCity to offload builds to Kubernetes. This executor is aware of the parameters available to the executor build.

project {
    // Other Project settings ...
    features {
        // Other Project Features ...
        kubernetesExecutor {
          id = "PROJECT_EXT_32"
          connectionId = "PROJECT_EXT_14"
          profileName = "executor"
          containerParameters = "requirement1=value1"
        }
Content copied to clipboard
    }
}

Constructors

KubernetesExecutor

constructor(init: KubernetesExecutor.() -> Unit)

constructor()

Properties

buildsLimit

var buildsLimit: String?

Maximum number of allowed builds running with the executor

connectionId

var connectionId: String?

The Kubernetes connection to use

containerParameters

var containerParameters: String?

Specify parameters in the “name=value” format to be matched against explicit agent requirements of build configurations. Pods without this setting will be compatible only with configurations that impose no explicit requirements. Format: parameter1=value1,parameter2=value2"

description

var description: String?

A small description of the current profile

enabled

var enabled: Boolean?

If executor is enabled for the project

var id: String?

Project feature id, if not specified will be generated

params

val params: List<Parameter>

profileName

var profileName: String?

Display name of the profile

serverURL

var serverURL: String?

The TeamCity URL for executor instances to connecto to. Leave empty to use default URL

templateContainer

var templateContainer: String?

A template of a pod with a single container with the settings to be applied to the build

templateName

var templateName: String?

The template's name with a pod with a single container with the settings to be applied to the build. The template must be available in the cluster of the selected connection.

type

var type: String

Project feature type

Functions

booleanParameter

fun booleanParameter(customName: String? = null, trueValue: String? = "true", falseValue: String? = "false"): DelegateProvider<Boolean?>

clear

fun clear()

compoundParameter

fun <T : CompoundParam<T>> compoundParameter(customName: String? = null): DelegateProvider<T>

copyParamsTo

fun <T : Parametrized> copyParamsTo(target: T): T

Copies parameters of this object to the specified target

create

open fun create(): ProjectFeature

Creates an instance of this project feature via reflection using a no argument constructor, used during copying. Throws an error if this class doesn't have a default constructor. Subclasses can override it to create an instance without using a default constructor.

doubleParameter