Commit graph

380 commits

Author SHA1 Message Date
noahtalerman
7aa380b0f0
Add testing fleetctl to the manual QA doc and update example config files (#1213)
- Update enroll secret config file with updated fields for Fleet 4.0.0
- Remove agent options config file. In Fleet 4.0.0, agent options are part of the organization settings configuration
2021-06-25 17:56:00 -04:00
noahtalerman
9ca91e7db6
Add information about use of differential queries in Lambda documentation (#1195) 2021-06-25 10:23:35 -04:00
noahtalerman
bf4eb899c6
Add usage statistics documentation to Using-Fleet section (#1196)
- Add new `usage-statistics.md` file
- Update link in the Fleet UI to point towards new docs
2021-06-24 16:59:25 -04:00
RachelElysia
aeb852e168
Remove username from UI (#1168)
* Remove username from UI code
* Remove username from tests
* Remove username from database
* Modify server endpoints for removing username
* Implement backend aspects of removing username
* Update API docs
* Add name to fleetctl
2021-06-24 13:42:29 -07:00
noahtalerman
be2cf92b37
Add documentation for setting global and team agent options in Fleet UI (#1190)
- Add "Configuring agent options" section to `/1-Using-Fleet/1-Fleet-UI.md`
- Add 2 screenshots: 1. Global agent options form 2. Team agent options form
2021-06-24 13:59:41 -04:00
Zach Wasserman
1417d01407
Make naming of host columns consistent (#1183)
Adding consistency between API and DB helps to make it easier for users
and developers working with the API to correctly order things.

Closes #317
2021-06-23 17:32:19 -07:00
aggiechris
a5bf3d8099
Add hint for flag file on Windows (#1178) 2021-06-23 17:41:27 -04:00
William Theaker
7bd4f2d395
Update SSO token docs (#1180) 2021-06-23 16:03:34 -04:00
William Theaker
f3ef70358a
Replace Okta image, compress others. (#1166) 2021-06-23 08:27:45 -07:00
Zach Wasserman
879774e60c
Add documentation on new --dev_license flag (#1165)
This flag makes it easier for developers to run Fleet in Fleet Basic
tier.
2021-06-22 18:02:40 -07:00
Zach Wasserman
5ad1ad1ffd
Update development documentation for SSO testing (#1161) 2021-06-22 14:31:26 -07:00
noahtalerman
a63a0ab6f2
Add license section to configuration documentation (#1157) 2021-06-21 18:57:50 -04:00
noahtalerman
e02b88d010
Update links to documentation so that they use main branch (#1151)
* Update to main branch

* Update link to releasing Fleet
2021-06-21 16:40:15 -05:00
noahtalerman
17a6c21224
Restructure documentation in preparation for docs living on fleetdm.com (#1143)
* Remove Orbit top level folder and rename folders to Deploying and Contributing

* Update link in doc README
2021-06-18 15:58:21 -05:00
Zach Wasserman
2ad557e3b3 Merge branch 'main' into teams 2021-06-18 09:42:20 -07:00
noahtalerman
7fb6a36a49
Move testing email using Mailhog out of the FAQ (#1122)
- Move instructions for connecting to the Mailhog simulated server out of the FAQ
- Merge instructions found in FAQ with existing instructions in `Testing.md`
2021-06-17 15:25:42 -04:00
Zach Wasserman
6b59a40dbc
Add backend and fleetctl support for API-only user (#1119)
- Add api_only to users table.
- Pass api_only values through service.
- Allow setting api_only in `fleetctl user create`.

Backend part of #402
2021-06-16 18:11:28 -07:00
RachelElysia
dea20a96b2
Add team's enroll secret GET request to API docs 2021-06-16 18:09:49 -04:00
Mike McNeil
0455ee144b
prepare docs so that images work on website (#1103) 2021-06-15 18:16:16 -05:00
noahtalerman
f9ce8c9a0f
Add question and answer for missing column error in Using Fleet FAQ (#1076)
- Point users to the upgrading Fleet docs (running database migrations) to resolve `unknown column` error
2021-06-14 11:48:27 -04:00
William Theaker
543f7144d8
Update docs to reflect IDP-initiated SAML support (#1057) 2021-06-11 13:12:04 -07:00
Zach Wasserman
e7cffa221d
Update release documentation (#1060) 2021-06-10 17:08:43 -07:00
gillespi314
676f3f0bd5
Query library improvements -- Round 2 (#973)
-Modify build-static-content back-end script to implement GitHub Users API and build contributor profile information into query library pages
-Remove related functionality from client-side page scripts
-Add dropdown menu to select filters
-Refine html and css
2021-06-10 12:57:37 -05:00
Mike McNeil
fccc58536b
Update 3-REST-API.md (#1052) 2021-06-10 12:54:12 -05:00
noahtalerman
718c644471
Documentation for RBAC and teams (#472)
- Add permissions.md and teams.md
2021-06-09 19:12:45 -04:00
noahtalerman
9b6c8d36e4
Additions and changes to Fleet REST API for multiple teams (#383)
- Add API documentation for Teams and RBAC features support
2021-06-09 19:11:48 -04:00
Mike McNeil
afacdcff90
fingers crossed 2021-06-07 18:26:22 -05:00
noahtalerman
8b13e354f8
Add link to simulated host instructions in Testing docs (#997)
- Add link testing documentation that points to instructions for starting up containerized hosts in the development environment.
2021-06-07 19:07:18 -04:00
Zach Wasserman
f75a2fc739
Fix up test osquery tooling (#996)
- Update certificate paths.
- Update documentation to point to the appropriate docs.
2021-06-07 13:34:17 -07:00
Zach Wasserman
6013194c1d
Reduce default session duration to 4 hours (#981) 2021-06-06 18:28:47 -07:00
Zach Wasserman
0356115b03
Remove JWT in Fleet session management (#979)
See #978 for motivations for this change.

Closes #978.
2021-06-06 18:10:58 -07:00
Zach Wasserman
db459d3363
Continue to update names in backend code and docs (#976) 2021-06-06 16:58:23 -07:00
Zach Wasserman
fa01df79d5 Merge branch 'master' into teams 2021-06-05 06:27:38 -07:00
Zach Wasserman
08d57b40d1
Remove deprecated kolide names from API routes and configuration (#957)
Closes #260
2021-06-04 16:51:18 -07:00
Zach Wasserman
16a8e13f85
Fix tls_compatibility key in yaml config (#955)
Closes #271
2021-06-04 08:44:36 -07:00
Martavis Parker
cb2682c273
Remove detection for OS during contributor build (#922) (#933)
- No longer detecting for OS make commands
- Using the same internal commands for every OS
- go.sum auto-updated during build
- Document build process on Windows
2021-06-04 08:10:25 -07:00
Mike McNeil
8b04c0c634
make example work from root dir of repo 2021-06-04 01:35:59 -05:00
noahtalerman
fa09131a5c
Specify that Fleet does not support Redis Sentinel in Configuration docs (#925) 2021-06-02 12:34:51 -04:00
noahtalerman
2dca66c33d
Add Fleet Core and Fleet Basic user/team creation scripts for manual QA (#919)
- Add `teams/create_core` script
- Add `teams/create_basic` script
- Rename existing script to `teams/create_figma`
2021-06-01 14:50:07 -04:00
Zach Wasserman
417ef2c9b6
Refactor teams service methods (#910)
- Move team-related service methods to `ee/server/service`.
- Instantiate different service on startup based on license key.
- Refactor service errors into separate package.
- Add support for running E2E tests in both Core and Basic tiers.
2021-05-31 17:07:51 -07:00
Zach Wasserman
9876dbe6b6
Implement license loading and validation (#908)
- Load license from ES256 signed JWT key.
- Parse license claims into LicenseInfo struct.
- Update contribution documentation with sample license key.

Closes #816.
2021-05-31 11:35:15 -07:00
Zach Wasserman
a5bd03e5d7 Merge branch 'master' into teams 2021-05-31 10:56:50 -07:00
Zach Wasserman
64f2cfc9cd
Refactor enroll secrets to support Teams (#903)
- Add `team_id` field to secrets.
- Remove secret `name` and `active` fields (migration deletes inactive secrets).
- Assign hosts to Team based on secret provided.
- Add API for retrieving secrets by Team.
2021-05-31 09:02:05 -07:00
Mike McNeil
7bb202f961
Publish fleetdm.com/queries (#899)
* /sandbox/queries becomes /queries, etc

* Publish fleetdm.com/queries

Expose query library routes the rest of the way, move remediation data sanitization to the point of entry, and update query library to match (pairing w/ @gillespi314)

* Fix accidental commit of sailsrc (again)
2021-05-28 17:51:47 -05:00
Mike McNeil
1512089384
add contributors to a query 2021-05-28 16:46:33 -05:00
noahtalerman
c450c86749
In 3-Deployment/2-Configuration add note about mitigating DoS attacks (#897) 2021-05-28 16:47:32 -04:00
noahtalerman
4cca4e7e7f
Remove @fleetdm.com emails from fleetdm/fleet repo (#882)
- In tests and documentation, replace `@fleetdm.com` with `@example.com`
- In documentation, replace `hello@fleetdm.com` with `fleetdm.com/contact`
- In documentation, replace `security@fleetdm.com` with `fleetdm.com/contact`
- In Dockerfiles, replace `engineering@fleetdm.com` with `hello@fleetdm.com`. These two files are the only remaining files with a `@fleetdm.com` email.
2021-05-27 17:19:14 -04:00
noahtalerman
6a72240860
Add link to release blog post in Software inventory documentation (#878)
- Add link to "Fleet 3.11.0 released with software inventory" to location in docs where software inventory is described.
- Change "host details" to "host vitals"
2021-05-27 17:18:41 -04:00
noahtalerman
dcbcc541a6
Move community project links into Example deployment scenario docs (#883)
- Move the community Fleet deployment tools to `docs/3-Deployment/4-Example-deployment-scenarios.md`
2021-05-27 17:14:10 -04:00
Zach Wasserman
8ee47f8b23
Add support for Teams in targets and live queries (#880)
- Accept Teams as a searchable target type for the target selection API.
- Accept Teams for targets in running live queries.
- Refactoring to support these changes.
- Update API documentation.
2021-05-27 13:18:00 -07:00
Zach Wasserman
cebd4df0f5
Update live query and targets APIs for Teams (#876)
- Take query_id in live query and target APIs.
- Use query_id to determine observer targets.
- Update documentation.
2021-05-26 20:45:06 -07:00
Zach Wasserman
48c413a254
Split host additional into separate table (#875)
- Move host `additional` into a separate table.
- Join when that data is needed.
- API change: `/api/v1/fleet/hosts` now returns only the requested
  `additional` columns, unless `*` is provided as the sole argument.

Background:

A customer reported that MySQL binlogs grew huge and replication lag
went way up when data was stored in the `additional` column. In this
deployment MySQL was running with ROW replication. This would cause the
entire `additional` data to be copied on each update of the host checkin
time. While switching to STATEMENT or MIXED replication would likely
mitigate the issue, this was not an option in their environment.
2021-05-26 16:24:12 -07:00
Zach Wasserman
a2a7082bd3
Implement add hosts to team by filters API (#866)
- Add hosts to team using label, status, and query filters.
- Documentation (+ docs for regular add hosts to team).
2021-05-25 21:29:52 -07:00
Zach Wasserman
15b81824f5
Filter query page API responses based on team membership (#850)
- Include only hosts that the user has access to in search targets API.
- Add parameter to specify whether `observer` hosts should be included.
- Generate counts based on which hosts user can access.
- Update API doc.
2021-05-24 21:34:08 -07:00
noahtalerman
fc4924a321
Add note about user passwords generated by teams script to docs (#844)
- Specify that users generated by the script found in `/tools/api/fleet/teams/create` are assigned the password of `user123#`
2021-05-24 17:50:55 -04:00
Zach Wasserman
b3a2a0496d
Corrections in configuration documentation (#829) 2021-05-21 08:41:13 -07:00
Mike McNeil
6fa518a300
Update 3-REST-API.md (#825) 2021-05-21 05:31:21 -05:00
Mike McNeil
6330b1ddc3
remove duplicate from standard query library
This will be prevented in the future by https://github.com/fleetdm/fleet/pull/827/files#diff-f6ef0e28b3715762f83a980eaadda37aec5c7ffe9ef9b19d303f53def956b98bR36
(which is how this got noticed )
2021-05-21 04:18:22 -05:00
noahtalerman
0c51f9de56
Add question about upgrading to FAQ (#821)
- Add question that addresses upgrading from Kolide Fleet to FleetDM Fleet
- Edit "Automatically add hosts to packs" question and move portion about `targets` field to `fleetctl` docs
2021-05-20 13:00:46 -04:00
noahtalerman
18f0e256e6
Add note that Fleet does not support Redis Cluster in configuration docs (#817)
- Add the Redis Cluster note to "High-level configuration overview" section
- Fix "connection" typo
2021-05-20 12:21:20 -04:00
Zach Wasserman
ba6dc0d19c
Update Orbit packaging documentation (#808)
More information about Windows packaging, dependencies.
2021-05-19 11:56:51 -07:00
Ahmed Elshaer
e18f154710
Add queries to Standard Query Library (#771)
Adds the following queries to the Standard query library:
- Get authorized keys for Local Accounts
- Get authorized keys for Domain Joined Accounts
- Get current users with active shell/console on the system
- Get Disk encryption status
- Detect Unencrypted SSH Keys for Local Accounts
- Detect Unencrypted SSH Keys for Domain Joined Accounts
- Line parsed values from system and user cron/tab
- Detect Dynamic Linker Hijacking (MITRE. T1574.006)
- Get etc hosts entries
- Get Network Interfaces
- Get Local User Accounts
- Detect active user accounts on servers
- Detect Nmap Scanner
- Get docker images on a system
- Get docker running containers on a system
- Get docker running process on a system
2021-05-19 11:21:45 -07:00
Noah Talerman
72882e8f9f Merge branch 'master' into teams 2021-05-19 13:16:54 -04:00
noahtalerman
3162b4206f
Add link to Loom demo (#790) 2021-05-18 12:40:12 -04:00
Mike McNeil
cc018bcfa6
Add "contributors" to YAML format to enable attribution (#780) 2021-05-18 10:33:40 -05:00
noahtalerman
e18ab29906
Add bash script that creates 3 teams and 12 users to /tools/api (#779)
- Add a bash script that populates the Fleet UI with 3 teams and 12 users. 
- Rename the `/tools/api/kolide` directory to `/tools/api/fleet`
2021-05-17 19:11:11 -04:00
noahtalerman
7d9ca2cee7
Convert standard query library to YAML format (#749)
- Create `/configuration-files/` directory inside of `/1-Using-Fleet` directory. This directory contains example Fleet configuration files in yaml format. Replaces the `/examples` directory.
- Create `/standard-query-library/` directory inside of `/1-Using-Fleet` directory. This directory contains the new `standard-query-library.yml`. This file will act as the source of community contributions to the standard query library.
- Edit references to `/examples` directory
2021-05-14 13:38:33 -04:00
Josh Brower
86745ba2dc
Add ability to duplicate live query results in Redis (#762)
This feature enables a new config option (redis.duplicate_results). When set to true, all Live Query results will be copied to an additional Redis pubsub channel named LQDuplicate

This is useful in a scenario that would involve shipping the Live Query results outside of Fleet, near-realtime.
2021-05-13 16:01:31 -07:00
Zach Wasserman
daa8eeb9d0
Add refetch host API (#767)
This allows the host details to be refetched on the next check in,
rather than waiting for the normal interval to go by. Associated UI
changes are in-progress.

- Migration and service methods for requesting refetch.
- Expose refetch over API.
- Change detail query logic to respect this flag.
2021-05-13 13:09:22 -07:00
noahtalerman
834ff4371c
Add "how to automatically target hosts" to 1-Using Fleet/FAQ docs (#751)
- Add question and answer to the following question: How do I automatically add hosts to packs when the hosts enroll to Fleet?
2021-05-10 18:54:27 -04:00
Michael Samuel
fb45806088
Copy log fields into GCP PubSub attributes (#712)
Add a config setting to allow copying message fields and decorations into Google Pub/Sub attributes, making it possible to use these values for subscription filters.
2021-05-08 12:29:52 -07:00
dsbaha
1cb514c460
Add flag to disable HTTP keepalives (#741)
In some environments, disabling keepalives helps prevent buildup of TCP sockets.
2021-05-07 17:29:54 -07:00
noahtalerman
40f2452e46
Change markdown links to relative links (#731)
My changes to the documentation file structure made in #717 resolved all broken documentation links on the `master` branch but not on the `teams` branch. As a result, those developing on the `teams` branch always get a   for the "Markdown link check" test.

- Add relative markdown links in the `teams` branch to resolve failed link test
2021-05-06 10:59:18 -04:00
noahtalerman
ea05195200
Add questions to FAQ and add documentation section to CONTRIBUTING.md (#726)
- Add section on contributing to Fleet documentation. This section covers the use of relative links and best practices for anchor links
- Add 3 questions and their respective answers to the FAQ section in the `1-Using-Fleet` docs
2021-05-05 18:00:05 -04:00
noahtalerman
9fb9da31f5
Bring Orbit docs into Fleet docs and add FAQ section (#717)
- Add new `2-Orbit-osquery/` directory to the top-level `docs/` directory.
- Rename `2-Deployment/` -> `3-Deployment/` to accommodate new Orbit directory.
- Rename `3-Contribution/` ->  `4-Contribution/` to accommodate new Orbit directory.
- Add FAQ section to Orbit documentation.
2021-05-04 15:50:18 -04:00
Zach Wasserman
3b81cb88e9
Update documentation on size of Fleet deployments (#718)
Better represents the growth of Fleet deployment size.
2021-05-04 11:09:23 -07:00
Zach Wasserman
a17556b2db Merge branch 'master' into teams 2021-04-30 09:40:10 -07:00
noahtalerman
b4e5097356
Draft API changes to api/v1/fleet/hosts/{id} endpoint for software inventory (#669)
Update documentation for the `api/v1/fleet/hosts/{id}` endpoint to align with the first iteration of Software inventory #399 in Fleet.
2021-04-29 11:25:54 -04:00
noahtalerman
dbfbde37b1
Add api/v1/status/ endpoints and api/v1/sso/callback endpoint to REST API docs (#671)
This PR concludes the Complete API documentation project #43

Add documentation for the following endpoints:
- api/v1/status/live_query
- api/v1/status/result_store
- api/v1/sso/callback
2021-04-29 10:45:43 -04:00
Zach Wasserman
e8669818eb
Initial backend software inventory implementation (#678)
- Maintain software inventory with detail queries.
- Associated database migrations.
- Feature flagged off by default (see documentation for details to turn on).
- Documentation.
- New test helper for slice element comparisons skipping ID.
2021-04-26 08:44:22 -07:00
Zach Wasserman
5350acb904
Update documentation about TLS configuration (#656) 2021-04-19 11:58:44 -07:00
Gabriel Hernandez
04712c0426 Merge master into teams 2021-04-14 17:52:15 +01:00
Zach Wasserman
7e85d71d9c
Add documentation for connecting to development MySQL shell (#637) 2021-04-13 11:07:39 -07:00
Joseph Henrich
7499f37cda
Fix promote/demote user doc (#629)
I believe this is just a copy/paste error from the enable/disable section.
2021-04-09 15:54:49 -07:00
Zach Wasserman
2f51493d20
Delete instead of disabling users (#622)
- Migration to delete existing disabled users.
- Remove enabled attribute.
- Add endpoint for user deletion.
2021-04-08 16:53:33 -07:00
noahtalerman
9ec90bfe6e
Provide documentation for reporting issues with the Fleet UI (#613)
- Add 2 sections in `CONTRIBUTING.md` these 2 sections correspond to the "Bug report" and "Report a security vulnerability" issue templates
- Add "Is this an issue with the Fleet UI" to "Bug report" section in `CONTRIBUTING.md`. This includes a walkthrough for opening the browser's JS console and network requests
- Fix misspelled file name
2021-04-07 16:30:32 -07:00
Zach Wasserman
fd13b3a72c
Fix carve documentation flag order (#605)
Update the docs to be consistent with stricter flag parsing in 3.10.

Fixes #602
2021-04-06 14:43:00 -07:00
Zach Wasserman
244983fd7a
Add filtering for invites (#600)
Uses the same API as for users and hosts.
2021-04-06 11:09:28 -07:00
Zach Wasserman
598c1e4c1f
Remove invited_by from invite parameters (#591)
Instead, use the value extracted from the viewer context.
2021-04-05 13:28:43 -07:00
Zach Wasserman
ee580bf811
Add ability to test SSO locally (#552)
- Use IdP in Docker container.
- Document process.
2021-03-29 13:50:39 -07:00
Zach Wasserman
0bd6903b2d
Add version endpoint to API (#549)
Part of #371
2021-03-26 18:03:31 -07:00
Zach Wasserman
d621650b78
Initial implementation of agent update management (#516)
This PR contains the initial implementation of the fleetctl updates commands, along with documentation on using this to self-host an agent update server.

Co-authored-by: Noah Talerman <noahtal@umich.edu>
Co-authored-by: Mike McNeil <mikermcneil@users.noreply.github.com>
2021-03-26 10:46:51 -07:00
Zach Wasserman
b6b9efe1cc
Document delve debug process (#538) 2021-03-25 16:29:00 -07:00
Zach Wasserman
0ae1bf3530
Fix default typo in host identifier docs (#534) 2021-03-24 17:32:25 -07:00
noahtalerman
e4a5ed7125
Add new screenshot (#525)
- Add new screenshot of the "Add new host" modal to /2-Deployment/4-Example-deployment scenarios docs
Closes #487
2021-03-23 16:20:00 -07:00
Mike Thomas
1ec7557dfd
Updated documentation screens (#521)
Updated screens in Using Fleet documentation to reflect updated UI.
2021-03-23 09:02:39 -05:00
Mike Thomas
dce7910411
Using Fleet text update (#522)
Updated text to match the new UI screenshots.
2021-03-23 08:16:05 -05:00
Zach Wasserman
7f43472431
Improve build documentation (#513)
Clarifies documentation based on observations from #510 and testing.
2021-03-22 13:34:34 -07:00
noahtalerman
2c341ee755
Fix broken anchor links in documentation (#509)
This PR includes various fixes to anchor links used in the documentation.

There are certain characters GitHub doesn't support for the use of anchor links in markdown files. The general rule I've found is to only use a-z or A-Z characters in anchor links. All other characters should be removed.

For example, consider the section title How do I connect to the Mailhog simulated server?. The valid GitHub anchor link for this section is #how-do-i-connect-to-the-mailhog-simulated-server. Notice no ?.

Closes #494
2021-03-21 16:05:11 -07:00
James Alseth
1da89ea987
Publish Helm chart (#475)
This adds a GH Action to publish the updated Helm chart with each new release. It can also be triggered manually if needed.

Fixes #345
2021-03-17 11:09:01 -07:00