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.

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

add valkey to oci-factory #306

Merged
merged 11 commits into from
Jan 15, 2025
6 changes: 6 additions & 0 deletions oci/valkey/contacts.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Who and how to notify about the build progress.
notify:
emails:
- data-platform@lists.launchpad.net
mattermost-channels:
- wxppdtg4obdg9csp9wxnqs1wqw # alerts on DataPlatform OCI channel
44 changes: 44 additions & 0 deletions oci/valkey/documentation.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +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
```
11 changes: 11 additions & 0 deletions oci/valkey/image.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
version: 1

upload:
- source: "canonical/charmed-valkey-rock"
commit: e244d7a2887a335642ce35e2dd464f8cc41afa22
directory: .
release:
7.2.7-24.04:
end-of-life: "2025-12-01T00:00:00Z"
risks:
- edge
Loading