Deployment

data class Deployment @JvmOverloads constructor(name: String, isProduction: Boolean, isStaging: Boolean, isTest: Boolean, isLocalDevelopment: Boolean)

Deployment describes the context in which the application is running

Constructors

fun Deployment(name: String, isProduction: Boolean = false, isStaging: Boolean = false, isTest: Boolean = false, isLocalDevelopment: Boolean = false)

Returns true if running outside of a cluster (CI or local development). Mutually exclusive with isReal.

Whether the service is running on a local developer machine, including as a Docker image.

Whether the service is running in a production environment, having an SLA or handling customer data.

Returns true if running in a managed cluster, such as a staging or production cluster. Mutually exclusive with isFake.

Whether the service is running in a staging environment.

val isTest: Boolean = false

Whether the service is running in a test environment, either locally or in a CI.

The name of this deployment. This is used for debugging and should not be parsed.