Commit graph

1888 commits

Author SHA1 Message Date
Rachael Shaw
e4044c5d63
Documentation for query_report_cap config (#20414)
- Add documentation for the `query_report_cap` config option. For #19600
2024-07-15 14:10:34 -04:00
James Kane
4e0c447daa
Add "exclude software" parameter to get host by identifier (#20133)
For #19540

Just added the same "exclude_software" functionality that exists in "get
hosts" to the "get host by identifier" function.

- [ ] Changes file added for user-visible changes in `changes/`,
`orbit/changes/` or `ee/fleetd-chrome/changes`.
See [Changes
files](https://fleetdm.com/docs/contributing/committing-changes#changes-files)
for more information.
- [ ] Manual QA for all new/changed functionality
2024-07-11 15:48:15 -05:00
Tim Lee
32176ef286
Ubuntu Kernel Vuln Docs (#20125)
Doc updates

---------

Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
Co-authored-by: Noah Talerman <noahtal@umich.edu>
Co-authored-by: Rachael Shaw <r@rachael.wtf>
2024-07-11 10:40:44 -05:00
Rachael Shaw
50a967bb53
Fix link to GitOps docs (#20365) 2024-07-10 17:08:06 -05:00
Eric
6b87d83207
Update commented out line on segment-hosts docs page (#20361)
Changes:
- Updated the commented out bullet point in the segment hosts page to
fix a rendering issue on fleetdm.com
2024-07-10 16:43:06 -05:00
Noah Talerman
fc12b24851
Update best practice teams (#20290)
- Add "Company-owned iPhones" and "Company-owned iPads"
- "BYOD iPhones" coming soon
2024-07-10 16:32:57 -04:00
Tim Lee
812140a760
Add createdAt to Vulnerability responses (#20019) 2024-07-09 11:09:16 -06:00
Lucas Manuel Rodriguez
2875a9dbb8
Fixes to fleetctl debug connection and TLS certs documentation (#20166)
#6085

- [X] Changes file added for user-visible changes in `changes/`,
`orbit/changes/` or `ee/fleetd-chrome/changes`.
See [Changes
files](https://fleetdm.com/docs/contributing/committing-changes#changes-files)
for more information.
- [X] Added/updated tests
- [x] Manual QA for all new/changed functionality
2024-07-09 14:04:23 -03:00
Marko Lisica
055145b7d3
API design: Software self-service (#20223)
API design for:
- #17587

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
Co-authored-by: Martin Angers <martin.n.angers@gmail.com>
2024-07-09 18:23:44 +02:00
Noah Talerman
2d2178655c
Update GitOps reference docs (#20255)
- `fleetctl apply` is for backwards compatibility GitOps
- Remove link to contributor doc page
2024-07-08 16:20:12 -04:00
Eric
df9a27769a
Fix broken link in GitOps docs (#20251)
Changes:
- Fixed a broken link on the GitOps documentation page
2024-07-08 13:52:18 -05:00
Robert Fairburn
3972c8a004
Update ref architecture + pricing to reflect terraform module (#20234) 2024-07-05 14:28:33 -05:00
Rachael Shaw
e0f18ef267
Update instructions for getting API-only user's API token (#20217)
Additional doc changes for
https://github.com/fleetdm/fleet/issues/16961.

+ Add example CLI response that shows the token being printed after
creating an API-only user
+ Add instructions to use the log in API to get the token again
+ Remove separate section about getting API-only user's API token
2024-07-03 17:35:31 -05:00
Marko Lisica
606fa14ed4
Fix broken link (#20151)
Link isn't working (org_setings)
2024-07-03 16:29:10 -05:00
Marko Lisica
9299f303e7
List software API: Fix the typo (#20155)
Fix the typo `GET /software/titles` > `available_for_install` param.
2024-07-02 13:59:20 -05:00
Noah Talerman
0076148a79
Docs: GitOps reference (#19740)
Docs for Fleet's best practice GitOps: #13643 (also #17043)
2024-07-02 11:11:43 -04:00
Rachael Shaw
dc9a94abfc
REST API docs: fix a few "Modify configuration" parameter descriptions (#20137)
Follow up from https://github.com/fleetdm/fleet/pull/20109: there were a
few descriptions that just said "body" because of some table rows with
an extra column I missed when merging in recent updates.
2024-07-01 17:05:29 -05:00
Rachael Shaw
1c3448eb42
Update how we document the objects in the "Modify configuration" parameters (#20109)
Since the "Modify config" parameters are mostly a bunch of different
objects, it's a bit unwieldy to document in one table. Trying out a new
format to see if it feels like the right way to document nested objects
in API parameters.
2024-07-01 16:51:56 -05:00
Noah Talerman
93eb61057c
API design: Find hosts with the most issues (#20122)
API changes for the "Find hosts with the most issues" story
- #18115
2024-07-01 16:06:21 -04:00
Noah Talerman
a53dff6200
iPhones and iPads can automatically enroll (#20124)
- Update ABM docs
2024-07-01 16:04:42 -04:00
Noah Talerman
5775f47a28
API design: Get unlock PIN immediately after locking macOS host (#20123)
API changes for the "Get unlock PIN immediately after locking macOS
host" story (https://github.com/fleetdm/fleet/issues/19545)

---------

Co-authored-by: Victor Lyuboslavsky <victor.lyuboslavsky@gmail.com>
2024-07-01 13:45:01 -05:00
Noah Talerman
36f7406eda
Server configuration docs: Comment out section (#20034)
- See commented out section for context
2024-06-28 17:11:02 -04:00
Roberto Dip
196f761b6d
use the latest fleetd-base version for MDM commands (#20078)
for #19176

# 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/`,
`orbit/changes/` or `ee/fleetd-chrome/changes`.
See [Changes
files](https://fleetdm.com/docs/contributing/committing-changes#changes-files)
for more information.
- [x] Added/updated tests
- [x] Manual QA for all new/changed functionality
2024-06-28 16:35:07 -03:00
Luke Heath
30ed2918d4
Switch to one planned patch per sprint (#20070) 2024-06-28 11:10:14 -07:00
RachelElysia
f26acee2e1
Fleet docs: Update config > sso settings documentation (#20092) 2024-06-28 13:42:14 -04:00
RachelElysia
077915eb38
Fleet docs: Update config > features documentation (#20087) 2024-06-28 13:32:57 -04:00
Noah Talerman
e9d4749eb8
Server configuration docs: S3 for software and carves (#20032)
Docs from changes to address following bug:
- #19526
2024-06-28 10:40:02 -04:00
Eric
e10b6c72c7
Docs: Update broken link in REST API documentation (#20060)
Closes: https://github.com/fleetdm/fleet/issues/20041

Changes:
- Updated a link to a moved section in the scripts section of the REST
API documentation
2024-06-27 18:31:45 -05:00
Noah Talerman
eb3d8d3405
API design: Upload APNs cert and ABM token (#19862)
API changes for:
- #10383

---------

Co-authored-by: Marko Lisica <83164494+marko-lisica@users.noreply.github.com>
Co-authored-by: George Karr <georgekarrv@users.noreply.github.com>
2024-06-27 10:06:39 -05:00
Rachael Shaw
a59cfc00be
16961 API changes (#20049)
API changes for #16961 

See https://github.com/fleetdm/fleet/pull/17609
2024-06-27 09:52:48 -05:00
Noah Talerman
e644f53335
Update docs: Webhooks for global activity (#19863)
Docs for the "Webhooks for global activity feed" story (#14722)

- Add item to permissions table
- Clean up and simplify Audit logs top section. It's a reference page
- Link to Audit logs reference from Automations page
2024-06-26 16:48:58 -04:00
Zach Wasserman
b2dec6de57
Fix anchor link for agent uninstall (#19937)
For #19936

# 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/`,
`orbit/changes/` or `ee/fleetd-chrome/changes`.
See [Changes
files](https://fleetdm.com/docs/contributing/committing-changes#changes-files)
for more information.
- [ ] Manual QA for all new/changed functionality
2024-06-25 13:06:03 -07:00
Noah Talerman
c7dfaf45f7
Update docs: Vulnerability Processing page (#19861)
- Fleet detects vulns (CVEs) for Linux kernels: #18053
2024-06-20 12:55:45 -05:00
Victor Lyuboslavsky
e3510cdcf6
Add exclude_software query param to hosts endpoint. (#19617)
API docs change for #19348
2024-06-20 08:06:46 -05:00
Victor Lyuboslavsky
c3efefa44a
Updated locked_host activity docs. (#19792)
#19545
Updated locked_host activity docs.
2024-06-17 11:54:56 -05:00
Dave Herder
bb6ee46987
fix a broken link in MDM-setup section (#19756)
Co-authored-by: Rachael Shaw <r@rachael.wtf>
2024-06-14 12:17:33 -07:00
Noah Talerman
a327aacdc4
REST API docs: Fix typo (#19729) 2024-06-13 13:43:17 -04:00
Marko Lisica
f71819a673
API design: Webhooks for global activity feed (#19725)
API design for: #14722

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2024-06-13 17:31:56 +02:00
Noah Talerman
19cd94385f
Contributor docs: APNs and ABM in the UI (#19549)
- Remove outdated sections
2024-06-12 18:31:09 -04:00
Noah Talerman
d7394aae6b
Device management > Setup and Commands docs: iOS/iPadOS (#19590)
- Update "Setup" and "Commands" doc pages to mention iOS and iPadOS.
2024-06-12 18:30:46 -04:00
Noah Talerman
80677d1dd0
REST API docs: Add policy (#19699)
- Fix typo in descriptions
- Remove legacy/deprecated way of adding a policy
2024-06-12 18:30:28 -04:00
Noah Talerman
bac033e0d6
REST API docs: manual enrollment profile (#19593)
- Clarify that the manual enrollment profile is unsigned
2024-06-12 18:29:19 -04:00
Rachael Shaw
5b4488c6b7
API docs: Update macos_settings and windows_settings format (#19476)
Noticed several places where the structure of
`mdm.macos_settings.custom_settings` and
`mdm.windows_settings.custom_settings` didn't match the example response
for "Get configuration" (which I think is the most up-to-date).

(Will follow up and update the parameter descriptions for
`mdm.macos_settings.custom_settings`/`mdm.windows_settings.custom_settings`
to clarify they're objects with `path` and `labels` once
https://github.com/fleetdm/fleet/pull/19424 is merged.)

---------

Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
2024-06-12 15:45:26 -05:00
Dave Herder
6c44a12a9e
Fix dead rotating enroll secrets guide link (#19667) 2024-06-11 15:56:20 -07:00
Noah Talerman
08c5867260
Update segment hosts (teams) docs (#19589)
- Add Fleet's best practice
2024-06-11 17:50:33 -04:00
Noah Talerman
6aef9520e9
MDM setup docs: APNs and ABM in the UI (#19463) 2024-06-07 14:33:00 -07:00
Rachael Shaw
97cc5d17ea
Remove "available in Fleet Premium" note from scripts permissions docs (#19492)
Scripts are available to free users.
2024-06-06 11:15:56 -05:00
Marko Lisica
5ff86f0b8e
Software permissions changes (#19405)
Adding new rows to manage access table to reflect new permissions added
with #14921
2024-06-06 10:12:12 -05:00
Roberto Dip
8bc79f8478
add documentation for edge case scenario (#19496)
for #16857
2024-06-05 13:55:53 -03:00
Marko Lisica
83edd57eca
Update scripts docs (#19419)
With #17321 we added support for `zsh` interpreter and we want to
document this.

@spokanemac had a hard time understanding that we don't support `.zsh`
extension while dogfooding the feature. I added note to explain that
user must create `.sh` file with `/bin/zsh` interpreter specified.
2024-06-04 08:17:00 +02:00