Official Docker image and documentation #850

JDiPierro · 2018-07-25T02:20:14Z

For #849 :)

Adds a basic Dockerfile that starts from python:3.6 and a includes custom startup script that allows you to start in any mode.

Includes a first attempt at documentation.

I added a Travis stage to build the image but for releasing I think the better approach is for someone to create a DockerHub account for locustio and set up an automated build for the repository. I believe they do security scanning on the resulting image as well.

Let me know if there's any docs changes, extra features, etc you'd like to see or if I can help with the DockerHub setup. I'm hanging around the Slack server as @JDiPierro as well :D

codecov · 2018-07-25T02:23:13Z

Codecov Report

Merging #850 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #850   +/-   ##
=======================================
  Coverage   66.55%   66.55%           
=======================================
  Files          14       14           
  Lines        1438     1438           
  Branches      226      226           
=======================================
  Hits          957      957           
  Misses        430      430           
  Partials       51       51

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c59360e...cb624eb. Read the comment docs.

cgoldberg · 2018-07-25T13:37:14Z

thanks for this!
I'd like a few maintainers to give this a review and try it out, so we are able to maintain it and answer questions that come up.
@aldenpeterson-wf @mbeacom can you guys give this a look and try it out when you have a chance?

I've found it easier to run locust locally in standalone mode while developing the locustfile. The example docker-compose file still exists though.

heyman · 2018-08-15T09:57:10Z

Hey! I think having an official Docker image for Locust would be great.

Do we really need the docker_start.sh shell-script? It introduces a new API and interface that you have to "learn" to use Locust with Docker. Couldn't we just set the Docker entrypoint to the locust binary?

mbeacom · 2018-08-15T14:35:54Z

.travis.yml

@@ -11,6 +11,8 @@ matrix:
      env: TOXENV=py34
    - python: 2.7
      env: TOXENV=py27
+    - stage: Verify Docker image builds
+      script: docker build -t locustio/locust .


Can we update this to push latest if the branch is master?

mbeacom · 2018-08-15T14:38:12Z

Dockerfile

@@ -0,0 +1,10 @@
+FROM python:3.6


I think we should use either alpine or slim-stretch variants to reduce the image size.

mbeacom · 2018-08-15T15:02:13Z

docker_start.sh

@@ -0,0 +1,25 @@
+#!/usr/bin/env bash
+
+if [ -z "${TARGET_URL}" ]; then


While I agree we should handle env vars for all of these settings, I think we should handle these at the app leveland simply take whatever the $@ entrypoint is, defaulting to locust. This allows the user to modify their entry as necessary and simply pass the envvars to be used.

mbeacom · 2018-08-15T15:03:37Z

docs/running-locust-docker.rst

+
+```
+FROM locustio/locust
+ADD locustfile.py locustfile.py


Maybe we should discourage the usage of ADD for the user's locustfile.py and document mounting a directory with the locustfile.py instead.

mbeacom · 2018-08-15T15:04:18Z

examples/docker-compose/docker-compose.yml

@@ -0,0 +1,25 @@
+version: "3.4"


I'm all for using the latest docker-compose syntax version, but maybe we could pin at 3 to increase availability/adoption.

sekka1 · 2018-09-25T03:07:43Z

I have tried the docker image as is in this PR branch and it works great! There was a Locust Helm chart in the stable repository that hasn't been updated in about a year. I made all of the changes necessary to do the update to v0.9.0 and also added a bunch of other Kubernetes items in there to make it work a little nicer like nodeSelectors/Taints and an Ingress.

I have this PR for the Helm Chart update but I should probably wait for an official image instead of using the image in my Docker Hub repo. Here is the updated Chart: https://github.com/helm/charts/compare/master...sekka1:with-v0.9.0?expand=1#diff-c9789cc33518b31f9230b6284b2b6116R4

The last response to the updates was about a month ago. I'm happy to continue on if @JDiPierro is too busy now.

Thoughs @mbeacom

cgoldberg · 2018-09-25T13:39:08Z

I'm happy to continue on if @JDiPierro is too busy now.

@sekka1 this PR was superseded by #882 , which has already been merged... so Docker stuff is in master branch now. Could you give it a try?

I am going to close this one now.

sekka1 · 2018-09-25T17:08:39Z

The Docker image in Master works for me.

@cgoldberg Is there any plans for an official Locust Docker hub image?

quorak · 2019-01-14T17:49:36Z

It would be great to release the image to an official account. This account looks like scam https://hub.docker.com/r/locustio/locust , though not sure if it actually is.

https://hub.docker.com/r/_/locust would be great !

swarupdonepudi · 2019-02-28T17:42:33Z

Is this docker image built and pushed to a public registry yet?

swarupdonepudi · 2019-02-28T17:45:53Z

Is this docker image built and pushed to a public registry yet?

Nevermind. There is an ongoing discussion around this topic - #849

JDiPierro added 3 commits July 24, 2018 22:06

Dockerfile and startup script

1bd6c4f

Docker Compose example

105354c

First pass at Docker docs

1b1c313

Attempt to add docker build to travis matrix

acdf33a

cgoldberg mentioned this pull request Jul 25, 2018

Provide an official Docker image #849

Closed

Remove Docker Compose docs

cb624eb

I've found it easier to run locust locally in standalone mode while developing the locustfile. The example docker-compose file still exists though.

mbeacom suggested changes Aug 15, 2018

View reviewed changes

cgoldberg closed this Sep 25, 2018

sekka1 mentioned this pull request Sep 25, 2018

Updating Locust to v0.9.0 and using official Dockerfile helm/charts#7970

Closed

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Official Docker image and documentation #850

Official Docker image and documentation #850

JDiPierro commented Jul 25, 2018 •

edited

Loading

codecov bot commented Jul 25, 2018 •

edited

Loading

cgoldberg commented Jul 25, 2018

heyman commented Aug 15, 2018

mbeacom Aug 15, 2018

mbeacom Aug 15, 2018

mbeacom Aug 15, 2018

mbeacom Aug 15, 2018

mbeacom Aug 15, 2018

sekka1 commented Sep 25, 2018

cgoldberg commented Sep 25, 2018

sekka1 commented Sep 25, 2018 •

edited

Loading

quorak commented Jan 14, 2019

swarupdonepudi commented Feb 28, 2019

swarupdonepudi commented Feb 28, 2019

		@@ -0,0 +1,25 @@
		#!/usr/bin/env bash

		if [ -z "${TARGET_URL}" ]; then

Official Docker image and documentation #850

Official Docker image and documentation #850

Conversation

JDiPierro commented Jul 25, 2018 • edited Loading

codecov bot commented Jul 25, 2018 • edited Loading

Codecov Report

cgoldberg commented Jul 25, 2018

heyman commented Aug 15, 2018

mbeacom Aug 15, 2018

Choose a reason for hiding this comment

mbeacom Aug 15, 2018

Choose a reason for hiding this comment

mbeacom Aug 15, 2018

Choose a reason for hiding this comment

mbeacom Aug 15, 2018

Choose a reason for hiding this comment

mbeacom Aug 15, 2018

Choose a reason for hiding this comment

sekka1 commented Sep 25, 2018

cgoldberg commented Sep 25, 2018

sekka1 commented Sep 25, 2018 • edited Loading

quorak commented Jan 14, 2019

swarupdonepudi commented Feb 28, 2019

swarupdonepudi commented Feb 28, 2019

JDiPierro commented Jul 25, 2018 •

edited

Loading

codecov bot commented Jul 25, 2018 •

edited

Loading

sekka1 commented Sep 25, 2018 •

edited

Loading