Skip to content

Update caching docs to match breaking changes in v25 #31047

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

Merged
ahus1 merged 1 commit into from
Jul 4, 2024
Merged

Update caching docs to match breaking changes in v25 #31047

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
10 changes: 5 additions & 5 deletions docs/guides/server/caching.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ By default, caches are using a UDP transport stack so that nodes are discovered

To explicitly enable distributed infinispan caching, enter this command:

<@kc.build parameters="--cache=ispn"/>
<@kc.start parameters="--cache=ispn"/>

When you start {project_name} in development mode, by using the `start-dev` command, {project_name} uses only local caches and distributed caches are completely disabled by implicitly setting the `--cache=local` option.
The `local` cache mode is intended only for development and testing purposes.
Expand Down Expand Up @@ -176,7 +176,7 @@ to change the number of owners accordingly to better fit into your availability

To specify your own cache configuration file, enter this command:

<@kc.build parameters="--cache-config-file=my-cache-file.xml"/>
<@kc.start parameters="--cache-config-file=my-cache-file.xml"/>

The configuration file is relative to the `conf/` directory.

Expand Down Expand Up @@ -204,7 +204,7 @@ Transport stacks ensure that distributed cache nodes in a cluster communicate in

To apply a specific cache stack, enter this command:

<@kc.build parameters="--cache-stack=<stack>"/>
<@kc.start parameters="--cache-stack=<stack>"/>

The default stack is set to `udp` when distributed caches are enabled.

Expand All @@ -220,7 +220,7 @@ The following table shows transport stacks that are available without any furthe
|udp|UDP|UDP multicast
|===

The following table shows transport stacks that are available using the `--cache-stack` build option and a minimum configuration:
The following table shows transport stacks that are available using the `--cache-stack` runtime option and a minimum configuration:

[%autowidth]
|===
Expand Down Expand Up @@ -249,7 +249,7 @@ For more information and links to repositories with these dependencies, see the

To provide the dependencies to {project_name}, put the respective JAR in the `providers` directory and build {project_name} by entering this command:

<@kc.build parameters="--cache-stack=<ec2|google|azure>"/>
<@kc.start parameters="--cache-stack=<ec2|google|azure>"/>

=== Custom transport stacks
If none of the available transport stacks are enough for your deployment, you are able to change your cache configuration file
Expand Down