Skip to content

Commit

Permalink
updates to the readme based on feedback
Browse files Browse the repository at this point in the history
Signed-off-by: AnaisUrlichs <urlichsanais@gmail.com>
  • Loading branch information
AnaisUrlichs committed Aug 15, 2023
1 parent 630a773 commit 54c4817
Showing 1 changed file with 8 additions and 10 deletions.
18 changes: 8 additions & 10 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,35 +13,33 @@ Tracee provides a rich filtering mechanism that allows you to eliminate noise an
**Key Features:**
* Kubernetes native installation
* Hundreds of default events
* Up-to-date tracking of malicious behaviour through signatures provided by the Aqua Security Research Team
* Ships with basic set of behavioral signatures for malicious detection out of the box
* Easy configuration through Tracee Policies
* Accessible user experience for cluster administrators
* Kubernetes native user experience that is targetted at cluster administrators

> We release new features and changes on a monthly basis. Learn more about the letest release in our [discussions.](https://github.com/aquasecurity/tracee/discussions)
**Integrations**
To learn more about Tracee, check out the [documentation](https://aquasecurity.github.io/tracee/latest/docs/overview/).

* Rego: You can easily define custom events that you would like Tracee to track using the popular [Rego](https://www.openpolicyagent.org/docs/latest/policy-language/) language.
* Monitoring: Additionally, we have several tutorials that showcase integration between monitoring solutions and Tracee.
## Quickstart

Either:
* [Install Tracee in your Kubernetes cluster.](https://aquasecurity.github.io/tracee/latest/getting-started/kubernetes-quickstart)
* [Experiment using the Tracee container image.](https://aquasecurity.github.io/tracee/v0.17/#quickstart)
* [Experiment using the Tracee container image.](https://aquasecurity.github.io/tracee/latest/#quickstart)

Steps to get started:
1. [Install Tracee in your Kubernetes cluster through Helm]()
2. [Query logs to see detected events]()
1. [Install Tracee in your Kubernetes cluster through Helm](https://aquasecurity.github.io/tracee/latest/getting-started/kubernetes-quickstart/)
2. Query logs to see detected events
3. Filter events through [Tracee Policies](https://aquasecurity.github.io/tracee/latest/tutorials/k8s-policies/)
4. [Manage logs through Grafana Loki](https://aquasecurity.github.io/tracee/latest/tutorials/promtail/) or your preferred monitoring solution

To learn more about Tracee, check out the [documentation](https://aquasecurity.github.io/tracee/latest/docs/overview/).
[The tutorials section showcases](https://aquasecurity.github.io/tracee/latest/tutorials/overview/) integration between monitoring solutions and Tracee.

![Example log output in Tracee pod](./docs/images/log-example.png)
Example log output in Tracee pod
## Contributing

Join the community, and talk to us about any matter in [GitHub Discussion](https://github.com/aquasecurity/tracee/discussions) or [Slack](https://slack.aquasec.com).
Join the community, and talk to us about any matter in the [GitHub Discussions](https://github.com/aquasecurity/tracee/discussions) or [Slack](https://slack.aquasec.com).
If you run into any trouble using Tracee or you would like to give use user feedback, please [create an issue.](https://github.com/aquasecurity/tracee/issues)

Find more information on [contributing to the source code](https://aquasecurity.github.io/tracee/latest/contributing/overview/) in the documentation.
Expand Down

0 comments on commit 54c4817

Please sign in to comment.