Moderne licensed

Kubernetes best practices

Recipe IDorg.openrewrite.kubernetes.KubernetesBestPracticesArtifactorg.openrewrite.recipe:rewrite-kubernetes

Applies best practices to Kubernetes manifests.

Composite recipekubernetesProprietary

Add to your build

Get a download tokenThis recipe is Moderne licensed, so the token must belong to a Moderne customer. It replaces YOUR_DOWNLOAD_TOKEN below.

~/.gradle/gradle.properties

codeGenomeUsername=you@example.com
codeGenomeToken=YOUR_DOWNLOAD_TOKEN

build.gradle.kts

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

rewrite {
    activeRecipe("org.openrewrite.kubernetes.KubernetesBestPractices")
}

repositories {
    mavenCentral()
    maven {
        url = uri("https://artifacts.codegenomeproject.org/maven")
        credentials {
            username = providers.gradleProperty("codeGenomeUsername").get()
            password = providers.gradleProperty("codeGenomeToken").get()
        }
    }
}

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

Then run

./gradlew rewriteRun

Usage

This recipe has no required configuration options. You’ll need the Moderne CLI configured before running the command below.

mod run . --recipe org.openrewrite.kubernetes.KubernetesBestPractices

If the recipe isn’t available locally, install it with:

mod config recipes jar install org.openrewrite.recipe:rewrite-kubernetes:RELEASE

Definition

This recipe runs the following recipes in order.

Ensure liveness probe is configuredorg.openrewrite.kubernetes.MissingPodLivenessProbe
Ensure readiness probe is configuredorg.openrewrite.kubernetes.MissingPodReadinessProbe
Ensure CPU request is setorg.openrewrite.kubernetes.MissingCpuRequest
Ensure CPU limits are setorg.openrewrite.kubernetes.MissingCpuLimits
Ensure memory request is setorg.openrewrite.kubernetes.MissingMemoryRequest
Ensure memory limits are setorg.openrewrite.kubernetes.MissingMemoryLimits
No privileged containersorg.openrewrite.kubernetes.NoPrivilegedContainers
Ensure lifecycle rule on StorageBucketorg.openrewrite.kubernetes.LifecycleRuleOnStorageBucket
No host process ID sharingorg.openrewrite.kubernetes.NoHostProcessIdSharing
No host IPC sharingorg.openrewrite.kubernetes.NoHostIPCSharing
No root containersorg.openrewrite.kubernetes.NoRootContainers
Ensure image pull policy is Alwaysorg.openrewrite.kubernetes.ImagePullPolicyAlways
No privilege escalationorg.openrewrite.kubernetes.NoPrivilegeEscalation
No host network sharingorg.openrewrite.kubernetes.NoHostNetworkSharing
Read-only root filesystemorg.openrewrite.kubernetes.ReadOnlyRootFilesystem
Limit root capabilities in a containerorg.openrewrite.kubernetes.LimitContainerCapabilities

Data tables

Structured output this recipe can produce.

Source files that had resultsSource files that were modified by the recipe run.org.openrewrite.table.SourcesFileResults
Source files that had search resultsSearch results that were found during the recipe run.org.openrewrite.table.SearchResults
Source files that errored on a recipeThe details of all errors produced by a recipe run.org.openrewrite.table.SourcesFileErrors
Recipe performanceStatistics used in analyzing the performance of recipes.org.openrewrite.table.RecipeRunStats