Skip to content

Commit 3284e2b

Browse files
chore: docs on hermes (#216)
1 parent 548fdf1 commit 3284e2b

File tree

2 files changed

+36
-1
lines changed

2 files changed

+36
-1
lines changed

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ Helm chart for deploying [Codefresh On-Premises](https://codefresh.io/docs/docs/
3535
- [Enable session cookie](#enable-session-cookie)
3636
- [X-Frame-Options response header](#x-frame-options-response-header)
3737
- [Image digests in containers](#image-digests-in-containers)
38+
- [Hermes configuration](#hermes-configuration)
3839
- [Configuring OIDC Provider](#configuring-oidc-provider)
3940
- [Maintaining MongoDB indexes](#maintaining-mongodb-indexes)
4041
- [Upgrading](#upgrading)
@@ -71,6 +72,7 @@ Helm chart for deploying [Codefresh On-Premises](https://codefresh.io/docs/docs/
7172
- Firebase [Realtime Database URL](https://firebase.google.com/docs/database/web/start#create_a_database) with [legacy token](https://firebase.google.com/docs/database/rest/auth#legacy_tokens). See [Firebase Configuration](#firebase-configuration)
7273
- Valid TLS certificates for Ingress
7374
- When [external](#external-postgressql) PostgreSQL is used, `pg_cron` and `pg_partman` extensions **must be enabled** for [analytics](https://codefresh.io/docs/docs/dashboards/home-dashboard/#pipelines-dashboard) to work (see [AWS RDS example](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/PostgreSQL_pg_cron.html#PostgreSQL_pg_cron.enable)). The `pg_cron` extension should be the 1.4 version or higher for Azure Postgres DB.
75+
- Redis persistent storage is required for CRON triggers in CI pipelines. Make sure that your external Redis instance supports persistence (AOF or RDB). It's recommended to deploy in-cluster Redis with persistence enabled (e.g. [bitnami/redis](https://github.com/bitnami/charts/tree/main/bitnami/redis) or [redis-ha](https://github.com/DandyDeveloper/charts/blob/master/charts/redis-ha/Chart.yaml)). See [Hermes configuration](#hermes-configuration) for more details.
7476

7577
## Get Repo Info
7678

@@ -1366,6 +1368,22 @@ cfapi:
13661368
digest: ""
13671369
```
13681370

1371+
### Hermes configuration
1372+
1373+
> **Note!** Unlike other services, `Hermes` requires Redis with persistent storage. ⚠️ **Thus, ElastiCache is not supported for Hermes!** It's recommended to deploy in-cluster Redis with persistence enabled (e.g. [bitnami/redis](https://github.com/bitnami/charts/tree/main/bitnami/redis) or [redis-ha](https://github.com/DandyDeveloper/charts/blob/master/charts/redis-ha/Chart.yaml)) and update the `REDIS_HOST` and `REDIS_PASSWORD` accordingly for `hermes` subchart.
1374+
1375+
```yaml
1376+
hermes:
1377+
container:
1378+
env:
1379+
REDIS_HOST: redis-ha-haproxy
1380+
REDIS_PASSWORD:
1381+
valueFrom:
1382+
secretKeyRef:
1383+
name: redis
1384+
key: REDIS_PASSWORD
1385+
```
1386+
13691387
## Configuring OIDC Provider
13701388

13711389
OpenID Connect (OIDC) allows Codefresh Builds to access resources in your cloud provider (such as AWS, Azure, GCP), without needing to store cloud credentials as long-lived pipeline secret variables.

README.md.gotmpl

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ Helm chart for deploying [Codefresh On-Premises](https://codefresh.io/docs/docs/
3535
- [Enable session cookie](#enable-session-cookie)
3636
- [X-Frame-Options response header](#x-frame-options-response-header)
3737
- [Image digests in containers](#image-digests-in-containers)
38+
- [Hermes configuration](#hermes-configuration)
3839
- [Configuring OIDC Provider](#configuring-oidc-provider)
3940
- [Maintaining MongoDB indexes](#maintaining-mongodb-indexes)
4041
- [Upgrading](#upgrading)
@@ -72,6 +73,7 @@ Helm chart for deploying [Codefresh On-Premises](https://codefresh.io/docs/docs/
7273
- Firebase [Realtime Database URL](https://firebase.google.com/docs/database/web/start#create_a_database) with [legacy token](https://firebase.google.com/docs/database/rest/auth#legacy_tokens). See [Firebase Configuration](#firebase-configuration)
7374
- Valid TLS certificates for Ingress
7475
- When [external](#external-postgressql) PostgreSQL is used, `pg_cron` and `pg_partman` extensions **must be enabled** for [analytics](https://codefresh.io/docs/docs/dashboards/home-dashboard/#pipelines-dashboard) to work (see [AWS RDS example](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/PostgreSQL_pg_cron.html#PostgreSQL_pg_cron.enable)). The `pg_cron` extension should be the 1.4 version or higher for Azure Postgres DB.
76+
- Redis persistent storage is required for CRON triggers in CI pipelines. Make sure that your external Redis instance supports persistence (AOF or RDB). It's recommended to deploy in-cluster Redis with persistence enabled (e.g. [bitnami/redis](https://github.com/bitnami/charts/tree/main/bitnami/redis) or [redis-ha](https://github.com/DandyDeveloper/charts/blob/master/charts/redis-ha/Chart.yaml)). See [Hermes configuration](#hermes-configuration) for more details.
7577

7678
## Get Repo Info
7779

@@ -1373,6 +1375,21 @@ cfapi:
13731375
digest: ""
13741376
```
13751377

1378+
### Hermes configuration
1379+
1380+
> **Note!** Unlike other services, `Hermes` requires Redis with persistent storage. ⚠️ **Thus, ElastiCache is not supported for Hermes!** It's recommended to deploy in-cluster Redis with persistence enabled (e.g. [bitnami/redis](https://github.com/bitnami/charts/tree/main/bitnami/redis) or [redis-ha](https://github.com/DandyDeveloper/charts/blob/master/charts/redis-ha/Chart.yaml)) and update the `REDIS_HOST` and `REDIS_PASSWORD` accordingly for `hermes` subchart.
1381+
1382+
```yaml
1383+
hermes:
1384+
container:
1385+
env:
1386+
REDIS_HOST: redis-ha-haproxy
1387+
REDIS_PASSWORD:
1388+
valueFrom:
1389+
secretKeyRef:
1390+
name: redis
1391+
key: REDIS_PASSWORD
1392+
```
13761393

13771394
## Configuring OIDC Provider
13781395

@@ -2472,7 +2489,7 @@ For built-in RabbitMQ `bitnami/rabbitmq` subchart, pre-upgrade hook was added to
24722489
### To 2-9-9
24732490

24742491
> **BREAKING CHANGES in Default Runtime**
2475-
>
2492+
>
24762493
> Default Runtime (`system/default`) drops support for Kubernetes versions older than 1.32 in `deploy` step ([docs](https://codefresh.io/docs/docs/pipelines/steps/deploy/)). Supported versions are: 1.34, 1.33, 1.32.
24772494

24782495
#### Affected values

0 commit comments

Comments
 (0)