Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/frain-dev/helm-charts


https://github.com/frain-dev/helm-charts

Last synced: 6 months ago
JSON representation

Awesome Lists containing this project

README 

          
# convoy



![Version: 3.6.2](https://img.shields.io/badge/Version-3.6.2-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 25.6.7](https://img.shields.io/badge/AppVersion-25.6.7-informational?style=flat-square)



Open Source Webhooks Gateway



## Maintainers



| Name | Email | Url |

| ---- | ------ | --- |

| Convoy Engineering Team |  |  |



## Requirements



| Repository | Name | Version |

|------------|------|---------|

| https://charts.bitnami.com/bitnami | postgresql | 12.5.6 |

| https://charts.bitnami.com/bitnami | redis | 17.11.3 |



## Values



| Key | Type | Default | Description |

|-----|------|---------|-------------|

| agent.app.replicaCount | int | `1` |  |

| agent.app.resources | object | `{}` |  |

| agent.autoscaling.enabled | bool | `false` | Enable autoscaling for the agent |

| agent.autoscaling.maxReplicas | int | `10` |  |

| agent.autoscaling.minReplicas | int | `2` |  |

| agent.autoscaling.targetCPUUtilizationPercentage | int | `80` |  |

| agent.autoscaling.targetMemoryUtilizationPercentage | int | `80` |  |

| agent.env.analytics_enabled | bool | `true` |  |

| agent.env.consumer_pool_size | int | `100` |  |

| agent.env.dispatcher.allow_list[0] | string | `"0.0.0.0/0"` |  |

| agent.env.dispatcher.deny_list[0] | string | `"127.0.0.1/8"` |  |

| agent.env.dispatcher.deny_list[1] | string | `"169.254.169.254/32"` |  |

| agent.env.dispatcher.insecure_skip_verify | bool | `false` |  |

| agent.env.enable_feature_flag | list | `[]` |  |

| agent.env.enable_profiling | bool | `false` |  |

| agent.env.environment | string | `"oss"` |  |

| agent.env.instance_ingest_rate | int | `100` |  |

| agent.env.license_key | string | `""` |  |

| agent.env.log_level | string | `"error"` |  |

| agent.env.max_retry_seconds | int | `7200` |  |

| agent.env.metrics.enabled | bool | `false` |  |

| agent.env.metrics.metrics_backend | string | `"prometheus"` |  |

| agent.env.metrics.prometheus_metrics.sample_time | int | `5` |  |

| agent.env.proxy | string | `""` |  |

| agent.env.pyroscope.enabled | bool | `false` |  |

| agent.env.pyroscope.password | string | `""` |  |

| agent.env.pyroscope.profile_id | string | `""` |  |

| agent.env.pyroscope.url | string | `""` |  |

| agent.env.pyroscope.username | string | `""` |  |

| agent.env.retention_policy.enabled | bool | `false` |  |

| agent.env.retention_policy.policy | string | `"720h"` |  |

| agent.env.sign_up_enabled | bool | `false` |  |

| agent.env.smtp.enabled | bool | `false` |  |

| agent.env.smtp.from | string | `""` |  |

| agent.env.smtp.password | string | `""` | Ignored in case of secret parameter with non-empty value |

| agent.env.smtp.port | int | `0` |  |

| agent.env.smtp.provider | string | `""` |  |

| agent.env.smtp.reply_to | string | `""` |  |

| agent.env.smtp.secret | string | `""` | If this secret parameter is not empty, password value will be ignored. The password in the secret should be in the 'password' key |

| agent.env.smtp.ssl | bool | `false` |  |

| agent.env.smtp.url | string | `""` |  |

| agent.env.smtp.username | string | `""` |  |

| agent.env.storage.enabled | bool | `false` |  |

| agent.env.storage.on_prem.path | string | `""` |  |

| agent.env.storage.s3.accessKey | string | `""` |  |

| agent.env.storage.s3.bucket | string | `""` |  |

| agent.env.storage.s3.endpoint | string | `""` |  |

| agent.env.storage.s3.region | string | `""` |  |

| agent.env.storage.s3.secret | string | `""` | If this secret parameter is not empty, secretKey value will be ignored. The password in the secret should be in the 'secretKey' key |

| agent.env.storage.s3.secretKey | string | `""` | Ignored in case of secret parameter with non-empty value |

| agent.env.storage.s3.session_token | string | `""` |  |

| agent.env.storage.type | string | `""` |  |

| agent.env.worker_execution_mode | string | `"default"` |  |

| agent.image.pullPolicy | string | `"IfNotPresent"` | Pull policy for the agent image |

| agent.image.repository | string | `"getconvoy/convoy"` | Repository to be used by the agent. The latest tag is used by default |

| agent.podDisruptionBudget | object | `{}` |  |

| agent.securityContext | object | `{}` |  |

| agent.service.port | int | `80` | Port for the agent service |

| agent.service.type | string | `"ClusterIP"` | Type of service for the agent |

| global.convoy.api_version | string | `"2024-01-01"` | API version |

| global.convoy.cacert_content | string | `""` | Dispatcher CA Certificate content. If provided, a secret will be created with this content |

| global.convoy.cacert_secret_name | string | `""` | Dispatcher CA Certificate configuration. If provided, it will use the content of the secret |

| global.convoy.enable_usage_analytics | bool | `true` | Enable usage analytics |

| global.convoy.environment | string | `"oss"` | Convoy Environment |

| global.convoy.image | string | `"getconvoy/convoy"` | Docker image tags for all convoy components |

| global.convoy.jwt_refresh_secret | string | `"convoy-refresh-secret"` | JWT Refresh Secret key |

| global.convoy.jwt_secret | string | `"convoy-secret"` | JWT Secret key |

| global.convoy.jwt_secret_name | string | `""` | If this secret parameter is not empty, JWT secret values will be ignored. The secrets should be in the 'jwt_secret' and 'jwt_refresh_secret' keys |

| global.convoy.license_key | string | `""` | License Key |

| global.convoy.license_key_secret_name | string | `""` | If this secret parameter is not empty, the inline license key value will be ignored. The license key should be present in the 'license_key' key of the specified secret. |

| global.convoy.log_level | string | `"error"` | Logger Level for all convoy components |

| global.convoy.otel_auth_header_name | string | `""` | Open Telemetry auth header name |

| global.convoy.otel_auth_header_value | string | `""` | Open Telemetry auth header value |

| global.convoy.otel_collector_url | string | `""` | Open Telemetry collector url |

| global.convoy.otel_insecure_skip_verify | bool | `true` | Open Telemetry insecure skip verify |

| global.convoy.otel_sample_rate | int | `1` | Open Telemetry sample rate |

| global.convoy.retention_policy_duration | string | `"720h"` | Retention policy duration |

| global.convoy.retention_policy_enabled | bool | `false` | Retention policy enabled |

| global.convoy.sentry_dsn | string | `""` | Sentry DSN |

| global.convoy.tag | string | `"v25.6.7"` | Docker image tags for all convoy components |

| global.convoy.tracer_enabled | bool | `false` | Tracing config for all convoy services |

| global.convoy.tracer_type | string | `"otel"` | Tracing provider type |

| global.externalDatabase.database | string | `"convoy"` | Database name for the external database |

| global.externalDatabase.enabled | bool | `true` | Enable an external database; This will use postgresql chart, Change values if you use an external database |

| global.externalDatabase.host | string | `"postgresql"` | Host for the external database |

| global.externalDatabase.options | string | `"sslmode=disable&connect_timeout=30"` | Query params for the external database |

| global.externalDatabase.password | string | `"postgres"` | Password for the external database, ignored in case of secret parameter with non-empty value |

| global.externalDatabase.port | int | `5432` | Port for the external database |

| global.externalDatabase.postgresPassword | string | `"postgres"` | Password for the external database |

| global.externalDatabase.readReplicas | object | `{}` | Read replicas configuration for the external database |

| global.externalDatabase.secret | string | `""` | If this secret parameter is not empty, the password value will be ignored. The password in the secret should be in the 'password' key |

| global.externalDatabase.username | string | `"postgres"` | Username for the external database |

| global.externalRedis.addresses | string | `""` | redis cluster addresses, if set the other values won't be used |

| global.externalRedis.database | string | `""` | Database name for the external redis. |

| global.externalRedis.enabled | bool | `false` | Enable external redis, Enable this if you use an external redis and disable Native redis |

| global.externalRedis.host | string | `""` | Host for the external redis |

| global.externalRedis.password | string | `""` | password for the external redis, ignored in case of secret parameter with non-empty value |

| global.externalRedis.port | string | `""` | Port for the external redis |

| global.externalRedis.scheme | string | `""` | Scheme for the external redis. This can be redis, rediss, redis-socket or redis-sentinel |

| global.externalRedis.secret | string | `""` | If this secret parameter is not empty, password value will be ignored. The password in the secret should be in the 'password' key |

| global.externalRedis.username | string | `""` | username for the external redis. |

| global.nativeRedis.enabled | bool | `true` | Enable redis; This will use redis chart, Disable if you use an external redis |

| global.nativeRedis.host | string | `"redis-master"` | Host for the redis |

| global.nativeRedis.password | string | `"convoy"` | password for the redis, ignored in case of secret parameter with non-empty value |

| global.nativeRedis.port | int | `6379` | Port for the redis |

| global.nativeRedis.secret | string | `""` | If this secret parameter is not empty, password value will be ignored. The password in the secret should be in the 'password' key |

| server.app.replicaCount | int | `1` |  |

| server.app.resources | object | `{}` |  |

| server.autoscaling.enabled | bool | `false` | Enable autoscaling for the server |

| server.autoscaling.maxReplicas | int | `10` |  |

| server.autoscaling.minReplicas | int | `2` |  |

| server.autoscaling.targetCPUUtilizationPercentage | int | `80` |  |

| server.autoscaling.targetMemoryUtilizationPercentage | int | `80` |  |

| server.env.analytics.enabled | bool | `true` |  |

| server.env.analytics_enabled | bool | `true` |  |

| server.env.api_version | string | `"2024-01-01"` |  |

| server.env.auth.file.basic | object | `{}` |  |

| server.env.auth.jwt.enabled | bool | `true` |  |

| server.env.auth.jwt.refresh_secret | string | `"convoy-refresh-secret"` |  |

| server.env.auth.jwt.secret | string | `"convoy-secret"` |  |

| server.env.auth.native.enabled | bool | `true` |  |

| server.env.enable_feature_flag | list | `[]` |  |

| server.env.enable_profiling | bool | `false` |  |

| server.env.environment | string | `"oss"` |  |

| server.env.host | string | `""` |  |

| server.env.instance_ingest_rate | int | `100` |  |

| server.env.license_key | string | `""` |  |

| server.env.log_level | string | `"error"` |  |

| server.env.max_response_size | int | `50` | Max response body when ingesting webhooks (might be renamed). Defaults to 50KB |

| server.env.max_retry_seconds | int | `7200` |  |

| server.env.metrics.enabled | bool | `false` |  |

| server.env.metrics.metrics_backend | string | `"prometheus"` |  |

| server.env.metrics.prometheus_metrics.sample_time | int | `5` |  |

| server.env.pyroscope.enabled | bool | `false` |  |

| server.env.pyroscope.password | string | `""` |  |

| server.env.pyroscope.profile_id | string | `""` |  |

| server.env.pyroscope.url | string | `""` |  |

| server.env.pyroscope.username | string | `""` |  |

| server.env.retention_policy.enabled | bool | `false` |  |

| server.env.retention_policy.policy | string | `"720h"` |  |

| server.env.sign_up_enabled | bool | `false` |  |

| server.env.storage.enabled | bool | `false` |  |

| server.env.storage.on_prem.path | string | `""` |  |

| server.env.storage.s3.accessKey | string | `""` |  |

| server.env.storage.s3.bucket | string | `""` |  |

| server.env.storage.s3.endpoint | string | `""` |  |

| server.env.storage.s3.prefix | string | `""` |  |

| server.env.storage.s3.region | string | `""` |  |

| server.env.storage.s3.secret | string | `""` | If this secret parameter is not empty, secretKey value will be ignored. The password in the secret should be in the 'secretKey' key |

| server.env.storage.s3.secretKey | string | `""` | Ignored in case of secret parameter with non-empty value |

| server.env.storage.s3.session_token | string | `""` |  |

| server.env.storage.type | string | `""` |  |

| server.image.pullPolicy | string | `"IfNotPresent"` | Pull policy for the server image |

| server.image.repository | string | `"getconvoy/convoy"` | Repository to be used by the server. The latest tag is used by default |

| server.ingress.annotations | object | `{}` |  |

| server.ingress.enabled | bool | `true` | Enable ingress for the server |

| server.ingress.hosts[0].host | string | `"test.com"` |  |

| server.ingress.hosts[0].http.paths[0].path | string | `"/"` |  |

| server.ingress.hosts[0].http.paths[0].pathType | string | `"Prefix"` |  |

| server.ingress.ingressClassName | string | `""` |  |

| server.ingress.tls[0].hosts[0] | string | `"test.com"` |  |

| server.ingress.tls[0].secretName | string | `"test-tls-secret"` |  |

| server.podDisruptionBudget | object | `{}` |  |

| server.securityContext | object | `{}` |  |

| server.service.port | int | `80` | Port for the server service |

| server.service.type | string | `"ClusterIP"` | Type of service for the server |



----------------------------------------------

Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2)