Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update the configuration section in README.md #5

Merged
merged 1 commit into from
Sep 16, 2024
Merged

Update the configuration section in README.md #5

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 21 additions & 20 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down