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

Commit 0c3b63e

Browse files
author
Eyar Zilberman
authored
docs: deprecation notice (#964)
1 parent 0b67300 commit 0c3b63e

File tree

1 file changed

+12
-64
lines changed

1 file changed

+12
-64
lines changed

README.md

+12-64
Original file line numberDiff line numberDiff line change
@@ -9,52 +9,27 @@
99
<img src="https://img.shields.io/github/downloads/datreeio/datree/total.svg" target="_blank"></a>
1010
<img src="https://goreportcard.com/badge/github.com/datreeio/datree" target="_blank"></a>
1111
</p>
12-
13-
<p align="center">
14-
<a href="https://bit.ly/3BHwCEG" target="_blank">
15-
<img src="https://img.shields.io/badge/Slack-4A154B?logo=slack&color=black&logoColor=white&style=for-the-badge alt="Join our Slack!" width="80" height="30">
16-
</a>
17-
</p>
1812

1913
<p align="center">
2014
<a href="https://hub.datree.io/#utm_source=github&utm_medium=organic_oss"><strong>Explore the docs »</strong></a>
2115
<br />
2216
</p>
2317

24-
# Datree
25-
26-
[Datree](https://www.datree.io/) (pronounced `/da-tree/`) secures your Kubernetes by blocking the deployment of misconfigured resources.
18+
# Datree [DEPRECATED]
2719

28-
## ✌️ Quick-start in two steps
20+
[Datree](https://www.datree.io/) (pronounced `/da-tree/`) was built to secure Kubernetes workloads by blocking the deployment of misconfigured resources. **Since July 2023, the commercial company that supports and actively maintains this project has been closed.**
2921

30-
Install Datree to get insights on the status of your cluster and enforce your desired policies on new resources.
22+
## Migrating to the (fully) open-source version of Datree
3123

32-
> **NOTE:**
33-
> By default, Datree does not block misconfigured resources, it only monitors and alerts about them.
34-
> To enable **enforcement mode**, see the [documentation](https://hub.datree.io/setup/behavior#options).
24+
For existing users, it is still possible to run Datree as a standalone: https://hub.datree.io/cli/offline-mode
3525

36-
### 1. Add the Datree Helm repository
37-
Run the following command in your terminal:
38-
```terminal
39-
helm repo add datree-webhook https://datreeio.github.io/admission-webhook-datree
40-
helm repo update
41-
```
26+
## What will not be available anymore
4227

43-
### 2. Install Datree on your cluster
44-
Replace `<DATREE_TOKEN>` with the token from your [dashboard](https://app.datree.io/), and run the following command in your terminal:
45-
46-
```terminal
47-
helm install -n datree datree-webhook datree-webhook/datree-admission-webhook --debug \
48-
--create-namespace \
49-
--set datree.token=<DATREE_TOKEN> \
50-
--set datree.clusterName=$(kubectl config current-context)
51-
```
52-
53-
This will create a new namespace (datree), where Datree’s services and application resources will reside. `datree.token` is used to connect your dashboard to your cluster. Note that the installation can take up to 5 minutes.
54-
55-
**Looking for a different installation method?**
56-
<a href="https://hub.datree.io"><img width="45px" src="/images/argo.png" /></a>&nbsp;&nbsp;<a href="https://hub.datree.io"><img width="45px" src="/images/flux.png" /></a>&nbsp;&nbsp;<a href="https://hub.datree.io"><img width="45px" src="/images/openshift.png" /></a>
57-
Datree also supports installation via **ArgoCD**, **Flux** and **Openshift**. See our [documentation](https://hub.datree.io/) for instructions.
28+
All the archived open source repositories under datreeio org will no longer be maintained and accept any new code changes, including any security patches.
29+
In addition, the following key capabilities will not longer be available anymore:
30+
* Centralized policy registry
31+
* Automatic Kubernetes schema validation
32+
* Access to the dashboard and all of its components (e.g. activity-log page, token management, etc.)
5833

5934
## ⚙️ How it works
6035

@@ -64,35 +39,8 @@ Datree comes with over 100 rules covering various use-cases, such as workload se
6439

6540
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).
6641

67-
## 📊 Management dashboard (web application)
68-
69-
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.
70-
71-
Datree can be configured via code or via the dashboard. The dashboard offers the following capabilities in an intuitive visual interface:
72-
* Control Datree's configuration:
73-
* Default action on failure - set whether resources that failed the policy check should be blocked or only monitored
74-
* Set which policy to use for your checks
75-
* Define resources and/or namespaces to ignore
76-
* Create & customize policies
77-
* Edit rules' failure message
78-
* Issue tokens
79-
* View policy check history
80-
* Configure Kubernetes schema version
81-
82-
<img src="/images/dashboard-policies.png" alt="Datree-saas" width="70%">
83-
84-
## 🤩 Additional features
85-
86-
Datree offers a suite of features to make adoption seamless:
87-
* **Monitoring** - By default, Datree is installed in monitoring mode and does not block deployments until you decide to do so.
88-
* [**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.
89-
* **Simple integrations** - Datree works seamlessly with popular CD tools such as ArgoCD and FluxCD, and comes with ready-made integrations for various CI platforms.
90-
* **Cluster score** - Rank the stability of your cluster based on the number of detected misconfigurations.
91-
9242
## Contributing
9343

94-
[Contributions](https://github.com/datreeio/datree/issues?q=is%3Aissue+is%3Aopen+label%3A%22up+for+grabs%22) are welcome!
95-
44+
We want to thank our contributors for helping us build Datree ❤️
45+
9646
[![Contributors](https://contrib.rocks/image?repo=datreeio/datree)](https://github.com/datreeio/datree/graphs/contributors)
97-
98-
Thank you to all the people who already contributed to Datree ❤️

0 commit comments

Comments
 (0)