Create Dockerfile and Docker Compose example

[0xReLogic]

Description

Create a Dockerfile for containerizing Helios and a Docker Compose example for easy deployment with backend services.

Requirements

• Multi-stage Dockerfile for optimized image size
• Docker Compose with Helios + 3 backend containers
• Health checks in Docker Compose
• Volume mounts for configuration

Deliverables

1. Dockerfile - Multi-stage build (build + runtime)
2. docker-compose.yml - Complete stack example
3. .dockerignore - Optimize build context
4. Update README with Docker deployment section

Docker Compose Example

version: '3.8'
services:
  helios:
    build: .
    ports:
      - "8080:8080"
      - "9090:9090"
      - "9091:9091"
    volumes:
      - ./helios.yaml:/app/helios.yaml
    depends_on:
      - backend1
      - backend2
      - backend3
  
  backend1:
    image: nginx:alpine
    # ... backend config

Acceptance Criteria

• Multi-stage Dockerfile with minimal final image
• Docker Compose with Helios + backends
• Documentation in README
• Tested and working deployment

References

• https://docs.docker.com/develop/develop-images/multistage-build/

[trivedi-khushi]

Hey,
I work as a Technical Documentation writer for my company and have worked for the Guides, User-Docs, API References & SDK guides. I wish to contribute to this issue, and would like to share my professional expertise on the same.

Kindly assign this issue to me @0xReLogic

[0xReLogic]

Hi @trivedi-khushi,

Thank you for your interest in contributing to Helios!

I've reviewed your background as a Technical Documentation writer, and I think you're a perfect fit for this issue. The Dockerfile and Docker Compose documentation will be valuable for users deploying Helios in production.

I'm assigning this issue to you. Here are some additional details to help you get started:

Current Project State:

• Helios is a Go-based load balancer (already built and tested)
• Main binary: helios.exe (or helios on Linux)
• Configuration: helios.yaml
• Metrics endpoint: Port 9090 (/metrics, /health)
• Main proxy: Port 8080
• Admin API: Port 9091

Docker Build Tips:

• Use Go 1.20+ for the build stage
• Final image can be based on alpine or distroless for minimal size
• Don't forget to copy helios.yaml as a template
• Expose ports 8080, 9090, and 9091

Docker Compose Tips:

• Include 3 backend services (can use simple nginx:alpine or httpbin/httpbin)
• Configure health checks using the /health endpoint
• Mount helios.yaml as a volume for easy configuration

Once you clone the repo and set up your environment, feel free to open a draft PR so we can iterate together early on.
Go ahead and start by forking the repository and setting up your branch excited to see your first commit

Feel free to ask if you need clarification on any aspect of the implementation!

Looking forward to your contribution.

[Chesblaw]

@trivedi-khushi hi please announce me when you merge the dockerfile

[0xReLogic]

Hey @trivedi-khushi!

Just checking in - how's it going with the Dockerfile?

Quick heads up @Chesblaw is working on the Helm chart (#31) and waiting on this to finalize the image references. To keep things moving, let's aim for

• Draft PR by October 10 (just to see initial progress)
• Final by October 12

If you're stuck on anything (Go builds, multi-stage Docker, config setup, etc.), just shout okey - happy to help

And if you're swamped with other stuff, no worries at all. Just let me know and I can either jump in to help or open it up for someone else.

Thanks!

[0xReLogic]

Hi @trivedi-khushi,

Since we haven't heard back and the October 10 deadline has passed, I'm going to open this issue up for other contributors to keep the project moving.

No worries at all - open source timing can be tricky! Feel free to contribute to other issues if you have time.

---

@Chesblaw - since you're already working on the Helm chart (#31) and waiting on this, would you be interested in taking over the Dockerfile as well?

It's actually simpler than the Helm chart, and you'd be able to:

1. Build the Docker image exactly how you need it for Helm
2. Unblock yourself on Create Kubernetes Helm chart for deployment #31
3. Have full control over both pieces
4. And you’ve got 2 reviews for your Hacktoberfest submission 👍

Let me know if you want to take this on!

Thanks again for your initial interest @trivedi-khushi feel free to grab any docs-related issue in the future 👍