Commit graph

1670 commits

Author SHA1 Message Date
Zach Wasserman
d6ef0841ec
Clarify Fleet Premium for self-hosted extension updates. (#16714) 2024-02-12 14:57:08 -08:00
Victor Lyuboslavsky
95437f9044
gitops role authorization changes for fleetctl gitops (#16710)
To support `fleetctl gitops`, gitops role can now read policies/queries
and write scripts.

# Checklist for submitter

If some of the following don't apply, delete the relevant line.

<!-- Note that API documentation changes are now addressed by the
product design team. -->

- [x] 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.
- [x] Documented any permissions changes (docs/Using
Fleet/manage-access.md)
- [x] Added/updated tests
- [x] Manual QA for all new/changed functionality
2024-02-12 16:44:35 -06:00
Rachael Shaw
3c06a0e6bf
Fix "Get manual enrollment profile" formatting (#16720)
Should be an h3 and have a link @ the top of the section like other API
endpoints.
2024-02-09 15:16:52 -06:00
Eric
14010452f8
Fix broken links in documentation (#16708)
Closes: #16493

Changes:
- Fixed five broken links in Fleet's documentation
2024-02-09 15:00:04 -06:00
Rachael Shaw
102d80e463
Document how to list all hosts on "No team" (#16635)
Example of documentation work for
https://github.com/fleetdm/fleet/issues/16350
2024-02-08 16:27:38 -05:00
Eric
5c7574964f
Website: Update confusing/outdated links. (#16522)
Closes: #16451

Changes:
- Updated the "spin up for yourself" link in the FAQ to go to the
deploying docs.
- Updated the custom idp integration card link to go to the IDP
configuration section of the SSO docs page.
2024-02-07 16:56:33 -06:00
Noah Talerman
633768676a
Docs: Windows custom OS settings (profiles) (#16398)
- Update "Custom macOS settings" page to cross-platform "Custom OS
settings" page
- Match format w/ "Disk encryption" and "OS updates" pages
- Cut content and make the docs more of reference
- Link to best practice GitOps
- Update pricing page
- Add redirects
2024-02-07 17:51:23 -05:00
Sabrina Coy
33563fba6e
Update rest-api.md (#16630)
Corrected status code from `2000` to `200`
2024-02-06 17:17:26 -05:00
Brock Walters
b3acc96c4f
Update standard-query-library.yml (#16271)
It is very easy for data collection like this to veer into double /
triple negative mulitverse of madness stuff...

That said, I may have a lack of understanding about how the product
works, i.e., that a query literally must return a 0 value & not null in
order to "pass" in a policy. If so, then this works as expected.

However, if a query just needs to return empty (null) & 0 is implied in
the logic that sets a policy flag to green or red, then, as a rule,
queries like this should be always be simplified & should default to
using "positive" as opposed to "negative" logic, i.e., check if
something exists, never check if a thing does NOT exist.

# Checklist for submitter

If some of the following don't apply, delete the relevant line.

- [x] Input data is properly validated, `SELECT *` is avoided, SQL
injection is prevented (using placeholders for values in statements)

- [x] Added/updated tests: Tested by adding dummy Emergency Kit.pdf
files to Desktop & Downloads, running query, then, removing files &
running query.
2024-02-06 16:27:21 -05:00
RachelElysia
f076769ee2
Documentation: Spelling and grammar fixes (#16403)
---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2024-02-06 09:19:42 -05:00
Noah Talerman
7fdda53dca
API design: Upcoming activities: Run scripts on online/offline hosts (#15931)
API changes for the "Upcoming activities: Run scripts on online/offline
hosts" (#15529) story

Changes:
- Script endpoints are available in Fleet Free and Fleet Premium
- Update `POST /scripts/run` to add a script to the bottom of the
upcoming activities
- Update `POST /scripts/run/sync`
- Add `GET /hosts/:id/activities` to show past activity feed
- Add `GET /hosts/:id/activities/upcoming` to show upcoming activity
feed
- Move docs for `GET /hosts/:id/scripts` to a new "Get host's scripts
section" under "Hosts"
2024-02-05 18:37:35 -05:00
Noah Talerman
c0f6e1f1cb
API design: Add API endpoint to get manual enrollment profile (#16252) (#16255)
API changes for the "Add API endpoint to get manual enrollment profile"
story: #16252
2024-02-05 18:35:44 -05:00
Noah Talerman
9069850585
Docs and articles: Remove Windows MDM feature flag (#16399)
- Remove feature flag from the docs and articles (it no longer exists)
- Remove mention of Windows MDM not being ready for production
2024-02-05 09:11:45 -05:00
Roberto Dip
d4ef9be990
fix query generation for docs + update them (#16537)
this fixes the `go:generate` directive + adds the changes for the files
generated automatically after running `make generate-doc`
2024-02-05 09:50:05 -03:00
Victor Lyuboslavsky
78911e9595
Updated docs for PATCH teams/:id/users (#16336)
Updated docs for PATCH teams/:id/users
#16275

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2024-02-04 14:52:45 -06:00
Roberto Dip
d479f93f49
add internal docs to set end user email (#16573)
for #15057
2024-02-02 18:13:07 -03:00
Noah Talerman
ffa929b24d
Server configuration docs: enable_scheduled_query_stats (#16571)
- Clearly document the behavior for `enable_scheduled_query_stats`
2024-02-02 15:49:53 -05:00
Marko Lisica
cb593d4818
Fix broken link in MDM section (#16507) 2024-02-01 17:11:11 -06:00
Victor Lyuboslavsky
7da9019f4d
Updated enroll-hosts.md for MSI generation on macOS. (#16459)
Doc update for #15463
2024-02-01 15:23:36 -06:00
Noah Talerman
08497bd5fe
Update rest-api.md (#16508)
- Update titles for enroll secret endpoints
- Use “list” for many and “get” for single
- No articles (“a” or “the”) in titles to make them shorter
2024-01-31 18:54:27 -05:00
Noah Talerman
1022282c15
Docs: update links (#16434)
- Update links for deprecated API endpoints so that they link to the
before they were deprecated
2024-01-30 10:14:48 -05:00
Marko Lisica
fb395f5ef1
API design: software titles (#14831)
API changes for the following story: 
- #14674 

- Both `GET /software` and [`GET
/software/versions`](https://github.com/fleetdm/fleet/pull/14831/files#diff-7246bc304b15c8865ed8eaa205e9c244d0a0314e4bae60cf553dc06147c38b64R7035)
will work the same. We're just documenting `GET /software/versions`
- Both `GET /software/{id}` and `GET /software/versions/{id}` will work
the same. We're just documenting `GET /software/versions/{id}`
- `count` added in both `GET /software/versions` and `GET
/software/titles`. `GET / software/count` still available (but removed
from docs).

---------

Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
Co-authored-by: Sarah Gillespie <73313222+gillespi314@users.noreply.github.com>
Co-authored-by: Rachael Shaw <r@rachael.wtf>
2024-01-29 17:19:26 -06:00
Grant Bilstad
f49075c58d
broken scripts API link on scripts execution doc (#16415)
Docs change to fix broken link
2024-01-29 15:57:39 -07:00
Victor Lyuboslavsky
edee09e22a
Added parameter to PATCH /fleet/teams/:id endpoint (#16254)
API doc update for #15609

Added parameter to PATCH /fleet/teams/:id endpoint
2024-01-24 13:06:15 -06:00
Marko Lisica
99163d5dfc
MDM Custom settings (profiles) - API changes (#14230)
API changes for the Windows configuration profiles story:
- #13281 

It's **ready for review**, but marked as a draft because of KPI (PR open
time)

- DONE: Remove activity types changes before merging (those will be
automatically generated)

#### `profile_id` and `profile_uuid` changes specified in following
ticket:
- #15274

---------

Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
Co-authored-by: Rachael Shaw <r@rachael.wtf>
2024-01-24 11:13:56 -06:00
Rachael Shaw
88d8bf3b90
Update docs for CIS benchmark support (#16211) 2024-01-24 09:57:19 -05:00
Luke Heath
576405b029
Typo fix (#16306) 2024-01-23 16:52:05 -06:00
Sharon Katz
09f9e4ba82
16026 - document that Disa-stig linux distribution is not supported. (#16281)
Co-authored-by: Rachael Shaw <r@rachael.wtf>
2024-01-23 14:19:51 -06:00
Luke Heath
0f245df4fe
Clarification and typo fix in releasing Fleet docs (#16266) 2024-01-22 17:13:07 -06:00
Victor Lyuboslavsky
4a5945b612
Corrected recent_vulnerability_max_age option. (#16153) 2024-01-17 16:06:32 -06:00
Mike Thomas
17f0a4e28e
Update tutorials-and-guides.md (#16158)
typo fix
2024-01-17 15:32:48 -06:00
Victor Lyuboslavsky
ac068f85c8
Failing policies are now listed first. (#16103)
API doc changes for #10379 -- failing policies are listed first.
2024-01-16 10:23:31 -06:00
Marko Lisica
8aaa4600ed
Docs: Configure script execution timeout (#15483)
Docs changes for:
- #15196
2024-01-12 17:29:43 -05:00
Noah Talerman
2132c7ee17
Update Fleet server configuration docs (#16054)
- Pull info about duration-based settings to the top to make it clear.
For this bug: #15926
- Add info about self-managed v. managed-cloud customers
- Cut content
2024-01-12 17:28:18 -05:00
Noah Talerman
c5738fbdeb
Update supported host operating system (#16070)
- macOS is always lowercased
2024-01-11 17:11:46 -05:00
Grant Bilstad
cd7da443a3
paragraph doubled in enroll docs (#16069)
Edit to remove double-copy of paragraph in docs
2024-01-11 14:09:42 -07:00
Rachael Shaw
0f3458b2a0
#14500 documentation: Option to disable scripts in organization settings (#15431)
Changes to the organization settings configuration example for
https://github.com/fleetdm/fleet/issues/14500
2024-01-11 14:37:25 -05:00
Rachael Shaw
bc075b1eea
#15058 API design: Add gigs total disk space to host endpoints (#15442)
Rest API changes for https://github.com/fleetdm/fleet/issues/15058
2024-01-11 14:35:56 -05:00
Rachael Shaw
7c84588689
#14800 API design: POST request for "Run live query" endpoint (#15508)
"Run live query" API updates based on @jrzmurray's PR
https://github.com/fleetdm/fleet/pull/13002, to resolve issue
https://github.com/fleetdm/fleet/issues/14800.
2024-01-11 14:28:48 -05:00
Katheryn Satterlee
e761ba529d
Update MySQL requirements (#15940)
Added a note about using alternative database servers with Fleet.

Resolves #15766
2024-01-11 10:00:38 -06:00
Noah Talerman
7a0e2089c4
API design: Get email w/o relying on end user (#15445)
- API changes for Get email w/o relying on end user: #15057
2024-01-10 17:29:51 -05:00
Noah Talerman
5f38355169
Merge fleetd doc page to enroll hosts page (#15907)
- Move relevant content from "Fleetd" doc page to "Enroll hosts" page
- Remove "Fleetd" docs page
2024-01-10 14:35:18 -05:00
Marko Lisica
89ff5541d3
API design: Lookup hosts based on IdP email (#15305)
API changes for the following story:

- #13034
2024-01-10 09:23:56 -05:00
Noah Talerman
59cd1bf491
Update Vulnerability Processing docs (#15939)
- Remove sentence and break out a new line to make top section more
scannable.
2024-01-10 09:18:36 -05:00
Eric
ad4737036b
Docs: Add downgrading Fleet page (#15788)
Closes: https://github.com/fleetdm/confidential/issues/4665

Changes: 
- Added a new documentation page that provides instructions for
downgrading from Fleet premium. The content for this section was pulled
from a [commented-out FAQ
question](1d2f5ae42a/docs/Get%20started/FAQ.md (L363-L394)).

---------

Co-authored-by: Mike Thomas <78363703+mike-j-thomas@users.noreply.github.com>
Co-authored-by: Rachael Shaw <r@rachael.wtf>
2024-01-08 17:01:47 -06:00
Tim Lee
2f937ce9a2
Docs: Host Details Pack Stats API (#15672) 2024-01-04 11:16:47 -07:00
Lucas Manuel Rodriguez
bd16acb66e
Adding doc changes for configuring fleetd channels remotely (#15872)
#13825

Creating a separate PR to not block on docs review.
2024-01-04 10:23:51 -03:00
Noah Talerman
72ccbbbc6f
Update supported operating systems (#15834)
- Clarify that Fleet Desktop on Fedora and Centos require Google Chrome
as the default browser.
2024-01-03 18:00:48 -05:00
Noah Talerman
3326dd4186
API design: Target hosts by serial number (#15344)
- API changes for #14748 
- Document `hardware_serial` name to be consistent w/ `hardware_serial`
parameter in hosts endpoints
2024-01-03 17:59:23 -05:00
Noah Talerman
ef75a0131e
MDM command docs (#15803)
- Fix typo. `fleetctl mdm run-command` expects `--hosts`
2024-01-03 17:58:49 -05:00