This adds documentation about our debugging endpoints and a brief excerpt about the fleetctl debug command with instructions to generate the archive so we have a place with instructions to which we can direct people.
It also adds the .prof file extension to profiling files, which hopefully clarifies that they are meant to be used by go tool pprof.
This adds two small changes to the contributing docs:
1. Instructions to connect to a local Redis REPL
2. Instructions to start `dlv` in headless mode and attach debuggers to it. I modified `.vscode/launch.json` with a new launch debug config and added instructions for vim.
this change prevents errors from being automatically cleared once they are read. A new flag `-flush` is introduced to flush errors on read if necessary.
* feat[WIP]: updating docs for deploying Fleet on Kubernetes
* feat: update spec to include environment variables
* chore: add fleet image version to yml file
* doc: add Kubernetes manifest file
Add Kubernetes manifest file to files to be edited for Fleet version change when releasing.
* docs: link to the docs on deploying Fleet via K8s
* feat: add kubernetes deployment.yml
* feat: update Fleet version
* Website editor pass - Contribution
I made the descriptions complete sentences. Please let me know if these require further revision.
* Update README.md
* Update docs/Contributing/README.md
Co-authored-by: Mike Thomas <78363703+mike-j-thomas@users.noreply.github.com>
* Update docs/Contributing/README.md
Co-authored-by: Mike Thomas <78363703+mike-j-thomas@users.noreply.github.com>
* Update docs/Contributing/README.md
Co-authored-by: Mike Thomas <78363703+mike-j-thomas@users.noreply.github.com>
* Update docs/Contributing/README.md
Co-authored-by: Mike Thomas <78363703+mike-j-thomas@users.noreply.github.com>
* Update README.md
Updated with imperative mood.
* Update docs/Contributing/README.md
Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
Co-authored-by: Mike Thomas <78363703+mike-j-thomas@users.noreply.github.com>
Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
* Move password reset instructions for API-only user
Moved instructions for resetting the password of a new API-only user to FAQ as it is no longer necessary as of `4.13.0`
* Fix link to reset password instructions
Linked to a previous commit with password reset instructions for API-only users (only necessary on legacy versions).
Install orbit to /opt instead of /var/lib. When installing to /var/lib,
the default selinux context of var_lib_t gets applied, which results in
an AVC error when running via systemd.
Co-authored-by: Lucas Rodriguez <lucas@fleetdm.com>
* remove outdated config file description
`example_config.json` was removed in f11da7b05b but the documentation
was still there, this removes the description from the README as well.
* add a note about how to use scripts with premium features
* feat: update query example to conform with the rest of the docs
* Update docs/Using-Fleet/REST-API.md
Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
* Add API-only user login issues to FAQ
Added question and detailed instructions for API-only user password reset to FAQ
* Update Using Fleet FAQ
Removed instructions for resetting password for new API-only user and added link to commit with instructions. As discussed with @noahtalerman
* Update docs/Using-Fleet/FAQ.md
Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
* Editor pass - Revert api v1 to latest in documentation
Editor pass for: https://github.com/fleetdm/fleet/pull/5149/files
Under: docs/Contributing/API-for-contributors.md
Line 457 needs to be carefully read and rewritten for clarity.
* Update API-for-contributors.md
* feat: add link to the docs of retrieving live query result over web socket
* Update REST-API.md
I added 2 small edits. It looks good!
Co-authored-by: Desmi-Dizney <99777687+Desmi-Dizney@users.noreply.github.com>
* Adding full disk access instructions
* Update Adding-hosts.md
As per @ksatter's comments!
* Update Adding-hosts.md
Made the output a code block
* Formatting code snippets
Changed inline code to code blocks in #Grant full disk access to osquery on macOS to follow previous convention.
Co-authored-by: Katheryn Satterlee <me@ksatter.com>
* Reorganized infrastructure, updated for frontend's loadtesting
* Add changes suggested by @chiiph
* Moved files per suggestion by Ben
* Update docs with new links
* Add config for multi account assume role
* App up to date or not installed
Adding "App installed and up to date OR not present" example
* Removed empty last line
* Update standard-query-library.yml
Added right descriptions and resolution for the Docker example, and added a new query to detect unencrypted SSH keys.
* Update docs/01-Using-Fleet/standard-query-library/standard-query-library.yml
Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
* Update docs/01-Using-Fleet/standard-query-library/standard-query-library.yml
Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
* Update docs/01-Using-Fleet/standard-query-library/standard-query-library.yml
Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
* Update standard-query-library.yml
Updated as per @noahtalerman's review
* Update docs/01-Using-Fleet/standard-query-library/standard-query-library.yml
Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
* removed global api routes; using 'latest' instead of v1 for api routes
* lint fixes
* updated docs and tests
* lint fixes
* route fix
* fixed routes breaking packs queries
* revert test change
* Weekly community-driven docs update for week ending March 25th
* Update Configuration.md
* Update FAQ.md
All edits are recorded by line:
192 added “-“ to “auto-updates”
194 added “-“ to “auto-updates”; deleted “,” after “(easy)”; replaced “reccomend” with “recommend”
209 added “,” after “work”
211 replaced “am I seeing” with “do I see”
225 replaced “The best way to maintain historical data currently would be to use the [REST API](./REST-API.md) or the [`fleetctl` CLI](./fleetctl-CLI.md) to manually retrieve and save the data you need on your schedule. “ with “Currently, Fleet only stores the current state of your hosts (when they last communicated with Fleet). The best way at the moment to maintain historical data would be to use the [REST API](./REST-API.md) or the [`fleetctl` CLI](./fleetctl-CLI.md) to retrieve it manually. Then save the data you need to your schedule.”
* Update FAQ.md
All edits are recorded by line:
194 deleted ”either” after “disabled”
* Update fleetctl-CLI.md
All edits are recorded by line:
28 deleted “of the” after “many”; replaced “User Interface” with “UI(User Interface)”; replace “, and to” with “. You can even”
43 capitalized “Fleet”
63 replaced “info” with “information”
* Additional context for help menu and add table
Tweaked wording around using the help command and moved available commands in to a table. @DominusKelvin @Desmi-Dizney
* Update Configuration.md
space
* Final grammar revision
Co-authored-by: Desmi-Dizney <99777687+Desmi-Dizney@users.noreply.github.com>
* Add instructions for creating and using an API-only user with fleetctl
* Update fleetctl-CLI.md
* Update example responses for policies and teams
* Update fleetctl-CLI.md
This was a super clean edit!
All edits are recorded by line:
199 replaced “passing” with “picking”; added “,” after “email”
253 replaced “:” with “.”
* Update fleetctl-CLI.md
Line 253 I changed "." to ":"
* Change `Create a new context for your standard user (optional)` > 'Switching users'
* Update fleetctl-CLI.md
All edits are recorded by line:
195 replaced “are” with “is”
207 replaced “will be able to” with “can”; replaced “needs to be” with “is”
249 replaced “has been” with “is”
* Update API-only user creation instructions
Added additional context to the user creation command and fixed some grammar issues.
Co-authored-by: Desmi-Dizney <99777687+Desmi-Dizney@users.noreply.github.com>
* Adding Orbit audit and new .md page
* Update Security-audits.md
Adding content. Link to PDF won't work until the PR with these two files is merged to main.
* Update Security-audits.md
Added pageOrderInSection
* Update Security-audits.md
Put link to the actual commit so the PDF link can be tested before this gets merged to main
* Update Security-audits.md
Added title
* Fixed tables
* a -> an
Co-authored-by: Eric <eashaw@sailsjs.com>
* feat: add FAQ for distinguishing between fleetctl vs the REST API vs Fleet UI
* Update FAQ.md
Edits recorded by line:
189 changed "vs" to "vs."
191 replaced "useful" with "helpful"
193 added "," after "fleetctl"; deleted "make" and "of"
195 replaced "nice to look at" with "visually appealing"; deleted "is" and "meant to"; added "s" to "make"; replaced "wider" with "broader"
Co-authored-by: Desmi-Dizney <99777687+Desmi-Dizney@users.noreply.github.com>
- Update CHANGELOG
- Bump versioning
- Tweak documentation
- Default `session_duration` to `5d`
- Add extra `#` to "Team policies" section so it doesn't show up in top level nav for docs
* Add Host OS compatibility chart for issue 3359
* Refining compatibility for Linux
* Updated wording of Linux note and changed file name to match heading
* Change Windows version to 10+
* Update Supported-host-operating-systems.md
Edits recorded by line:
5 replaced ":" with "."
17 replaced "in" with "for"
22 added "a" before "CPU"
* Update Supported-host-operating-systems.md
@Desmi-Dizney let me know if that helps at all!
Co-authored-by: Desmi-Dizney <99777687+Desmi-Dizney@users.noreply.github.com>
* geoip wip
* return nil if ip is empty string or if ParseIP returns nil
* add ui component to render geolocation if available, address PR feedback
* render public ip if available
* add changes file, document geoip in deployment guide
* update rest-api docs
* docs: add FAQ for migrating from Fleet Free to Fleet Premium
* docs: add note for redeploying Fleet not being necessary
* docs: add note for redeploying Fleet not being necessary
* fix: add question mark to FAQ
* Renaming files and a lot of find and replace
* pageRank meta tags, sorting by page rank
* reranking
* removing numbers
* revert changing links that are locked to a commit
* update metatag name, uncomment github contributers
* Update basic-documentation.page.js
* revert link change
* more explicit errors, change pageOrderInSection numbers, updated sort
* Update build-static-content.js
* update comment
* update handbook link
* handbook entry
* update sort
* update changelog doc links to use fleetdm.com
* move standard query library back to old location, update links/references to location
* revert unintentional link changes
* Update handbook/community.md
Co-authored-by: Mike Thomas <78363703+mike-j-thomas@users.noreply.github.com>
Co-authored-by: Mike Thomas <78363703+mike-j-thomas@users.noreply.github.com>
Co-authored-by: Mike McNeil <mikermcneil@users.noreply.github.com>
* Improve documentation for how we do vulnerability processing
* Add mermaid diagrams
* Mermaid, next try
* Change style of once an hour node
* Improve collection diagram
* Improve readability of diagrams
* Improve flow charts
* Update broken link
* docs: add new manage-packs.png
* feat: add new team-agent-options.png
* feat: add new global-agent-options.png
* docs: update screenshots and docs context
* chore: delete stale screenshots
* feat: update screenshot to recommended preset size
* chore: remove editor new line
* feat: update new line
On website + constants.ts. Does not support all Linux encryption scenarios, we will add more to this query as we discover the patterns people need.
Closes#4208
* Adding antivirus queries
Adding 3 antivirus queries in the form of an information query as well as in the form of policy queries
* Update standard-query-library.yml
Adding newline at end of file
* Add CentOS parsing and post-processing in fleet
* Add tests and amend SyncCPEDatabase
* Add test for centosPostProcessing
* Changes from PR comments
* Amend software test
* Fix sync test
* Add index to source and vendor
* Use os.MkdirTemp
* Rearrange migrations
* Regenerate test schema
* Add support for testing migrations (#4112)
* Add support for testing migrations
* Rename migration in tests
* Changes suggested in PR
* Go mod tidy
* fix: update headings in configuration files docs
* fix: update heading in testing docs
* fix: update heading in seeding data docs
* fix: update headings in committing changes docs
* fix: update heading from External Contributors to External contributors
* fix: update headings in API for contributors docs.
* fix: update heading in API versioning docs.
* Add platform filters for MDM/Munki/Chrome queries
This should help quiet warnings that users/customers have reported when
these queries try to run on platforms without the macadmins extension
tables.
For #4123
* Improve documentation
* add changes file
* revert doc formatting
* Update tests
* Yet another test fix
Co-authored-by: Tomas Touceda <chiiph@gmail.com>
* Add remaining policy templates
* Removeempty resolution field
* Update naming for standard policies
* Add enabled word to SIP policy
* Use full SIP
* Also change in constants
* Update windows disk encryption
* Add changes file
* Tweak windows disk encryption policy
* Address lint errors
* Make requested changes
* Reflect changes in policy tempaltes
* Make sure that standard policies and policy templates are the same
* Edit automatic login disabled description
* Also edit in constants
* docs: add instructions for enabling SSO for existing users
* fix: update sentence to emphasize admin
Reword sentence for clarity that admins are the ones supposed to carry out the enable SSO action for existing users
* fix: remove extraneous whitespace
* doc: add introduction to fleetctl docs
* Update docs/01-Using-Fleet/02-fleetctl-CLI.md
Co-authored-by: Mike Thomas <78363703+mike-j-thomas@users.noreply.github.com>
* handle query tags in build-static-content script, update query readme
* show tags in query library, add ability to filter by tags
* fix lint errors
* update mobile styles
* fix CTA link
* update mobile layout
* remove tag line-height and font size
* Update build-static-content.js
* Style update
* remove margin from selected tag, adjust OS logo placement
* requested changes from code review
Co-authored-by: Mike Thomas <mthomas@fleetdm.com>
* feat: add FAQ for what happens to logs
FAQ for what happens to log if either the Fleet's server or the log destination are offline
* fix: add the default buffered_log_max
Added reference architectures using https://docs.gitlab.com/ee/administration/reference_architectures/ as inspiration.
- updated terraform based on some feedback of usage
- pinned fleet docker version in terraform as to no get unexpected upgrades when applying
- updated some documentation around apply migration tasks
* Add sentry
* Fix gosum
* More gosum fixes
* Add missing def for config
* Enrich sentry scope a bit
* Add changes file
* Add goroutine safe scope to errors
* Encapsulate sentry logic
* Add documentation for new flag
* Add sentry capturing to crons and other background tasks
* Only send to sentry when enabled
This helps the period stay under the default request timeouts for most
load balancers.
Some default timeouts:
* AWS ALB - 60s
* Nginx - 60s
* GCP LB - 30s
* doc: add FAQ for orbit running alongside osquery
* fix: update FAQ to be more clear.
Co-authored-by: Mike Thomas <78363703+mike-j-thomas@users.noreply.github.com>
* fix: typo on osquery
Co-authored-by: Mike Thomas <78363703+mike-j-thomas@users.noreply.github.com>
Co-authored-by: Mike Thomas <78363703+mike-j-thomas@users.noreply.github.com>
* Updating Upgrade docs
* making changes to database section of upgrade docs
* Update docs/02-Deploying/06-Upgrading-Fleet.md
Co-authored-by: Mike Thomas <78363703+mike-j-thomas@users.noreply.github.com>
* Update docs/02-Deploying/06-Upgrading-Fleet.md
Co-authored-by: Mike Thomas <78363703+mike-j-thomas@users.noreply.github.com>
* Update docs/02-Deploying/06-Upgrading-Fleet.md
Co-authored-by: Mike Thomas <78363703+mike-j-thomas@users.noreply.github.com>
* Corrected anchor tags, ready to merge
Co-authored-by: Katheryn Satterlee <ksatter@Kathys-MacBook-Pro.local>
Co-authored-by: Mike Thomas <78363703+mike-j-thomas@users.noreply.github.com>
* feat: add query to find running docker containers
* docs: 📝 add query to get Mac and Linux machines with unencrypted primary disks
* feat: add query to find running docker containers
* docs: 📝 add query to get Mac and Linux machines with unencrypted primary disks
* chore: remove queries from develop
* docs: add query to get running docker containers
* docs: add query to get machines with unencrypted primary disks
* fix: remove trailing ---
* fix: remove trailing ---
* chore: remove trailing ---
* docs: add query to get applications hogging memory
* fix: resolve merge conflicts
* chore: update PR
* chore: update PR
* chore: merge previous query
* feat: add query to find servers with root logins within the day
* fix: remove unneeded period
* docs: add instructions for submiting multiple queries
* fix: remove duplicate entry
* fix: remove period from get running docker containers query description
* docs: add instructions for submiting multiple queries
* fix: resolve merge conflicts
* feat: add description for query to fetch failing batteries
* fix: resolve duplicate descriptions
* fix: remove typo in deplying docs
* fix: reword description
* fix: add suggestions to improve description
* feat: add description to query to fet windows machines with unencrypted hard disks
* feat: update description for count apple applications installed query
* chore: add dominuskelvin as maintainer
* docs: 📝 Add query to get apps opened within the last 24 hours
* feat: add link to signing installers
* fix: typo with link to the getting started page
* feat: docs on how to sign an osquery installer
* feat: make signing installer a subsection of osquery installer
* feat: make description for signing installer shorter and compact
* fix: change package to installers
* fix: reword note section
* feat: add query to find running docker containers
* docs: 📝 add query to get Mac and Linux machines with unencrypted primary disks
* feat: add query to find running docker containers
* docs: 📝 add query to get Mac and Linux machines with unencrypted primary disks
* chore: remove queries from develop
* docs: add query to get running docker containers
* docs: add query to get machines with unencrypted primary disks
* fix: remove trailing ---
* fix: remove trailing ---
* chore: remove trailing ---
* docs: add query to get applications hogging memory
* fix: resolve merge conflicts
* chore: update PR
* chore: update PR
* chore: merge previous query
* feat: add query to find servers with root logins within the day
* fix: remove unneeded period
* docs: add instructions for submiting multiple queries
* fix: remove duplicate entry
* fix: remove period from get running docker containers query description
* docs: add instructions for submiting multiple queries
* fix: resolve merge conflicts
* feat: add description for query to fetch failing batteries
* fix: resolve duplicate descriptions
* fix: remove typo in deplying docs
* fix: reword description
* fix: add suggestions to improve description
* feat: add description to query to fet windows machines with unencrypted hard disks
* feat: update description for count apple applications installed query
* docs: 📝 Add query to get apps opened within the last 24 hours
* feat: add query to find apps not in Applications directory
* feat: add query to find subscription based applications that have not been opened for the last 30 days
- Add "Automations" documentation page to document the available automations in Fleet
- Update the "Vulnerability processing" documentation
- Update the "REST API" documentation
* Add webhook to app config
* Add redis failing policies set and webhook
* Add basic webhook test
* Store hostname in redis
* Global policy deletion to remove policy ID from set and config
* Also process new passing policies
* Fix unit test
* Sort hosts
* Add more tests
* Add ListSets to the failing policies interface
* Fix server URL and garbage collect on the triggering side
* Do not use Redis SCAN
* Fix Redis operation order
* Add API changes to doc
* Add comments
* Add more tests
* Fix tests
* Add tests for config update upon deletion of policies
* Run make dump-test-schema
* Ignore policies that failed to run
* Add proper unit tests to trigger logic
* Fix comments
* WIP
* Add tests to service_osquerty_test.go
* Use SSCAN for listing hosts instead of SMEMBERS
* Add failing policies to docs/01-Using-Fleet/configuration-files/README.md
* Remove skip
* Fix PR comments
* Finish first draft of API versions
* wip
* Finalize tests
* Revert change in handler
* Remove made up version
* Update versioning with aliases
* Add changes file
* Address review comments
* Revert overupdated routes
* Expand life time of deprecated APIs
* Fix test
* Comment out problematic part of test
* Revert bad path changes
* updating docs to make things a bit more clear
* fixing broken links
* more broken links
* fixing broken links
* website updates
* PR review changes
* fixing bad links
Queries:
- Get applications hogging memory
- Get Mac and Linux machines with unencrypted primary disks
- Get servers with root login in the last 24 hours
* Add software count API
* Fix makefile
* Fine no mock generating at this point
* Actually, one last try
* Use go install instead
* Fix go sum/mod
* Improve documentation
* Try setting node to 14
- Emphasize generating an "osquery installer" (also referred as "Orbit") using the `fleetctl package` command
- Add instructions for adding multiple hosts and automatically adding hosts to a team
- Remove instructions for generating an enrollment package with the tooling in `tools/mac/`
- Remove the `tools/mac/` directory from the repository because it is no longer used or referenced in any documentation
- Update "Automatically adding hosts to a team" section of "Teams" documentation to point to "Adding hosts" documentation
- Add instructions for migrating from plain osquery to Fleet's osquery installers
* add faq questions
* Apply suggestions from code review
Co-authored-by: Mike Thomas <78363703+mike-j-thomas@users.noreply.github.com>
* fix broken links
* Update FAQ.md
Co-authored-by: Mike Thomas <78363703+mike-j-thomas@users.noreply.github.com>
- Fix a broken link in the summary of the "Osquery logs" documentation
- Update instructions for linking to a specific section within a page in the Fleet documentation in product handbook
