Design Partners
Add Kubernetes configuration
** org.openrewrite.kubernetes.AddConfiguration** Add default required configuration when it is missing.

Source

  • groupId: org.openrewrite.recipe
  • artifactId: rewrite-kubernetes
  • version: 1.18.0

Options

Type
Name
Description
String
apiVersion
Optional. The Kubernetes resource API version to use.
String
resourceKind
The Kubernetes resource type the configured is required on.
String
configurationPath
A JsonPath expression to locate Kubernetes configuration. Must be an absolute path.
String
value
The configuration that is added when necessary, including the key.

Usage

This recipe has required configuration parameters. Recipes with required configuration parameters cannot be activated directly. To activate this recipe you must create a new recipe which fills in the required parameters. In your rewrite.yml create a new recipe with a unique name. For example: com.yourorg.AddConfigurationExample. Here's how you can define and customize such a recipe within your rewrite.yml:
rewrite.yml
1
---
2
type: specs.openrewrite.org/v1beta/recipe
3
name: com.yourorg.AddConfigurationExample
4
displayName: Add Kubernetes configuration example
5
recipeList:
6
- org.openrewrite.kubernetes.AddConfiguration:
7
apiVersion: policy/v1beta1
8
resourceKind: PodSecurityPolicy
9
configurationPath: $.spec
10
value: 'privileged: false'
Copied!
Now that com.yourorg.AddConfigurationExample has been defined activate it and take a dependency on org.openrewrite.recipe:rewrite-kubernetes:1.18.0 in your build file:
Gradle
Maven
build.gradle
1
plugins {
2
id("org.openrewrite.rewrite") version("5.22.2")
3
}
4
5
rewrite {
6
activeRecipe("com.yourorg.AddConfigurationExample")
7
}
8
9
repositories {
10
mavenCentral()
11
}
12
13
dependencies {
14
rewrite("org.openrewrite.recipe:rewrite-kubernetes:1.18.0")
15
}
Copied!
pom.xml
1
<project>
2
<build>
3
<plugins>
4
<plugin>
5
<groupId>org.openrewrite.maven</groupId>
6
<artifactId>rewrite-maven-plugin</artifactId>
7
<version>4.25.0</version>
8
<configuration>
9
<activeRecipes>
10
<recipe>com.yourorg.AddConfigurationExample</recipe>
11
</activeRecipes>
12
</configuration>
13
<dependencies>
14
<dependency>
15
<groupId>org.openrewrite.recipe</groupId>
16
<artifactId>rewrite-kubernetes</artifactId>
17
<version>1.18.0</version>
18
</dependency>
19
</dependencies>
20
</plugin>
21
</plugins>
22
</build>
23
</project>
Copied!
Recipes can also be activated directly from the commandline by adding the argument -Drewrite.activeRecipescom.yourorg.AddConfigurationExample
Export as PDF
Copy link