Commit graph

1788 commits

Author SHA1 Message Date
Marko Lisica
643a3eb34a
Docs: Reminder for APNs and ABM renewal (#16919)
Improve docs for APNs renewal:
- Learn users that they should check that Common name (CN) of
certificate in APNs portal should match one used in Fleet
2024-05-07 14:04:06 -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
Rachael Shaw
e213ebde45
API design: Resend configuration profile (#18717)
Fresh PR to avoid product design PRs messing with the PR open time KPI
(previously https://github.com/fleetdm/fleet/pull/17711)

---------

Co-authored-by: Marko Lisica <83164494+marko-lisica@users.noreply.github.com>
Co-authored-by: George Karr <georgekarrv@users.noreply.github.com>
2024-05-02 17:08:22 -05:00
Rachael Shaw
0bd2f00495
Permissions: Resend a configuration profile (#18724)
Fresh PR to avoid product design PRs messing with the PR open time KPI
(previously https://github.com/fleetdm/fleet/pull/17841)

Co-authored-by: Marko Lisica <83164494+marko-lisica@users.noreply.github.com>
2024-05-02 17:06:36 -05:00
Rachael Shaw
080d466121
API design: Add manual labels via UI and API (#18716)
Fresh PR to avoid product design PRs messing with the PR open time KPI
(previously https://github.com/fleetdm/fleet/pull/17670)

---------

Co-authored-by: Marko Lisica <83164494+marko-lisica@users.noreply.github.com>
2024-05-02 16:59:03 -05:00
Rachael Shaw
74eb6c4f01
API design: Add critical policy and resolution data to device health API (#18715)
Fresh PR to avoid product design PRs messing with the PR open time KPI
(original: https://github.com/fleetdm/fleet/pull/16982)

---------

Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
2024-05-02 16:28:34 -05:00
Rachael Shaw
7cfb7721b3
FAQ: Add doc link to "How do I contact Fleet for support?" (#18654)
Add doc link to "How do I contact Fleet for support?"
2024-04-30 15:21:32 -05:00
Rachael Shaw
2e2137129a
Simplify "Is Fleet MIT licensed?" answer (#18653)
Simplify the language in "Is Fleet MIT licensed?"
2024-04-30 15:09:59 -05:00
Tim Lee
0a27843b83
bump golangci-lint to 1.55.2 (#18604) 2024-04-30 08:59:14 -06:00
Michael Pinto
373e9153b7
Add 2023 penetration test (#18375)
Co-authored-by: Robert Fairburn <8029478+rfairburn@users.noreply.github.com>
2024-04-29 14:39:28 -05:00
Rachael Shaw
895d4bc2f7
Use "Fleet's agent (fleetd)" naming in the docs (#18138)
For #16512

---------

Co-authored-by: Eric <eashaw@sailsjs.com>
2024-04-29 11:12:03 -05:00
Marko Lisica
a0a8579b56
API design: API endpoint for updating a host's manual labels (#16979)
API design for: 
- #16767

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2024-04-25 15:53:01 -05:00
Rachael Shaw
1657b38eba
#17361 API changes: Add fleetd version to host details (#17814)
For #17361.

---------

Co-authored-by: Victor Lyuboslavsky <victor@fleetdm.com>
2024-04-25 13:26:28 -05:00
Rachael Shaw
de26973953
#17148 API changes: See if scripts are enabled for a host (#17813)
For #17148.
2024-04-25 13:20:01 -05:00
Marko Lisica
28e501cd3c
Docs change: Use new Software Update (DDM) for macOS Sonoma (14) and higher (#17487)
Docs changes related to:

- #17295
2024-04-25 13:19:03 -05:00
Grant Bilstad
414c27d53b
Add link to file carve contributor docs (#18309)
File carves were moved to their own section in contributor docs
https://github.com/fleetdm/fleet/pull/16877
Fixed link on API page

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2024-04-25 10:19:33 -06:00
Rachael Shaw
63d91526d2
A few capitalization fixes in the docs (#18416)
Sentence-casing.
2024-04-18 16:45:55 -05:00
Lucas Manuel Rodriguez
d0b02fa985
Add sequence diagram for NVD vulnerability processing (#18216)
#17966

Better view here:
https://github.com/fleetdm/fleet/blob/17966-add-sequence-diagram-oncall/docs/Contributing/Vulnerability-processing.md#cpe-and-cve-data-generation-workflow

Added these docs during my oncall time (and also during the VulnCheck PR
review).

@mostlikelee Let me know if I got this right.
2024-04-17 13:28:39 -03:00
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
George Karr
fa5e224a4a
Add feature to resend MDM configuration profiles (#18280)
Includes PRs #18111, #18212, and #18271
2024-04-15 16:48:42 -05:00
Sarah Gillespie
ecdcb7c2fb
Add activity item for resend configuration profile (#18271) 2024-04-15 14:18:09 -05:00
Victor Lyuboslavsky
1dc1e23b65
Removed current_instance_checks from docs. (#18186)
#16661 

Removed current_instance_checks from docs.
2024-04-15 10:25:04 -05:00
Rachael Shaw
29b482fffa
#17230 API design: Fleet in your calendar (#17552)
REST API updates for #17230.

---------

Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
2024-04-12 18:01:52 -05:00
Noah Talerman
0888cdb8de
Update end user auth and SSO docs (#18127)
Docs improvements uncovered during
[dogfooding](https://github.com/fleetdm/confidential/issues/2506):

- Update end user auth docs to link to SSO docs. So the user knows what
do to get the necessary info from their IdP (create an Okta/GW app)
- Cut content from SSO docs and move Okta and Google Workspace to top
level headers
- "IDP" => "IdP"
- Use **bold** styling to indicate UI elements in docs (instead of
_italics_)

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2024-04-12 16:39:56 -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
Roberto Dip
3b96743932
document research done to extract name and version from installers (#18241)
copying what's described here
https://github.com/fleetdm/fleet/issues/17984#issuecomment-2051911744
for future reference.
2024-04-12 17:16:13 -03:00
Rachael Shaw
57a28ed18d
#14916 Configuration change: Host status webhook per-team (#15612)
Adds `webhook_settings.host_status_webhook` options to team config for
#14916.

Also updated conceptual docs that reference this config (and cut down
some content to make room).
2024-04-10 15:28:17 -05:00
Noah Talerman
65ab7a896d
Remove duplicate DEP profile example (#18114)
- Remove duplicate
- Add redirect so the example profile can move later w/o breaking links
- Update links
2024-04-09 09:47:47 -04:00
Roberto Dip
02f4d5c134
run make generate-docs for DDM activities (#17888) 2024-04-08 13:19:56 -03:00
Brock Walters
8d0d309a1f
Update macos-install-wine.sh with codesign warning (#17982)
The Wine developer does have an Apple Develeoper certificate but the
"Wine Stable" app bundle is not code-signed or notarized post-install &
disables Gatekeeper for the install. This adds a warning to the script
user about the app not being signed. post-install

---------

Co-authored-by: Victor Lyuboslavsky <victor.lyuboslavsky@gmail.com>
2024-04-05 16:14:57 -04:00
Marko Lisica
4585a6e2c2
API design: Pre-fill and lock local account creation screen during out-of-the-box macOS setup (#17118)
API design for:
- #9147
2024-04-04 14:38:42 -04:00
Victor Lyuboslavsky
5a3c54c0b6
Updated 1Password policy to only search 1 level deep for performance reasons. (#18003)
#17827 

Updated 1Password policy to only search one level deep for performance
reasons.

---------

Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
2024-04-04 09:33:17 -05:00
Rachael Shaw
1d80aa7668
When flagging a parameter as premium-only, always include a period. (#18038)
For better readability: add periods as separation between the Fleet
Premium message and parameter descriptions.
   _Available in Fleet Premium_. Description text.
 _Available in Fleet Premium_ Description text.
2024-04-03 11:48:22 -05:00
Marko Lisica
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 Karr
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 Karr
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
Eric
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 Lisica
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 Shaw
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
Katheryn Satterlee
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