Skip to content

Commit 112248b

Browse files
openshift-cherrypick-robotthemr0cCopilotkim-tsaojmagak
authored
[release-1.6] RHIDP-5184 - added steps to _Configuring Redis cache_ (#1173)
* RHIDP-5184 - added steps to _Configuring Redis cache_ Signed-off-by: Fabrice Flore-Thébault <[email protected]> * Apply suggestions from code review Co-authored-by: Copilot <[email protected]> * Update modules/configuring/proc-installing-and-configuring-redis-cache.adoc Co-authored-by: Kim Tsao <[email protected]> * Update modules/configuring/proc-installing-and-configuring-redis-cache.adoc Co-authored-by: Kim Tsao <[email protected]> * Update modules/configuring/proc-installing-and-configuring-redis-cache.adoc * Update modules/configuring/proc-installing-and-configuring-redis-cache.adoc * Update modules/configuring/proc-installing-and-configuring-redis-cache.adoc * Update modules/configuring/proc-installing-and-configuring-redis-cache.adoc * Update modules/configuring/proc-installing-and-configuring-redis-cache.adoc * Update modules/configuring/proc-installing-and-configuring-redis-cache.adoc * language review Signed-off-by: Fabrice Flore-Thébault <[email protected]> * language review Signed-off-by: Fabrice Flore-Thébault <[email protected]> * Update modules/configuring/proc-enabling-the-rhdh-plugin-assets-cache.adoc Co-authored-by: Judith Magak <[email protected]> * Update modules/configuring/proc-enabling-the-rhdh-plugin-assets-cache.adoc Co-authored-by: Judith Magak <[email protected]> * Update modules/configuring/proc-enabling-the-rhdh-plugin-assets-cache.adoc Co-authored-by: Judith Magak <[email protected]> * Update modules/configuring/proc-enabling-the-rhdh-plugin-assets-cache.adoc Co-authored-by: Judith Magak <[email protected]> --------- Signed-off-by: Fabrice Flore-Thébault <[email protected]> Co-authored-by: Fabrice Flore-Thébault <[email protected]> Co-authored-by: Copilot <[email protected]> Co-authored-by: Kim Tsao <[email protected]> Co-authored-by: Judith Magak <[email protected]>
1 parent 7b0977f commit 112248b

File tree

3 files changed

+38
-18
lines changed

3 files changed

+38
-18
lines changed
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
[id="enabling-the-rhdh-plugin-assets-cache_{context}"]
2+
= Enabling the {product} plugin assets cache
3+
4+
By default, {product} does not cache plugin assets.
5+
You can use a Redis cache store to improve {product-short} performance and reliability.
6+
Configured plugins in {product-short} receive dedicated cache connections, which are powered by the Keyv Redis client.
7+
8+
.Prerequisites
9+
* You have installed {product}.
10+
* You have an active Redis server.
11+
For more information on setting up an external Redis server, see the link:https://www.redis.io/docs/latest/[`official Redis documentation`].
12+
13+
.Procedure
14+
. Enable the {product-short} cache by defining Redis as the cache store type and entering your Redis server connection URL in your `{my-app-config-file}` file.
15+
+
16+
.`{my-app-config-file}` file fragment
17+
[source,yaml,subs="+quotes"]
18+
----
19+
backend:
20+
cache:
21+
store: redis
22+
connection: redis://user:[email protected]:6379
23+
----
24+
25+
. Enable the cache for Techdocs by adding the `techdocs.cache.ttl` setting in your `{my-app-config-file}` file.
26+
This setting specifies how long, in milliseconds, a statically built asset should stay in the cache.
27+
+
28+
.`{my-app-config-file}` file fragment
29+
[source,yaml]
30+
----
31+
techdocs:
32+
cache:
33+
ttl: 3600000
34+
----
35+
36+
TIP: Optionally, enable the cache for unsupported plugins that support this feature.
37+
See their respective documentation for details.

modules/dynamic-plugins/proc-installing-and-configuring-redis-cache.adoc

Lines changed: 0 additions & 17 deletions
This file was deleted.

titles/configuring/master.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,5 +36,5 @@ include::modules/dynamic-plugins/con-dynamic-plugins-cache.adoc[ leveloffset=+1]
3636
include::assemblies/assembly-configuring-default-secret-pvc-mounts.adoc[leveloffset=+1]
3737

3838

39-
include::modules/dynamic-plugins/proc-installing-and-configuring-redis-cache.adoc[leveloffset=+1]
39+
include::modules/configuring/proc-enabling-the-rhdh-plugin-assets-cache.adoc[leveloffset=+1]
4040

0 commit comments

Comments
 (0)