https://github.com/softonic/homing-pigeon-chart
Helm chart for Homing Pigeon
https://github.com/softonic/homing-pigeon-chart
homing-pigeon
Last synced: 3 months ago
JSON representation
Helm chart for Homing Pigeon
- Host: GitHub
- URL: https://github.com/softonic/homing-pigeon-chart
- Owner: softonic
- License: other
- Created: 2019-11-26T15:44:20.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2025-07-24T14:21:47.000Z (10 months ago)
- Last Synced: 2025-07-24T17:50:30.612Z (10 months ago)
- Topics: homing-pigeon
- Language: Mustache
- Size: 83 KB
- Stars: 1
- Watchers: 8
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# Homing Pigeon
Helm chart for https://github.com/softonic/homing-pigeon
❗Use chart version >= 0.9.0 with homing-pigeon greater or equal to v0.9.0
[](https://github.com/softonic/homing-pigeon-chart/releases)
[](LICENSE)
[](http://isitmaintained.com/project/softonic/homing-pigeon-chart "Average time to resolve an issue")
### Overview
| Parameter | Description | Default |
|-------------------------------------------|-------------------------------------------------------------------------------------------|---------------------------------------------|
| `image.repository` | Image repository | `softonic/homing-pigeon` |
| `image.tag` | Tag used for the image | `0.1.0` |
| `image.pullPolicy` | Image pull policy | `IfNotPresent` |
| `imagePullSecrets` | Image pull secrets array | `[]` |
| `resources` | Resources policy | `{}` |
| `updateStrategy` | Update strategy for statefulset | `null` |
| `nodeSelector` | Node Selector for homing pigeon deployment | `{}` |
| `tolerations` | Tolerations for homing pigeon deployment | `[]` |
| `affinity` | Affinity for homing pigeon deployment | `{}` |
| `initContainers` | List of init containers | `[]` |
| `extraContainers` | List of extra containers to add to homing pigeon pod | `[]` |
| `nameOverride` | Override name of chart | `""` |
| `fullnameOverride` | Override full name of chart | `""` |
| `replicaCount` | Number of replicas for homing pigeon deployment | `1` |
| `consumerId` | Define CONSUMER_ID env var. It affects `queueName` | `null` |
| `messageBufferLen` | Buffer length for write buffer | `400` |
| `ackBufferLen` | Buffer length for acks | `200` |
| `caCerts` | List of CA certs with `name` being an identifier, and `cert` the certificate in base64 | `null` |
| `podSecurityContext` | Pod security context configuration | `{ fsGroup: 1000 }` |
| `securityContext` | Container security context | `{ runAsUser: 1000, runAsGroup: 1000 ... }` |
| `reader.rabbitmq.enabled` | Enable RabbitMQ reader | `false` |
| `reader.rabbitmq.consumerName` | Consumer identifier label | `""` |
| `reader.rabbitmq.url` | RabbitMQ url | `""` |
| `reader.rabbitmq.caCertName` | Enable SSL for RabbitMQ | `""` |
| `reader.rabbitmq.deadLettersExchangeName` | RabbitMQ reader dead letters exchange name (where unacked and unroutable messsages go to) | `""` |
| `reader.rabbitmq.deadLettersQueueName` | RabbitMQ reader dead letters queue name | `""` |
| `reader.rabbitmq.exchangeName` | RabbitMQ reader exchange name | `""` |
| `reader.rabbitmq.exchangeType` | RabbitMQ reader exchange type | `""` |
| `reader.rabbitmq.exchangeInternal` | Whether RabbitMQ exchange is internal or not | `"false"` |
| `reader.rabbitmq.outerExchangeName` | RabbitMQ reader outer exchange name | `""` |
| `reader.rabbitmq.outerExchangeType` | RabbitMQ reader outer exchange type | `""` |
| `reader.rabbitmq.outerExchangeBindingKey` | RabbitMQ reader binding key for outer exchange | `""` |
| `reader.rabbitmq.queueName` | RabbitMQ reader queue name. It supports templating. | `""` |
| `reader.rabbitmq.queueMaxPriority` | RabbitMQ reader queue x-max-priority value. | `0` |
| `reader.rabbitmq.qos.prefetchCount` | RabbitMQ QoS prefetch count | `0` |
| `writer.elasticsearch.enabled` | elasticsearch writer enabled | `false` |
| `writer.elasticsearch.host` | elasticsearch writer host | `""` |
| `writer.elasticsearch.flushMaxSize` | elasticsearch writer flush max size for bulk writes | `100` |
| `writer.elasticsearch.flushMaxIntervalMs` | elasticsearch writer flush max interval for bulk writes in ms | `5000` |
| `middlewareBatchSize` | number of messages to be passed to the middleware in each call (batch) | `50`. |
| `middlewareBatchTimeoutMs` | time in ms to wait for the batch size to be completed before sending to middleware | `100` |
| `requestMiddlewares[*].name` | middleware name | `null` |
| `requestMiddlewares[*].repository` | middleware image repository | `null` |
| `requestMiddlewares[*].tag` | middleware image tag | `null` |
| `requestMiddlewares[*].pullPolicy` | middleware image pull policy | `IfNotPresent` |
| `requestMiddlewares[*].inSocket` | specifies the URL that exposes the middleware* | `null` |
| `requestMiddlewares[*].outSocket` | specifies the URL that will be used to connect to the next middleware in the queue* | `null` |
| `requestMiddlewares[*].env` | container env vars* | `null` |
| `requestMiddlewares[*].resources` | container resources* | `null` |
| `requestMiddlewares[*].command` | container command* | `null` |
| `requestMiddlewares[*].args` | container args* | `null` |
| `responseMiddlewares[*].name` | middleware name | `null` |
| `responseMiddlewares[*].repository` | middleware image repository | `null` |
| `responseMiddlewares[*].tag` | middleware image tag | `null` |
| `responseMiddlewares[*].pullPolicy` | middleware image pull policy | `IfNotPresent` |
| `responseMiddlewares[*].inSocket` | specifies the URL that exposes the middleware* | `null` |
| `responseMiddlewares[*].outSocket` | specifies the URL that will be used to connect to the next middleware in the queue* | `null` |
| `responseMiddlewares[*].env` | container env vars* | `null` |
| `responseMiddlewares[*].resources` | container resources* | `null` |
| `responseMiddlewares[*].command` | container command* | `null` |
| `responseMiddlewares[*].args` | container args* | `null` |
| `flags` | arbitrary set of flags that will be added to the flags config map | {} |
* These options are not compatible when the middleware is configured with an image.
QueueName templating available variables:
| Name | Description |
| ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
| ConsumerId | Everything after the last `-` in the hostname by default. If no `-` are present, the whole hostname is used. Can be overriden with `CONSUMER_ID` env var. |
### Middlewares
You can define middlewares using the `requestMiddlewares` and `responseMiddlewares` keys.
Middlewares will be concatenated in the same order than declared
in the yaml.
#### Request vs Response middlewares
The `request middlewares` are placed between the reader output and the writer input. In contrast `response middlewares` are placed between the writer output and the reader input.
```
|---> Request middlewares --->|
Reader | | Writer
|<--- Response middlewares <---|
```
#### Usage examples
When using a sidecar middleware with an image:
```yaml
requestMiddlewares:
- name: "middleware1"
repository: "myrepo/middleware1"
tag: "latest"
pullPolicy: "IfNotPresent"
```
When using an external middleware with a socket:
```yaml
requestMiddlewares:
- inSocket: "http://middleware1:5051"
outSocket: "http://middleware2:5052"
```
### Usage
```
helm repo add softonic https://charts.softonic.io
helm upgrade homing-pigeon --install softonic/homing-pigeon
```
### Test
```
helm template . -f test.yaml
```