Commit c3cf7e25 authored by Eyar's avatar Eyar
Browse files

docs: update readme file

parent ac77db9a
Showing with 32 additions and 6 deletions
+32 -6
[![datree-logo](https://raw.githubusercontent.com/datreeio/datree/master/images/datree_LOGO-180px.png)](#)
[![datree-logo](https://raw.githubusercontent.com/datreeio/datree/main/images/datree_LOGO-180px.png)](#)
![Travis (.com) branch](https://img.shields.io/travis/com/datreeio/datree/staging?label=build-staging)
![Travis (.com) branch](https://img.shields.io/travis/com/datreeio/datree/main?label=build-main)
![open issues](https://img.shields.io/github/issues-raw/datreeio/datree)
[![HitCount](http://hits.dwyl.com/datreeio/datree.svg)](http://hits.dwyl.com/datreeio/datree)
# Prevent Kubernetes misconfigurations from ever making it to production
## What is Datree?
[Datree](https://datree.io/?utm_source=github&utm_medium=organic_oss) helps to prevent Kubernetes misconfigurations from ever making it to production.
The CLI integration provides policies enforcement solution for Kubernetes to run automatic checks on every pull request for rule violations and misconfigurations. When rule violations are found, Datree prevents merging and shows the developer instructions to understand and fix the issue inside the CI process.
## Support
## Quick start in two steps
#### 1. Install the latest release on your CLI
**MacOS:** ``curl https://get.datree.io | /bin/sh``
**Linux:** ``curl https://get.datree.io/install-linux.sh | /bin/sh``
**Windows:** ``not supported yet :(``
#### 2. Pass datree a Kuberntes manifest file
``datree test <k8s-manifest-file>``
...and voilà, you just made your first invocation! 🥳
In your CLI, you will see something like that:
[![datree-cli-output](https://raw.githubusercontent.com/datreeio/datree/main/images/CLI-output.png)](#)
[Datree](https://bridgecrew.io/?utm_source=github&utm_medium=organic_oss) builds and maintains this project to make Kubernetes policies simple and accessible.
#### Ready to review our "Getting Started" guide?
All the information that is needed to explore a bunch of other cool feature, or how to set up your policy, can be found in [**our docs**](https://hub.datree.io/getting-started/?utm_source=github&utm_medium=organic_oss).
Start with our [documentation](https://hub.datree.io/?utm_source=github&utm_medium=organic_oss) for quick tutorials and examples.
## Built-in rules
Right now, there are 30 battle-tested rules for you to choose from.
The rules are covering different Kubernetes resources/use-cases:
* [Workload](https://hub.datree.io/workload/?utm_source=github&utm_medium=organic_oss)
* [CronJob](https://hub.datree.io/cronjob/?utm_source=github&utm_medium=organic_oss)
* [Containers](https://hub.datree.io/containers/?utm_source=github&utm_medium=organic_oss)
* [Networking](https://hub.datree.io/networking/?utm_source=github&utm_medium=organic_oss)
* [Deprecation](https://hub.datree.io/deprecation/?utm_source=github&utm_medium=organic_oss)
* [Other](https://hub.datree.io/other/?utm_source=github&utm_medium=organic_oss)
## Support
If you need direct support you can contact us at support@datree.io.
[Datree](https://datree.io/?utm_source=github&utm_medium=organic_oss) builds and maintains this project to make Kubernetes policies simple and accessible.
Start with our [documentation](https://hub.datree.io/?utm_source=github&utm_medium=organic_oss) for quick tutorials and examples.
If you need direct support you can contact us at support@datree.io.
\ No newline at end of file
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment