Skip to content

Commit

Permalink
Merge pull request #583 from opencybersecurityalliance/doc-k2-install
Browse files Browse the repository at this point in the history
Kestrel 2 doc update
  • Loading branch information
subbyte authored Sep 27, 2024
2 parents b457503 + 75dbc5d commit 01fd5fa
Showing 1 changed file with 29 additions and 9 deletions.
38 changes: 29 additions & 9 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,26 @@ Visit `Kestrel documentation`_ to learn Kestrel:
- `How to use Kestrel via API`_
- `How to launch Kestrel as a Docker container`_

Kestrel 2
=========

Kestrel 2 debuts at `Black Hat USA 2024`_. While maintaining the language
syntax from Kestrel 1, we entirely redesign Kestrel 2 runtime to achieve better
performance and more flexible syntax regarding entity, attribute, and relation
representations.

Key features of Kestrel 2:

- Just-in-time compilation instead of interpretation

- Lazy evaluation and the new ``EXPLAIN`` command

- Data Lakehouse optimization with deeply nested query

- OCSF and OpenTelemetry entity/attribute support besides STIX

Kestrel 2 is currently in beta, learn more at `Kestrel runtime installation`_.

Kestrel Huntbooks And Analytics
===============================

Expand Down Expand Up @@ -148,16 +168,16 @@ Connecting With The Community
.. _Kestrel live tutorial in a cloud sandbox: https://mybinder.org/v2/gh/opencybersecurityalliance/kestrel-huntbook/HEAD?filepath=tutorial
.. _Kestrel documentation: https://kestrel.readthedocs.io/

.. _A comprehensive introduction to Kestrel: https://kestrel.readthedocs.io/en/stable/overview/
.. _The two key concepts of Kestrel: https://kestrel.readthedocs.io/en/stable/language/tac.html#key-concepts
.. _A comprehensive introduction to Kestrel: https://kestrel.readthedocs.io/en/latest/overview/
.. _The two key concepts of Kestrel: https://kestrel.readthedocs.io/en/latest/language/tac.html#key-concepts
.. _Interactive tutorial with quiz: https://mybinder.org/v2/gh/opencybersecurityalliance/kestrel-huntbook/HEAD?filepath=tutorial
.. _Kestrel runtime installation: https://kestrel.readthedocs.io/en/stable/installation/runtime.html
.. _How to connect to your data sources: https://kestrel.readthedocs.io/en/stable/installation/datasource.html
.. _How to execute an analytic hunt step in Python/Docker: https://kestrel.readthedocs.io/en/stable/installation/analytics.html
.. _Language reference book: https://kestrel.readthedocs.io/en/stable/language/commands.html
.. _How to use Kestrel via API: https://kestrel.readthedocs.io/en/stable/source/kestrel.session.html
.. _How to launch Kestrel as a Docker container: https://kestrel.readthedocs.io/en/stable/deployment/
.. _Kestrel documentation on talks: https://kestrel.readthedocs.io/en/stable/talks.html
.. _Kestrel runtime installation: https://kestrel.readthedocs.io/en/latest/installation/runtime.html
.. _How to connect to your data sources: https://kestrel.readthedocs.io/en/latest/installation/datasource.html
.. _How to execute an analytic hunt step in Python/Docker: https://kestrel.readthedocs.io/en/latest/installation/analytics.html
.. _Language reference book: https://kestrel.readthedocs.io/en/latest/language/commands.html
.. _How to use Kestrel via API: https://kestrel.readthedocs.io/en/latest/source/kestrel.session.html
.. _How to launch Kestrel as a Docker container: https://kestrel.readthedocs.io/en/latest/deployment/
.. _Kestrel documentation on talks: https://kestrel.readthedocs.io/en/latest/talks.html

.. _Kestrel huntbook: https://github.com/opencybersecurityalliance/kestrel-huntbook
.. _Kestrel analytics: https://github.com/opencybersecurityalliance/kestrel-analytics
Expand Down

0 comments on commit 01fd5fa

Please sign in to comment.