https://github.com/kubernetes-sigs/crdify
a CLI tool to compare CustomResourceDefinitions and identify breaking changes
https://github.com/kubernetes-sigs/crdify
crd customresourcedefinition customresourcedefinitions kubernetes
Last synced: 3 months ago
JSON representation
a CLI tool to compare CustomResourceDefinitions and identify breaking changes
- Host: GitHub
- URL: https://github.com/kubernetes-sigs/crdify
- Owner: kubernetes-sigs
- License: apache-2.0
- Created: 2024-10-30T21:15:21.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-06-04T18:13:56.000Z (4 months ago)
- Last Synced: 2025-06-12T11:25:33.763Z (4 months ago)
- Topics: crd, customresourcedefinition, customresourcedefinitions, kubernetes
- Language: Go
- Homepage:
- Size: 202 KB
- Stars: 4
- Watchers: 1
- Forks: 5
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: code-of-conduct.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# crdify
`crdify` is a CLI tool for comparing Kubernetes `CustomResourceDefinition` resources (CRDs) for differences.
It checks for incompatible changes to help:
- Cluster administrators protect CRDs on their clusters from breaking changes
- GitOps practitioners prevent CRDs with breaking changes being committed
- Developers of Kubernetes extension identify when changes to their CRDs are incompatible
## Usage
```sh
crdify is a tool for evaluating changes to Kubernetes CustomResourceDefinitions
to help cluster administrators, gitops practitioners, and Kubernetes extension developers identify
changes that might result in a negative impact to clusters and/or users.
Example use cases:
Evaluating a change in a CustomResourceDefinition on a Kubernetes Cluster with one in a file:
$ crdify kube://{crd-name} file://{filepath}
Evaluating a change from file to file:
$ crdify file://{filepath} file://{filepath}
Evaluating a change from git ref to git ref:
$ crdify git://{ref}?path={filepath} git://{ref}?path={filepath}
Usage:
crdify [flags]
crdify [command]
Available Commands:
completion Generate the autocompletion script for the specified shell
help Help about any command
version installed version of crdify
Flags:
--config string the filepath to load the check configurations from
-h, --help help for crdify
-o, --output string the format the output should take when incompatibilities are identified. May be one of plaintext, json, yaml (default "plaintext")
Use "crdify [command] --help" for more information about a command.
```
The `` and `` arguments are required and should be the sourcing information for the old and new
`CustomResourceDefinition` YAML
The supported sources are:
- `kube://{name}`
- `git://{ref}?path={filepath}`
- `file://{filepath}`
An example of using `crdify` to compare a `CustomResourceDefinition` on a Kubernetes cluster to the same one in a local file:
```sh
crdify kube://memcacheds.cache.example.com file://crd.yaml
```
## Installation
`crdify` can be installed by running:
```sh
go install sigs.k8s.io/crdify@{revision}
```
Replace `{revision}` with a tag, commit, or `latest` to build and install the tool from source at that particular revision.