adjust release links and docs

clyso · May 2, 2024 · caf5fb2 · caf5fb2
1 parent 45934cd
commit caf5fb2
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 11 deletions.
diff --git a/.github/workflows/ci-go.yml b/.github/workflows/ci-go.yml
@@ -6,6 +6,10 @@ on:
   pull_request:
     branches:
       - main
+    paths:
+      - ".github/**"
+      -  "**.go"
+      - "**/config.yaml"
 jobs:
   test:
     runs-on: ubuntu-latest

diff --git a/deploy/chorus/values.yaml b/deploy/chorus/values.yaml
@@ -17,7 +17,7 @@ proxy:
       port: 9669
       targetPort: http
     type: ClusterIP
-  config:
+  config: # for full spec and default values see proxy config: https://github.com/clyso/chorus/blob/main/service/proxy/config.yaml and common config https://github.com/clyso/chorus/blob/main/pkg/config/config.yaml
     metrics:
       enabled: false
     log:
@@ -35,11 +35,13 @@ proxy:
     auth:
       allowV2Signature: false
       useStorage: # use credentials from one of configured storages <one|two>
-      custom: # use custom credentials for proxy s3 endpoint
-      #      - accessKeyID: <s3 v4 accessKey credential>
-      #        secretAccessKey: <s3 v4 secretKey credential>
-      #      - accessKeyID: <s3 v4 accessKey credential>
-      #        secretAccessKey: <s3 v4 secretKey credential>
+      custom: # or use custom credentials for proxy s3 endpoint
+    #    user1:
+    #      accessKeyID: <user1 v4 accessKey credential>
+    #      secretAccessKey: <user1 v4 secretKey credential>
+    #    user2:
+    #      accessKeyID: <user2 v4 accessKey credential>
+    #      secretAccessKey: <user2 v4 secretKey credential>
 worker:
   replicas: 2
   image:
@@ -63,7 +65,7 @@ worker:
       port: 9670
       targetPort: grpc
     type: ClusterIP
-  config:
+  config: # for full spec and default values see worker config: https://github.com/clyso/chorus/blob/main/service/worker/config.yaml and common config https://github.com/clyso/chorus/blob/main/pkg/config/config.yaml
     metrics:
       enabled: false
     log:
@@ -130,7 +132,7 @@ agent:
       port: 9673
       targetPort: http
     type: ClusterIP
-  config:
+  config: # for full spec and default values see agent config: https://github.com/clyso/chorus/blob/main/service/agent/config.yaml and common config https://github.com/clyso/chorus/blob/main/pkg/config/config.yaml
     metrics:
       enabled: false
     log:

diff --git a/service/proxy/config.yaml b/service/proxy/config.yaml
@@ -7,7 +7,7 @@ cors:
 auth:
   allowV2Signature: false
   useStorage: # use credentials from one of configured storages <one|two>
-  custom: # use custom credentials for proxy s3 endpoint
+  custom: # OR use custom credentials for proxy s3 endpoint
 #    user1:
 #      accessKeyID: <user1 v4 accessKey credential>
 #      secretAccessKey: <user1 v4 secretKey credential>
@@ -51,4 +51,4 @@ storage:
 #      isSecure: true #set false for http address
 #      rateLimit:
 #        enable: true
-#        rpm: 60
+#        rpm: 60
diff --git a/tools/chorctl/README.md b/tools/chorctl/README.md
@@ -7,7 +7,12 @@ CLI for chorus management api.
 ```shell
 go build .
 ```
-Or download binary from [docs page](https://docs.clyso.com/docs/products/chorus/installation#management-cli)
+Or download binary from [the latest release](https://github.com/clyso/chorus/releases).
+
+Or with homebrew (MacOS and Linux only):
+```shell
+brew install clyso/tap/chorctl
+```
 
 ## Usage