Skip to content

Commit

Permalink
Update documentation.yaml
Browse files Browse the repository at this point in the history
  • Loading branch information
reneradoi authored Jan 14, 2025
1 parent 576de2d commit b981823
Showing 1 changed file with 37 additions and 1 deletion.
38 changes: 37 additions & 1 deletion oci/valkey/documentation.yaml
Original file line number Diff line number Diff line change
@@ -1,8 +1,44 @@
version: 1

# --- OVERVIEW INFORMATION ---
application: valkey
is_chiselled: False
description: |
This is an OCI image that bundles Valkey together with the metrics exporter.
Valkey is an open source, flexible distributed key-value datastore that is
optimized for caching and other realtime workloads.
# Quickstart:
To deploy a simple Valkey container:
```bash
docker run --name valkey ubuntu/valkey:7.2.7-24.04_edge
```
To connect to Valkey and check status:
```bash
docker exec valkey valkey-cli ping
```
To adjust the configuration of your Valkey container (e.g. disabling protected mode), create a config file and mount it into the container to this directory:
```
/var/lib/valkey
```
# --- USAGE INFORMATION ---
docker:
parameters:
- -p 6379:6379
access: Access your Valkey server at `http://localhost:6379`.
debug:
text: |
### Debugging
To debug the container:
```bash
docker logs -f <valkey-container>
```
To get an interactive shell:
```bash
docker exec -it <valkey-container> /bin/bash
```

0 comments on commit b981823

Please sign in to comment.