Commit Graph

175 Commits

Author SHA1 Message Date
Martin Angers
c23a15394e
Keep created_at timestamp of existing enroll secrets (#8062) 2022-10-05 08:35:36 -04:00
Mo Zhu
86b05bce3d
Bug process (#7983)
* shift quality stuff to its own level

* add bug process

* specify rituals and slack channels

* remove QA steps section

Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>

* GitHub not github

Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>

* Use bug review DRI

Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>

* GitHub not Github or github

* reconcile previous release blocking process with new

* typo

* specify help-release-bugs channel for more specificity

* specify DRIs

* specify metrics

* Apply suggestions from code review

Co-authored-by: Chris McGillicuddy <108031970+chris-mcgillicuddy@users.noreply.github.com>

* include suggestions

* update filter links slightly

* fix typo

Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
Co-authored-by: Chris McGillicuddy <108031970+chris-mcgillicuddy@users.noreply.github.com>
2022-10-04 13:15:02 -04:00
Zach Wasserman
db7d1c5bf5
Strongly discourage use of MariaDB (#7699) 2022-09-23 11:18:34 -07:00
Noah Talerman
0170326853
Move packs API and YAML file to contributor docs (#7885)
- Move docs for packs API routes to "API for contributors" page
- Clean up "Overview" section in the "REST API" page
- Organize anchor link list in the "API for contributors" page
- Move docs for `pack` YAML file to the "Configuration for contributors" doc page
- Add instructions for using teams to schedule queries for groups of hosts
2022-09-22 17:41:57 -04:00
Gabriel Hernandez
517d79e5a5
add fleet UI testing docs (#7687)
* add fleet UI testing docs

* revisions to FE testing document

* add meta tag and change page title

* more revisions to fleet UI docs
2022-09-21 16:56:13 +01:00
Martin Angers
478b4d3f69
Validate team and appconfig payloads, with dry-run and force modes (#7731) 2022-09-19 13:53:44 -04:00
Juan Fernandez
b60d535d4a
Feature 7084: Add new EE endpoint for Fleet Desktop (#7530)
Added new EE endpoint, that is meant to be used by Fleet Desktop only. The new endpoint will return the number of failed policies.
2022-09-12 15:37:38 -04:00
Martin Angers
988f50fa34
Document all keys in config and team YAML documents (#7449)
- Add a new "Configuration for contributors" doc page. Move settings that are not recommended for production use
- Remove settings modified in the `config` YAML document from the deploying/configuration doc page
- Document all keys in `config` and `teams` YAML documents
- Add comments to several `.go` files and remove unused struct
2022-09-08 17:57:38 -04:00
Eric
30bd86fe2d
Remove newlines before indented lists in Markdown (#7461) 2022-08-31 15:42:09 -05:00
Luke Heath
61b5f9849f
Replace references to /api/latest/fleet with /api/v1/fleet (#7464) 2022-08-31 09:51:25 -05:00
Roberto Dip
eeefe2fab9
enable controlled rollout of features by teams (#7408) 2022-08-30 08:13:09 -03:00
Eric
55af48910a
Move CONTRIBUTING.md into docs/contributing (#7283)
* move contributing.md into docs/contributing, update link in readme

* Update CONTRIBUTING.md

Co-authored-by: Chris McGillicuddy <108031970+chris-mcgillicuddy@users.noreply.github.com>
2022-08-26 12:14:43 -05:00
Luke Heath
eee8219498
Update Releasing-Fleet.md (#7366) 2022-08-24 14:20:54 -05:00
Noah Talerman
b0e37accc9
Update "Learn how to use Fleet" for Fleet Sandbox (#7142)
- Update "Learn how to use Fleet" docs page to walk a Fleet Sandbox user through adding their device and running a query
- Add a "Get operating system information" query to standard query library for the "Learn how to use Fleet" walkthrough
- Update Fleet's top level README to point users who want to try Fleet to Fleet Sandbox
- Update "How to install osquery..." (macOS, Windows, Linux) blog posts to point users who want to try Fleet to Fleet Sandbox
- Move `fleetctl preview` questions to "Contributing" FAQ section in docs. This is because `fleetctl preview` is now a testing tool for Fleet contributors
- Update "Deploying" docs to point users who want to try Fleet to Fleet Sandbox
2022-08-19 14:13:15 -04:00
Luke Heath
ba86865231
Add API docs for /setup endpoint (#7281) 2022-08-18 13:58:39 -05:00
Roberto Dip
8acf14ab43
adjust installers endpoint to avoid AJAX downloads (#7226)
Related to #7206, this delegates the handling of the download to the browser
2022-08-16 12:54:41 -03:00
Roberto Dip
05ddeade90
add back-end implementation for SSO JIT provisioning (#7182)
Related to #7053, this uses the SSO config added in #7140 to enable JIT provisioning for premium instances.
2022-08-15 14:42:33 -03:00
Martin Angers
c8cdddf0ea
Update /macadmins endpoints to include MDM name and aggregate count (#7137) 2022-08-10 15:15:01 -04:00
Roberto Dip
bfd98557f9
update golangci-lint version (#7115) 2022-08-09 15:42:35 -03:00
Roberto Dip
2b8743e240
send enroll secret in query for installers (#7064)
This changes how the enroll secret is sent to the server, as they might contain /, which was causing problems with our router.
2022-08-04 18:39:38 -03:00
Noah Talerman
7ad0667b6a
Add DRIs for release testing (#6804)
- Add DRIs for release testing
- Add DRIs for patch release testing
- Update patch release playbook
2022-08-04 12:23:19 -04:00
Martin Angers
c1d38598e2
Prevent removing team enroll secrets when applying team specs without new secrets (#6890) 2022-08-02 09:51:03 -04:00
Noah Talerman
5d2455d623
Update API versioning docs (#6644)
- Specify when the new API versioning will be introduced
2022-08-02 09:22:02 -04:00
Roberto Dip
33252011f0
add instructions to change db images on local development (#6995) 2022-08-02 12:17:26 +00:00
Mike Thomas
26d763c426
Updated testing.md (#6583)
* Updated testing.md

Updated the name of testing.md to testing-and-local-development.md based off https://github.com/fleetdm/fleet/issues/4706

* add redirect for /docs/contributing/testing

Co-authored-by: Eric <eashaw@sailsjs.com>
2022-08-01 19:06:30 -05:00
Eric
46aa36356b
Website: Update LANG markers regex in build-static-content.js (#6785)
* Update LANG markers regex

* update regex to remove extra newlines from codeblocks

* revert regex in build-static-content

* remove nested codeblock

* update whitespace in changed codeblock

* update regex replace to match indentation on LANG tags

* update regex, add error if markdown was compiled with nested codeblocks

* Revert lang marker regex

* remove newlines before codeblocks in lists

* Update error, move LANG tag regex replace

* update comment to clarify what we mean by nested codeblocks

Co-authored-by: Mike McNeil <mikermcneil@users.noreply.github.com>
2022-07-27 16:55:06 -05:00
Roberto Dip
90b723e45a
consolidate sandbox env flags (#6917)
Related to #6894, this entirely replaces FLEET_DEMO with the server config added in #6597

As part of this, I also implemented a small refactor to the integration test suite to allow setting a custom config when the server is initialized.
2022-07-27 16:47:39 -03:00
Roberto Dip
02a37db3d0
update documentation for viewing code coverage locally (#6821) 2022-07-25 10:48:53 -05:00
Desmi-Dizney
31508f3a7f
Editor pass - add API endpoints to retrieve pre-built installers (#6770)
Editor pass for:
-  https://github.com/fleetdm/fleet/pull/6672
2022-07-21 10:44:19 -05:00
gillespi314
4792d7a759
Add UI for Fleet Sandbox to download prepackaged installers (#6721) 2022-07-19 14:28:06 -05:00
Roberto Dip
69f8f2a73b
add API endpoints to retrieve pre-built installers (#6672)
Rel: #6365, this adds a new endpoint to check and download pre-built installers.
2022-07-18 13:44:30 -03:00
Roberto Dip
86366b2ed8
add a new S3 datastore to retrieve pre-built packages (#6631)
Related to #6365, this extends the datastore/s3 package to retrieve installers from S3 according to the conventions listed in the parent issue. This also includes:

- A minor refactor to decouple Carves-related functionality from the core S3 functionality
- Set-up to run tests using minio (only enabled via the FILE_STORAGE_TEST env flag)
2022-07-14 14:14:24 -03:00
Desmi-Dizney
8623aa14e2
Editor pass - Document the device-authenticated endpoints in API for Contributors (#6444)
Editor pass for:
-  https://github.com/fleetdm/fleet/pull/6406
2022-07-05 17:42:08 -04:00
Desmi-Dizney
ddf4d5a45a
Editor pass - Add endpoint documentation (#6414)
Editor pass for:
-  https://github.com/fleetdm/fleet/pull/6290
2022-06-29 16:11:28 -05:00
Martin Angers
b9930930f5
Document the device-authenticated endpoints in API for Contributors (#6406) 2022-06-29 08:12:20 -04:00
Tomas Touceda
1faa3c47b2
Add endpoint documentation (#6290)
* Add endpoint documentation

* Fix few typos

* Update documentation based on reviews

* Add missing meta

* Fix doc typos
2022-06-22 11:34:14 -03:00
Desmi-Dizney
55d1e338cb
Editor pass - Improve live query UX (#6201)
Editor pass for:
-  https://github.com/fleetdm/fleet/pull/5749
2022-06-14 14:55:59 -04:00
gillespi314
44f902218c
Improve live query UX (#5749) 2022-06-10 13:29:45 -05:00
Desmi-Dizney
cc4a3b7862
Docs editor pass - Contruting -Testing (#6036)
This has been edited for content and copy.
2022-06-02 14:13:41 -04:00
Desmi-Dizney
6a808ce952
Docs editor pass - Contributing - Releasing Fleet (#5960)
This has been edited for content and copy.
2022-06-02 14:12:58 -04:00
Tomas Touceda
3116da54ac
Add platform scaling gotchas (#5369)
* Add platform scaling gotchas

* Move release documentation in engineering to releasing-fleet

* Remove reference to event scheduler as it's not needed anymore

* Address feedback from review

* Remove redundant check box

* Address remaining corrections
2022-06-01 13:53:51 -03:00
Desmi-Dizney
afcf61abab
Docs editor pass - Contributing - Testing (#5962)
This has been edited for content and copy.
2022-05-31 14:45:07 -04:00
Desmi-Dizney
bf0db96e74
Docs editor pass - Contributing - API-Versioning (#5923)
This has been edited for content and copy.
2022-05-31 09:35:45 -05:00
Desmi-Dizney
95832d74db
Docs Editor pass - Contributing - API for contributors (#5927)
This has been edited for content and copy.
2022-05-31 09:54:03 -04:00
Desmi-Dizney
f8e8c20034
Docs editor pass - Contributing - Building Fleet (#5952)
This has been edited for content and copy.
2022-05-31 09:53:09 -04:00
Desmi-Dizney
45f169de27
Docs editor pass - Contributing - Committing-Changes (#5957)
This has been edited for content and copy.
2022-05-31 09:52:27 -04:00
Desmi-Dizney
17834890a2
Docs editor pass - Contributing - Contribution FAQ (#5958)
This has been edited for content and copy.
2022-05-31 09:51:41 -04:00
Desmi-Dizney
b12a942cc1
Docs editor pass - Contributing - Migrations (#5959)
This has been edited for content and copy.
2022-05-31 09:50:18 -04:00
Desmi-Dizney
283302c595
Docs editor pass - Contributing - Seeding data (#5961)
This has been edited for content and copy.
2022-05-31 09:49:33 -04:00
Michal Nicpon
ad33f8cc89
update docs (#5721) 2022-05-16 09:20:54 -06:00
Desmi-Dizney
ba820384f9
Docs editor pass - Contributing - API for contributors (#5649)
* Docs editor pass - Contributing - API for contributors

Editor pass

* Update docs/Contributing/API-for-contributors.md

Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>

* Update docs/Contributing/API-for-contributors.md

Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>

* Update docs/Contributing/API-for-contributors.md

Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>

* Update docs/Contributing/API-for-contributors.md

Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>

* Update docs/Contributing/API-for-contributors.md

Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>

* Update docs/Contributing/API-for-contributors.md

Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>

* Update docs/Contributing/API-for-contributors.md

Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>

* Update API-for-contributors.md

Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
2022-05-12 11:32:54 -05:00
Roberto Dip
9b67736212
document how to run dlv in headless mode and connect to the Redis CLI (#5535)
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.
2022-05-10 11:51:09 -03:00
Desmi-Dizney
e04bfba195
Docs editor pass - Contributing - API versioning (#5647)
Editor pass
2022-05-09 16:29:33 -05:00
Kelvin Oghenerhoro Omereshone
a5da7c95ce
Update docs for deploying Fleet on Kubernetes (#4755)
* 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
2022-05-09 17:05:11 +01:00
Desmi-Dizney
eafff45970
Website editor pass - Contribute (#5238)
* 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>
2022-05-09 10:56:35 -05:00
Desmi-Dizney
5eede3fcb7
Updated "Contribute" title (#5234)
* Update README.md

I changed title to "Contribute" to match the link from the community drop down.

* Update README.md
2022-05-04 22:54:19 -05:00
Desmi-Dizney
0b9ad123a4
Editor pass - tweak docs related to dev local environment setup (#5502)
Editor pass for: https://github.com/fleetdm/fleet/pull/5434
2022-05-03 13:28:41 -05:00
Kelvin Oghenerhoro Omereshone
25ce199f34
Normalize sql statements throughout the docs (#5487)
* feat: normalize SQL statements in API-for-contributors.md

* feat: normalize SQL statements in Adding-hosts.md

* feat: normalize SQL statements in fleetctl-CLI.md

* feat: normalize SQL statements in REST-API.md

* feat: normalize SQL statements in Vulnerability-Processing.md

* feat: normaize SQL statemetns in Using Fleet ReadMe

* feat: normalize SQL statements in tools/api README

* fix: revert adding hosts page
2022-05-03 15:47:31 +01:00
Roberto Dip
fc859321dc
tweak docs related to dev local environment setup (#5434)
* 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
2022-04-28 11:42:22 -03:00
Desmi-Dizney
86ddbadebe
Editor pass - Revert api v1 to latest in documentation (#5314)
* 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
2022-04-26 17:56:35 -05:00
Martin Angers
b3fc0cd844
Unversion the /setup endpoint, version the websocket endpoint (#5104) 2022-04-20 15:57:26 -04:00
Zach Wasserman
61a4d03f96
Update changelog for Fleet v4.12.1 (#4942) 2022-04-18 14:41:14 -04:00
Michal Nicpon
cc249e0ff1
revert api v1 to latest in documentation (#5149)
* revert api v1 to latest in documentation

* Update fleetctl doc page

Co-authored-by: Noah Talerman <noahtal@umich.edu>
2022-04-14 16:33:52 -05:00
Zachary Winnerman
2fbe53b6c9
Reorg infrastructure and add changes for frontend's loadtesting environment (#4947)
* 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
2022-04-12 12:49:00 -04:00
Martavis Parker
a8d7b5478b
Updated API routes to use current format for frontend use (#5018)
* 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
2022-04-11 13:04:38 -07:00
Martin Angers
90b15071a4
Introduce API version 2022-04, deprecate use of /global in paths (#4731) 2022-04-05 11:35:53 -04:00
RachelElysia
78dc9f2a31
Fix sentence casing on login (#4741) 2022-03-22 17:32:41 -04:00
eashaw
2ee98e1fa1
fix broken update guide link, add redirect (#4541) 2022-03-10 13:13:48 -06:00
Kelvin Oghenerhoro Omereshone
81bc22bb74
fix: update internal links to point to the correct ids (#4510) 2022-03-09 20:41:20 +00:00
eashaw
983fbd736d
Update website slack links to point to osquery.fleetdm.com (#4478)
* Add slack redirect

* update slack invite links to use redirect
2022-03-04 15:51:11 -06:00
Luke Heath
75d12e6e95
Update broken relative url links to absolute urls (#4464) 2022-03-04 12:29:12 -06:00
Lucas Manuel Rodriguez
85a4b27aa4
Add dev/test docs for Kinesis (#4427) 2022-03-03 12:14:43 -03:00
eashaw
45ca20502b
sentence case (#4360) 2022-02-25 10:48:34 +09:00
eashaw
4f624e91ee
fixed indentation on ordered lists (#4356) 2022-02-24 16:56:35 -06:00
eashaw
0af5e161d0
Remove numbers from documentation filenames in Fleet repo (#4313)
* 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>
2022-02-23 12:17:55 -06:00