https://github.com/fkorotkov/k8s-kotlin-dsl
Kotlin DSL for Kubernetes configs
https://github.com/fkorotkov/k8s-kotlin-dsl
dsl generator kotlin kotlin-dsl kubernetes kubernetes-deployment kubernetes-setup
Last synced: 5 months ago
JSON representation
Kotlin DSL for Kubernetes configs
- Host: GitHub
- URL: https://github.com/fkorotkov/k8s-kotlin-dsl
- Owner: fkorotkov
- License: mit
- Created: 2017-03-14T06:01:29.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2025-01-24T17:56:46.000Z (over 1 year ago)
- Last Synced: 2025-10-29T15:49:51.546Z (8 months ago)
- Topics: dsl, generator, kotlin, kotlin-dsl, kubernetes, kubernetes-deployment, kubernetes-setup
- Language: Kotlin
- Homepage:
- Size: 1.5 MB
- Stars: 354
- Watchers: 15
- Forks: 21
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-kubernetes-configuration-management - k8s-kotlin-dsl
README
[](https://cirrus-ci.com/github/fkorotkov/k8s-kotlin-dsl)
[](https://jitpack.io/#fkorotkov/k8s-kotlin-dsl)
[Kotlin](https://kotlinlang.org) DSL for [Kubernetes](https://kubernetes.io/) and [Openshift Container Platform](https://www.openshift.com/container-platform/) on top of [fabric8 client](https://github.com/fabric8io/kubernetes-client).
## Usage
`k8s-kotlin-dsl` package can be found on [jitpack](https://jitpack.io/#fkorotkov/k8s-kotlin-dsl). Simply add following lines to your `build.gradle`:
```groovy
allprojects {
repositories {
maven { url 'https://jitpack.io' }
}
}
dependencies {
implementation("com.github.fkorotkov:k8s-kotlin-dsl:${kubernetes_dsl_version}")
}
```
### Using with `kubernetes-client`
Let's check out how to create an Ingress via [fabric8 client](https://github.com/fabric8io/kubernetes-client). Don't forget to add a dependency on `io.fabric8:kubernetes-client:${kubernetes_client_version}`.
```kotlin
import com.fkorotkov.kubernetes.extensions.*
import io.fabric8.kubernetes.api.model.IntOrString
import io.fabric8.kubernetes.client.DefaultKubernetesClient
fun main() {
val client = DefaultKubernetesClient().inNamespace("default")
client.extensions().ingresses().createOrReplace(
newIngress {
metadata {
name = "example-ingress"
}
spec {
backend {
serviceName = "example-service"
servicePort = IntOrString(8080)
}
}
}
)
}
```
### Apply modifications
By leveraging awesomeness of Kotlin it becomes super easy to have a base service template that every microservice is created from:
```kotlin
val baseService = defaultServiceTemplate()
baseService.apply {
metadata {
name = "foo"
}
}
```
### Complete Deployment example
Here is an example of `BaseDeployment` that defines a deployment with one replica and mounts a secret that can be used by the service.
```kotlin
import com.fkorotkov.kubernetes.*
import com.fkorotkov.kubernetes.apps.*
import io.fabric8.kubernetes.api.model.IntOrString
import io.fabric8.kubernetes.api.model.apps.Deployment
class BaseDeployment : Deployment {
constructor(serviceName: String) {
metadata {
name = "$serviceName-service-deployment"
labels = mapOf(
"app" to serviceName,
"tier" to "backend"
)
}
spec {
replicas = 1
template {
metadata {
labels = mapOf(
"app" to serviceName,
"tier" to "backend"
)
}
spec {
containers = listOf(
newContainer {
name = "$serviceName-service"
image = "gcr.io/fkorotkov/$serviceName-service:latest"
volumeMounts = listOf(
newVolumeMount {
name = "gcp-credentials"
mountPath = "/etc/credentials"
readOnly = true
}
)
env = listOf(
newEnvVar {
name = "GOOGLE_APPLICATION_CREDENTIALS"
value = "/etc/credentials/service-account-credentials.json"
}
)
ports = listOf(
newContainerPort {
containerPort = 8080
}
)
livenessProbe {
httpGet {
path = "/healthz"
port = IntOrString(8080)
}
periodSeconds = 60
}
readinessProbe {
httpGet {
path = "/healthz"
port = IntOrString(8080)
}
initialDelaySeconds = 10
periodSeconds = 60
}
}
)
volumes = listOf(
newVolume {
name = "gcp-credentials"
secret {
secretName = "gcp-credentials"
}
}
)
}
}
}
}
}
```
## Contribution
Check `CONTRIBUTING.md`