Shard Detail

k8s v0.1.9

Kubernetes Object Mappings for Crystal

Install & Use

Add the following code to your project's shard.yml under:

dependencies to use in production
- OR -
development_dependencies to use in development

  github: spoved/


A Kubernetes Binding lib for Crystal-lang forked from psykube/pyrite. Forked due to possibly destructive changes to change namespaces and adapt for use with Kube::Client

.github/workflows/ci.yml .github/workflows/docs.yml GitHub release Chat on Telegram

This library contains generated classes for Kubernetes resources for various Kubernetes API versions, as well as a Hashdiff module for comparing hashes of Kubernetes resources.


Add this to your application's shard.yml:

    github: spoved/


View the Documentation for the version you are using:

Usage should support Kubernetes API from 1.11.0 and beyond. In order to use the bindings, you will want to include the VERSION that best maps to your k8s api version. Requiring more than one version at this time will result in an error.

require "k8s/versions/v1.20"


Some examples on the easier methods to grab/set variables:

# Access a nested path
resource.spec![:template, :metadata, :labels, :app]

# Set a nested path
resource.spec![:template, :metadata, :labels, :app] = "myapp"

# Can use symbols or strings

CRD Generation

To generate resources for a CRD, you can use the file.

# First dump the CRDs to a file
kubectl get crds -o yaml > crds.yaml

# Then generate the resources
./lib/k8s/bin/ -- ./crds.yaml <output directory>


  1. Fork it ( )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request