What is Datree?
Datree is a CLI tool that supports Kubernetes admins in their roles by preventing developers from making errors in Kubernetes configurations that can cause clusters to fail in production. Our CLI tool is open source, enabling it to be supported by the Kubernetes community.
It’s far more effective than manual processes, such as sending an email to a slew of developers, begging them to set various limits, which likely falls on deaf ears because developers are already overwhelmed.
How it Works
The CLI integration provides a policy enforcement solution for Kubernetes to run automatic checks on every code change for rule violations and misconfigurations. When rule violations are found, Datree produces an alert that guides the developer to fix the issue inside the CI process — or even earlier as a pre-commit hook — while explaining the reason behind the rule.
Quick start in two steps
1. Install the latest release on your CLI
Linux & MacOS: curl https://get.datree.io | /bin/bash
Windows: iwr -useb https://get.datree.io/windows_install.ps1 | iex
Other installation options (Homebrew, Docker, etc.) can be found here
2. Pass datree a Kubernetes manifest file to scan
datree test [k8s-manifest-file]
...and voilà, you just ran your first invocation! 🥳
Command Line Interface
Web Application Interface
Playground
You can also checkout our interactive demo scenario on Katacoda without having to install anything on your machine.
Ready to review our "Getting Started" guide?
All the information needed to get started, as well as a bunch of other cool features (including how to set up your policy), can be found in our docs.
Helm plugin
Datree's Helm plugin can be accessed through the helm CLI, to provide a seamless experience to Helm users:
helm plugin install https://github.com/datreeio/helm-datree
Built-in schema & policy validation
Every check will validate your schema. In addition, there are 30 battle-tested rules for you to select to create your policy.
The policy rules cover a variety of Kubernetes resources and use cases:
Custom rules
In additon to our built-in rules, you can write any custom rule you wish, and then run them against your Kubernetes configurations to check for rule violations. The custom rule engine is based on JSON Schema.
Support
Datree builds and maintains this project to make Kubernetes policies simple and accessible. Start with our documentation for quick tutorials and examples.
Disclaimer
We do our best to maintain backward compatibility, but there may be breaking changes in the future to the command usage, flags, and configuration file formats. The CLI will output a warning message when a new version with breaking changes is detected. We encourage you to use Datree to test your Kubernetes manifests files and Helm charts, see what breaks, and contribute.