Skip to content

Latest commit

 

History

History
163 lines (132 loc) · 6.36 KB

findservicesbytype.md

File metadata and controls

163 lines (132 loc) · 6.36 KB
Raw

Service type

org.openrewrite.kubernetes.services.FindServicesByType

Type of Kubernetes Service to find.

Recipe source

GitHub, Issue Tracker, Maven Central

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

Options

Type Name Description Example
String serviceType Type of Kubernetes Service to find. Valid options: ClusterIP, NodePort, LoadBalancer, ExternalName NodePort
String fileMatcher Optional. Matching files will be modified. This is a glob expression. **/pod-*.yml

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.FindServicesByTypeExample. Here's how you can define and customize such a recipe within your rewrite.yml:

{% code title="rewrite.yml" %}

---
type: specs.openrewrite.org/v1beta/recipe
name: com.yourorg.FindServicesByTypeExample
displayName: Service type example
recipeList:
  - org.openrewrite.kubernetes.services.FindServicesByType:
      serviceType: NodePort
      fileMatcher: '**/pod-*.yml'

{% endcode %}

Now that com.yourorg.FindServicesByTypeExample has been defined, activate it and take a dependency on org.openrewrite.recipe:rewrite-kubernetes:2.8.3 in your build file: {% tabs %} {% tab title="Gradle" %}

  1. Add the following to your build.gradle file: {% code title="build.gradle" %}
plugins {
    id("org.openrewrite.rewrite") version("6.23.3")
}

rewrite {
    activeRecipe("com.yourorg.FindServicesByTypeExample")
    exportDatatables = true
}

repositories {
    mavenCentral()
}

dependencies {
    rewrite("org.openrewrite.recipe:rewrite-kubernetes:2.8.3")
}

{% endcode %} 2. Run gradle rewriteRun to run the recipe. {% endtab %} {% tab title="Maven" %}

  1. Add the following to your pom.xml file: {% code title="pom.xml" %}
<project>
  <build>
    <plugins>
      <plugin>
        <groupId>org.openrewrite.maven</groupId>
        <artifactId>rewrite-maven-plugin</artifactId>
        <version>5.40.2</version>
        <configuration>
          <exportDatatables>true</exportDatatables>
          <activeRecipes>
            <recipe>com.yourorg.FindServicesByTypeExample</recipe>
          </activeRecipes>
        </configuration>
        <dependencies>
          <dependency>
            <groupId>org.openrewrite.recipe</groupId>
            <artifactId>rewrite-kubernetes</artifactId>
            <version>2.8.3</version>
          </dependency>
        </dependencies>
      </plugin>
    </plugins>
  </build>
</project>

{% endcode %} 2. Run mvn rewrite:run to run the recipe. {% endtab %} {% tab title="Moderne CLI" %} You will need to have configured the Moderne CLI on your machine before you can run the following command.

{% code title="shell" %}

mod run . --recipe FindServicesByTypeExample

{% endcode %} {% endtab %} {% endtabs %}

See how this recipe works across multiple open-source repositories

Moderne Link Image

The community edition of the Moderne platform enables you to easily run recipes across thousands of open-source repositories.

Please contact Moderne for more information about safely running the recipes on your own codebase in a private SaaS.

Data Tables

Source files that had results

org.openrewrite.table.SourcesFileResults

Source files that were modified by the recipe run.

Column Name Description
Source path before the run The source path of the file before the run. null when a source file was created during the run.
Source path after the run A recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run.
Parent of the recipe that made changes In a hierarchical recipe, the parent of the recipe that made a change. Empty if this is the root of a hierarchy or if the recipe is not hierarchical at all.
Recipe that made changes The specific recipe that made a change.
Estimated time saving An estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds.
Cycle The recipe cycle in which the change was made.

Source files that errored on a recipe

org.openrewrite.table.SourcesFileErrors

The details of all errors produced by a recipe run.

Column Name Description
Source path The file that failed to parse.
Recipe that made changes The specific recipe that made a change.
Stack trace The stack trace of the failure.

Recipe performance

org.openrewrite.table.RecipeRunStats

Statistics used in analyzing the performance of recipes.

Column Name Description
The recipe The recipe whose stats are being measured both individually and cumulatively.
Source file count The number of source files the recipe ran over.
Source file changed count The number of source files which were changed in the recipe run. Includes files created, deleted, and edited.
Cumulative scanning time The total time spent across the scanning phase of this recipe.
99th percentile scanning time 99 out of 100 scans completed in this amount of time.
Max scanning time The max time scanning any one source file.
Cumulative edit time The total time spent across the editing phase of this recipe.
99th percentile edit time 99 out of 100 edits completed in this amount of time.
Max edit time The max time editing any one source file.

Contributors

Jon Brisbin, Knut Wannheden, Jonathan Schnéider, Aaron Gershman, Tim te Beek