mirror of
https://gitea.com/Lydanne/buildx.git
synced 2025-07-31 23:58:03 +08:00
docs: more context around shm-size and ulimit usage
Signed-off-by: CrazyMax <1951866+crazy-max@users.noreply.github.com>
This commit is contained in:
@@ -836,6 +836,9 @@ RUN --mount=type=secret,id=KUBECONFIG \
|
||||
|
||||
### `target.shm-size`
|
||||
|
||||
Sets the size of the shared memory allocated for build containers when using
|
||||
`RUN` instructions.
|
||||
|
||||
The format is `<number><unit>`. `number` must be greater than `0`. Unit is
|
||||
optional and can be `b` (bytes), `k` (kilobytes), `m` (megabytes), or `g`
|
||||
(gigabytes). If you omit the unit, the system uses bytes.
|
||||
@@ -848,6 +851,12 @@ target "default" {
|
||||
}
|
||||
```
|
||||
|
||||
> **Note**
|
||||
>
|
||||
> In most cases, it is recommended to let the builder automatically determine
|
||||
> the appropriate configurations. Manual adjustments should only be considered
|
||||
> when specific performance tuning is required for complex build scenarios.
|
||||
|
||||
### `target.ssh`
|
||||
|
||||
Defines SSH agent sockets or keys to expose to the build.
|
||||
@@ -896,7 +905,8 @@ target "default" {
|
||||
|
||||
### `target.ulimits`
|
||||
|
||||
Ulimits are specified with a soft and hard limit as such:
|
||||
Ulimits overrides the default ulimits of build's containers when using `RUN`
|
||||
instructions and are specified with a soft and hard limit as such:
|
||||
`<type>=<soft limit>[:<hard limit>]`, for example:
|
||||
|
||||
```hcl
|
||||
@@ -913,6 +923,12 @@ target "app" {
|
||||
> for both values. If no `ulimits` are set, they are inherited from
|
||||
> the default `ulimits` set on the daemon.
|
||||
|
||||
> **Note**
|
||||
>
|
||||
> In most cases, it is recommended to let the builder automatically determine
|
||||
> the appropriate configurations. Manual adjustments should only be considered
|
||||
> when specific performance tuning is required for complex build scenarios.
|
||||
|
||||
## Group
|
||||
|
||||
Groups allow you to invoke multiple builds (targets) at once.
|
||||
|
Reference in New Issue
Block a user