Evolutionary-Algorithms-On-Click/runner_controller_microservice

Update README: Instructions to Run with Docker alongside other services.

Open

#31 opened on Jul 1, 2025

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Go (3 forks)auto 404
amsoc-accepteddocumentationenhancementhacktoberfest

Repository metrics

Stars
 (3 stars)
PR merge metrics
 (PR metrics pending)

Description

Update the README to provide clear instructions for running this service with Docker in conjunction with the full operations stack. The steps should be:

  1. Follow the steps described in the operations/docker directory to launch all services in the operations stack with Docker Compose.
  2. Once all services are up, stop the container (or service) corresponding to runner_controller_microservice.
  3. Use the Docker Compose file provided in this repository (runner_controller_microservice) to launch an updated version of this microservice, making sure to set any required environment variables so it can communicate properly with the other stack services.
  4. Ensure the new instance integrates seamlessly with the rest of the running stack.
  5. Document any additional or changed environment variables, networking considerations, or ports needed for integration.

This update will help users cleanly upgrade or develop on top of runner_controller_microservice without redeploying the full stack.

Contributor guide

Research direction
Follow the link to operations/docker to understand the full stack setup, then adapt the README to include step by step Docker instructions for runner controller microservice integration.
Tech stack
godocker
Domain
backenddevops
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitDocker
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70