Commit Graph
1755 Commits
Author SHA1 Message Date
87fe581b93 Scripts API: documented missing parameter and improved copy (#17881)
- Updated `GET /api/v1/fleet/scripts`: documented `team_id` parameter
that was missing
- Replaced "Upload" with "Add" since that's the language we want to use
across the product and docs.
- Removed articles from headings

---------

Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
Co-authored-by: Rachael Shaw <r@rachael.wtf>
2024-04-01 16:53:00 -05:00
Noah Talerman 4ae6b362b9 Cut content from CIS Benchmarks (#17887)
- Remove "Overview" header 
- Cut "MDM required" and "Fleetd required" sections
- Move "How to add" above "Requirements."
- Cut the "Audit vs. remediation" section
2024-04-01 11:34:39 -04:00
Katheryn Satterlee 2479c21622 Update fleetctl-CLI.md (#17975) 2024-04-01 08:53:00 -05:00
George KarrandRachael Shaw b0bb2e6ab5 Update FAQ.md (#17707)
This instructions were inaccurate following these steps only `Fleet
Osquery` was installed not `orbit`

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2024-03-30 02:33:41 -05:00
Dave Herder f4ab2125cc Update enroll-hosts.md (#17834) 2024-03-29 16:05:46 -07:00
George Karr 0752993c93 Update MDM-macOS-setup.md (#17807) 2024-03-26 12:36:38 -05:00
George KarrandSam Pfluger c739ed2472 Update Releasing-Fleet.md (#16725)
Updating broken link

---------

Co-authored-by: Sam Pfluger <108141731+Sampfluger88@users.noreply.github.com>
2024-03-26 12:02:09 -05:00
Noah Talerman 4271ca7fd6 Update rest-api.md (#17794)
- Clarify that hostnames are fully qualified domain names (FQDNs). FQDN
= hostname + domain.

For the following issue: #16895
2024-03-26 11:16:28 -05:00
Noah Talerman a0e3407f21 Update rest-api.md (#17801)
- Fix anchor link
2024-03-25 09:41:12 -04:00
EricandMike McNeil 6ae3880704 Website: Update build script to exclude folders with an underscore prefix & rename docs/Deploy/kubernetes/ (#17817)
Closes: #17582

Changes:
- Updated the `build-static-content` script to not generate HTML pages
for files in subfolders that are prefixed with an underscore
- Renamed the `docs/Deploy/kubernetes` folder »
`docs/Deploy/_kubernetes`
- Documented this new behavior on the communications page of the
handbook.
- Updated commands on the Deploy Fleet on Kubernetes page.

---------

Co-authored-by: Mike McNeil <mikermcneil@users.noreply.github.com>
2024-03-22 18:15:01 -05:00
Marko LisicaandRachael Shaw a71e4c7d92 Typo: "removing" /past from host's activities API (#16871)
Typo: "removing" /past from host's activities API

# 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. -->

- [ ] 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 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
- [ ] 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.
- [ ] 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)).

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2024-03-22 11:42:11 +01:00
Noah Talerman 3c33e83085 Update standard-query-library.yml (#17782)
- Policy's fail when they return no results
2024-03-21 18:48:56 -04:00
Rachael ShawandNoah Talerman 44c3ba83e5 Reduce CIS benchmark documentation page contents (#17108)
+ Move specific CIS benchmark details into READMEs
+ Reduce content in Using Fleet > CIS Benchmarks

---------

Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
2024-03-21 15:03:14 -05:00
Noah Talerman 1bb81c9e10 Update rest-api.md (#17686)
- Remove note about fleetd 
- Update note about MDM being turned on
2024-03-21 15:44:23 -04:00
Dante Catalfamo bd3e775e67 Windows MDM Fix Manual Detection (#17721)
#15565 

Replace the use of the isFederated registry key with a keys that check
for AAD (Azure Active Directory, now Entra ID)

Federated enrollment (`isFederated`) seems to be when windows uses a
Discovery MDM endpoint to get its policy and management endpoint
configuration. This is always the case when a client is enrolled with
fleet, so installations always show up as automatic.

It's being replaced by a different key, `AADResourceID`, which appears
to identify the resource that controls the automated deployment. In my
tests it only appears to be populated when the computer is enrolled
through automated deployments. This key appears on both Windows 10 and
11.

There is a similar key, `AADTenantID`, which appears to identify the
client (tenant) to the Azure cloud. I haven't seen this ID in our
systems, so it is likely exclusively used in Azure. Both this key and
`AADResourceID` seem to always be set at the same time, so we only
check for the `AADResourceID`.

I've also added documentation on the registry keys I've analyzed for future reference.
2024-03-21 15:09:05 -04:00
Jacob Thorne 8ed8f3daa7 Fix Incorrect Helm Chart Keys in MySQL Installation Documentation (#17160)
This PR addresses an issue in the documentation for installing the MySQL
chart using Helm. Previously, the documentation provided a Helm install
command that incorrectly referenced mysqlUser and mysqlDatabase.
However, these keys don't exist in the chart's values.yaml file anymore.
2024-03-21 13:59:45 -05:00
f018f68e46 Update script execution documentation (#17147)
Removed reference to **Scripts** tab and added instructions for
accessing the **Run Script** modal from the host detail page.

# Checklist for submitter

Docs-only change

---------

Co-authored-by: Brock Walters <153771548+nonpunctual@users.noreply.github.com>
Co-authored-by: Rachael Shaw <r@rachael.wtf>
2024-03-21 13:50:18 -05:00
Roberto DipandRachael Shaw 85209ae758 document permissions changes for Puppet gitops (#17367)
#15337

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2024-03-21 13:38:06 -05:00
Noah Talerman 4a0c62613f API design: See macOS hosts that failed DEP profile assignment (#15461) (#16166)
API changes for the "See macOS hosts that failed DEP profile assignment"
(#15461) story
2024-03-21 13:33:35 -05:00
Marko LisicaandRachael Shaw 14786afe20 API design: Increase character limit for saved scripts (#16699)
API design for:
#16668

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2024-03-21 13:30:48 -05:00
Martin Angers 813a831a08 Add mention of the environment variable to disable logs in integration tests (#17524) 2024-03-18 09:24:02 -04:00
Noah Talerman 7afe341017 Update Supported-host-operating-systems.md (#17661)
For the following bug: #12334

- Call out that, currently on Ubuntu, Fleet Desktop only supports
display number of `0`
2024-03-15 18:03:33 -04:00
Eric 29e66efc19 Website: Add required meta tag to page in contributing documentation (#17668)
Changes:
- Added a `pageOrderInSection` `<meta>` tag to the
`windows-mdm-glossary-and-protocol.md`
2024-03-15 13:19:54 -05:00
Dante Catalfamo 58dc1d4502 Create initial windows MDM glossary and diagram document (#17507)
```mermaid
sequenceDiagram
    participant windows as Windows
    participant orbit as Orbit
    participant server as fleet server
    loop every 30 seconds
        orbit->>+server: POST /api/fleet/orbit/config
        server-->>-orbit: pending notifications
    end
    note over orbit: receive enrollment notification
    orbit->>windows: mdmregistration.dll<br/>RegisterDeviceWithManagement
    windows->>+server: POST /api/mdm/microsoft/discovery
    server-->>-windows: EnrollmentServiceURL, EnrollmentPolicyServiceUrl
    windows->>+server: POST /api/mdm/microsoft/policy<br/>DeviceEnrollmentUserToken
    server-->>-windows: Policy Schema, Certificate requirements
    activate windows
    note left of windows: Generate keypair
    deactivate windows
    windows->>+server: POST /api/mdm/microsoft/enroll<br/>Self-signed CSR & cert values
    note right of server: Creates certificate signed by WSTEP ident key
    server-->>-windows: Signed certificate, management endpoint, enrollment parameters
    loop SYNCML MDM Protocol (mTLS)
        windows->>+server: POST /api/mdm/microsoft/management
        server-->>-windows: Response
    end
```
2024-03-15 10:02:47 -04:00
Dante Catalfamo 797e12983c Add diagram to texting-and-local-development explaining internal certificate generation flow (#17396)
```mermaid
sequenceDiagram
    participant user as user email
    participant fleetctl as fleetctl
    participant server as fleet server
    participant fleetdm as fleetdm.com sails app
    participant apple as identity.apple.com
    link apple: PushCert @ https://identity.apple.com/pushcert
    note over fleetctl: fleetctl login
    fleetctl->>+server: login
    server-->>-fleetctl: token
    note over fleetctl: fleetctl generate mdm_apple
    fleetctl->>+server: generate certificates
    server->>server: generate self-signed SCEP cert & key
    server->>server: generate APNs key
    server->>server: generate APNs CSR
    server-)+fleetdm: request vendor signature on APNs CSR
    server-->>-fleetctl: SCEP cert, SCEP key, APNs key
    note over fleetdm: calls /ee/tools/mdm/cert
    fleetdm--)-user: vendor-signed APNs CSR
    user->>+apple: vendor-signed APNs CSR
    note right of apple: managed through web ui
    apple-->>-user: Apple-signed APNs certificate
```
2024-03-15 10:01:51 -04:00
Lucas Manuel Rodriguez 01dfce56cf Doc changes for VSCode extensions (#17639)
Doc changes for #17003
2024-03-14 17:00:07 -03:00
Rachael Shaw 5349403374 API design: Wipe host (#17107)
REST API updates for remote wipe
([#9951](https://github.com/fleetdm/fleet/issues/9951)).
2024-03-14 14:30:16 -04:00
bc034b6bb2 #15919 API design: Vulnerabilities page (#16443)
REST API changes for #15919

---------

Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
Co-authored-by: Tim Lee <timlee@fleetdm.com>
2024-03-14 13:27:07 -05:00
Rachael Shaw ee7dbaa5a0 #1642 API design: Populate policy data in GET /hosts API (#16582)
- Adds a `populate_policies` parameter to the "List hosts" endpoint
2024-03-14 14:07:03 -04:00
Sam Pfluger 7e4964385c DRIs (#17614)
...
2024-03-14 10:24:53 -05:00
Rachael Shaw 42aeb9f75e Sentence-case fix (#17611)
+ Fix casing of "External activity audit logging"
+ Fix a nearby typo
2024-03-13 18:00:06 -05:00
Luke Heath 3217e4ccf8 Specify node version required to build Fleet (#17578) 2024-03-13 17:29:15 -05:00
Austin Culter 917b8b0d85 Update broken URL to fleet-deployment.yml on "Deploy Fleet on Kubernetes" docs (#17486)
The _"Fleet's best practice `fleet-deployment.yml` file"_ link on the
["Deploy Fleet on Kubernetes" docs
page](https://fleetdm.com/docs/deploy/deploy-fleet-on-kubernetes)
doesn't actually target the YAML file it purports to and, instead, it
just points to the Markdown version of the "Deploy Fleet on Kubernetes"
docs on GitHub.

This PR changes the target URL so that link actually goes to the place
where one would expect it to (the YAML file).
2024-03-08 10:46:30 -06:00
Roberto Dip 7d0513000f fix link in scripts docs (#17488) 2024-03-08 13:45:45 -03:00
Lucas Manuel Rodriguez 37885d0932 Remove filtering of private IPs in public IP field (#17352)
#11102

- [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] Added/updated tests
- [x] Manual QA for all new/changed functionality
2024-03-08 12:57:18 -03:00
Noah Talerman d52643b3eb Add OS updates to permissions table (#17384)
- Maintainers and up can edit OS udpates
2024-03-07 17:47:54 -05:00
Luke Heath 70d369dcf7 Update Releasing-Fleet.md (#17436) 2024-03-07 15:17:37 -06: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
Sharon KatzandLuke Heath 2be6a32295 Update Releasing-Fleet.md (#17233)
Swap steps 1 and 3

---------

Co-authored-by: Luke Heath <luke@fleetdm.com>
2024-03-07 15:07:00 -05: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
Victor Lyuboslavsky e01c79ca7f Updating server config docs. (#17214)
Server config doc updates for:
https://github.com/fleetdm/fleet/issues/16331
2024-03-07 13:22:03 -06:00
Victor Lyuboslavsky 58f30aaf99 Allowing GitOps role to read org configs -- doc change. (#17238)
Allowing GitOps role to read org configs.

Docs for https://github.com/fleetdm/fleet/pull/17223
2024-03-07 13:21:14 -06:00
Rachael Shaw 6f7fd8f881 Docs: Fix some links in the hosts API section (#17449)
Noticed a few links in the hosts section of the REST API docs that were
out-of-date or missing.
2024-03-06 16:34:29 -06:00
RachelElysia 316321e889 [released bug] Fleet Full stack: Allow teams filter when transferring hosts by filters (#17241) 2024-03-04 15:48:19 -05:00
Dante Catalfamo e30640d701 Add mention of distutils in Building-Fleet (#17343)
Python >= 3.12 no longer ships with the `distutils` module out of the
box. It can be installed using `pip install setuptools`.

This may be fixed when updating node packages that rely on python, but
until then it may come up during `make deps`.

Reference: https://stackoverflow.com/a/76691103
2024-03-04 14:32:32 -05:00
Victor LyuboslavskyandNoah Talerman 7a20da1f2f Moving mdm_profiles to it-and-security/lib/mdm_profiles (#17268)
Moving mdm_profiles to it-and-security/lib/mdm_profiles so that they are
together with other gitops config files.

---------

Co-authored-by: Noah Talerman <noahtal@umich.edu>
2024-03-01 15:18:54 -06:00
Gabriel Hernandez 4fa50778ac merge main into feat-mdm-wipe-host 2024-03-01 17:08:41 +00:00
Noah Talerman fc6fca60c7 Tweak custom OS settings docs (#17277)
- Add a link to Microsoft's docs that explain the error codes. We link
to the same page on the [MDM commands doc
page](https://fleetdm.com/docs/using-fleet/mdm-commands)
2024-03-01 12:05:36 -05:00
Rachael Shaw dd2d6eb4d0 Update "Team member" wording in docs to reference users instead. (#17116)
+ Changed a bunch of instances of "member" to "user" to match the
updated UI (https://github.com/fleetdm/fleet/issues/15893)
+ Cut some step-by-step instructions for using the team UI from the
"Segment hosts" docs
2024-02-29 16:07:59 -05:00
Gabriel Hernandez 4ee65ce184 Merge branch 'main' into feat-mdm-wipe-host 2024-02-29 11:22:31 +00:00