diff --git a/docs/administration/config-cheat-sheet.md b/docs/administration/config-cheat-sheet.md index c75bdbb0..8db300a9 100644 --- a/docs/administration/config-cheat-sheet.md +++ b/docs/administration/config-cheat-sheet.md @@ -1459,6 +1459,11 @@ PROXY_HOSTS = *.github.com - `STORAGE_TYPE`: **local**: Storage type for actions logs, `local` for local disk or `minio` for s3 compatible object storage service, default is `local` or other name defined with `[storage.xxx]` - `MINIO_BASE_PATH`: **actions_log/**: Minio base path on the bucket only available when STORAGE_TYPE is `minio` - `LOG_RETENTION_DAYS`: **365**: Logs retention time in days. Old logs will be deleted after this period. +- `LOG_COMPRESSION`: **none**: Log compression type, `none` for no compression, `zstd` for zstd compression. + Other compression types like `gzip` are NOT supported, since seekable stream is required for log view. + It's always recommended to use compression when using local disk as log storage if CPU or memory is not a bottleneck. + And for object storage services like S3, which is billed for requests, it would cause extra 2 times of get requests for each log view. + But it will save storage space and network bandwidth, so it's still recommended to use compression. - `ARTIFACT_RETENTION_DAYS`: **90**: Default number of days to keep artifacts. Artifacts could have their own retention periods by setting the `retention-days` option in `actions/upload-artifact` step. - `ZOMBIE_TASK_TIMEOUT`: **10m**: Timeout to stop the task which have running status, but haven't been updated for a long time - `ENDLESS_TASK_TIMEOUT`: **3h**: Timeout to stop the tasks which have running status and continuous updates, but don't end for a long time diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/current/administration/config-cheat-sheet.md b/i18n/zh-cn/docusaurus-plugin-content-docs/current/administration/config-cheat-sheet.md index 77599e33..4b0dd7da 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/current/administration/config-cheat-sheet.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/current/administration/config-cheat-sheet.md @@ -1333,6 +1333,11 @@ PROXY_HOSTS = *.github.com - `STORAGE_TYPE`: **local**:用于操作日志的存储类型,`local`表示本地磁盘,`minio`表示与S3兼容的对象存储服务,默认为`local`,或者使用定义为`[storage.xxx]`的其他名称。 - `MINIO_BASE_PATH`: **actions_log/**:Minio存储桶上的基本路径,仅在`STORAGE_TYPE`为`minio`时可用。 - `LOG_RETENTION_DAYS`: **365**:日志保留时间(天)。此期限后将删除旧日志。 +- `LOG_COMPRESSION`: **none**:日志压缩方式,`none`表示不压缩,`zstd`表示 zstd 压缩。 + 其它的压缩方式如`gzip`是不支持的,因为查看日志需要可寻址流。 + 如果 CPU 或内存不是瓶颈,建议在使用本地磁盘作为日志存储时总是使用压缩。 + 对于像 S3 这样的会对请求次数计费的对象存储服务,每次查看日志会导致额外的 2 次获取请求。 + 但它将节省存储空间和网络带宽,因此仍然建议使用压缩。 - `ARTIFACT_RETENTION_DAYS`: **90**:保留 artifacts 的默认天数。可以通过在`actions/upload-artifact`步骤中设置`retention-days`选项来指定 artifacts 的保留期。 - `ZOMBIE_TASK_TIMEOUT`: **10m**:僵尸任务超时时间,指具有运行状态但长时间未更新的任务。 - `ENDLESS_TASK_TIMEOUT`: **3h**:无尽任务超时时间,指具有运行状态并持续更新,但长时间未结束的任务。