Skip to content

Commit ff3f95f

Browse files
committed
docs: create valkey module entry
1 parent f04cd7c commit ff3f95f

File tree

2 files changed

+35
-0
lines changed

2 files changed

+35
-0
lines changed

docs/modules/valkey.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Valkey
2+
3+
!!! note This module is INCUBATING.
4+
While it is ready for use and operational in the current version of Testcontainers, it is possible that it may receive breaking changes in the future.
5+
See our [contributing guidelines](../contributing.md#incubating-modules) for more information on our incubating modules policy.
6+
7+
Testcontainers module for [Valkey](https://hub.docker.com/r/valkey/valkey)
8+
9+
## Valkey's usage examples
10+
11+
You can start a Valkey container instance from any Java application by using:
12+
13+
<!--codeinclude-->
14+
[Default Valkey container](../../modules/valkey/src/test/java/org/testcontainers/valkey/ValkeyContainerTest.java) inside_block:container
15+
<!--/codeinclude-->
16+
17+
## Adding this module to your project dependencies
18+
19+
Add the following dependency to your `pom.xml`/`build.gradle` file:
20+
21+
=== "Gradle"
22+
```groovy
23+
testImplementation "org.testcontainers:valkey:{{latest_version}}"
24+
```
25+
26+
=== "Maven"
27+
```xml
28+
<dependency>
29+
<groupId>org.testcontainers</groupId>
30+
<artifactId>valkey</artifactId>
31+
<version>{{latest_version}}</version>
32+
<scope>test</scope>
33+
</dependency>
34+
```

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,7 @@ nav:
108108
- modules/solr.md
109109
- modules/toxiproxy.md
110110
- modules/typesense.md
111+
- modules/valkey.md
111112
- modules/vault.md
112113
- modules/weaviate.md
113114
- modules/webdriver_containers.md

0 commit comments

Comments
 (0)