Skip to content
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.

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

[Server config] Speed up bootstrap package delivery w/ CloudFront #24702

Merged
merged 7 commits into from
Dec 17, 2024
Merged
Changes from all commits
Commits
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
40 changes: 40 additions & 0 deletions docs/Configuration/fleet-server-configuration.md
Copy link
Member Author

@marko-lisica marko-lisica Dec 16, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Dev note:

  • If user configure s3_software_installers_cloudfront_url_signing_public_key_id or s3_software_installers_cloudfront_url_signing_private_key without previously configuring s3_software_installers_cloudfront_url , show error:

    Error: Couldn't configure. "s3_software_installers_cloudfront_url" must be set to use `s3_software_installers_cloudfront_url_signing_public_key_id` and `s3_software_installers_cloudfront_url_signing_private_key`.
    
  • If user configure s3_software_installers_cloudfront_url and one of s3_software_installers_cloudfront_url_signing_public_key_id and s3_software_installers_cloudfront_url_signing_private_key , show error:

    Error: Couldn't configure. Both `s3_software_installers_cloudfront_url_signing_public_key_id` and `s3_software_installers_cloudfront_url_signing_private_key` must be set for URL signing.
    

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If user configure s3_software_installers_cloudfront_url only, show error:

Error: Couldn't configure. Both `s3_software_installers_cloudfront_url_signing_public_key_id` and `s3_software_installers_cloudfront_url_signing_private_key` must be set when CloudFront distribution URL is set.

Original file line number Diff line number Diff line change
Expand Up @@ -2091,6 +2091,46 @@ Minio users must set this to any nonempty value (eg. `minio`), as Minio does not
software_intallers_region: us-east-1
```

### s3_software_installers_cloudfront_url

CloudFront URL. Leave blank if you don't use CloudFront distribution.

- Default value: none
- Environment variable: `FLEET_S3_SOFTWARE_INSTALLERS_CLOUDFRONT_URL`
- Config file format:
```yaml
s3:
software_intallers_cloudfront_url: https://jkl8dxv87sdh.cloudfront.net
```

### s3_software_installers_cloudfront_url_signing_public_key_id

Public key ID for URL signing. If `s3_software_installers_cloudfront_url` is set, this is required.

- Default value: none
- Environment variable: `FLEET_S3_SOFTWARE_INSTALLERS_CLOUDFRONT_URL_SIGNING_PUBLIC_KEY_ID`
- Config file format:
```yaml
s3:
software_intallers_cloudfront_url_signing_public_key_id: 1babd7e98b03
```

### s3_software_installers_cloudfront_url_signing_private_key

Private key for URL signing. If `s3_software_installers_cloudfront_url` is set, this is required.

- Default value: none
- Environment variable: `FLEET_S3_SOFTWARE_INSTALLERS_CLOUDFRONT_URL_SIGNING_PRIVATE_KEY`
- Config file format:
```yaml
s3:
software_intallers_cloudfront_url_signing_private_key: |
------BEGIN BEGIN RSA PRIVATE KEY-----
3126756bd0c54fbc90c9928ef59e7037af8983afd10048929ae5
7473e62c7aed...
```


### s3_carves_bucket

Name of the S3 bucket for file carves.
Expand Down
Loading