empayre/fleet
14
0
Fork 0
mirror of https://github.com/empayre/fleet.git synced 2024-11-07 01:15:22 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
8f048dbce3
fleet/docs/2-Deployment/1-Installation.md

68 lines
3.2 KiB
Markdown
Raw Normal View History

Part 1 of documentation restructure. Deployment section. (#147) This PR includes the Deployment section of the documentation restructure #144. - Changes include the addition of 3 overarching folders/sections named Deployment, Using fleet, and Contribution guide. Each folder includes new files for the subsections. - Move the copy from the appropriate files into the new files in the Deployment folder. Removed old files. A detailed outline of the exact old files can be found in the linked issue above. - Add navigation to the top of each file via links to anchors in the markdown. The naming convention for each folder and file is up for discussion. I chose to use number prefixes (1, 2, 3) to order the folders and files. This way we have control over the order when viewing on GitHub.
2020-12-24 22:00:22 +00:00
# Installation
- [Installing the Fleet binary](#installing-the-fleet-binary)
- [Docker container](#docker-container)
- [Raw binaries](#raw-binaries)
- [Infrastructure dependencies](#infrastructure-dependencies)
- [MySQL](#mysql)
- [Redis](#redis)
Rename Kolide to Fleet in the docs (#1554)
2017-09-21 22:51:26 +00:00
The Fleet application is distributed as a single static binary. This binary serves:
- The Fleet web interface
- The Fleet application API endpoints
- The osquery TLS server API endpoints
Fix markdown link check CI action. (#169) - Split the array of objects to separate objects for each pattern in ignorePatterns. Rename the key in each object to "pattern." The documentation for the example config file is poor. - Add hello@fleetdm.com and /server/datastore/mysql/migrations/ to ignorePatterns - Add 999 to aliveStatucCodes (Seems to be a LinkedIn edge case) - Fix all broken markdown links
2021-01-04 21:55:05 +00:00
All of these are served via a built-in HTTP server, so there is no need for complex web server configurations. Once you've installed the `fleet` binary and it's infrastructure dependencies as illustrated below, refer to the [Configuration](./2-Configuration.md) documentation for information on how to use and configure the Fleet application.
Rename Kolide to Fleet in the docs (#1554)
2017-09-21 22:51:26 +00:00
## Installing the Fleet binary
Because everyone's infrastructure is different, there are a multiple options available for installing the Fleet binary.
Part 1 of documentation restructure. Deployment section. (#147) This PR includes the Deployment section of the documentation restructure #144. - Changes include the addition of 3 overarching folders/sections named Deployment, Using fleet, and Contribution guide. Each folder includes new files for the subsections. - Move the copy from the appropriate files into the new files in the Deployment folder. Removed old files. A detailed outline of the exact old files can be found in the linked issue above. - Add navigation to the top of each file via links to anchors in the markdown. The naming convention for each folder and file is up for discussion. I chose to use number prefixes (1, 2, 3) to order the folders and files. This way we have control over the order when viewing on GitHub.
2020-12-24 22:00:22 +00:00
### Docker container
Rename Kolide to Fleet in the docs (#1554)
2017-09-21 22:51:26 +00:00
Pull the latest Fleet docker image:
```
Changes to additional links for transition to fleetdm (#21)
2020-11-05 05:48:39 +00:00
docker pull fleetdm/fleet
Rename Kolide to Fleet in the docs (#1554)
2017-09-21 22:51:26 +00:00
```
Fix markdown link check CI action. (#169) - Split the array of objects to separate objects for each pattern in ignorePatterns. Rename the key in each object to "pattern." The documentation for the example config file is poor. - Add hello@fleetdm.com and /server/datastore/mysql/migrations/ to ignorePatterns - Add 999 to aliveStatucCodes (Seems to be a LinkedIn edge case) - Fix all broken markdown links
2021-01-04 21:55:05 +00:00
For more information on using Fleet, refer to the [Configuration](./2-Configuration.md) documentation.
Rename Kolide to Fleet in the docs (#1554)
2017-09-21 22:51:26 +00:00
Part 1 of documentation restructure. Deployment section. (#147) This PR includes the Deployment section of the documentation restructure #144. - Changes include the addition of 3 overarching folders/sections named Deployment, Using fleet, and Contribution guide. Each folder includes new files for the subsections. - Move the copy from the appropriate files into the new files in the Deployment folder. Removed old files. A detailed outline of the exact old files can be found in the linked issue above. - Add navigation to the top of each file via links to anchors in the markdown. The naming convention for each folder and file is up for discussion. I chose to use number prefixes (1, 2, 3) to order the folders and files. This way we have control over the order when viewing on GitHub.
2020-12-24 22:00:22 +00:00
### Raw binaries
Rename Kolide to Fleet in the docs (#1554)
2017-09-21 22:51:26 +00:00
Download the latest raw Fleet binaries:
```
Changes to additional links for transition to fleetdm (#21)
2020-11-05 05:48:39 +00:00
curl -LO https://github.com/fleetdm/fleet/releases/latest/download/fleet.zip
Rename Kolide to Fleet in the docs (#1554)
2017-09-21 22:51:26 +00:00
```
Unzip the binaries for your platform:
```
# For a Darwin compatible binary
Update docs and Makefile to use Github releases for binaries (#2055)
2019-06-04 17:42:41 +00:00
unzip fleet.zip 'darwin/*' -d fleet
Updating docs to reference new binary and package (#1557)
2017-10-06 01:33:41 +00:00
./fleet/darwin/fleet_darwin_amd64 --help
Rename Kolide to Fleet in the docs (#1554)
2017-09-21 22:51:26 +00:00
# For a Linux compatible binary
Update docs and Makefile to use Github releases for binaries (#2055)
2019-06-04 17:42:41 +00:00
unzip fleet.zip 'linux/*' -d fleet
Updating docs to reference new binary and package (#1557)
2017-10-06 01:33:41 +00:00
./fleet/linux/fleet_linux_amd64 --help
Rename Kolide to Fleet in the docs (#1554)
2017-09-21 22:51:26 +00:00
```
Fix markdown link check CI action. (#169) - Split the array of objects to separate objects for each pattern in ignorePatterns. Rename the key in each object to "pattern." The documentation for the example config file is poor. - Add hello@fleetdm.com and /server/datastore/mysql/migrations/ to ignorePatterns - Add 999 to aliveStatucCodes (Seems to be a LinkedIn edge case) - Fix all broken markdown links
2021-01-04 21:55:05 +00:00
For more information on using Fleet, refer to the [Configuration](./2-Configuration.md) documentation.
Rename Kolide to Fleet in the docs (#1554)
2017-09-21 22:51:26 +00:00
## Infrastructure Dependencies
Updating docs to reference new binary and package (#1557)
2017-10-06 01:33:41 +00:00
Fleet currently has two infrastructure dependencies in addition to the `fleet` web server itself. Those dependencies are MySQL and Redis.
Rename Kolide to Fleet in the docs (#1554)
2017-09-21 22:51:26 +00:00
Part 1 of documentation restructure. Deployment section. (#147) This PR includes the Deployment section of the documentation restructure #144. - Changes include the addition of 3 overarching folders/sections named Deployment, Using fleet, and Contribution guide. Each folder includes new files for the subsections. - Move the copy from the appropriate files into the new files in the Deployment folder. Removed old files. A detailed outline of the exact old files can be found in the linked issue above. - Add navigation to the top of each file via links to anchors in the markdown. The naming convention for each folder and file is up for discussion. I chose to use number prefixes (1, 2, 3) to order the folders and files. This way we have control over the order when viewing on GitHub.
2020-12-24 22:00:22 +00:00
### MySQL
Rename Kolide to Fleet in the docs (#1554)
2017-09-21 22:51:26 +00:00
Fix markdown link check CI action. (#169) - Split the array of objects to separate objects for each pattern in ignorePatterns. Rename the key in each object to "pattern." The documentation for the example config file is poor. - Add hello@fleetdm.com and /server/datastore/mysql/migrations/ to ignorePatterns - Add 999 to aliveStatucCodes (Seems to be a LinkedIn edge case) - Fix all broken markdown links
2021-01-04 21:55:05 +00:00
Fleet uses MySQL extensively as it's main database. Many cloud providers (such as [AWS](https://aws.amazon.com/rds/mysql/) and [GCP](https://cloud.google.com/sql/)) host reliable MySQL services which you may consider for this purpose. A well supported MySQL [Docker container](https://hub.docker.com/_/mysql/) also exists if you would rather run MySQL in a container. For more information on how to configure the `fleet` binary to use the correct MySQL instance, see the [Configuration](./2-Configuration.md) document.
Rename Kolide to Fleet in the docs (#1554)
2017-09-21 22:51:26 +00:00
Add MySQl version information to infra docs (#1919)
2018-09-11 17:56:14 +00:00
Fleet requires at least MySQL version 5.7.
Add automatic host expiration capability (#2117) When configured, this feature will delete hosts that have not checked in after the specified number of days. Closes #1860.
2019-10-16 23:35:17 +00:00
For host expiry configuration, the [event scheduler](https://dev.mysql.com/doc/refman/5.7/en/events-overview.html) must be enabled. This can be enabled via the command line, configuration file, or a user with the required privileges.
Part 1 of documentation restructure. Deployment section. (#147) This PR includes the Deployment section of the documentation restructure #144. - Changes include the addition of 3 overarching folders/sections named Deployment, Using fleet, and Contribution guide. Each folder includes new files for the subsections. - Move the copy from the appropriate files into the new files in the Deployment folder. Removed old files. A detailed outline of the exact old files can be found in the linked issue above. - Add navigation to the top of each file via links to anchors in the markdown. The naming convention for each folder and file is up for discussion. I chose to use number prefixes (1, 2, 3) to order the folders and files. This way we have control over the order when viewing on GitHub.
2020-12-24 22:00:22 +00:00
### Redis
Rename Kolide to Fleet in the docs (#1554)
2017-09-21 22:51:26 +00:00
Fix markdown link check CI action. (#169) - Split the array of objects to separate objects for each pattern in ignorePatterns. Rename the key in each object to "pattern." The documentation for the example config file is poor. - Add hello@fleetdm.com and /server/datastore/mysql/migrations/ to ignorePatterns - Add 999 to aliveStatucCodes (Seems to be a LinkedIn edge case) - Fix all broken markdown links
2021-01-04 21:55:05 +00:00
Fleet uses Redis to ingest and queue the results of distributed queries, cache data, etc. Many cloud providers (such as [AWS](https://aws.amazon.com/elasticache/) and [GCP](https://console.cloud.google.com/launcher/details/click-to-deploy-images/redis)) host reliable Redis services which you may consider for this purpose. A well supported Redis [Docker container](https://hub.docker.com/_/redis/) also exists if you would rather run Redis in a container. For more information on how to configure the `fleet` binary to use the correct Redis instance, see the [Configuration](./2-Configuration.md) document.
Reference in New Issue Copy Permalink