port-agent: added readme

port-labs · Dec 18, 2024 · 0373127 · 0373127
1 parent ddff5c2
commit 0373127
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 0 deletions.
diff --git a/charts/port-agent/README.md b/charts/port-agent/README.md
@@ -49,6 +49,7 @@ The following table lists the configuration parameters of the `port-agent` chart
 | `image.repository`                                   | Image repository                                                                           | `ghcr.io/port-labs/port-agent`                                                                                                                                                                                                    |
 | `image.pullPolicy`                                   | Image pull policy                                                                          | `IfNotPresent`                                                                                                                                                                                                                    |
 | `image.tag`                                          | Image tag                                                                                  | `""`                                                                                                                                                                                                                              |
+| `replicaCount`                                       | Number of port-agent replicas (ensure Kafka topic has enough partitions when scaling up)   | `1`                                                                                                                                                                                                                               |
 | `imagePullSecrets`                                   | Image pull secrets                                                                         | `[]`                                                                                                                                                                                                                              |
 | `nameOverride`                                       | Chart name override                                                                        | `""`                                                                                                                                                                                                                              |
 | `fullnameOverride`                                   | Fully qualified app name override                                                          | `""`                                                                                                                                                                                                                              |

diff --git a/charts/port-agent/values.yaml b/charts/port-agent/values.yaml
@@ -3,6 +3,7 @@ image:
   pullPolicy: IfNotPresent
   tag: ""
 
+# If you increase this number, you will need to make sure that the kafka topic has enough partitions
 replicaCount: 1
 
 imagePullSecrets: []