Add screen to API Docker image

AetherUnbound commented 1 year ago

Description

This PR is paired with enabling SSM on the API ECS cluster (https://github.com/WordPress/openverse-infrastructure/pull/374) - adding screen to the Django image will allow us to connect to the running ECS instance, launch a screen session, initiate a long-running command, and detach from the sessions without stopping the command. It will also enable any of the maintainers to access the running process, since anyone with SSM access can re-attach to the session.

This is similar in nature to how we've executed long-running processes on the API in the past. The only difference is that now this is done via ECS!

Testing Instructions

Build and start the stack: just build && just up
Exec into the running Django container: just exec web bash
Create a screen session: screen -S foobar
Run some commands: ls, pwd, date, etc
Detach from the screen session (should be CTRL+a -> d)
(Optional) exit the container and re-exec
Re-attach to screen: screen -r
See that the session has been maintained!

Checklist

[x] My pull request has a descriptive title (not a vague title like Update index.md).
[x] My pull request targets the default branch of the repository (main) or a parent feature branch.
[x] My commit messages follow [best practices][best_practices].
[x] My code follows the established code style of the repository.
[ ] I added or updated tests for the changes I made (if applicable).
[ ] I added or updated documentation (if applicable).
[x] I tried running the project locally and verified that there are no visible errors.

[best_practices]: https://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project#_commit_guidelines

Developer Certificate of Origin

``` Developer Certificate of Origin Version 1.1 Copyright (C) 2004, 2006 The Linux Foundation and its contributors. 1 Letterman Drive Suite D4700 San Francisco, CA, 94129 Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Developer's Certificate of Origin 1.1 By making a contribution to this project, I certify that: (a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or (b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or (c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it. (d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved. ```

github-actions[bot] commented 1 year ago

API Developer Docs Preview: Ready

https://wordpress.github.io/openverse-api/_preview/1144

Please note that GitHub pages takes a little time to deploy newly pushed code, if the links above don't work or you see old versions, wait 5 minutes and try again.

You can check the GitHub pages deployment action list to see the current status of the deployments.

AetherUnbound commented 1 year ago

This looks good to me. A comment for future readers for why this image has screen might be nice.

Oh, great call!

Nit: I liked having all of the packages on the same line.

Why is that, if you don't mind me asking? ~~The way it's structured now, I can add a comment right above the screen package specifically for it 😄~~ Update: it turns out this is false, my mistake!

WordPress / openverse-api