fleet/docs/infrastructure/README.md
noahtalerman 268b752366
Change name to Fleet in documentation. (#77)
In the documentation, all references to the Fleet product now use "Fleet" instead of "Kolide Fleet"
2020-12-01 13:34:08 -05:00

2.7 KiB

Infrastructure Documentation

Fleet is an infrastructure instrumentation application which has it's own infrastructure dependencies and requirements. The infrastructure documentation contains documents on the following topics:

Deploying and configuring osquery

  • For information on installing osquery on hosts that you own, see our Adding Hosts To Fleet document, which complements existing osquery documentation.
  • To add hosts to Fleet, you will need to provide a minimum set of configuration to the osquery agent on each host. These configurations are defined in the aforementioned Adding Hosts To Fleet document. If you'd like to further customize the osquery configurations and options, this can be done via fleetctl. You can find more documentation on this feature in the fleetctl documentation.
  • To manage osquery configurations at your organization, we strongly suggest using some form of configuration management tooling. For more information on configuration management, see the Managing Osquery Configurations document.

Installing Fleet and its dependencies

The Fleet server has a few infrastructure dependencies. To learn more about installing the Fleet server and it's dependencies, see the Installing Fleet guide.

Managing a Fleet server

We're prepared a brief guide to help you manage and maintain your Fleet server. Check out the guide for setting up and running Fleet on Ubuntu and Fleet on CentOS.

For more information, you can also read the Configuring The Fleet Binary guide for information on how to configure and customize Fleet for your organization.

Once the Fleet server is installed and configured, take a look at the Monitoring & Alerting documentation.

Working with osquery logs

Fleet allows users to schedule queries, curate packs, and generate a lot of osquery logs. For more information on how you can access these logs as well as examples on what you can do with them, see the Working With Osquery Logs documentation.

File Carving

Learn how to work with the osquery file carving functionality to extract file contents in the File Carving documentation.

Troubleshooting & FAQ

Check out the Frequently Asked Questions, which include troubleshooting steps for the most common issues experience by Fleet users.

Security

Fleet developers have documented how Fleet handles the OWASP Top 10.