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

Docker Container Support #56

Open
alhasacademy96 opened this issue Oct 31, 2024 · 1 comment
Open

Docker Container Support #56

alhasacademy96 opened this issue Oct 31, 2024 · 1 comment
Labels
enhancement New feature or request stale

Comments

@alhasacademy96
Copy link
Contributor

alhasacademy96 commented Oct 31, 2024

Is your feature request related to a problem? Please describe.
This issue proposes introducing Docker container support to streamline environment setup, dependencies management, and improve reproducibility for the Kinds-of-Intelligence-CFI/animal-ai project. The benefit would be cross-repository, where testing would benefit the most from this feature.

Describe the solution you'd like

Adding Docker support to this repository can offer several advantages:

  1. Reproducibility: Ensures that all users run the same software versions and configurations.
  2. Ease of Setup: Reduces the time required to install dependencies, troubleshoot, and configure the environment.
  3. Portability: Allows contributors to work on different OS without environment-specific issues.
  4. Scalability: Supports deployment across different cloud providers or CI/CD pipelines using containerized workflows.

So, the full process would be something like this...


1. Create a Dockerfile: Define a Dockerfile to encapsulate the dependencies and configurations. This file should:

Install necessary libraries and dependencies (Unity, ML-Agents, Python, etc.).
Copy necessary project files into the container.
Set up any required environment variables.
Docker Compose (Optional): If the project requires multiple services (e.g., a database, separate backend service), create a docker-compose.yml to orchestrate multi-container setups.

2. Documentation: Add instructions to the README or a docker/README.md to guide users on:

3. Building and running the Docker container locally.
Configuring and mounting any external files (like YAML files) into the container for custom configurations.
CI Integration: (Optional) Update GitHub Actions workflow to build and test the Docker image on each commit, ensuring environment consistency.

Describe alternatives you've considered
None

Additional context

Currently implementing this feature and this issue post simply confirms there is work currently being implemented.

@alhasacademy96 alhasacademy96 added the enhancement New feature or request label Oct 31, 2024
@alhasacademy96 alhasacademy96 self-assigned this Oct 31, 2024
@alhasacademy96 alhasacademy96 removed their assignment Dec 26, 2024
Copy link

This issue is stale because it has been open for 60 days with no activity.

@github-actions github-actions bot added the stale label Feb 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request stale
Projects
None yet
Development

No branches or pull requests

1 participant