add modules workaround docs - #214
Conversation
Signed-off-by: hieu2102 <hieund2102@gmail.com>
|
| Filename | Overview |
|---|---|
| docs/using-modules.md | New guide for module usage workaround; contains an args-format bug that would prevent the module from loading, and a missing registry push step. |
| docs/quickstart.md | Adds a correctly-referenced link to the new using-modules guide; no issues. |
Flowchart
%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[Developer machine] -->|docker build| B[valkey-customized:1.0 local image]
B -->|missing step: docker push to registry| C[Container Registry]
C -->|image pull| D[Kubernetes Nodes]
A -->|kubectl apply| E[ValkeyCluster CR]
E -->|operator reconciles| F[ValkeyNode pods]
F -->|strategic merge patch containers spec| G[server container Command: valkey-server /config/valkey.conf Args: --loadmodule /path/to/libjson.so as ONE string]
G -->|single argv element not parsed correctly| H[Module fails to load]
G2[Corrected args: two separate list items] -->|two separate argv elements| H2[Module loads successfully]
Reviews (4): Last reviewed commit: "update wording" | Re-trigger Greptile
|
CI hit the problem in #215, I trigger a CI rerun since this is only docs |
Signed-off-by: hieu2102 <hieund2102@gmail.com>
jdheyburn
left a comment
There was a problem hiding this comment.
LGTM, thank you for raising! cc @stockholmux to see if this is what you had in mind from chatting on Friday
stockholmux
left a comment
There was a problem hiding this comment.
A couple of nits but I think this makes a lot of sense for where we are today.
Signed-off-by: hieu2102 <hieund2102@gmail.com>
jdheyburn
left a comment
There was a problem hiding this comment.
Thanks for raising this! I'll get this merged now, we can refine it if we need to.
This PR closes #213
Summary
Add docs/using-module.md describing a workaround to deploy a ValkeyCluster with module.
Features / Behaviour Changes
docs/using-module.mddocs/using-module.mdfromdocs/quickstart.mdImplementation
Limitations
Testing
Checklist
Before submitting the PR make sure the following are checked:
pre-commit run --all-filesor hooks on commit)