mirror of
https://github.com/empayre/fleet.git
synced 2024-11-06 08:55:24 +00:00
1d0aa1f318
# Checklist for submitter If some of the following don't apply, delete the relevant line. - [ ] Changes file added for user-visible changes in `changes/` or `orbit/changes/`. See [Changes files](https://fleetdm.com/docs/contributing/committing-changes#changes-files) for more information. - [ ] Documented any API changes (docs/Using-Fleet/REST-API.md or docs/Contributing/API-for-contributors.md) - [ ] Documented any permissions changes (docs/Using Fleet/manage-access.md) - [ ] Input data is properly validated, `SELECT *` is avoided, SQL injection is prevented (using placeholders for values in statements) - [ ] Added support on fleet's osquery simulator `cmd/osquery-perf` for new osquery data ingestion features. - [ ] Added/updated tests - [ ] Manual QA for all new/changed functionality - For Orbit and Fleet Desktop changes: - [ ] Manual QA must be performed in the three main OSs, macOS, Windows and Linux. - [ ] Auto-update manual QA, from released version of component to new version (see [tools/tuf/test](../tools/tuf/test/README.md)).
49 lines
2.0 KiB
Markdown
49 lines
2.0 KiB
Markdown
This module provides a basic Fleet setup. This assumes that you bring nothing to the installation.
|
|
If you want to bring your own VPC/database/cache nodes/ECS cluster, then use one of the submodules provided.
|
|
|
|
To quickly list all available module versions you can run:
|
|
```shell
|
|
git tag |grep '^tf'
|
|
```
|
|
|
|
The following is the module layout, so you can navigate to the module that you want:
|
|
|
|
* Root module (use this to get a Fleet instance ASAP with minimal setup)
|
|
* BYO-VPC (use this if you want to install Fleet inside an existing VPC)
|
|
* BYO-database (use this if you want to use an existing database and cache node)
|
|
* BYO-ECS (use this if you want to bring your own everything but Fleet ECS services)
|
|
|
|
# Migrating from existing Dogfood code
|
|
The below code describes how to migrate from existing Dogfood code
|
|
|
|
```hcl
|
|
moved {
|
|
from = module.vpc
|
|
to = module.main.module.vpc
|
|
}
|
|
|
|
moved {
|
|
from = module.aurora_mysql
|
|
to = module.main.module.byo-vpc.module.rds
|
|
}
|
|
|
|
moved {
|
|
from = aws_elasticache_replication_group.default
|
|
to = module.main.module.byo-vpc.module.redis.aws_elasticache_replication_group.default
|
|
}
|
|
```
|
|
|
|
This focuses on the resources that are "heavy" or store data. Note that the ALB cannot be moved like this because Dogfood uses the `aws_alb` resource and the module uses the `aws_lb` resource. The resources are aliases of eachother, but Terraform can't recognize that.
|
|
|
|
# How to improve this module
|
|
If this module somehow doesn't fit your needs, feel free to contact us by
|
|
opening a ticket, or contacting your contact at Fleet. Our goal is to make this module
|
|
fit all needs within AWS, so we will try to find a solution so that this module fits your needs.
|
|
|
|
If you want to make the changes yourself, simply make a PR into main with your additions.
|
|
We would ask that you make sure that variables are defined as null if there is
|
|
no default that makes sense and that variable changes are reflected all the way up the stack.
|
|
|
|
# How to update this readme
|
|
Edit .header.md and run `terraform-docs markdown . > README.md`
|