fleet/docs/Using Fleet
Lucas Manuel Rodriguez e7f61305a9
New APIs to add/remove manual labels to/from a host (#18283)
#16767

To create a manual label:
```sh
cat labels.yml
---
apiVersion: v1
kind: label
spec:
  name: Manually Managed Example
  label_membership_type: manual
  hosts:
    - lucass-macbook-pro.local
```

To add/delete a manual label to/from a host:
```
curl -k -v -X POST -H "Authorization: Bearer $TEST_TOKEN" https://localhost:8080/api/latest/fleet/hosts/1/labels -d '{"labels": ["Manually Managed Example"]}'

curl -k -v -X DELETE -H "Authorization: Bearer $TEST_TOKEN" https://localhost:8080/api/latest/fleet/hosts/1/labels -d '{"labels": ["Manually Managed Example"]}'
```

API draft changes: https://github.com/fleetdm/fleet/pull/16979/files
Figma with error strings:
https://www.figma.com/file/JiWoAiuHlkt76s3o3Uyz6h/%2316767-API-endpoint-for-updating-a-host's-manual-labels?type=design&node-id=2-130&mode=design&t=pxRPhrn6E1bOCrEd-0

- [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] 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.~
- [X] Added/updated tests
- ~[ ] If database migrations are included, checked table schema to
confirm autoupdate~
- ~For database migrations:~
- ~[ ] Checked schema for all modified table for columns that will
auto-update timestamps during migration.~
- ~[ ] Confirmed that updating the timestamps is acceptable, and will
not cause unwanted side effects.~
- ~[ ] Ensured the correct collation is explicitly set for character
columns (`COLLATE utf8mb4_unicode_ci`).~
- [x] 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)).~
2024-04-16 06:37:58 -03:00
..
Audit-logs.md Add activity item for resend configuration profile (#18271) 2024-04-15 14:18:09 -05:00
Automations.md #14916 Configuration change: Host status webhook per-team (#15612) 2024-04-10 15:28:17 -05:00
CIS-Benchmarks.md Cut content from CIS Benchmarks (#17887) 2024-04-01 11:34:39 -04:00
downgrading-fleet.md Docs: Add downgrading Fleet page (#15788) 2024-01-08 17:01:47 -06:00
enroll-chromebooks.md Enroll hosts docs improvements (#14862) 2023-11-20 19:39:41 +01:00
enroll-hosts.md Update macos-install-wine.sh with codesign warning (#17982) 2024-04-05 16:14:57 -04:00
Fleet-desktop.md Remove version support from Fleet Desktop, consolidate version support (#14093) 2023-09-23 00:27:33 -05:00
Fleet-UI.md Docs: Using Fleet > Fleet UI changes for #7766 (#14977) 2023-11-09 20:38:13 -06:00
fleetctl-CLI.md Update fleetctl-CLI.md (#17975) 2024-04-01 08:53:00 -05:00
Learn-how-to-use-Fleet.md Reorganize Fleet documentation (#12871) 2023-07-27 17:40:01 -05:00
Log-destinations.md Docs: how the product sets the name attribute of the scheduled query (#14307) 2023-11-02 14:57:42 -05:00
manage-access.md New APIs to add/remove manual labels to/from a host (#18283) 2024-04-16 06:37:58 -03:00
MDM-commands.md MDM command docs (#15803) 2024-01-03 17:58:49 -05:00
MDM-custom-OS-settings.md Tweak custom OS settings docs (#17277) 2024-03-01 12:05:36 -05:00
MDM-disk-encryption.md Fix broken links in documentation (#16708) 2024-02-09 15:00:04 -06:00
MDM-macOS-setup-experience.md Update end user auth and SSO docs (#18127) 2024-04-12 16:39:56 -05:00
MDM-macOS-setup.md Update MDM-macOS-setup.md (#17807) 2024-03-26 12:36:38 -05:00
MDM-migration-guide.md Docs: Windows custom OS settings (profiles) (#16398) 2024-02-07 17:51:23 -05:00
MDM-OS-updates.md Docs: Windows OS updates (#16270) 2024-02-16 14:30:00 -06:00
Osquery-process.md Reorganize Fleet documentation (#12871) 2023-07-27 17:40:01 -05:00
Puppet-module.md Puppet module docs (#15336) 2023-12-04 11:18:18 -05:00
README.md Reorganize Fleet documentation (#12871) 2023-07-27 17:40:01 -05:00
Scripts.md Update script execution documentation (#17147) 2024-03-21 13:50:18 -05:00
segment-hosts.md Update "Team member" wording in docs to reference users instead. (#17116) 2024-02-29 16:07:59 -05:00
Supported-browsers.md Reorganize Fleet documentation (#12871) 2023-07-27 17:40:01 -05:00
Supported-host-operating-systems.md Update Supported-host-operating-systems.md (#17661) 2024-03-15 18:03:33 -04:00
Understanding-host-vitals.md run make generate-docs for DDM activities (#17888) 2024-04-08 13:19:56 -03:00
update-agents.md Fix broken links in documentation (#16708) 2024-02-09 15:00:04 -06:00
Usage-statistics.md 2023-11-21 Website: Add new usage statistics (#15263) 2023-12-01 17:59:41 -06:00
Vulnerability-Processing.md Removed current_instance_checks from docs. (#18186) 2024-04-15 10:25:04 -05:00

Using Fleet

Fleet UI

Provides documentation about running and scheduling queries from within the Fleet UI

fleetctl CLI

Includes resources for setting up and configuring Fleet via the fleetctl CLI

Enroll hosts

Provides resources for enrolling your hosts to Fleet

Log destinations

Includes documentation on the log destinations for sending with osquery logs

Osquery processes

Includes documentation about osquery children processes and under which conditions they are terminated