Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kuberig-io/kuberig-dsl
KubeRig DSL generation code
https://github.com/kuberig-io/kuberig-dsl
dsl generator gradle gradle-plugin kotlin kuberig kuberig-dsl kubernetes openshift
Last synced: 3 days ago
JSON representation
KubeRig DSL generation code
- Host: GitHub
- URL: https://github.com/kuberig-io/kuberig-dsl
- Owner: kuberig-io
- License: apache-2.0
- Created: 2019-02-26T20:25:25.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2021-12-20T20:56:50.000Z (about 3 years ago)
- Last Synced: 2024-11-15T09:47:04.743Z (2 months ago)
- Topics: dsl, generator, gradle, gradle-plugin, kotlin, kuberig, kuberig-dsl, kubernetes, openshift
- Language: Kotlin
- Homepage: https://kuberig.io
- Size: 2.22 MB
- Stars: 8
- Watchers: 3
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://kuberig.io)
[](https://app.circleci.com/pipelines/github/kuberig-io/kuberig-dsl)
[](https://codecov.io/gh/kuberig-io/kuberig-dsl)
# kuberig-dsl
Generates a Kotlin DSL based on the swagger api spec of Kubernetes and OpenShift.
Want to know more about Kuberig checkout [kuberig.io](https://kuberig.io).
## API generator project
Place the swagger API definition file from your API server in src\main\resources\swagger.json.
Create a build.gradle.kts file containing. For different ways of applying the plugin please check the
[Gradle plugin portal](https://plugins.gradle.org/plugin/io.kuberig.dsl.generator).
```kotlin
plugins {
id("io.kuberig.dsl.generator") version "0.1.4"
}
repositories {
jcenter()
}
```
Run `gradle build` and start using the generated DslKindsRoot class. See the API usage examples for more details.
In case you want to customize the location of the swagger.json or the generation target directory
you can customize them by adding the kuberigDsl block. The code below shows the defaults applied by the plugin.
```kotlin
kuberigDsl {
swaggerFileLocation.set("src/main/resources/swagger.json")
sourceOutputDirectoryLocation.set("build/generated-src/main/kotlin")
}
```
## API usage examples
### Kubernetes
```kotlin
DslKindsRoot(YamlOutputSink()).apps.v1.deployment("nginx") {
metadata {
name("nginx")
}
spec {
template {
metadata {
name("nginx")
}
spec {
containers {
container {
image("nginx")
ports {
port {
containerPort(80)
}
}
}
}
}
}
replicas(1)
}
}
```
### OpenShift
```kotlin
DslKindsRoot(YamlOutputSink()).apply {
v1 {
deploymentConfig("nginx") {
metadata {
name("nginx")
}
spec {
template {
metadata {
name("nginx")
}
spec {
containers {
container {
image("nginx")
ports {
port {
containerPort(80)
}
}
}
}
}
}
replicas(1)
}
}
}
}
```
## Something more complex
```kotlin
val name = "my-spring-boot-service"
val metadata = objectMeta {
namespace("my-spring-boot-service")
name(name)
}
val podLabel = Pair("app", name)
val containerPort = 8080
val springBootActuatorHealth = probe {
httpGet {
path("/actuator/health")
port(9090)
}
}
val springBootResources = resourceRequirements {
requests {
request("cpu") {
quantity("500m")
}
request("memory") {
quantity("250Mi")
}
}
limits {
limit("cpu") {
quantity("1000m")
}
limit("memory") {
quantity("500Mi")
}
}
}
DslKindsRoot(YamlOutputSink()).apply {
apps{
v1{
deployment(name) {
metadata(metadata)
spec {
template {
metadata {
labels {
label(podLabel)
}
}
spec {
containers {
container {
name(name)
image("my-spring-boot-service:0.1.0")
ports {
port {
name("http")
containerPort(containerPort)
}
}
readinessProbe(springBootActuatorHealth)
resources(springBootResources)
}
}
}
}
replicas(1)
}
}
}
}
v1 {
service(name) {
metadata(metadata)
spec {
ports {
port {
port(80)
targetPort(containerPort)
protocol("TCP")
}
}
selector(podLabel)
}
}
secret(name) {
metadata(metadata)
stringData("some-key", "super-secret")
}
}
}
```