Skip to content

Add documentation about tool dependencies #16107

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kvch merged 5 commits into from
Feb 6, 2020
Merged

Add documentation about tool dependencies #16107

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
bdf95cf
add information about tool dependencies
kvch Feb 5, 2020
6fd1d1f
add flatbuffers version
kvch Feb 5, 2020
d22ca20
Fix the name of FlatBuffers
kvch Feb 5, 2020
5d29c50
add one more sentence
kvch Feb 5, 2020
b6fbf9b
add missing float attributes to titles
kvch Feb 6, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions docs/devguide/contributing.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,12 +172,37 @@ your browser with the docs for preview.
[[dependencies]]
=== Dependencies

Comment thread
kvch marked this conversation as resolved.
In order to create Beats we rely on Golang libraries and other
external tools.

[float]
==== Golang

To manage the `vendor/` folder we use
https://github.com/kardianos/govendor[govendor]. Please see
the govendor documentation on how to add or update vendored dependencies.

In most cases `govendor fetch your/dependency@version +out` will get the job done.

[float]
==== Other dependencies

Besides Go libraries, we are using development tools to generate parsers for inputs and processors.

The following packages are required to run `go generate`:

[float]
===== Auditbeat

* FlatBuffers >= 1.9

[float]
===== Filebeat

* Graphviz >= 2.43.0
* Ragel >= 6.10


[float]
[[changelog]]
=== Changelog
Expand Down