Commit graph

122 commits

Author SHA1 Message Date
Victor Lyuboslavsky
a541961a26
fleetd telemetry doc updates (#23423)
docs for #23413
2024-11-14 13:43:16 -06:00
Konstantin Sykulev
48b992e268
Modify status code for software batch endpoint (#23711)
When using the `fleet/software/batch` endpoint, due to its async nature,
it should return a 202 (Accepted) rather than a 200 (Ok).

https://github.com/fleetdm/fleet/issues/23492

# 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://github.com/fleetdm/fleet/blob/main/docs/Contributing/Committing-Changes.md#changes-files)
for more information.
- [x] Added/updated tests
- [x] Manual QA for all new/changed functionality
2024-11-13 17:22:51 -06:00
Rachael Shaw
f5598e003c
Docs v4.59.0 (#23693) 2024-11-12 11:05:45 -06:00
Victor Lyuboslavsky
c4c1b65492
NDES REST API and config doc changes (#22968) 2024-11-12 11:05:33 -06:00
Rachael Shaw
4cc3e3bb63
Docs v4.58.0 (#22769) 2024-10-17 17:51:52 -05:00
Marko Lisica
c545495f60
API design: Self-service: Install Apple App Store apps on macOS (#22102)
API design for:
- #19620
2024-10-01 17:09:33 -04:00
Noah Talerman
beec753a3f
API docs: OTA enrollment profile (#22457)
- Bring OTA enrollment profile endpoint into REST API docs
2024-10-01 17:07:30 -04:00
Jahziel Villasana-Espinoza
38ba6cce47
fix: update docs with accurate response body (#22360) 2024-09-25 09:44:08 -05:00
Dante Catalfamo
d83ed46373
Add batch app store apps documentation (#21912) 2024-09-23 18:09:31 -05:00
Lucas Manuel Rodriguez
21b3c468c1
Add doc API changes for the now async software batch (#22259)
API changes for #22069.

---------

Co-authored-by: Marko Lisica <83164494+marko-lisica@users.noreply.github.com>
Co-authored-by: Ian Littman <iansltx@gmail.com>
Co-authored-by: Noah Talerman <noahtal@umich.edu>
2024-09-23 17:40:53 -05:00
Lucas Manuel Rodriguez
dfc7289a6d
Add missing docs for batch apply VPP apps (#22265)
#22069
2024-09-23 17:24:08 -04:00
Noah Talerman
adf19c4527
Reference docs for v4.57.0 (#22319)
Co-authored-by: Rachael Shaw <r@rachael.wtf>
Co-authored-by: mostlikelee <tim@mostlikelee.com>
Co-authored-by: Tim Lee <timlee@fleetdm.com>
Co-authored-by: Marko Lisica <markol.lisica@gmail.com>
Co-authored-by: Ian Littman <iansltx@gmail.com>
Co-authored-by: Luke Heath <luke@fleetdm.com>
2024-09-23 15:56:59 -05:00
Noah Talerman
1677783064
GitOps & API design: Add multiple Apple Business Manager and Volume Purchasing Program connections (#21043)
GitOps and API changes for the following story:
- #9956

DONE: 
- ~~Contributor API endpoints to support best practice GitOps (`fleetctl
gitops`) and backwards compatibility GitOps (`fleetctl apply`)~~
  - https://github.com/fleetdm/fleet/pull/21043#issuecomment-2338218929

---------

Co-authored-by: Martin Angers <martin.n.angers@gmail.com>
Co-authored-by: Dante Catalfamo <43040593+dantecatalfamo@users.noreply.github.com>
Co-authored-by: Marko Lisica <83164494+marko-lisica@users.noreply.github.com>
Co-authored-by: George Karr <georgekarrv@users.noreply.github.com>
Co-authored-by: Gabriel Hernandez <ghernandez345@gmail.com>
Co-authored-by: Rachael Shaw <r@rachael.wtf>
2024-09-20 12:21:52 -05:00
Victor Lyuboslavsky
970b7b6f84
Added uninstall_script to software/batch (#22040)
Contributor docs for #20320
2024-09-16 11:25:54 -05:00
Victor Lyuboslavsky
6b20dade95
Added endpoints for downloading software package. (#21346)
Updated contributor docs for #19561
2024-08-21 14:14:08 -05:00
Gabriel Hernandez
e1e425a2ab
add UI to support self service VPP software (#21174) (#21415)
relates to #19883

implements UI to support self service VPP apps. 

**Self service checkbox in add software modal**



![image](https://github.com/user-attachments/assets/bb6f3b3b-61aa-4a78-a223-e73ad2c2c5b9)

The rest of the changes are the same as the original self service
feature.

- [x] Changes file added for user-visible changes in `changes/`,
`orbit/changes/` or `ee/fleetd-chrome/changes`.
See [Changes

files](https://github.com/fleetdm/fleet/blob/main/docs/Contributing/Committing-Changes.md#changes-files)
for more information.
- [x] Manual QA for all new/changed functionality
2024-08-20 15:51:36 +01:00
Marko Lisica
0a2a48b6d8
API design: Install Apple App Store apps on macOS (#19291) 2024-08-09 10:00:21 -07:00
Luke Heath
12132b3a50
Make contributor API warning clearer (#20814) 2024-08-06 14:34:11 -07:00
Tim Lee
a6a9a2e1c2
no team software gitops (#20847)
#20464 

Adding gitops support for a top level `software` key to be used to
manage installable software into "no team".

- [ ] Changes file added for user-visible changes in `changes/`,
`orbit/changes/` or `ee/fleetd-chrome/changes`.
See [Changes
files](https://github.com/fleetdm/fleet/blob/main/docs/Contributing/Committing-Changes.md#changes-files)
for more information.
- [X] Added/updated tests
- [X] Manual QA for all new/changed functionality

---------

Co-authored-by: Victor Lyuboslavsky <victor.lyuboslavsky@gmail.com>
2024-08-05 14:39:10 -03:00
Noah Talerman
0f41fc1a8d
API design: Hide "Self-service" if there's no self-service software (#20908) 2024-08-02 12:49:20 -07:00
Roberto Dip
42ff57d059
UI/Docs changes to rotate keys using Escrow Buddy (#20843)
UI portion for #13157

# 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] Added/updated tests
- [x] Manual QA for all new/changed functionality
2024-07-31 16:49:24 -03:00
Marko Lisica
36c1b918d3
API design: Scope configuration profiles to hosts by excluding any label (#20614)
API design for:  #17315

Old PR: #18844

---------

Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
2024-07-26 12:32:02 +02:00
Marko Lisica
7ff93583e8
API changes: Increase timeout limit for scripts (#20650)
API changes for:  #16645
2024-07-25 18:25:48 -04: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
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
Noah Talerman
23e80f2ce4
API design: Deploy security agents to macOS, Windows, and Linux hosts (#19245)
API changes for:
- #14921
2024-05-23 17:07:07 -04:00
Rachael Shaw
6fa8763714
API design: Add declaration (DDM) profiles for macOS (#18718)
Fresh PR to avoid product design PRs messing with the PR open time KPI
(original here: https://github.com/fleetdm/fleet/pull/17369)

---------

Co-authored-by: Marko Lisica <83164494+marko-lisica@users.noreply.github.com>
2024-05-02 17:33:06 -05:00
Marko Lisica
b032ddf06e
Add missing searchable fields to docs (#17825)
Docs are missing some of the searchable fields.
2024-04-12 17:34:38 -04:00
Victor Lyuboslavsky
165917b492
Doc changes for running live queries with team_id=0 (No team) (#17267)
Doc changes for #16350
2024-03-07 14:23:18 -06:00
Eric
dcaf2d0a4c
Website: update relative link validation in markdown content (#17213)
Closes: #16797

Changes:
- Updated `build-static-content` to throw an error if an extensionless
Markdown link containing a hash link is found.
- Fixed two broken relative links in the contributing documentation
2024-03-07 13:45:41 -06:00
Marko Lisica
489b45368e
API design: enable profiles based on labels (#15117)
API changes for the following story: 
- #14715

---------

Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
Co-authored-by: Rachael Shaw <r@rachael.wtf>
Co-authored-by: Roberto Dip <me@roperzh.com>
2024-02-23 12:54:18 -06: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
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
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
Victor Lyuboslavsky
2520fc2179
Reduce server load for fleetd upgrade (#15606)
📺 Loom:
https://www.loom.com/share/9e17848963574af3aa10d426b450bcd0?sid=f8078293-c7e1-4864-a8a3-4cec996971f5

#15476 
#15540 
#15542

After upgrading fleetd, customer-blanco saw a spike in traffic and a
spike in DB connections. These fixes attempt to reduce the traffic and
DB load when fleetd is upgraded.

On the server, added fleet/device/{token}/ping endpoint to be used by
agents to check their token.

On the agent:
- Removed call to fleet/orbit/device_token unless token needs to be
updated.
- Changed call to fleet/device/{token}/desktop with a less resource
intensive call to fleet/device/{token}/ping
- Removed call to fleet/orbit/ping

# 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] Manual QA for all new/changed functionality
  - For Orbit and Fleet Desktop changes:
- [x] Manual QA must be performed in the three main OSs, macOS, Windows
and Linux.
- [x] Auto-update manual QA, from released version of component to new
version (see [tools/tuf/test](../tools/tuf/test/README.md)).
2023-12-13 14:31:48 -06:00
Noah Talerman
845ef393bb
Update scripts docs (#15416)
- Simplify usage instructions to make it more like a reference
- Move "Run script asynchronously" to contributor docs so that user
facing API docs have one best practice API endpoint for scripts. Call
synchronous endpoint "Run script"
2023-12-06 12:40:42 -05:00
Martin Angers
6fd06d6486
Add back Windows Profiles documentation changes (#15358) 2023-12-04 08:41:37 -05:00
Roberto Dip
9c7b740b03
disable windows profiles feature in the back-end (#15278)
per discussion in slack, reverting relevant user-facing changes for
#13281
2023-11-27 16:08:52 -03:00
Roberto Dip
319b64f368
allow to set mdm.windows_settings.custom_settings in configs (#15145)
for #14361 this adds the bits related to saving a slice of strings with
paths to configuration profiles.

---------

Co-authored-by: Martin Angers <martin.n.angers@gmail.com>
Co-authored-by: Marko Lisica <83164494+marko-lisica@users.noreply.github.com>
2023-11-15 13:58:46 -03:00
Marko Lisica
de5695659a
Batch-apply scripts: parameters documented incorrectly (#14653)
# Checklist for submitter

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

- [ ] 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.
- [ ] Documented any API changes (docs/Using-Fleet/REST-API.md or
docs/Contributing/API-for-contributors.md)
- [ ] Documented any permissions changes (docs/Using
Fleet/manage-access.md)
- [ ] Input data is properly validated, `SELECT *` is avoided, SQL
injection is prevented (using placeholders for values in statements)
- [ ] Added support on fleet's osquery simulator `cmd/osquery-perf` for
new osquery data ingestion features.
- [ ] Added/updated tests
- [ ] Manual QA for all new/changed functionality
  - For Orbit and Fleet Desktop changes:
- [ ] Manual QA must be performed in the three main OSs, macOS, Windows
and Linux.
- [ ] Auto-update manual QA, from released version of component to new
version (see [tools/tuf/test](../tools/tuf/test/README.md)).
2023-10-26 10:59:10 +02:00
Roberto Dip
2f589ff37c
document flags required for fleetd error reporting (#14656)
For #13189, this documents the server config flag required to report
errors.
...
2023-10-19 23:49:18 -05:00
Rachael Shaw
10ed97e570
Docs: API changes for #7766 (#13484)
Draft PR to show API changes for #7766

#13469

---------

Co-authored-by: Lucas Rodriguez <lucas@fleetdm.com>
Co-authored-by: Mike McNeil <mikermcneil@users.noreply.github.com>
2023-10-16 23:34:32 -05:00
Roberto Dip
9ffa11c25d
Feat: saved scripts (#14409)
For #9537
2023-10-10 19:00:45 -03:00
Marcos Oviedo
f0d77ab3db
Merging Bitlocker feature branch (#14350)
This relates to #12577

---------

Co-authored-by: gillespi314 <73313222+gillespi314@users.noreply.github.com>
Co-authored-by: Roberto Dip <dip.jesusr@gmail.com>
2023-10-06 19:04:33 -03:00
Katheryn Satterlee
8852709d6e
Update messaging for contributor API (#13494)
Added additional information about what differentiates the Contributor
API routes from the public API routes.

# Checklist for submitter

Docs-only change
2023-09-29 17:03:29 -05:00
Roberto Dip
e18b6bd52b
add missing docs for org_info (#13972)
As the title says, this adds missing docs for a feature we shipped a
while ago.

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2023-09-22 19:15:37 -03:00
Eric
1b25187453
Docs: add syntax highlighting keywords to code blocks (#13963)
Closes: #13691

Changes: 
- Added keywords for syntax highlighting to code blocks in documentation
Markdown files.

---------

Co-authored-by: Mike Thomas <78363703+mike-j-thomas@users.noreply.github.com>
2023-09-22 16:57:40 -05:00
Noah Talerman
6026130a8e
Update API docs: add get host by device token (#13761)
- Add get host by device token
- Remove this API route from the contributor docs
2023-09-12 17:13:09 -04:00
Roberto Dip
5c7019cfc4
allow clients to report errors back to the server (#13478)
for #13189, #13238 and #13239
2023-08-24 13:04:27 -03:00
Dave Herder
d0caf81bca
Update API-for-contributors.md (#13027)
Updated the name options for the trigger endpoint
2023-07-28 14:18:45 -04:00