updateserviceexternalip.md

Update Service externalIP

org.openrewrite.kubernetes.services.UpdateServiceExternalIP

Swap out an IP address with another one in Service externalIP settings.

Source

GitHub, Issue Tracker, Maven Central

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

Options

Type	Name	Description
String	ipToFind	An externalIP address to find in the service's external IPs.
String	ipToUpdate	An externalIP address to update to in the service's external IPs.
String	fileMatcher	Optional. Matching files will be modified. This is a glob expression.

Example

Parameters

Parameter	Value
ipToFind	192.168.0.1
ipToUpdate	10.10.0.1
fileMatcher	null

{% tabs %} {% tab title="yaml" %}

Before

{% code %}

apiVersion: v1
kind: Service
metadata:
  name: my-service
spec:
  selector:
    app: MyApp
  ports:
    - name: http
      protocol: TCP
      port: 80
      targetPort: 9376
  externalIPs:
    - 192.168.0.1

{% endcode %}

After

{% code %}

apiVersion: v1
kind: Service
metadata:
  name: my-service
spec:
  selector:
    app: MyApp
  ports:
    - name: http
      protocol: TCP
      port: 80
      targetPort: 9376
  externalIPs:
    - 10.10.0.1

{% endcode %}

{% endtab %} {% tab title="Diff" %} {% code %}

@@ -14,1 +14,1 @@
      targetPort: 9376
  externalIPs:
-   - 192.168.0.1
+   - 10.10.0.1

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

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.UpdateServiceExternalIPExample. 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.UpdateServiceExternalIPExample
displayName: Update `Service` `externalIP` example
recipeList:
  - org.openrewrite.kubernetes.services.UpdateServiceExternalIP:
      ipToFind: 192.168.0.1
      ipToUpdate: 10.10.0.1
      fileMatcher: '**/pod-*.yml'

{% endcode %}

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

plugins {
    id("org.openrewrite.rewrite") version("6.1.4")
}

rewrite {
    activeRecipe("com.yourorg.UpdateServiceExternalIPExample")
}

repositories {
    mavenCentral()
}

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

{% endcode %} {% endtab %} {% tab title="Maven" %} {% code title="pom.xml" %}

<project>
  <build>
    <plugins>
      <plugin>
        <groupId>org.openrewrite.maven</groupId>
        <artifactId>rewrite-maven-plugin</artifactId>
        <version>5.2.4</version>
        <configuration>
          <activeRecipes>
            <recipe>com.yourorg.UpdateServiceExternalIPExample</recipe>
          </activeRecipes>
        </configuration>
        <dependencies>
          <dependency>
            <groupId>org.openrewrite.recipe</groupId>
            <artifactId>rewrite-kubernetes</artifactId>
            <version>2.0.1</version>
          </dependency>
        </dependencies>
      </plugin>
    </plugins>
  </build>
</project>

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

Contributors

• Jon Brisbin
• Jonathan Schneider
• Knut Wannheden
• Aaron Gershman

See how this recipe works across multiple open-source repositories

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.