Add docker image #235

plantroon · 2023-03-29T15:34:23Z

Apparently there was a similar PR/suggestion in the past but it was withdrawn. I am reviving that effort.

I wrote a minimal distroless (there's only python) and rootless Dockerfile. I successfully use this in my more elaborate setup with rssbridge and chadburn scheduling. The docker-compose example in the README.rst is taken from my setup.

This PR contains a github automation for building a docker image for ghcr.io.

I will implement any necessary changes if requested.

formatting

plantroon · 2023-04-04T19:04:33Z

This would close #218 for example

Can anyone approve this please? :) I am happy to work on any adjustments as requested.

auouymous

@amiryal Do you know anything about docker?

auouymous · 2023-06-09T07:13:18Z

.github/workflows/docker-publish.yml

+
+on:
+  schedule:
+    - cron: '43 23 * * *'


Does this build an image every day, even if no changes have been made?

I will bring this in line with the other python workflow, to run on push. Yes the schedule was stupid and I forgot to remove it from here.

auouymous · 2023-06-09T07:20:10Z

README.rst

+      entrypoint: "/venv/bin/python3 -c 'import threading; threading.Event().wait()'"
+      labels:
+        chadburn.enabled: "true"
+        chadburn.job-exec.rss2email.schedule: "@every 5m"


We shouldn't be suggesting users run r2e more than once per day.

agreed, I will bring this in line with cron example

auouymous · 2023-06-09T07:33:29Z

README.rst

@@ -53,6 +53,8 @@ A docker package exists for this project::
 Then it can be used like::

  $ docker run  -v ./data:/data -v ./config:/config rss2email list
+


Whitespace on blank line.

Will fix. Got a better setup now so that I won't miss these anymore

auouymous · 2023-06-09T07:34:18Z

README.rst

@@ -65,9 +72,11 @@ docker-compose.yaml::yaml
        chadburn.job-exec.rss2email.schedule: "@every 5m"
        chadburn.job-exec.rss2email.command: "r2e run"

-The example docker-compose snippet sets up chadburn (or ofelia) job scheduler to run r2e periodically. For the labels to be picked up, it is required that the container keeps running which is ensured with the entrypoint. Python's Event().wait() was used as there is no shell and this method should use less cpu than sleeping or looping (with sleep). You can of course abandon this and just call r2e from any other job scheduler as this entrypoint only circumvents chadburn/ofelia limitations.
+The example docker-compose snippet sets up chadburn (or ofelia) job scheduler to run r2e periodically. 


End of line whitespace.

@plantroon
The guide should either walk the user through the entire setup (e.g., how does chadburn get installed and invoked?) or leave out invocation details for users to figure out for themselves.

@auouymous Sorry, will fix

@amiryal it's a few more lines, I suggest adding it but want the feedback if it's a good idea or we should forget the whole job scheduler stuff.

services: chadburn: image: premoweb/chadburn:latest command: daemon restart: unless-stopped volumes: - /var/run/docker.sock:/var/run/docker.sock:ro

README.rst

auouymous · 2023-06-09T07:42:42Z

.github/workflows/docker-publish.yml

+  # github.repository as <account>/<repo>
+  IMAGE_NAME: ${{ github.repository }}
+
+


There are multiple instances of double line spacing in this file.

I'll bring this more in line with the other workflow too, the comments are also possibly useless and come from some other example. The actions are descriptive enough by themselves.

plantroon · 2023-06-09T08:29:03Z

I'll squash commits when I fix this so that it doesn't mess up history too much

README.rst

amiryal · 2023-06-09T08:18:54Z

README.rst

@@ -65,9 +72,11 @@ docker-compose.yaml::yaml
        chadburn.job-exec.rss2email.schedule: "@every 5m"
        chadburn.job-exec.rss2email.command: "r2e run"

-The example docker-compose snippet sets up chadburn (or ofelia) job scheduler to run r2e periodically. For the labels to be picked up, it is required that the container keeps running which is ensured with the entrypoint. Python's Event().wait() was used as there is no shell and this method should use less cpu than sleeping or looping (with sleep). You can of course abandon this and just call r2e from any other job scheduler as this entrypoint only circumvents chadburn/ofelia limitations.
+The example docker-compose snippet sets up chadburn (or ofelia) job scheduler to run r2e periodically. 


@plantroon
The guide should either walk the user through the entire setup (e.g., how does chadburn get installed and invoked?) or leave out invocation details for users to figure out for themselves.

amiryal · 2023-06-09T08:30:51Z

README.rst

+
+The example docker-compose snippet sets up chadburn (or ofelia) job scheduler to run r2e periodically. 
+
+Some background for entrypoint override: For the labels to be picked up, it is required that the container keeps running which is ensured with the entrypoint. Python's Event().wait() was used as there is no shell and this method should use less cpu than sleeping or looping (with sleep). You can of course abandon this and just call r2e from any other job scheduler as this entrypoint only circumvents chadburn/ofelia limitations.


This seems like too much detail for something that is outside of r2e. In future iterations of chadburn this workaround will be made redundant, but it will remain here until someone cares enough to update. Also, it seems a little excessive for something to be kept running indefinitely just to wake up a couple of times per day. The CPU usage while running may be close to 0%, but RAM is also a resource, and some cloud platforms might charge you for every second of run time.

The CPU usage here should be lower than any sleep command available.

I don't think it's possible for Chadburn or Ofelia to do exec on a stopped service, though other job schedulers operating outside of Docker might be able to.

I originally had this set up to run via docker run in cron, but opted to go for a cleaner docker-centric setup where I have everything in one place.

@amiryal In future iterations of chadburn this workaround will be made redundant - is this related to the job-run functionality? I was not aware of that coming :)

amiryal · 2023-06-09T08:39:33Z

README.rst

+      volumes:
+        - ./config:/config
+        - ./data:/data
+      entrypoint: "/venv/bin/python3 -c 'import threading; threading.Event().wait()'"


@plantroon
A later paragraph mentions there is no shell in the container, but this looks like a shell command line to me. Educate me here — does docker-compose parse this line and call exec with the parsed parameters?

@auouymous
To answer your opening question, no, I do not have much hands-on experience with Docker.

@amiryal yes, this is executed directly by Docker (no need for compose, specifying docker run --entrypoint=... would yield the same result) even without a shell available in the container.

The rationale behind this is for it to keep running as a service so that a job scheduler can pick it up and exec r2e run, which to my understanding runs the same way as when you would call docker exec.

@amiryal I understand the confusion now. I specified it in the shell command form, therefore it runs through a shell - and even distroless images have sh binary in them by default, but I thought they didn't.

I will change this to use the exec command form to make it cleaner.

plantroon

Fixed all your concerns. I additionally requested @amiryal to take another look at the chadburn part.

Centro1993 · 2023-09-10T18:30:26Z

Great Stuff, would love to see this added!

plantroon added 7 commits March 27, 2023 21:23

Create Dockerfile

992ea0f

Create docker-publish.yml

17a1fab

Update README.rst with Docker usage

afaaaf1

Update README.rst

9cf22e9

formatting

Update Dockerfile with venv's bin added to PATH

0578538

Fixed formatting in README.rst

60e8919

Added some more info regarding Docker to README.rst

15ef27a

auouymous requested changes Jun 9, 2023

View reviewed changes

amiryal reviewed Jun 9, 2023

View reviewed changes

plantroon added 2 commits June 9, 2023 17:19

Fixed whitespaces in README and similar errors

83f2256

Removed extra information about the entrypoint workaround

3b20dbd

plantroon requested a review from amiryal June 9, 2023 18:04

plantroon commented Jun 9, 2023

View reviewed changes

plantroon requested a review from auouymous June 9, 2023 19:12

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add docker image #235

Add docker image #235

plantroon commented Mar 29, 2023

plantroon commented Apr 4, 2023

auouymous left a comment

auouymous Jun 9, 2023

plantroon Jun 9, 2023

auouymous Jun 9, 2023

plantroon Jun 9, 2023

auouymous Jun 9, 2023

plantroon Jun 9, 2023

auouymous Jun 9, 2023

amiryal Jun 9, 2023

plantroon Jun 9, 2023 •

edited

plantroon Jun 9, 2023

auouymous Jun 9, 2023

plantroon Jun 9, 2023

plantroon commented Jun 9, 2023

amiryal Jun 9, 2023

amiryal Jun 9, 2023

plantroon Jun 9, 2023

plantroon Jun 9, 2023

amiryal Jun 9, 2023

plantroon Jun 9, 2023 •

edited

plantroon Jun 9, 2023

plantroon left a comment

Centro1993 commented Sep 10, 2023

		@@ -53,6 +53,8 @@ A docker package exists for this project::
		Then it can be used like::

		$ docker run -v ./data:/data -v ./config:/config rss2email list

		# github.repository as <account>/<repo>
		IMAGE_NAME: ${{ github.repository }}


		The example docker-compose snippet sets up chadburn (or ofelia) job scheduler to run r2e periodically.

		Some background for entrypoint override: For the labels to be picked up, it is required that the container keeps running which is ensured with the entrypoint. Python's Event().wait() was used as there is no shell and this method should use less cpu than sleeping or looping (with sleep). You can of course abandon this and just call r2e from any other job scheduler as this entrypoint only circumvents chadburn/ofelia limitations.

Add docker image #235

Are you sure you want to change the base?

Add docker image #235

Conversation

plantroon commented Mar 29, 2023

plantroon commented Apr 4, 2023

auouymous left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

plantroon Jun 9, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

plantroon commented Jun 9, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

plantroon Jun 9, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

plantroon left a comment

Choose a reason for hiding this comment

Centro1993 commented Sep 10, 2023

plantroon Jun 9, 2023 •

edited

plantroon Jun 9, 2023 •

edited