Add redis-proxy Dockerfile, GHCR publishing workflow, and deployment … by bootjp · Pull Request #367 · bootjp/elastickv

bootjp · 2026-03-20T09:27:10Z

…guide for automated container deployment

gemini-code-assist · 2026-03-20T09:27:28Z

Summary of Changes

Hello, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly enhances the deployability and usability of the redis-proxy by introducing a dedicated Dockerfile for containerization and a detailed deployment guide. These additions streamline the process of packaging, deploying, and operating the redis-proxy in various environments, facilitating its role in gradual migrations from Redis to ElasticKV.

Highlights

Dockerfile for redis-proxy: A new multi-stage Dockerfile (Dockerfile.redis-proxy) was added to build and containerize the redis-proxy application, using golang:latest for building and gcr.io/distroless/static:latest for the final image.
Redis-proxy Deployment Guide: A comprehensive deployment guide (docs/redis-proxy-deployment.md) was added, detailing Docker image usage, command-line options, proxy modes for migration, deployment examples (Docker, Docker Compose, Kubernetes), health checks, Prometheus metrics, internal parameters, graceful shutdown, and troubleshooting.
GHCR Publishing Workflow: The pull request description indicates the addition of a GitHub Container Registry (GHCR) publishing workflow, which automatically builds and publishes redis-proxy images on pushes to main when relevant files change.

Ignored Files

Ignored by pattern: .github/workflows/** (1)
- .github/workflows/redis-proxy-docker.yml

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	`/gemini review`	Performs a code review for the current pull request in its current state.
Pull Request Summary	`/gemini summary`	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	`/gemini help`	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.

Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

gemini-code-assist

Code Review

This pull request introduces a Dockerfile for the redis-proxy and a comprehensive deployment guide. The changes are a great addition. My review includes suggestions to improve the Dockerfile for better reproducibility and build performance by pinning base image versions and optimizing layer caching. For the deployment guide, I've pointed out that the Kubernetes example uses a command not available in the container and recommended using specific image tags in examples instead of latest to promote best practices.

gemini-code-assist · 2026-03-20T09:29:22Z

Dockerfile.redis-proxy

@@ -0,0 +1,11 @@
+FROM golang:latest AS build


For better reproducibility and to avoid unexpected build failures, it's recommended to pin the Go version instead of using latest. For example, you can use a specific version like golang:1.22.

FROM golang:1.22 AS build

gemini-code-assist · 2026-03-20T09:29:22Z

Dockerfile.redis-proxy

+
+RUN CGO_ENABLED=0 go build -o /redis-proxy ./cmd/redis-proxy/
+
+FROM gcr.io/distroless/static:latest


It's a best practice to pin the base image version for the final stage instead of using latest to ensure your deployments are deterministic. Additionally, consider using the nonroot variant for enhanced security, as it runs the container as a non-privileged user.

FROM gcr.io/distroless/static:nonroot

gemini-code-assist · 2026-03-20T09:29:22Z

Dockerfile.redis-proxy

+FROM golang:latest AS build
+
+WORKDIR $GOPATH/src/app
+COPY . .


To improve Docker build performance and leverage layer caching more effectively, you should copy go.mod and go.sum first, download dependencies, and then copy the rest of the source code. This prevents re-downloading dependencies every time any file in the repository changes. The structure should be:

COPY go.mod go.sum ./ RUN go mod download COPY . .

docs/redis-proxy-deployment.md

Copilot

Pull request overview

Adds end-to-end container packaging and deployment documentation for redis-proxy, enabling automated builds/publishing to GHCR and providing run examples for Docker/Compose/Kubernetes.

Changes:

Added a deployment guide covering proxy modes, flags, metrics, alerts, and example manifests.
Added a dedicated Dockerfile.redis-proxy to build a distroless redis-proxy image.
Added a GitHub Actions workflow to build (and on main, publish) the redis-proxy image to GHCR.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 6 comments.

File	Description
`docs/redis-proxy-deployment.md`	New deployment guide covering modes, configuration, observability, and deployment examples.
`Dockerfile.redis-proxy`	New multi-stage build for a distroless redis-proxy container image.
`.github/workflows/redis-proxy-docker.yml`	New workflow to build/push the redis-proxy image to GHCR on relevant changes.

docs/redis-proxy-deployment.md

Copilot · 2026-03-20T09:31:53Z

Dockerfile.redis-proxy

+
+RUN CGO_ENABLED=0 go build -o /redis-proxy ./cmd/redis-proxy/
+
+FROM gcr.io/distroless/static:latest


The runtime image runs as root by default. For a network-facing proxy, consider switching to a non-root distroless variant (or setting an explicit unprivileged USER) to reduce impact if the process is compromised.

Suggested change

FROM gcr.io/distroless/static:latest

FROM gcr.io/distroless/static:nonroot

Dockerfile.redis-proxy

Copilot · 2026-03-20T09:31:53Z

docs/redis-proxy-deployment.md

+Pre-built images are published to GitHub Container Registry on every push to `main`:
+
+```
+ghcr.io/bootjp/elastickv/redis-proxy:latest
+ghcr.io/bootjp/elastickv/redis-proxy:sha-<commit>
+```
+
+The CI workflow (`.github/workflows/redis-proxy-docker.yml`) builds the image automatically when files under `cmd/redis-proxy/`, `proxy/`, or `Dockerfile.redis-proxy` change.
+


The guide says images are published “on every push to main”, but the workflow is path-filtered and will only run when specific files change. Please update this sentence to match the workflow behavior (or remove the path filters if the intent really is every push).

Copilot · 2026-03-20T09:31:54Z

docs/redis-proxy-deployment.md

+```bash
+docker run --rm \
+  ghcr.io/bootjp/elastickv/redis-proxy:latest \
+  -listen :6379 \
+  -primary redis.internal:6379 \
+  -mode redis-only
+```


In the “Minimal (redis-only)” docker run example, the container listens on :6379 but no -p/--publish is set, so the proxy won’t be reachable from the host in a typical local run. Consider adding the appropriate -p 6379:6379 mapping (or clarify that this example assumes a user-defined Docker network / --network host).

@copilot open a new pull request to apply changes based on this feedback

docs/redis-proxy-deployment.md

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

bootjp · 2026-03-20T09:34:20Z

@copilot open a new pull request to apply changes based on the comments in this thread

Copilot · 2026-03-20T09:34:23Z

@bootjp I've opened a new pull request, #368, to work on those changes. Once the pull request is ready, I'll request review from you.

Copilot · 2026-03-20T09:34:27Z

@bootjp I've opened a new pull request, #369, to work on those changes. Once the pull request is ready, I'll request review from you.

Co-authored-by: bootjp <1306365+bootjp@users.noreply.github.com>

docs: add missing port mapping to minimal redis-proxy docker run example

Fix redis-proxy deployment docs: workflow trigger accuracy and docker run port mapping

Copilot

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.

docs/redis-proxy-deployment.md

Dockerfile.redis-proxy

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Copilot

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated 7 comments.

Copilot · 2026-03-20T10:07:22Z

docs/redis-proxy-deployment.md

+| Mode | Reads from | Writes to | Use case |
+|------|-----------|-----------|----------|
+| `redis-only` | Redis | Redis only | Transparent proxy. Route traffic through the proxy first |
+| `dual-write` | Redis | Redis + ElasticKV | Begin data sync. Populate ElasticKV |


The proxy modes table also starts with a double leading pipe (||), which will render an extra empty column. Use a single leading pipe for proper markdown table formatting.

Copilot · 2026-03-20T10:07:22Z

docs/redis-proxy-deployment.md

+| Metric | Type | Description |
+|--------|------|-------------|
+| `proxy_command_total` | Counter | Commands processed (labels: command, backend, status) |
+| `proxy_command_duration_seconds` | Histogram | Backend command latency |


The Key Metrics markdown table uses a double leading pipe (||), which typically renders as an extra empty column. Switch to a single leading pipe for the header and separator rows.

Copilot · 2026-03-20T10:07:23Z

docs/redis-proxy-deployment.md

+| Parameter | Value | Description |
+|-----------|-------|-------------|
+| Connection pool size | 128 | go-redis pool size per backend |
+| Dial timeout | 5s | Backend connection timeout |
+| Read timeout | 3s | Backend read timeout |


The Internal Parameters markdown table also starts with a double leading pipe (||), which usually creates an empty first column. Use a single leading pipe for correct table formatting.

Copilot · 2026-03-20T10:07:23Z

.github/workflows/redis-proxy-docker.yml

+          images: ghcr.io/${{ github.repository }}/redis-proxy
+          tags: |
+            type=sha
+            type=ref,event=branch


This workflow publishes a branch tag (e.g., :main) via type=ref,event=branch. The deployment guide currently documents only :latest and :sha-...; either drop the branch tag here or update the docs so users know all published tags.

Suggested change

type=ref,event=branch

Copilot · 2026-03-20T10:07:23Z

docs/redis-proxy-deployment.md

+| Flag | Default | Description |
+|------|---------|-------------|
+| `-listen` | `:6479` | Proxy listen address |
+| `-primary` | `localhost:6379` | Primary (Redis) address |


The markdown table header uses a double leading pipe (|| ... |), which renders as an extra empty column in most Markdown viewers. Use a single leading pipe for the header and separator row (and apply the same fix to the other tables in this doc).

Copilot · 2026-03-20T10:07:23Z

docs/redis-proxy-deployment.md

+Pre-built images are published to GitHub Container Registry when relevant files change on `main` (see path filters in the workflow):
+
+```
+ghcr.io/bootjp/elastickv/redis-proxy:latest
+ghcr.io/bootjp/elastickv/redis-proxy:sha-<commit>
+```


The docs list only latest and sha-... image tags, but the workflow configuration also publishes a branch tag (e.g., :main) via type=ref,event=branch. Either document the additional tag here or remove the branch tag from the workflow to match the docs.

docs/redis-proxy-deployment.md

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Add redis-proxy Dockerfile, GHCR publishing workflow, and deployment …

181f332

…guide for automated container deployment

bootjp requested a review from Copilot March 20, 2026 09:27

Copilot started reviewing on behalf of bootjp March 20, 2026 09:27 View session

gemini-code-assist bot reviewed Mar 20, 2026

View reviewed changes

Copilot AI reviewed Mar 20, 2026

View reviewed changes

bootjp and others added 4 commits March 20, 2026 18:32

Update docs/redis-proxy-deployment.md

63da0f5

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

Update docs/redis-proxy-deployment.md

c01d736

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update Dockerfile.redis-proxy

1bc6141

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update docs/redis-proxy-deployment.md

fe2071e

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Initial plan

ab41647

Copilot AI mentioned this pull request Mar 20, 2026

docs: add missing port mapping to minimal redis-proxy docker run example #368

Merged

Initial plan

011f1f0

Copilot AI mentioned this pull request Mar 20, 2026

Fix redis-proxy deployment docs: workflow trigger accuracy and docker run port mapping #369

Merged

Copilot AI and others added 5 commits March 20, 2026 09:35

docs: add -p 6379:6379 port mapping to minimal docker run example

f79d4a7

Co-authored-by: bootjp <1306365+bootjp@users.noreply.github.com>

Fix docs: accurate workflow trigger description and add port mapping

2a50e29

Co-authored-by: bootjp <1306365+bootjp@users.noreply.github.com>

Update Dockerfile.redis-proxy

c27e57c

Merge branch 'feature/redis-proxy' into copilot/sub-pr-367

7a51fd4

Merge pull request #368 from bootjp/copilot/sub-pr-367

6e91ade

docs: add missing port mapping to minimal redis-proxy docker run example

bootjp requested a review from Copilot March 20, 2026 09:49

Merge branch 'feature/redis-proxy' into copilot/sub-pr-367-again

8075aa2

Copilot started reviewing on behalf of bootjp March 20, 2026 09:50 View session

Merge pull request #369 from bootjp/copilot/sub-pr-367-again

1caf3b3

Fix redis-proxy deployment docs: workflow trigger accuracy and docker run port mapping

Copilot AI reviewed Mar 20, 2026

View reviewed changes

docs/redis-proxy-deployment.md Outdated Show resolved Hide resolved

Dockerfile.redis-proxy Show resolved Hide resolved

Dockerfile.redis-proxy Show resolved Hide resolved

bootjp and others added 2 commits March 20, 2026 18:54

Update Dockerfile.redis-proxy

753a980

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update docs/redis-proxy-deployment.md

44a49d4

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

bootjp requested a review from Copilot March 20, 2026 10:03

Copilot started reviewing on behalf of bootjp March 20, 2026 10:04 View session

Copilot AI reviewed Mar 20, 2026

View reviewed changes

bootjp enabled auto-merge March 20, 2026 10:13

bootjp and others added 2 commits March 20, 2026 19:13

Merge branch 'main' into feature/redis-proxy

17b4d58

Update docs/redis-proxy-deployment.md

b9525b0

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

bootjp merged commit 0ae8389 into main Mar 20, 2026
8 checks passed

bootjp deleted the feature/redis-proxy branch March 20, 2026 10:16


		RUN CGO_ENABLED=0 go build -o /redis-proxy ./cmd/redis-proxy/

		FROM gcr.io/distroless/static:latest

	FROM gcr.io/distroless/static:latest
	FROM gcr.io/distroless/static:nonroot

Conversation

bootjp commented Mar 20, 2026

Uh oh!

gemini-code-assist bot commented Mar 20, 2026

Summary of Changes

Highlights

Footnotes

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

gemini-code-assist bot Mar 20, 2026

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist bot Mar 20, 2026

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist bot Mar 20, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Copilot AI Mar 20, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI Mar 20, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 20, 2026

Choose a reason for hiding this comment

Uh oh!

bootjp Mar 20, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

bootjp commented Mar 20, 2026

Uh oh!

Copilot AI commented Mar 20, 2026

Uh oh!

Copilot AI commented Mar 20, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Mar 20, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 20, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 20, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 20, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 20, 2026

Choose a reason for hiding this comment

Uh oh!