scout: dd sbom indexing settings (#18461)

Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
This commit is contained in:
David Karlsson 2023-10-26 17:29:26 +02:00 committed by GitHub
parent 270c2ef7b6
commit c434eec2de
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 21 additions and 2 deletions

View File

@ -39,6 +39,7 @@ Using the `admin-settings.json` file, admins can:
- Configure Docker Engine - Configure Docker Engine
- Turn off Docker Desktop's ability to checks for updates - Turn off Docker Desktop's ability to checks for updates
- Turn off Docker Extensions - Turn off Docker Extensions
- Turn off Docker Scout SBOM indexing
For more details on the syntax and options admins can set, see [Configure Settings Management](configure.md). For more details on the syntax and options admins can set, see [Configure Settings Management](configure.md).

View File

@ -108,6 +108,11 @@ The following `admin-settings.json` code and table provides an example of the re
"extensionsEnabled": { "extensionsEnabled": {
"value": false, "value": false,
"locked": true "locked": true
},
"scout": {
"locked": false,
"sbomIndexing": true,
"useBackgroundIndexing": true
} }
} }
``` ```
@ -129,6 +134,7 @@ The following `admin-settings.json` code and table provides an example of the re
|`disableUpdate`| |If `value` is set to true, checking for and notifications about Docker Desktop updates is disabled.| |`disableUpdate`| |If `value` is set to true, checking for and notifications about Docker Desktop updates is disabled.|
|`analyticsEnabled`| |If `value` is set to false, Docker Desktop doesn't send usage statistics to Docker. | |`analyticsEnabled`| |If `value` is set to false, Docker Desktop doesn't send usage statistics to Docker. |
|`extensionsEnabled`| |If `value` is set to false, Docker extensions are disabled. | |`extensionsEnabled`| |If `value` is set to false, Docker extensions are disabled. |
|`scout`|| Setting `useBackgroundIndexing` to `false` disables automatic indexing of images loaded to the image store. Setting `sbomIndexing` to `false` prevents the manual indexing triggered by inspecting an image in Docker Desktop.<br><br>**Note**: Users can still use the `docker scout` CLI commands to index images, even if indexing is disabled in Settings Management. |
### Step three: Re-launch Docker Desktop ### Step three: Re-launch Docker Desktop
>**Note** >**Note**

View File

@ -44,6 +44,10 @@ If you choose the integrated terminal, you can run commands in a running contain
- **Show CLI hints**. Displays CLI hints and tips when running Docker commands in the CLI. This is turned on by default. To turn CLI hints on or off from the CLI, set `DOCKER_CLI_HINTS` to `true` or `false` respectively. - **Show CLI hints**. Displays CLI hints and tips when running Docker commands in the CLI. This is turned on by default. To turn CLI hints on or off from the CLI, set `DOCKER_CLI_HINTS` to `true` or `false` respectively.
- **SBOM Indexing**. When this option is enabled, inspecting an image in Docker Desktop shows a **Start analysis** button that, when selected, analyzes the image with Docker Scout.
- **Enable background SBOM indexing**. When this option is enabled, Docker Scout automatically analyzes images that you build or pull.
## Resources ## Resources
The **Resources** tab allows you to configure CPU, memory, disk, proxies, The **Resources** tab allows you to configure CPU, memory, disk, proxies,

View File

@ -64,6 +64,10 @@ If you choose the integrated terminal, you can run commands in a running contain
- **Show CLI hints**. Displays CLI hints and tips when running Docker commands in the CLI. This is turned on by default. To turn CLI hints on or off from the CLI, set `DOCKER_CLI_HINTS` to `true` or `false` respectively. - **Show CLI hints**. Displays CLI hints and tips when running Docker commands in the CLI. This is turned on by default. To turn CLI hints on or off from the CLI, set `DOCKER_CLI_HINTS` to `true` or `false` respectively.
- **SBOM Indexing**. When this option is enabled, inspecting an image in Docker Desktop shows a **Start analysis** button that, when selected, analyzes the image with Docker Scout.
- **Enable background SBOM indexing**. When this option is enabled, Docker Scout automatically analyzes images that you build or pull.
## Resources ## Resources
The **Resources** tab allows you to configure CPU, memory, disk, proxies, The **Resources** tab allows you to configure CPU, memory, disk, proxies,

View File

@ -53,6 +53,10 @@ On the **General** tab, you can configure when to start Docker and specify other
- **Show CLI hints**. Displays CLI hints and tips when running Docker commands in the CLI. This is turned on by default. To turn CLI hints on or off from the CLI, set `DOCKER_CLI_HINTS` to `true` or `false` respectively. - **Show CLI hints**. Displays CLI hints and tips when running Docker commands in the CLI. This is turned on by default. To turn CLI hints on or off from the CLI, set `DOCKER_CLI_HINTS` to `true` or `false` respectively.
- **SBOM Indexing**. When this option is enabled, inspecting an image in Docker Desktop shows a **Start analysis** button that, when selected, analyzes the image with Docker Scout.
- **Enable background SBOM indexing**. When this option is enabled, Docker Scout automatically analyzes images that you build or pull.
## Resources ## Resources
The **Resources** tab allows you to configure CPU, memory, disk, proxies, The **Resources** tab allows you to configure CPU, memory, disk, proxies,