Skip to content
This repository has been archived by the owner on Jun 6, 2024. It is now read-only.

Commit

Permalink
docs: update readme including config as a service support (#929)
Browse files Browse the repository at this point in the history
* docs: update readme including config as a service support

* docs: update readme
  • Loading branch information
hadar-co authored May 2, 2023
1 parent b301937 commit 0f52763
Showing 1 changed file with 19 additions and 13 deletions.
32 changes: 19 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,29 +56,35 @@ This will create a new namespace (datree), where Datree’s services and applica

Datree scans Kubernetes resources against a centrally managed policy, and blocks those that violate your desired policies.

Datree comes with multiple pre-built policies covering various use-cases, such as workload security, high availability, ArgoCD best practices, NSA hardening guide, and [many more](https://hub.datree.io/built-in-rules).
Datree comes with over 100 rules covering various use-cases, such as workload security, high availability, ArgoCD best practices, NSA hardening guide, and [many more](https://hub.datree.io/built-in-rules).

In addition to our built-in rules, you can write [any custom rule you wish](https://hub.datree.io/custom-rules-overview) and then run it against your Kubernetes configurations to check for rule violations. The custom rule engine is based on JSON Schema.

## 🤩 Additional features

Datree offers a suite of features to make adoption seamless:
* **Monitoring** - Datree is first installed in monitoring mode that reports on policy violations, rather than block their deployments.
* [**CLI**](https://hub.datree.io/cli/getting-started) - Help your developers find misconfigurations in their configs before deploying them, by integrating Datree into their CI.
* **Misconfiguration prioritization** - Datree makes it easy to improve the quality of your cluster by prioritizing the misconfigurations to be fixed.
* **Cluster score** - Rank the stability of your cluster based on the number of detected misconfigurations.
In addition to our built-in rules, you can write [any custom rule you wish](https://hub.datree.io/custom-rules-overview) and then run it against your Kubernetes configurations to check for rule violations. Custom rules can be written in [JSON schema](https://hub.datree.io/custom-rules/custom-rules-overview) or in [Rego](https://hub.datree.io/custom-rules/rego-support).

## 📊 Management dashboard (web application)

Datree can be customized via code (policy as code) or via a management dashboard. The dashboard offers the following capabilities in an intuitive visual interface:
* Customize policies
* Edit rules failure message
Datree's dashboard provides valuable information about your clusters' health and stability. It details the resources that failed your policy checks, and shows you how to fix each violation.

Datree can be configured via code or via the dashboard. The dashboard offers the following capabilities in an intuitive visual interface:
* Control Datree's configuration:
* Default action on failure - set whether resources that failed the policy check should be blocked or only monitored
* Set which policy to use for your checks
* Define resources and/or namespaces to ignore
* Create & customize policies
* Edit rules' failure message
* Issue tokens
* View policy check history
* Configure Kubernetes schema version

<img src="/images/dashboard-policies.png" alt="Datree-saas" width="70%">

## 🤩 Additional features

Datree offers a suite of features to make adoption seamless:
* **Monitoring** - Datree is first installed in monitoring mode that reports on policy violations, rather than block their deployments.
* [**CLI**](https://hub.datree.io/cli/getting-started) - Help your developers find misconfigurations in their configs before deploying them, by integrating Datree into their CI.
* **Simple integrations** - Datree works seamlessly with popular CD tools such as ArgoCD and FluxCD, and comes with ready-made integrations for various CI platforms.
* **Cluster score** - Rank the stability of your cluster based on the number of detected misconfigurations.

## Contributing

[Contributions](https://github.com/datreeio/datree/issues?q=is%3Aissue+is%3Aopen+label%3A%22up+for+grabs%22) are welcome!
Expand Down

0 comments on commit 0f52763

Please sign in to comment.