mirror of https://github.com/docker/docs.git
scout: dd sbom indexing settings (#18461)
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
This commit is contained in:
parent
270c2ef7b6
commit
c434eec2de
|
@ -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).
|
||||||
|
|
||||||
|
@ -58,4 +59,4 @@ Docker doesn't automatically mandate that developers re-launch and re-authentica
|
||||||
|
|
||||||
Any settings that are enforced, are grayed out in Docker Desktop and the user is unable to edit them, either via the Docker Desktop UI, CLI, or the `settings.json` file. In addition, if Enhanced Container Isolation is enforced, users can't use privileged containers or similar techniques to modify enforced settings within the Docker Desktop Linux VM, for example, reconfigure proxy and networking of reconfigure Docker Engine.
|
Any settings that are enforced, are grayed out in Docker Desktop and the user is unable to edit them, either via the Docker Desktop UI, CLI, or the `settings.json` file. In addition, if Enhanced Container Isolation is enforced, users can't use privileged containers or similar techniques to modify enforced settings within the Docker Desktop Linux VM, for example, reconfigure proxy and networking of reconfigure Docker Engine.
|
||||||
|
|
||||||

|

|
||||||
|
|
|
@ -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**
|
||||||
|
@ -148,4 +154,4 @@ Docker doesn't automatically mandate that developers re-launch and sign in once
|
||||||
|
|
||||||
In Docker Desktop, developers see the relevant settings grayed out and the message **Locked by your administrator**.
|
In Docker Desktop, developers see the relevant settings grayed out and the message **Locked by your administrator**.
|
||||||
|
|
||||||

|

|
||||||
|
|
|
@ -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,
|
||||||
|
|
|
@ -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,
|
||||||
|
|
|
@ -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,
|
||||||
|
|
Loading…
Reference in New Issue