From 256da1adec25b35787116237174a001ad11cdd4d Mon Sep 17 00:00:00 2001 From: Sarah Sanders Date: Tue, 1 Apr 2025 14:26:01 -0400 Subject: [PATCH] cx: desktop settings reporting (#21646) ## Description - Added guide on desktop settings reporting NOTE: To go out with DD 4.40 release in EA ## Related issues or tickets [ENGDOCS-2346](https://docker.atlassian.net/browse/ENGDOCS-2346) ## Reviews - [ ] Technical review - [ ] Editorial review - [ ] Product review [ENGDOCS-2346]: https://docker.atlassian.net/browse/ENGDOCS-2346?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ --------- Co-authored-by: Allie Sadler <102604716+aevesdocker@users.noreply.github.com> --- .../compliance-reporting.md | 99 +++++++++++++++++++ .../configure-json-file.md | 2 +- data/summary.yaml | 5 + 3 files changed, 105 insertions(+), 1 deletion(-) create mode 100644 content/manuals/security/for-admins/hardened-desktop/settings-management/compliance-reporting.md diff --git a/content/manuals/security/for-admins/hardened-desktop/settings-management/compliance-reporting.md b/content/manuals/security/for-admins/hardened-desktop/settings-management/compliance-reporting.md new file mode 100644 index 0000000000..c556b435fe --- /dev/null +++ b/content/manuals/security/for-admins/hardened-desktop/settings-management/compliance-reporting.md @@ -0,0 +1,99 @@ +--- +description: Understand how to use the Desktop settings reporting dashboard +keywords: Settings Management, docker desktop, hardened desktop, reporting, compliance +title: Desktop settings reporting +linkTitle: Desktop settings reporting +weight: 30 +params: + sidebar: + badge: + color: violet + text: EA +--- + +{{< summary-bar feature_name="Compliance reporting" >}} + +Desktop settings reporting is a feature of Desktop Settings Management that +tracks and reports user compliance with the settings policies that are assigned +to them. This lets administrators track the application of settings and +monitor what actions they need to take to make users compliant. + +This guide provides steps for accessing Desktop settings reporting, viewing +compliance status, and resolving non-compliant users. + +## Access Desktop settings reporting + +> [!IMPORTANT] +> +> Desktop settings reporting is in Early Access and is being rolled out +> gradually. You may not see this setting in the Admin Console yet. + +1. Sign in to the [Admin Console](https://app.docker.com/admin). +2. Select your organization or company from the **Choose profile** page. +3. Under Docker Desktop, select **Reporting**. + +This opens the Desktop settings reporting page. From here you can: + +- Use the **Search** field to search by username or email address +- Filter by policies +- Hide or un-hide compliant users +- View a user’s compliance status and what policy is assigned to the user +- Download a CSV file of user compliance information + +## View compliance status + +> [!WARNING] +> +> Users on Docker Desktop versions older than 4.40 may appear non-compliant +> because older versions can't report compliance. To ensure accurate +> compliance status, users must update to Docker Desktop version 4.40 and later. + +1. Sign in to the [Admin Console](https://app.docker.com/admin). +2. Select your organization or company from the **Choose profile** page. +3. Under Docker Desktop, select **Reporting**. By default, non-compliant users +are displayed. +4. Optional. Select the **Hide compliant users** checkbox to show both compliant +and non-compliant users. +5. Use the **Search** field to search by username or email address. +6. Hover over a user’s compliance status indicator to quickly view their status. +7. Select a username to view more details about their compliance status, and for +steps to resolve non-compliant users. + +## Resolve compliance status + +To resolve compliance status, you must view a user's compliance status details +by selecting their username from the Desktop settings reporting page. +These details include the following information: + +- **Compliance status**: Indicates whether the user is compliant with the +settings applied to them +- **Domain status**: Indicates whether the user’s email address is associated +with a verified domain +- **Settings status**: Indicates whether the user has settings applied to them +- **Resolution steps**: If a user is non-compliant, this provides information +on how to resolve the user’s compliance status + +### Compliant + +When a user is compliant, a **Compliant** icon appears next to their name on the +Desktop settings reporting dashboard. Select a compliant user to open their +compliance status details. Compliant users have the following status details: + +- **Compliance status**: Compliant +- **Domain status**: Verified domain +- **Settings status**: Compliant +- **User is compliant** indicator + +No resolution steps are needed for compliant users. + +### Non-compliant + +When a user is non-compliant, a **Non-compliant** or **Unknown** icon appears +next to their name on the Desktop settings reporting dashboard. Non-compliant +users must have their compliance status resolved: + +1. Select a username from the Desktop settings reporting dashboard. +2. On the compliance status details page, follow the resolution steps provided +to resolve the compliance status. +3. Refresh the page to ensure the resolution steps resolved the compliance +status. diff --git a/content/manuals/security/for-admins/hardened-desktop/settings-management/configure-json-file.md b/content/manuals/security/for-admins/hardened-desktop/settings-management/configure-json-file.md index db391e0b58..3fdcf7b005 100644 --- a/content/manuals/security/for-admins/hardened-desktop/settings-management/configure-json-file.md +++ b/content/manuals/security/for-admins/hardened-desktop/settings-management/configure-json-file.md @@ -4,7 +4,7 @@ keywords: admin, controls, rootless, enhanced container isolation title: Configure Settings Management with a JSON file linkTitle: Use a JSON file weight: 10 -aliases: +aliases: - /desktop/hardened-desktop/settings-management/configure/ - /security/for-admins/hardened-desktop/settings-management/configure/ --- diff --git a/data/summary.yaml b/data/summary.yaml index 0694cb5a9d..fe53413d53 100644 --- a/data/summary.yaml +++ b/data/summary.yaml @@ -62,6 +62,11 @@ Cache backend API: Company: subscription: [Business] for: Administrators +Compliance reporting: + subscription: [Business] + for: Administrators + requires: Docker Desktop 4.40 and later + availability: Early Access Compose attach: requires: Docker Compose [2.20.0](/manuals/compose/releases/release-notes.md#2200) and later Compose bridge: