From 433338bdced5e65d616b4726c2df307ba89eaa60 Mon Sep 17 00:00:00 2001 From: thanhnc2 Date: Fri, 3 May 2024 02:29:26 +0700 Subject: [PATCH] update readme.md --- .github/workflows/release.yaml | 4 ++++ README.md | 24 ++++++++++++++++-------- 2 files changed, 20 insertions(+), 8 deletions(-) diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml index 202b4ca..aa55d53 100644 --- a/.github/workflows/release.yaml +++ b/.github/workflows/release.yaml @@ -4,6 +4,10 @@ on: push: branches: - main + paths-ignore: + - 'README.md' + - '**/*.md' + jobs: diff --git a/README.md b/README.md index 3ece679..d059475 100644 --- a/README.md +++ b/README.md @@ -16,27 +16,35 @@ Dựa vào đề bài helm template sử dụng các CRDs/options: Values được đặt với các cấu hình tùy chỉnh như sau. ```yaml redis: - enabled: false + enabled: true + # replicaCount: 1 + # memoryLimit: 2Gi + # cpuLimit: "1" registry: replicaCount: 1 - username: admin - password: admin - + # username: + # password: maxUploadSize: 30m # maximum upload file host: registry.local garbageCron: 0 1 * * * # set the time to run docker image garbage collection, default is run daily at 00:00 AM + # memoryLimit: 2Gi + # cpuLimit: "1" ``` -Trong đó, cho phép bạn bật tắt tùy chọn Redis, nếu không sử dụng, service mặc định sử dụng `inmemory` -Các tham số có thể update username/password sử dụng trong basic auth (mặc định sẽ là admin/admin nếu không được cấu hình). Set số lượng Rep. Cấu hình hostname sử dụng trong nginx Ingress và cấu hình maximum file có thể tải lên với key:`maxUploadSize`. Với `garbageCron` - Thời gian chạy cron có thể tham khảo tại: https://crontab.guru/ (mặc định sẽ chạy mỗi ngày `0 0 * * *` UTC (7h sáng VN)) +- Trong đó, cho phép bạn bật tắt tùy chọn Redis, nếu không sử dụng, service mặc định sử dụng `inmemory` +- `username`/`password` sử dụng trong basic auth (mặc định sẽ là admin/admin nếu không được cấu hình). +- Set số lượng Rep qua key `replicaCount`. +- Cấu hình hostname sử dụng trong nginx Ingress và cấu hình maximum file có thể tải lên với key:`maxUploadSize`. +- Resource limit với 2 keys: `memoryLimit`, `cpuLimit` mặc định limit ở mức 512MB, 0.5CPU. +- `garbageCron` - Thời gian chạy cron có thể tham khảo tại: https://crontab.guru/ (mặc định sẽ chạy mỗi ngày `0 0 * * *` UTC (7h sáng VN)) # Sử dụng chart -Có thể sử dụng bằng cách tải xuống file trong mục release, vd: sử dụng file release `registry-0.1.0.tgz`: +Có thể sử dụng bằng cách tải xuống file trong mục release, vd: sử dụng file release `registry-0.1.1.tgz`: ```sh -tar -zxvf registry-0.1.0.tgz +tar -zxvf registry-0.1.1.tgz ``` Lệnh trên sẽ giải nén thư mục mới có tên `registry` tại path giải nén.