From 5f32ec8a9837f36d0d5b8f0a6dfdb33f74c086ef Mon Sep 17 00:00:00 2001 From: Jens Fischer Date: Mon, 16 Sep 2024 10:12:20 +0200 Subject: [PATCH] chore(readme): update README.md --- README.md | 41 +++++++++++++++++++++-------------------- 1 file changed, 21 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 88ef9b8..515573b 100644 --- a/README.md +++ b/README.md @@ -56,26 +56,27 @@ Quasar can be configured using environment variables and/or a configuration file > **Please note:** Redis isn't fully supported (yet) as Hazelcast is the primary cache method of Horizon in its current state. -| Path | Variable | Type | Default | Description | -|-----------------------------|------------------------------|---------------|---------------------------|--------------------------------------------------------------------------------------------------------------------| -| logLevel | QUASAR_LOGLEVEL | string | info | The log-level. | -| fallback.database | QUASAR_FALLBACK_DATABASE | string | horizon | The database that should be used to restore the cache in case of a CR unavailability | -| fallback.uri | QUASAR_FALLBACK_URI | string | mongodb://localhost:27017 | MongoDB uri of the fallback database. | -| reSyncPeriod | QUASAR_RESYNCPERIOD | string | 30s | Resync-period of the Kubernetes informer. | -| store.storeType | QUASAR_STORETYPE | string | hazelcast | Type of store Quasar should write to. | -| store.hazelcast.addresses | QUASAR_HAZELCAST_ADDRESSES | string (list) | [] | The addresses to connect to. | -| store.hazelcast.clusterName | QUASAR_HAZELCAST_CLUSTERNAME | string | horizon | Hazelcast cluster to write to. | -| store.hazelcast.username | QUASAR_HAZELCAST_USERNAME | string | - | Username to authenticate with. | -| store.hazelcast.password | QUASAR_HAZELCAST_PASSWORD | string | - | Password to authenticate with. | -| store.hazelcast.writeBehind | QUASAR_HAZELCAST_WRITEBEHIND | bool | true | Whether or not to perform write-behind writes to the fallback database. | -| store.redis.host | QUASAR_REDIS_HOST | string | localhost | The redis host. | -| store.redis.port | QUASAR_REDIS_PORT | int | 6379 | The redis port. | -| store.redis.username | QUASAR_REDIS_USERNAME | string | - | Username to authenticate with. | -| store.redis.password | QUASAR_REDIS_PASSWORD | string | - | Password to authenticate with. | -| metrics.enabled | QUASAR_METRICS_ENABLED | bool | false | Whether or not metrics should be served. | -| metrics.port | QUASAR_METRICS_PORT | int | 8080 | The port for exposing the metrics service. | -| metrics.timeout | QUASAR_METRICS_TIMEOUT | string | 5s | Timeout of HTTP connections to the metrics service. | -| resources | - | object (list) | [] | The custom resources that should be synchronized. See [configuring resources](#configuring-resources) for details. | +| Path | Variable | Type | Default | Description | +|-----------------------------|--------------------------------|---------------|---------------------------|--------------------------------------------------------------------------------------------------------------------| +| logLevel | QUASAR_LOGLEVEL | string | info | The log-level. | +| fallback.type | QUASAR_FALLBACK_TYPE | string | mongo | | +| fallback.mongo.database | QUASAR_FALLBACK_MONGO_DATABASE | string | horizon | The database that should be used to restore the cache in case of a CR unavailability | +| fallback.mongo.uri | QUASAR_FALLBACK_MONGO_URI | string | mongodb://localhost:27017 | MongoDB uri of the fallback database. | +| reSyncPeriod | QUASAR_RESYNCPERIOD | string | 30s | Resync-period of the Kubernetes informer. | +| store.type | QUASAR_STORE_TYPE | string | hazelcast | Type of store Quasar should write to. | +| store.hazelcast.addresses | QUASAR_HAZELCAST_ADDRESSES | string (list) | [] | The addresses to connect to. | +| store.hazelcast.clusterName | QUASAR_HAZELCAST_CLUSTERNAME | string | horizon | Hazelcast cluster to write to. | +| store.hazelcast.username | QUASAR_HAZELCAST_USERNAME | string | - | Username to authenticate with. | +| store.hazelcast.password | QUASAR_HAZELCAST_PASSWORD | string | - | Password to authenticate with. | +| store.hazelcast.writeBehind | QUASAR_HAZELCAST_WRITEBEHIND | bool | true | Whether or not to perform write-behind writes to the fallback database. | +| store.redis.host | QUASAR_REDIS_HOST | string | localhost | The redis host. | +| store.redis.port | QUASAR_REDIS_PORT | int | 6379 | The redis port. | +| store.redis.username | QUASAR_REDIS_USERNAME | string | - | Username to authenticate with. | +| store.redis.password | QUASAR_REDIS_PASSWORD | string | - | Password to authenticate with. | +| metrics.enabled | QUASAR_METRICS_ENABLED | bool | false | Whether or not metrics should be served. | +| metrics.port | QUASAR_METRICS_PORT | int | 8080 | The port for exposing the metrics service. | +| metrics.timeout | QUASAR_METRICS_TIMEOUT | string | 5s | Timeout of HTTP connections to the metrics service. | +| resources | - | object (list) | [] | The custom resources that should be synchronized. See [configuring resources](#configuring-resources) for details. | ### Configuring resources The `resources` configuration option is a list of custom resources that should be synchronized. Each resource has the following fields: