Summary:

Add cron to official Docker image

Review Request #11669 — Created June 21, 2021 and submitted July 23, 2021, 6:30 p.m.

Information
Owner:	ryanm
Repository:	Review Board
Branch:	master
Bugs:
Depends On:
Reviewers
Groups:	reviewboard
People:

Description

So long as the crontab is being generated, use it for a nice out-of-box experience with Docker and search.

Testing Done

Created fresh test instance docker-compose with equivalent changes to this review request.

With the modified docker-entrypoint.sh in the same dir:

Dockerfile

FROM beanbag/reviewboard:4.0.2
RUN apt-get update && apt-get install -y cron
ADD docker-entrypoint.sh /

docker-compose.yml based on docker-compose.mysql.yaml

...
  reviewboard:
    build: .
    environment:
      - REVIEWBOARD_CRONTAB=/site/conf/cron.conf
...

Start instance, and create search index with docker-compose exec reviewboard /bin/bash -c 'gosu reviewboard rb-site manage /site rebuild_index'
Wait until the next cron run, and check the modified times in the search index e.g. docker-compose exec reviewboard /bin/bash -c 'ls -al /site/data/search-index/'

Commits

Summary
Add cron to official Docker image

Screenshots

Issues

Description	From	Last Updated
Upon further reflection, I think this needs to be optional on launch. The reason is that, if you have, say, …	chipx86	July 4, 2021, 11:44 p.m.

flake8 passed.

JSHint passed.

Thanks! This looks good. I'll test it out and we'll get it into the next release.

Show all issues

Upon further reflection, I think this needs to be optional on launch.

The reason is that, if you have, say, 5 Review Board Docker instances for a server running simultaneously, you're going to end up with 5 instances trying to clear sessions at the same time, 5 instances trying to update indexes at the same time, and that's going at best be a waste of effort and at worst lead to problems.

Being able to control whether a particular instance is performing cron-related tasks would avoid these issues.

The cron.conf we provide on site installation is also merely an example, which can be overridden. We probably should have a way for users to do this. That's not a blocker for getting the change in, but making cron functionality optional is.

Let me know if you're up for doing that. Otherwise, we'll take it on (though I don't have an ETA right now).

Change Summary:

Use environment var to specify crontab, making this feature optional and configurable.

Testing Done:

		Created fresh test instance `docker-compose` with equivalent changes to this review request.

		With the modified `docker-entrypoint.sh` in the same dir:

		`Dockerfile`

		`FROM beanbag/reviewboard:4.0.2`
		RUN apt-get update && apt-get install -y cron
		ADD docker-entrypoint.sh /




		`docker-compose.yml` based on `docker-compose.mysql.yaml`

		`...`
		reviewboard:
		build: .
	+	environment:
	+	- REVIEWBOARD_CRONTAB=/site/conf/cron.conf
		...




		Start instance, and create search index with `docker-compose exec reviewboard /bin/bash -c 'gosu reviewboard rb-site manage /site rebuild_index'`
		Wait until the next cron run, and check the modified times in the search index e.g. `docker-compose exec reviewboard /bin/bash -c 'ls -al /site/data/search-index/'`

Commits:

	Summary
-	Add cron to official Docker image
+	Add cron to official Docker image

Diff:

Revision 2 (+12)

Show changes

	contrib/docker/Dockerfile
	contrib/docker/scripts/docker-entrypoint.sh

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Status: Closed (submitted)

Change Summary:

Pushed to release-4.0.x (84e8985)