From 6c63aefd22fc97926e4c1d3642993224161b4b8e Mon Sep 17 00:00:00 2001 From: David Karlsson Date: Tue, 2 May 2023 17:33:28 +0200 Subject: [PATCH] build: add ignore-error opt for cache exporters Signed-off-by: David Karlsson --- build/cache/backends/azblob.md | 3 ++- build/cache/backends/gha.md | 13 +++++++------ build/cache/backends/local.md | 3 ++- build/cache/backends/registry.md | 3 ++- build/cache/backends/s3.md | 19 ++++++++++--------- 5 files changed, 23 insertions(+), 18 deletions(-) diff --git a/build/cache/backends/azblob.md b/build/cache/backends/azblob.md index 1a25844e67a2..f80a69bf278c 100644 --- a/build/cache/backends/azblob.md +++ b/build/cache/backends/azblob.md @@ -36,11 +36,12 @@ The following table describes the available CSV parameters that you can pass to `--cache-to` and `--cache-from`. | Name | Option | Type | Default | Description | -|---------------------|-------------------------|-------------|---------|----------------------------------------------------| +| ------------------- | ----------------------- | ----------- | ------- | -------------------------------------------------- | | `name` | `cache-to`,`cache-from` | String | | Required. The name of the cache image. | | `account_url` | `cache-to`,`cache-from` | String | | Base URL of the storage account. | | `secret_access_key` | `cache-to`,`cache-from` | String | | Blob storage account key, see [authentication][1]. | | `mode` | `cache-to` | `min`,`max` | `min` | Cache layers to export, see [cache mode][2]. | +| `ignore-error` | `cache-to` | Boolean | `false` | Ignore errors caused by failed cache exports. | [1]: #authentication [2]: index.md#cache-mode diff --git a/build/cache/backends/gha.md b/build/cache/backends/gha.md index eed959ed4349..9cdc377450f4 100644 --- a/build/cache/backends/gha.md +++ b/build/cache/backends/gha.md @@ -39,12 +39,13 @@ $ docker buildx build --push -t / \ The following table describes the available CSV parameters that you can pass to `--cache-to` and `--cache-from`. -| Name | Option | Type | Default | Description | -|---------|-------------------------|-------------|---------------------------------|----------------------------------------------| -| `url` | `cache-to`,`cache-from` | String | `$ACTIONS_CACHE_URL` | Cache server URL, see [authentication][1]. | -| `token` | `cache-to`,`cache-from` | String | `$ACTIONS_RUNTIME_TOKEN` | Access token, see [authentication][1]. | -| `scope` | `cache-to`,`cache-from` | String | Name of the current Git branch. | Cache scope, see [scope][2] | -| `mode` | `cache-to` | `min`,`max` | `min` | Cache layers to export, see [cache mode][3]. | +| Name | Option | Type | Default | Description | +| -------------- | ----------------------- | ----------- | ------------------------------- | --------------------------------------------- | +| `url` | `cache-to`,`cache-from` | String | `$ACTIONS_CACHE_URL` | Cache server URL, see [authentication][1]. | +| `token` | `cache-to`,`cache-from` | String | `$ACTIONS_RUNTIME_TOKEN` | Access token, see [authentication][1]. | +| `scope` | `cache-to`,`cache-from` | String | Name of the current Git branch. | Cache scope, see [scope][2] | +| `mode` | `cache-to` | `min`,`max` | `min` | Cache layers to export, see [cache mode][3]. | +| `ignore-error` | `cache-to` | Boolean | `false` | Ignore errors caused by failed cache exports. | [1]: #authentication [2]: #scope diff --git a/build/cache/backends/local.md b/build/cache/backends/local.md index 0c42cc1a3d51..ce800683c934 100644 --- a/build/cache/backends/local.md +++ b/build/cache/backends/local.md @@ -35,7 +35,7 @@ The following table describes the available CSV parameters that you can pass to `--cache-to` and `--cache-from`. | Name | Option | Type | Default | Description | -|---------------------|--------------|-------------------------|---------|----------------------------------------------------------------------| +| ------------------- | ------------ | ----------------------- | ------- | -------------------------------------------------------------------- | | `src` | `cache-from` | String | | Path of the local directory where cache gets imported from. | | `digest` | `cache-from` | String | | Digest of manifest to import, see [cache versioning][4]. | | `dest` | `cache-to` | String | | Path of the local directory where cache gets exported to. | @@ -44,6 +44,7 @@ The following table describes the available CSV parameters that you can pass to | `compression` | `cache-to` | `gzip`,`estargz`,`zstd` | `gzip` | Compression type, see [cache compression][3]. | | `compression-level` | `cache-to` | `0..22` | | Compression level, see [cache compression][3]. | | `force-compression` | `cache-to` | `true`,`false` | `false` | Forcibly apply compression, see [cache compression][3]. | +| `ignore-error` | `cache-to` | Boolean | `false` | Ignore errors caused by failed cache exports. | [1]: index.md#cache-mode [2]: index.md#oci-media-types diff --git a/build/cache/backends/registry.md b/build/cache/backends/registry.md index d2e64c6d432c..ff9e0063831e 100644 --- a/build/cache/backends/registry.md +++ b/build/cache/backends/registry.md @@ -43,7 +43,7 @@ The following table describes the available CSV parameters that you can pass to `--cache-to` and `--cache-from`. | Name | Option | Type | Default | Description | -|---------------------|-------------------------|-------------------------|---------|----------------------------------------------------------------------| +| ------------------- | ----------------------- | ----------------------- | ------- | -------------------------------------------------------------------- | | `ref` | `cache-to`,`cache-from` | String | | Full name of the cache image to import. | | `dest` | `cache-to` | String | | Path of the local directory where cache gets exported to. | | `mode` | `cache-to` | `min`,`max` | `min` | Cache layers to export, see [cache mode][1]. | @@ -51,6 +51,7 @@ The following table describes the available CSV parameters that you can pass to | `compression` | `cache-to` | `gzip`,`estargz`,`zstd` | `gzip` | Compression type, see [cache compression][3]. | | `compression-level` | `cache-to` | `0..22` | | Compression level, see [cache compression][3]. | | `force-compression` | `cache-to` | `true`,`false` | `false` | Forcibly apply compression, see [cache compression][3]. | +| `ignore-error` | `cache-to` | Boolean | `false` | Ignore errors caused by failed cache exports. | [1]: index.md#cache-mode [2]: index.md#oci-media-types diff --git a/build/cache/backends/s3.md b/build/cache/backends/s3.md index bcc82d308bf5..5d6ba4ae9332 100644 --- a/build/cache/backends/s3.md +++ b/build/cache/backends/s3.md @@ -36,15 +36,16 @@ $ docker buildx build --push -t / \ The following table describes the available CSV parameters that you can pass to `--cache-to` and `--cache-from`. -| Name | Option | Type | Default | Description | -|---------------------|-------------------------|-------------|---------|----------------------------------------------| -| `region` | `cache-to`,`cache-from` | String | | Geographic location. | -| `bucket` | `cache-to`,`cache-from` | String | | Name of the S3 bucket used for caching | -| `name` | `cache-to`,`cache-from` | String | | Name of the cache image | -| `access_key_id` | `cache-to`,`cache-from` | String | | See [authentication][1] | -| `secret_access_key` | `cache-to`,`cache-from` | String | | See [authentication][1] | -| `session_token` | `cache-to`,`cache-from` | String | | See [authentication][1] | -| `mode` | `cache-to` | `min`,`max` | `min` | Cache layers to export, see [cache mode][2]. | +| Name | Option | Type | Default | Description | +| ------------------- | ----------------------- | ----------- | ------- | --------------------------------------------- | +| `region` | `cache-to`,`cache-from` | String | | Geographic location. | +| `bucket` | `cache-to`,`cache-from` | String | | Name of the S3 bucket used for caching | +| `name` | `cache-to`,`cache-from` | String | | Name of the cache image | +| `access_key_id` | `cache-to`,`cache-from` | String | | See [authentication][1] | +| `secret_access_key` | `cache-to`,`cache-from` | String | | See [authentication][1] | +| `session_token` | `cache-to`,`cache-from` | String | | See [authentication][1] | +| `mode` | `cache-to` | `min`,`max` | `min` | Cache layers to export, see [cache mode][2]. | +| `ignore-error` | `cache-to` | Boolean | `false` | Ignore errors caused by failed cache exports. | [1]: #authentication [2]: index.md#cache-mode