Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Lock host API: include host data in lock and wipe response #23241

Closed
18 of 19 tasks
noahtalerman opened this issue Oct 25, 2024 · 5 comments
Closed
18 of 19 tasks

Lock host API: include host data in lock and wipe response #23241

noahtalerman opened this issue Oct 25, 2024 · 5 comments
Assignees
@iansltx
Labels
~backend Backend-related issue. ~customer promise A feature request from a Fleet customer that Fleet has contractually agreed to deliver customer-pingali #g-software Software product group P2 Prioritize as urgent :product Product Design department (shows up on 🦢 Drafting board) story A user story defining an entire feature
Milestone
4.64.0

Comments

@noahtalerman
Copy link
Member

noahtalerman commented Oct 25, 2024 •
edited
Loading

Goal

User story
As an IT admin,
I want to get more information from the lock host API
so that I can automate confirmation that the host was locked.

Objective

Small UX improvement

Original requests

Context

Changes

Product

  • UI changes: No changes
  • CLI (fleetctl) usage changes: No changes
  • YAML changes: No changes
  • REST API changes: PR
  • Fleet's agent (fleetd) changes: No changes
  • GitOps mode changes: No changes.
  • Activity changes: No changes
  • Permissions changes: No changes
  • Changes to paid features or tiers: No changes
  • Other reference documentation changes: No changes
  • Once shipped, requester has been notified: Lock API: 204 response doesn't clarify status #22762 (comment)
  • Once shipped, dogfooding issue has been filed: @noahtalerman: No need for dogfooding. Testing this one is covered by QA

Engineering

  • Feature guide changes: No changes
  • Database schema migrations: No changes
  • Load testing: No changes
  • Specification: implement per the API change PR.
  • Test-plan - To be created by the DRI engineer and approved by QA person

ℹ️  Please read this issue carefully and understand it. Pay special attention to UI wireframes, especially "dev notes".

QA

Risk assessment

  • Requires load testing: No
  • Risk level: Low

Manual testing steps

  1. With Dev Tools open, lock a host via the Fleet web UI. Should see pending action and device status in the response to the lock API call.
  2. Unlock the host via the web UI. Should see pending action and device status in the response to the unlock API call.
  3. Wipe the host via the web UI. Should see the pending action and device status in the response to the wipe API call.

Bonus points for testing across multiple platforms.

Testing notes

  • Check to see if device_status and pending action in example responses in docs are accurate for macOS.

^ confirmed accurate for macOS as well - @iansltx (self-QA'd with macOS and we checked the statuses with the host details call in our integration test suite)

Confirmation

  1. Engineer (@iansltx): Added comment to user story confirming successful completion of QA.
  2. QA (@jmwatts): Added comment to user story confirming successful completion of QA.
@noahtalerman noahtalerman added story A user story defining an entire feature :product Product Design department (shows up on 🦢 Drafting board) #g-endpoint-ops Endpoint ops product group labels Oct 25, 2024
@noahtalerman noahtalerman mentioned this issue Oct 25, 2024
Open
@rachaelshaw rachaelshaw added #g-mdm MDM product group and removed #g-endpoint-ops Endpoint ops product group labels Oct 29, 2024
@rachaelshaw rachaelshaw mentioned this issue Oct 29, 2024
Merged
@rachaelshaw rachaelshaw added #g-endpoint-ops Endpoint ops product group and removed #g-mdm MDM product group labels Oct 31, 2024
rachaelshaw added a commit that referenced this issue Oct 31, 2024
@rachaelshaw
#23241 API design: Include host data in lock/wipe responses (#23374)
9e92ba6 
For #23241
@sharon-fdm sharon-fdm added the ~backend Backend-related issue. label Nov 4, 2024
@sharon-fdm
Copy link
Collaborator

Hey team! Please add your planning poker estimate with Zenhub @iansltx @lucasmrod @mostlikelee

@sharon-fdm sharon-fdm removed their assignment Nov 8, 2024
@noahtalerman noahtalerman added Epic DO NOT USE. Auto-created by ZenHub, cannot be disabled. customer-pingali and removed Epic DO NOT USE. Auto-created by ZenHub, cannot be disabled. labels Nov 11, 2024
@rachaelshaw rachaelshaw mentioned this issue Nov 18, 2024
Merged
rachaelshaw added a commit that referenced this issue Nov 18, 2024
@rachaelshaw
Remove docs for #23241 (Include host data in lock/wipe responses) (#2…
0e22a7c 
…3934)

#23241 is no longer planned for the v4.61.0 release (didn't make it into
the sprint)
@noahtalerman noahtalerman added Epic DO NOT USE. Auto-created by ZenHub, cannot be disabled. ~customer promise A feature request from a Fleet customer that Fleet has contractually agreed to deliver and removed Epic DO NOT USE. Auto-created by ZenHub, cannot be disabled. labels Nov 22, 2024
ksykulev pushed a commit that referenced this issue Nov 30, 2024
@rachaelshaw @ksykulev
#23241 API design: Include host data in lock/wipe responses (#23374)
5b94e0a 
For #23241
ksykulev pushed a commit that referenced this issue Nov 30, 2024
@rachaelshaw @ksykulev
Remove docs for #23241 (Include host data in lock/wipe responses) (#2…
ec9bab4 
…3934)

#23241 is no longer planned for the v4.61.0 release (didn't make it into
the sprint)
@lukeheath lukeheath added #g-mdm MDM product group and removed #g-endpoint-ops Endpoint ops product group labels Dec 19, 2024
@lukeheath lukeheath added P2 Prioritize as urgent and removed #g-mdm MDM product group labels Jan 17, 2025
@lukeheath lukeheath added the #g-software Software product group label Jan 17, 2025
@mostlikelee mostlikelee added :release Ready to write code. Scheduled in a release. See "Making changes" in handbook. and removed :product Product Design department (shows up on 🦢 Drafting board) labels Jan 21, 2025
@iansltx iansltx added this to the 4.64.0-tentative milestone Jan 24, 2025
This was referenced Jan 24, 2025
Merged
Merged
iansltx added a commit that referenced this issue Jan 27, 2025
@iansltx
Include current host status and pending action in lock, unlock, and w…
8ee29dc 
…ipe API calls (#25754)

For #23241.

# 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 automated tests
- [x] A detailed QA plan exists on the associated ticket (if it isn't
there, work with the product group's QA engineer to add it)
- [x] Manual QA for all new/changed functionality
- [x] Docs re-PR'd
iansltx added a commit that referenced this issue Jan 30, 2025
@iansltx
Add API design for including host status and pending action in lock/u…
af9b5e0 
…nlock/wipe responses (#25773)

Originally PR'd in #23374. This commit includes pending action of unlock
for macOS hosts when unlocking, includes host ID for all unlock
responses (not just macOS), and mentions that macOS hosts require
entering an unlock PIN to unlock, but is otherwise the same as the
original PR.

For #23241.
@jmwatts
Copy link
Member

jmwatts commented Feb 6, 2025 •
edited
Loading

QA Notes

MacOS

  • With Dev Tools open, lock a host via the Fleet web UI. Should see pending action and device status in the response to the lock API call.

Image

  • Unlock the host via the web UI. Should see pending action and device status in the response to the unlock API call.

Image

  • Wipe the host via the web UI. Should see the pending action and device status in the response to the wipe API call.

Image

Windows

  • With Dev Tools open, lock a host via the Fleet web UI. Should see pending action and device status in the response to the lock API call.

Image

  • Unlock the host via the web UI. Should see pending action and device status in the response to the unlock API call.

Image

  • Wipe the host via the web UI. Should see the pending action and device status in the response to the wipe API call.

Image

Linux

  • With Dev Tools open, lock a host via the Fleet web UI. Should see pending action and device status in the response to the lock API call.

Image

  • Unlock the host via the web UI. Should see pending action and device status in the response to the unlock API call.

Image

  • Wipe the host via the web UI. Should see the pending action and device status in the response to the wipe API call.

Image

@jmwatts
Copy link
Member

jmwatts commented Feb 6, 2025

@iansltx I just want to confirm that it is expected that only the "Unlock" API response contains the host_id field?

@iansltx
Copy link
Member

iansltx commented Feb 6, 2025

@jmwatts yep; the host ID being in there at all is a holdover from the existing API, and adding it to the other two endpoints isn't in the API docs for this revision unless I missed something.

@lukeheath lukeheath added :product Product Design department (shows up on 🦢 Drafting board) and removed :release Ready to write code. Scheduled in a release. See "Making changes" in handbook. labels Feb 18, 2025
@fleet-release
Copy link
Contributor

Lock host API shines,
More data flows, confirms locked,
Admin's peace of mind.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@iansltx iansltx

Labels
~backend Backend-related issue. ~customer promise A feature request from a Fleet customer that Fleet has contractually agreed to deliver customer-pingali #g-software Software product group P2 Prioritize as urgent :product Product Design department (shows up on 🦢 Drafting board) story A user story defining an entire feature
Projects
None yet
Milestone
4.64.0
Development

No branches or pull requests
8 participants
@iansltx @lukeheath @rachaelshaw @mostlikelee @noahtalerman @fleet-release @sharon-fdm @jmwatts