Combine docker image into one unified service with skin, core, and pit (optionally).

WithSecureLabs / snake

snake - a malware storage zoo

BSD 3-Clause "New" or "Revised" License

217 stars 40 forks source link

Combine docker image into one unified service with skin, core, and pit (optionally). #14

Closed kennethklee closed 4 years ago

kennethklee commented 4 years ago

Thought snake-skin and snake-core are closely tied together so would be helpful to combine them in a single docker image. As a benefit, makes it a lot easier to run snake without a docker-compose.

This PR combines snake-skin, snake-core, and snake-pit into one docker image to make it easier to launch. Left a way to run snake-core and snake-pit separately as well via the entrypoint.sh with snake-core and snake-pit commands.

Changes:

Adds docker/Dockerfile with snake-skin and snake-core.
Adds docker/entrypoint.sh to run snake-skin, and snake-core or snake-pit or both
Adds docker/nginx.conf with snake-skin, with proxy pass to snake-core via /api
Gave snake-pit a SNAKE_PIT_CONCURRENCY env variable for fine-tuning
Updated docker-compose.yml to run one service instead of three separate services

alexkornitzer commented 4 years ago

Ah sweet,

So I am in two minds about this due to the fact that Docker is all about microservices, but then again I get the appeal of being able to spin one docker image (especially for people who will never interact with the API direct or people who land directly on Snake and don't care about core/skin/pit).

I don't know what your thoughts are on this but I am thinking that we should provide the above image for your use case above, while maintaining the individual Dockerfiles in their respective repos. We can then provide one of the following:

two docker-compose files
one docker-compose file with commented out options
keep the current docker-compose and not provide one for that above as it is now self contained

Do you have any strong thoughts on this?

kennethklee commented 4 years ago

two docker compose files might get confusing to users.

I like the sound of keeping the current docker-compose since the image would become self contained.

let me know what you'd like to do and I'll make the appropriate changes.

alexkornitzer commented 4 years ago

On second thoughts lets go with what you have, this then lets us have snake, snake-core and snake-skin. Most users will use snake and power users can then use the individual images if needed. This also makes adding snake scales easier as core and pit are one image as you have already said above.