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

docs: documentation improvements (Redis, Address Doctor) #1605

Merged
merged 2 commits into from
Mar 11, 2024
Merged

docs: documentation improvements (Redis, Address Doctor) #1605

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2fc9680
docs: more motivation for shared Redis cache feature
shauke Jan 31, 2024
407c6de
docs: add Address Doctor version reference
shauke Jan 31, 2024
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
2 changes: 2 additions & 0 deletions docs/guides/address-doctor.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ kb_sync_latest_only

We integrated [Address Doctor](https://www.informatica.com/de/products/data-quality/data-as-a-service/address-verification.html) to verify address data for correctness.

The current integration is based on the [Address Doctor API 6.0.0](https://docs.informatica.com/data-as-a-service/address-verification/6-0-0/developer-guide/preface.html).

## Setup

First, activate the feature toggle `addressDoctor`.
Expand Down
8 changes: 6 additions & 2 deletions docs/guides/nginx-startup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ If no environment variable is set, this feature is disabled.
### Add additional headers

> [!IMPORTANT]
> To configure additional headers the [PWA Helm Chart](https://github.com/intershop/helm-charts/tree/main/charts/pwa) version 0.8.0 or above should be used.
> To configure additional headers the [PWA Helm Chart](https://github.com/intershop/helm-charts/tree/main/charts/pwa) version 0.8.0 or above has to be used.

For some security or functional reasons it is necessary to add additional headers to page responses.
To make such headers configurable, the environment variable `ADDITIONAL_HEADERS` is introduced.
Expand Down Expand Up @@ -189,8 +189,12 @@ The value supplied must be in the `time` format that is supported by [nginx prox

### Shared Redis Cache

Each NGINX has its own cache so in a deployment with multiple NGINX (for redundancy), the cache hit rate is significantly lower than it could be.
With the shared Redis cache the different NGINX instances push the cache to a shared Redis service and retrieve it from there.
This way each NGINX profits from already rendered SSR results and the overall performance of such a deployment should be better.

> [!IMPORTANT]
> To configure additional headers the [PWA Helm Chart](https://github.com/intershop/helm-charts/tree/main/charts/pwa) version 0.8.0 or above should be used.
> To configure the shared Redis cache the [PWA Helm Chart](https://github.com/intershop/helm-charts/tree/main/charts/pwa) version 0.8.0 or above has to be used.

Multiple nginx instances can share the same Redis cache if this feature is activated.
To use the shared Redis cache, the environment variable `REDIS_URI` must be provided with a valid Redis Entrypoint.
Expand Down
Loading