k8sdepr

README

Go code analyzer for Kubernetes API deprecation/removal.

Overview

As Kubernetes version goes up, the resource API such as apps/v1beta2:Deployment will be deprecated/removed. If you are developing or using custom Kubernetes controller/operator, you need to track API deprecation/removal to ensure the controller/operator works correctly even after upgrading the Kubernetes cluster to new version.

k8sdepr detects these API deprecation/removal in Go codes; based on the specified target Kubernetes version.

• Detects resource API deprecation/removal based on target Kubernetes version.
• Allows to set target Kubernetes version via CLI parameter.
• Suggests replacement API for deprecated/removed API.

If you are interested in detecting API deprecation/removal in YAML manifests and Kubernetes cluster resources, then check follwing tools:

• FairwindsOps/pluto

Install

The analyzer is work in progress. You need to specify wip branch as following:

go get -u github.com/yoichiwo7/k8sdepr@wip

Usage

• -targetVersion flag must be set. The value must follow semantic version. (ex. v1.16.0)

k8sdepr -targetVersion VERSION [-ignoreDeprecation] [-ignoreRemoval] [package]

Flags:
  -targetVersion string
        target semantic version of the Kubernetes (ex. v1.16.0)
  -ignoreDeprecation
        ignore deprecation detection
  -ignoreRemoval
        ignore removal detection

Example

Run the analyzer command on target source directory. As described in previous section, -targetVersion must be set with valid semantic version.

# Check codes in current directory against Kubernetes v1.17.0
k8sdepr -targetVersion v1.17.0 ./...

If the analyzer detects API deprecation or removal, it will prints message like following.

/tmp/src/services.go:9:10: extensions/v1beta1:DaemonSet is removed. Migrate to apps/v1:DaemonSet. {deprecated=v1.9.0, removed=v1.16.0} 
/tmp/src/ingress.go:38:10: extensions/v1beta1:Ingress is deprecated. Migrate to networking.k8s.io/v1beta1:Ingress. {deprecated=v1.14.0, removed=v1.22.0}

Check Non-Module Codes

If you want to check non-module codes, you must setup go module and sync vendor directory first. The following example shows how to check these code by using old version of spotahome/redis-operator which has some deprecated/removed APIs.

# Get redis-operator (specify version that has some removed APIs)
git clone -b 0.5.0 --depth=1 https://github.com/spotahome/redis-operator
cd redis-operator

# Setup go module
go mod init github.com/spotahome/redis-operator

# Sync vendor directory
go mod vendor

# Check against v1.15.0 -> Detects lots of API deprecation
k8sdepr -targetVersion v1.15.0 ./...

# Check against v1.16.0 -> Detects lots of API removal
k8sdepr -targetVersion v1.16.0 ./...