From 2f5110c3fb80669ffc0659331504cc97d3c89b6f Mon Sep 17 00:00:00 2001 From: Jan Koppe Date: Tue, 5 Mar 2024 21:04:47 +0100 Subject: [PATCH] rewrite of concierge - more extendable code, switch to docker instead of supervisord to execute tasks --- .dockerignore | 29 ++ .flake8 | 2 + .github/workflows/build-and-publish.yml | 42 --- .gitignore | 129 --------- .pre-commit-config.yaml | 31 +++ .travis.yml | 9 - Dockerfile | 43 +-- LICENSE | 339 ------------------------ README.md | 29 +- concierge/__init__.py | 0 concierge/config.py | 11 + concierge/defaults.yaml | 10 + concierge/executor/__init__.py | 0 concierge/executor/base.py | 24 ++ concierge/executor/docker.py | 66 +++++ concierge/main.py | 101 +++++++ concierge/portier.py | 61 +++++ concierge/task.py | 14 + kill.py | 36 --- main.py | 168 ------------ requirements.txt | 3 +- setup.cfg | 3 - supervisord.conf | 41 --- tasks.templates/restream.conf.j2 | 8 - workerimages/Makefile | 24 ++ workerimages/base/Dockerfile | 23 ++ workerimages/restream/Dockerfile | 2 + workerimages/restream/work.sh | 16 ++ 28 files changed, 464 insertions(+), 800 deletions(-) create mode 100644 .dockerignore create mode 100644 .flake8 delete mode 100644 .github/workflows/build-and-publish.yml delete mode 100644 .gitignore create mode 100644 .pre-commit-config.yaml delete mode 100644 .travis.yml delete mode 100644 LICENSE create mode 100644 concierge/__init__.py create mode 100644 concierge/config.py create mode 100644 concierge/defaults.yaml create mode 100644 concierge/executor/__init__.py create mode 100644 concierge/executor/base.py create mode 100644 concierge/executor/docker.py create mode 100644 concierge/main.py create mode 100644 concierge/portier.py create mode 100644 concierge/task.py delete mode 100755 kill.py delete mode 100755 main.py delete mode 100644 setup.cfg delete mode 100644 supervisord.conf delete mode 100644 tasks.templates/restream.conf.j2 create mode 100644 workerimages/Makefile create mode 100644 workerimages/base/Dockerfile create mode 100644 workerimages/restream/Dockerfile create mode 100755 workerimages/restream/work.sh diff --git a/.dockerignore b/.dockerignore new file mode 100644 index 0000000..9ad67a2 --- /dev/null +++ b/.dockerignore @@ -0,0 +1,29 @@ +**/.DS_Store +**/__pycache__ +**/.venv +**/.classpath +**/.dockerignore +**/.env +**/.git +**/.gitignore +**/.project +**/.settings +**/.toolstarget +**/.vs +**/.vscode +**/*.*proj.user +**/*.dbmdl +**/*.jfm +**/bin +**/charts +**/docker-compose* +**/compose* +**/Dockerfile* +**/node_modules +**/npm-debug.log +**/obj +**/secrets.dev.yaml +**/values.dev.yaml +workerimages +LICENSE +README.md diff --git a/.flake8 b/.flake8 new file mode 100644 index 0000000..1fd4893 --- /dev/null +++ b/.flake8 @@ -0,0 +1,2 @@ +[flake8] +max-line-length = 160 diff --git a/.github/workflows/build-and-publish.yml b/.github/workflows/build-and-publish.yml deleted file mode 100644 index 37d7e9e..0000000 --- a/.github/workflows/build-and-publish.yml +++ /dev/null @@ -1,42 +0,0 @@ -name: Build and Publish - -on: - push: - branches: - - 'main' - tags: - - 'v*' - pull_request: - -jobs: - docker: - runs-on: ubuntu-latest - steps: - - name: Checkout code - uses: actions/checkout@v2 - - - name: Set up Docker Buildx - uses: docker/setup-buildx-action@v1 - - - name: Docker meta - id: meta - uses: docker/metadata-action@v3 - with: - images: ghcr.io/${{ github.repository }} - - - name: Login to Github Packages - uses: docker/login-action@v1 - if: github.event_name != 'pull_request' - with: - registry: ghcr.io - username: ${{ github.actor }} - password: ${{ secrets.GITHUB_TOKEN }} - - - name: Build and push - id: docker_build - uses: docker/build-push-action@v2 - with: - context: . - push: ${{ github.event_name != 'pull_request'}} - tags: ${{ steps.meta.outputs.tags }} - labels: ${{ steps.meta.outputs.labels }} \ No newline at end of file diff --git a/.gitignore b/.gitignore deleted file mode 100644 index b6e4761..0000000 --- a/.gitignore +++ /dev/null @@ -1,129 +0,0 @@ -# Byte-compiled / optimized / DLL files -__pycache__/ -*.py[cod] -*$py.class - -# C extensions -*.so - -# Distribution / packaging -.Python -build/ -develop-eggs/ -dist/ -downloads/ -eggs/ -.eggs/ -lib/ -lib64/ -parts/ -sdist/ -var/ -wheels/ -pip-wheel-metadata/ -share/python-wheels/ -*.egg-info/ -.installed.cfg -*.egg -MANIFEST - -# PyInstaller -# Usually these files are written by a python script from a template -# before PyInstaller builds the exe, so as to inject date/other infos into it. -*.manifest -*.spec - -# Installer logs -pip-log.txt -pip-delete-this-directory.txt - -# Unit test / coverage reports -htmlcov/ -.tox/ -.nox/ -.coverage -.coverage.* -.cache -nosetests.xml -coverage.xml -*.cover -*.py,cover -.hypothesis/ -.pytest_cache/ - -# Translations -*.mo -*.pot - -# Django stuff: -*.log -local_settings.py -db.sqlite3 -db.sqlite3-journal - -# Flask stuff: -instance/ -.webassets-cache - -# Scrapy stuff: -.scrapy - -# Sphinx documentation -docs/_build/ - -# PyBuilder -target/ - -# Jupyter Notebook -.ipynb_checkpoints - -# IPython -profile_default/ -ipython_config.py - -# pyenv -.python-version - -# pipenv -# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. -# However, in case of collaboration, if having platform-specific dependencies or dependencies -# having no cross-platform support, pipenv may install dependencies that don't work, or not -# install all needed dependencies. -#Pipfile.lock - -# PEP 582; used by e.g. github.com/David-OConnor/pyflow -__pypackages__/ - -# Celery stuff -celerybeat-schedule -celerybeat.pid - -# SageMath parsed files -*.sage.py - -# Environments -.env -.venv -env/ -venv/ -ENV/ -env.bak/ -venv.bak/ - -# Spyder project settings -.spyderproject -.spyproject - -# Rope project settings -.ropeproject - -# mkdocs documentation -/site - -# mypy -.mypy_cache/ -.dmypy.json -dmypy.json - -# Pyre type checker -.pyre/ diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000..22ce7bd --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,31 @@ +# See https://pre-commit.com for more information +# See https://pre-commit.com/hooks.html for more hooks +repos: +- repo: https://github.com/pre-commit/pre-commit-hooks + rev: v3.2.0 + hooks: + - id: trailing-whitespace + - id: end-of-file-fixer + - id: check-yaml + - id: check-added-large-files +- repo: https://github.com/PyCQA/flake8 + rev: 7.0.0 + hooks: + - id: flake8 +- repo: https://github.com/PyCQA/bandit + rev: 1.7.7 + hooks: + - id: bandit +- repo: https://github.com/PyCQA/isort + rev: 5.13.2 + hooks: + - id: isort +- repo: https://github.com/psf/black + rev: 24.2.0 + hooks: + - id: black + +#- repo: https://github.com/pylint-dev/pylint +# rev: v3.1.0 +# hooks: +# - id: pylint diff --git a/.travis.yml b/.travis.yml deleted file mode 100644 index e56d1cd..0000000 --- a/.travis.yml +++ /dev/null @@ -1,9 +0,0 @@ -language: python -python: - - "3.7" - - "3.8" -install: - - pip install -r requirements.txt - - pip install flake8 -script: - - flake8 diff --git a/Dockerfile b/Dockerfile index afe81da..6355abd 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,27 +1,28 @@ -FROM python:3.8-alpine +ARG PYTHON_VERSION=3.11.5 +FROM python:${PYTHON_VERSION}-slim as base + +ENV PYTHONDONTWRITEBYTECODE=1 +ENV PYTHONUNBUFFERED=1 + WORKDIR /app -# set env -ENV PYTHONDONTWRITEBYTECODE 1 -ENV PYTHONUNBUFFERED 1 +# TODO: Because portier needs to be able to talk to the docker socket, we need to run as root +#ARG UID=10001 +#RUN adduser \ +# --disabled-password \ +# --gecos "" \ +# --home "/nonexistent" \ +# --shell "/sbin/nologin" \ +# --no-create-home \ +# --uid "${UID}" \ +# appuser -# install required packages -RUN pip install -U supervisor \ - && mkdir -p /var/log/supervisor \ - && apk add --no-cache ffmpeg +RUN --mount=type=cache,target=/root/.cache/pip \ + --mount=type=bind,source=requirements.txt,target=requirements.txt \ + python -m pip install -r requirements.txt -# install dependencies -ADD ./requirements.txt /app/requirements.txt -RUN pip install -r requirements.txt +#USER appuser -# add user -RUN addgroup -S concierge && adduser -S concierge -G concierge +COPY concierge concierge -# add supervisord tasks directories -RUN mkdir -p /app/tasks.d /app/tasks.logs && chown concierge:concierge /app/tasks.d /app/tasks.logs - -# add code -ADD . /app - -# aaaaand go! -CMD ["/usr/local/bin/supervisord", "-c","/app/supervisord.conf"] +CMD python -m concierge.main diff --git a/LICENSE b/LICENSE deleted file mode 100644 index d159169..0000000 --- a/LICENSE +++ /dev/null @@ -1,339 +0,0 @@ - GNU GENERAL PUBLIC LICENSE - Version 2, June 1991 - - Copyright (C) 1989, 1991 Free Software Foundation, Inc., - 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The licenses for most software are designed to take away your -freedom to share and change it. By contrast, the GNU General Public -License is intended to guarantee your freedom to share and change free -software--to make sure the software is free for all its users. This -General Public License applies to most of the Free Software -Foundation's software and to any other program whose authors commit to -using it. (Some other Free Software Foundation software is covered by -the GNU Lesser General Public License instead.) You can apply it to -your programs, too. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -this service if you wish), that you receive source code or can get it -if you want it, that you can change the software or use pieces of it -in new free programs; and that you know you can do these things. - - To protect your rights, we need to make restrictions that forbid -anyone to deny you these rights or to ask you to surrender the rights. -These restrictions translate to certain responsibilities for you if you -distribute copies of the software, or if you modify it. - - For example, if you distribute copies of such a program, whether -gratis or for a fee, you must give the recipients all the rights that -you have. You must make sure that they, too, receive or can get the -source code. And you must show them these terms so they know their -rights. - - We protect your rights with two steps: (1) copyright the software, and -(2) offer you this license which gives you legal permission to copy, -distribute and/or modify the software. - - Also, for each author's protection and ours, we want to make certain -that everyone understands that there is no warranty for this free -software. If the software is modified by someone else and passed on, we -want its recipients to know that what they have is not the original, so -that any problems introduced by others will not reflect on the original -authors' reputations. - - Finally, any free program is threatened constantly by software -patents. We wish to avoid the danger that redistributors of a free -program will individually obtain patent licenses, in effect making the -program proprietary. To prevent this, we have made it clear that any -patent must be licensed for everyone's free use or not licensed at all. - - The precise terms and conditions for copying, distribution and -modification follow. - - GNU GENERAL PUBLIC LICENSE - TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION - - 0. This License applies to any program or other work which contains -a notice placed by the copyright holder saying it may be distributed -under the terms of this General Public License. The "Program", below, -refers to any such program or work, and a "work based on the Program" -means either the Program or any derivative work under copyright law: -that is to say, a work containing the Program or a portion of it, -either verbatim or with modifications and/or translated into another -language. (Hereinafter, translation is included without limitation in -the term "modification".) Each licensee is addressed as "you". - -Activities other than copying, distribution and modification are not -covered by this License; they are outside its scope. The act of -running the Program is not restricted, and the output from the Program -is covered only if its contents constitute a work based on the -Program (independent of having been made by running the Program). -Whether that is true depends on what the Program does. - - 1. You may copy and distribute verbatim copies of the Program's -source code as you receive it, in any medium, provided that you -conspicuously and appropriately publish on each copy an appropriate -copyright notice and disclaimer of warranty; keep intact all the -notices that refer to this License and to the absence of any warranty; -and give any other recipients of the Program a copy of this License -along with the Program. - -You may charge a fee for the physical act of transferring a copy, and -you may at your option offer warranty protection in exchange for a fee. - - 2. You may modify your copy or copies of the Program or any portion -of it, thus forming a work based on the Program, and copy and -distribute such modifications or work under the terms of Section 1 -above, provided that you also meet all of these conditions: - - a) You must cause the modified files to carry prominent notices - stating that you changed the files and the date of any change. - - b) You must cause any work that you distribute or publish, that in - whole or in part contains or is derived from the Program or any - part thereof, to be licensed as a whole at no charge to all third - parties under the terms of this License. - - c) If the modified program normally reads commands interactively - when run, you must cause it, when started running for such - interactive use in the most ordinary way, to print or display an - announcement including an appropriate copyright notice and a - notice that there is no warranty (or else, saying that you provide - a warranty) and that users may redistribute the program under - these conditions, and telling the user how to view a copy of this - License. (Exception: if the Program itself is interactive but - does not normally print such an announcement, your work based on - the Program is not required to print an announcement.) - -These requirements apply to the modified work as a whole. If -identifiable sections of that work are not derived from the Program, -and can be reasonably considered independent and separate works in -themselves, then this License, and its terms, do not apply to those -sections when you distribute them as separate works. But when you -distribute the same sections as part of a whole which is a work based -on the Program, the distribution of the whole must be on the terms of -this License, whose permissions for other licensees extend to the -entire whole, and thus to each and every part regardless of who wrote it. - -Thus, it is not the intent of this section to claim rights or contest -your rights to work written entirely by you; rather, the intent is to -exercise the right to control the distribution of derivative or -collective works based on the Program. - -In addition, mere aggregation of another work not based on the Program -with the Program (or with a work based on the Program) on a volume of -a storage or distribution medium does not bring the other work under -the scope of this License. - - 3. You may copy and distribute the Program (or a work based on it, -under Section 2) in object code or executable form under the terms of -Sections 1 and 2 above provided that you also do one of the following: - - a) Accompany it with the complete corresponding machine-readable - source code, which must be distributed under the terms of Sections - 1 and 2 above on a medium customarily used for software interchange; or, - - b) Accompany it with a written offer, valid for at least three - years, to give any third party, for a charge no more than your - cost of physically performing source distribution, a complete - machine-readable copy of the corresponding source code, to be - distributed under the terms of Sections 1 and 2 above on a medium - customarily used for software interchange; or, - - c) Accompany it with the information you received as to the offer - to distribute corresponding source code. (This alternative is - allowed only for noncommercial distribution and only if you - received the program in object code or executable form with such - an offer, in accord with Subsection b above.) - -The source code for a work means the preferred form of the work for -making modifications to it. For an executable work, complete source -code means all the source code for all modules it contains, plus any -associated interface definition files, plus the scripts used to -control compilation and installation of the executable. However, as a -special exception, the source code distributed need not include -anything that is normally distributed (in either source or binary -form) with the major components (compiler, kernel, and so on) of the -operating system on which the executable runs, unless that component -itself accompanies the executable. - -If distribution of executable or object code is made by offering -access to copy from a designated place, then offering equivalent -access to copy the source code from the same place counts as -distribution of the source code, even though third parties are not -compelled to copy the source along with the object code. - - 4. You may not copy, modify, sublicense, or distribute the Program -except as expressly provided under this License. Any attempt -otherwise to copy, modify, sublicense or distribute the Program is -void, and will automatically terminate your rights under this License. -However, parties who have received copies, or rights, from you under -this License will not have their licenses terminated so long as such -parties remain in full compliance. - - 5. You are not required to accept this License, since you have not -signed it. However, nothing else grants you permission to modify or -distribute the Program or its derivative works. These actions are -prohibited by law if you do not accept this License. Therefore, by -modifying or distributing the Program (or any work based on the -Program), you indicate your acceptance of this License to do so, and -all its terms and conditions for copying, distributing or modifying -the Program or works based on it. - - 6. Each time you redistribute the Program (or any work based on the -Program), the recipient automatically receives a license from the -original licensor to copy, distribute or modify the Program subject to -these terms and conditions. You may not impose any further -restrictions on the recipients' exercise of the rights granted herein. -You are not responsible for enforcing compliance by third parties to -this License. - - 7. If, as a consequence of a court judgment or allegation of patent -infringement or for any other reason (not limited to patent issues), -conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot -distribute so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you -may not distribute the Program at all. For example, if a patent -license would not permit royalty-free redistribution of the Program by -all those who receive copies directly or indirectly through you, then -the only way you could satisfy both it and this License would be to -refrain entirely from distribution of the Program. - -If any portion of this section is held invalid or unenforceable under -any particular circumstance, the balance of the section is intended to -apply and the section as a whole is intended to apply in other -circumstances. - -It is not the purpose of this section to induce you to infringe any -patents or other property right claims or to contest validity of any -such claims; this section has the sole purpose of protecting the -integrity of the free software distribution system, which is -implemented by public license practices. Many people have made -generous contributions to the wide range of software distributed -through that system in reliance on consistent application of that -system; it is up to the author/donor to decide if he or she is willing -to distribute software through any other system and a licensee cannot -impose that choice. - -This section is intended to make thoroughly clear what is believed to -be a consequence of the rest of this License. - - 8. If the distribution and/or use of the Program is restricted in -certain countries either by patents or by copyrighted interfaces, the -original copyright holder who places the Program under this License -may add an explicit geographical distribution limitation excluding -those countries, so that distribution is permitted only in or among -countries not thus excluded. In such case, this License incorporates -the limitation as if written in the body of this License. - - 9. The Free Software Foundation may publish revised and/or new versions -of the General Public License from time to time. Such new versions will -be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - -Each version is given a distinguishing version number. If the Program -specifies a version number of this License which applies to it and "any -later version", you have the option of following the terms and conditions -either of that version or of any later version published by the Free -Software Foundation. If the Program does not specify a version number of -this License, you may choose any version ever published by the Free Software -Foundation. - - 10. If you wish to incorporate parts of the Program into other free -programs whose distribution conditions are different, write to the author -to ask for permission. For software which is copyrighted by the Free -Software Foundation, write to the Free Software Foundation; we sometimes -make exceptions for this. Our decision will be guided by the two goals -of preserving the free status of all derivatives of our free software and -of promoting the sharing and reuse of software generally. - - NO WARRANTY - - 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY -FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN -OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES -PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED -OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF -MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS -TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE -PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, -REPAIR OR CORRECTION. - - 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR -REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, -INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING -OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED -TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY -YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER -PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE -POSSIBILITY OF SUCH DAMAGES. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -convey the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - - Copyright (C) - - This program is free software; you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation; either version 2 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License along - with this program; if not, write to the Free Software Foundation, Inc., - 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. - -Also add information on how to contact you by electronic and paper mail. - -If the program is interactive, make it output a short notice like this -when it starts in an interactive mode: - - Gnomovision version 69, Copyright (C) year name of author - Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. - This is free software, and you are welcome to redistribute it - under certain conditions; type `show c' for details. - -The hypothetical commands `show w' and `show c' should show the appropriate -parts of the General Public License. Of course, the commands you use may -be called something other than `show w' and `show c'; they could even be -mouse-clicks or menu items--whatever suits your program. - -You should also get your employer (if you work as a programmer) or your -school, if any, to sign a "copyright disclaimer" for the program, if -necessary. Here is a sample; alter the names: - - Yoyodyne, Inc., hereby disclaims all copyright interest in the program - `Gnomovision' (which makes passes at compilers) written by James Hacker. - - , 1 April 1989 - Ty Coon, President of Vice - -This General Public License does not permit incorporating your program into -proprietary programs. If your program is a subroutine library, you may -consider it more useful to permit linking proprietary applications with the -library. If this is what you want to do, use the GNU Lesser General -Public License instead of this License. diff --git a/README.md b/README.md index f724222..a9b96fb 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,27 @@ -[![Docker Repository on Quay](https://quay.io/repository/cwtv/concierge/status "Docker Repository on Quay")](https://quay.io/repository/cwtv/portier) -[![Travis Pipelines](https://api.travis-ci.org/chaoswest-tv/concierge.svg?branch=master)](https://travis-ci.org/github/chaoswest-tv/concierge) - # Concierge + +The counter-part of [Portier](https://git.chaoswest.tv/cwtv/portier), which will execute the required processes to make what's configured in Portier happen. + +It is implemented as a very simple Python application. It will periodically ask Portier for "tasks" to execute. If there are any new tasks, it will claim them and then execute them through an executor. If any tasks are not required anymore by Portier, it will stop them. + +Tasks are essentially background processes, that need to do some continuous work. They are not something that does work and finishes at some point, but rather something that needs to be running all the time. This could be an ffmpeg process that re-transmits an existing video stream as long as it is available. + +## Executors + +Concierge needs an executor to execute the required processes. The current structure allows to switch between different executors, but the only one implemented currently is the `docker` executor. It will use the Docker API to start and stop containers. For every required task type, there's a corresponding Docker image, which will be started with the required parameters. Docker in this case makes our life easier, as it handles running the process for us and schedule it across multiple machines in a Docker swarm mode cluster. + +## Task types + +Tasks have different types, which determine what exactly they are doing. Concierge is mostly indifferent to the type of task, but it does need to know what parameters for the executor to use, and how many resources to allocate for the task. These definitions are stored in the `defaults.yaml`, but can be extended through environment variables as defined by [dynaconf](https://dynaconf.readthedocs.io/en/latest/). + +To implement the task types there are currently individual Docker images, which are started by the docker executor. The build files for these images can be found in `workerimages`, and are available as built images from our container registry. + +Implementing new task types is as simple as creating a new Docker image, and adding the required parameters to the `defaults.yaml` file. The configuration that Portier attaches to a Task will be passed to the Docker container through the `CONCIERGE_CONFIGURATION` environment variable, so the worker image can use them to configure itself. + +## Running + +Currently only the docker executor is implemented, so running Concierge makes most sense in a Docker environment. The following command will start Concierge and let it use the underlying Docker daemon to start and stop containers. + +```bash +$ docker run -d --name concierge --restart unless-stopped -e CONCIERGE_PORTIER_ENDPOINT=http://portier:8080 -e CONCIERGE_IDENTITY=12345 -v /var/run/docker.sock:/var/run/docker.sock git.chaoswest.tv/cwtv/concierge:latest +``` diff --git a/concierge/__init__.py b/concierge/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/concierge/config.py b/concierge/config.py new file mode 100644 index 0000000..662d35f --- /dev/null +++ b/concierge/config.py @@ -0,0 +1,11 @@ +import os + +from dynaconf import Dynaconf + +settings = Dynaconf( + merge_enabled=True, + settings_files=[ + os.path.join(os.path.dirname(__file__), "defaults.yaml"), + ], + envvar_prefix="CONCIERGE", +) diff --git a/concierge/defaults.yaml b/concierge/defaults.yaml new file mode 100644 index 0000000..b470890 --- /dev/null +++ b/concierge/defaults.yaml @@ -0,0 +1,10 @@ +portier_endpoint: "http://localhost" +identity: "ee463ecf-a0cf-4ca1-a1d6-2cbf1726d59d" +loop_interval: 1 +loop_grace: 60 +task_types: + restream: + image: "git.chaoswest.tv/cwtv/concierge/worker-restream:latest" + reservations: + cpus: 0.1 + memory: "256m" diff --git a/concierge/executor/__init__.py b/concierge/executor/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/concierge/executor/base.py b/concierge/executor/base.py new file mode 100644 index 0000000..1efcdf9 --- /dev/null +++ b/concierge/executor/base.py @@ -0,0 +1,24 @@ +"""Abstract base class for executors.""" + +from abc import ABC, abstractmethod + +from concierge.task import Task + + +class BaseExecutor(ABC): + """Abstract base class for executors.""" + + def __init__(self, *args, **kwargs) -> None: + """Initialize the executor with the given arguments.""" + + @abstractmethod + def run_task(self, task: Task) -> None: + """Run the given task.""" + + @abstractmethod + def stop_task(self, uuid: str) -> None: + """Stop the task with the given UUID.""" + + @abstractmethod + def list_task_uuids(self) -> list[str]: + """Return a list of UUIDs of all running tasks.""" diff --git a/concierge/executor/docker.py b/concierge/executor/docker.py new file mode 100644 index 0000000..5e8a9dd --- /dev/null +++ b/concierge/executor/docker.py @@ -0,0 +1,66 @@ +import json +import logging + +import docker + +from concierge.config import settings +from concierge.executor.base import BaseExecutor +from concierge.task import Task + +logger = logging.getLogger(__name__) + + +class DockerExecutor(BaseExecutor): + def __init__(self, identity: str): + self.client = docker.from_env() + self.identity = identity + + def labels_for_task(self, uuid: str): + return { + "concierge.chaoswest.tv/concierge-id": self.identity, + "concierge.chaoswest.tv/task-id": uuid, + } + + def run_task(self, task: Task): + logger.debug(task) + logger.info("Running task %s of type %s", task.uuid, task.type) + labels = self.labels_for_task(task.uuid) + container = self.client.containers.run( + settings.task_types[task.type]["image"], + cpu_shares=int( + float( + settings.task_types[task.type] + .get("reservations", {}) + .get("cpus", 0.25) + ) + * 1024 + ), + mem_limit=settings.task_types[task.type] + .get("reservations", {}) + .get("memory", "256m"), + detach=True, + labels=labels, + restart_policy={"Name": "always"}, + name=f"concierge-task-{task.uuid}", + environment={"CONCIERGE_CONFIGURATION": json.dumps(task.configuration)}, + ) + logger.debug(container) + logger.info("Started container %s for task %s", container.name, task.uuid) + + def list_task_uuids(self) -> list[str]: + labelfilters = [f"concierge.chaoswest.tv/concierge-id={self.identity}"] + containers = self.client.containers.list(filters={"label": labelfilters}) + return [c.labels["concierge.chaoswest.tv/task-id"] for c in containers] + + def stop_task(self, uuid: str): + logger.info("Stopping task %s", uuid) + labels = self.labels_for_task(uuid) + labelfilters = [f"{k}={v}" for k, v in labels.items()] + + containers = self.client.containers.list(filters={"label": labelfilters}) + + for container in containers: + logger.debug(container) + logger.info("Stopping container %s for task %s", container.name, uuid) + container.stop() + container.remove() diff --git a/concierge/main.py b/concierge/main.py new file mode 100644 index 0000000..7a55f61 --- /dev/null +++ b/concierge/main.py @@ -0,0 +1,101 @@ +"""Main module for the concierge service, contains the main loop and signal handlers.""" + +import logging +import signal +import sys +import time + +from requests.exceptions import RequestException + +from concierge.config import settings +from concierge.executor.docker import DockerExecutor +from concierge.portier import PortierClient + +logging.basicConfig(level=logging.INFO) +logger = logging.getLogger(__name__) + +executor = DockerExecutor(settings.identity) +portier = PortierClient(settings.identity, settings.portier_endpoint) + +grace = settings.loop_grace + + +def cleanup_tasks(): + """Stop and release all running tasks.""" + + running_tasks = executor.list_task_uuids() + for task_uuid in running_tasks: + executor.stop_task(task_uuid) + try: + portier.release_task(task_uuid) + except RequestException as e: + logger.error( + "Failed to release task %s while shutting down: %s", task_uuid, e + ) + logger.info("All tasks stopped and released") + + +def sigterm_handler(signum, _): + """Signal handler for SIGTERM and SIGINT, stops all running tasks and exits.""" + + logger.info("Received %s, shutting down", signum) + cleanup_tasks() + sys.exit(0) + + +signal.signal(signal.SIGTERM, sigterm_handler) +signal.signal(signal.SIGINT, sigterm_handler) + + +while True: + time.sleep(settings.loop_interval) + + try: + tasks_offered, tasks_current = portier.heartbeat() + grace = settings.loop_grace + except RequestException: + if grace <= 0: + logger.error("portier remains unreachable, exiting") + cleanup_tasks() + sys.exit(1) + else: + logger.warning("portier unreachable, will try %d more times", grace) + grace -= 1 + continue + + for offer in tasks_offered: + + logger.info("Offered task %s of type %s", offer.uuid, offer.type) + if offer.type not in settings.task_types.keys(): + logger.info("Task type %s not supported, skipping", offer.type) + continue + + try: + task = portier.claim_task(offer) + except RequestException: + continue + + if task is None: + logger.info("Unable to claim task, maybe someone else was quicker?") + continue + + tasks_current.append(task.uuid) + + try: + executor.run_task(task) + except Exception as e: # pylint: disable=broad-except + logger.error("Failed to start task: %s", e) + + try: + portier.release_task(task.uuid) + except RequestException: + pass + + tasks_current.remove(task.uuid) + + for task_uuid in executor.list_task_uuids(): + if task_uuid not in tasks_current: + try: + executor.stop_task(task_uuid) + except Exception as e: # pylint: disable=broad-except + logger.error("Failed to stop obsolete task: %s", e) diff --git a/concierge/portier.py b/concierge/portier.py new file mode 100644 index 0000000..6dbf9e8 --- /dev/null +++ b/concierge/portier.py @@ -0,0 +1,61 @@ +"""Client class that communicates with Portier""" + +import logging + +import requests + +from concierge import task + +logger = logging.getLogger(__name__) + + +class PortierClient: + def __init__(self, concierge_id: str, base_url: str): + self.concierge_id = concierge_id + self.base_url = base_url + + def _request(self, method: str, endpoint: str, **kwargs) -> dict: + r = requests.request( + method, + f"{self.base_url}/concierge/api/{self.concierge_id}/{endpoint}", + **kwargs, + ) + r.raise_for_status() + return r.json() + + def heartbeat(self) -> tuple[list[task.TaskOffer], list[str]]: + logger.debug("Heartbeat") + response = self._request("POST", "heartbeat") + + if response.get("success", False): + return [task.TaskOffer(**t) for t in response.get("available", [])], [ + t.get("uuid") for t in response.get("claims", []) + ] + if response.get("error"): + logger.error(response.get("error")) + else: + logger.error("Unknown error") + logger.debug(response) + return [], [] + + def claim_task(self, offer: task.TaskOffer) -> task.Task | None: + logger.debug("Claiming task %s", offer.uuid) + response = self._request("POST", f"claim/{offer.uuid}") + if response.get("success", False): + logger.debug("Task %s claimed", response["uuid"]) + return task.Task( + uuid=response["uuid"], + type=response["type"], + configuration=response["configuration"], + ) + logger.debug("Failed to claim task %s", offer.uuid) + if response.get("error"): + logger.error(response.get("error")) + else: + logger.error("Unknown error") + logger.debug(response) + return None + + def release_task(self, uuid: str): + logger.debug("Releasing task %s", uuid) + return self._request("POST", f"release/{uuid}") diff --git a/concierge/task.py b/concierge/task.py new file mode 100644 index 0000000..532ca46 --- /dev/null +++ b/concierge/task.py @@ -0,0 +1,14 @@ +from dataclasses import dataclass + + +@dataclass +class Task: + uuid: str + type: str + configuration: dict + + +@dataclass +class TaskOffer: + uuid: str + type: str diff --git a/kill.py b/kill.py deleted file mode 100755 index adaafcb..0000000 --- a/kill.py +++ /dev/null @@ -1,36 +0,0 @@ -#!/usr/bin/env python -import sys -import os -import signal - -from supervisor.childutils import listener - - -def write_stdout(s): - sys.stdout.write(s) - sys.stdout.flush() - - -def write_stderr(s): - sys.stderr.write(s) - sys.stderr.flush() - - -def main(): - while True: - headers, body = listener.wait(sys.stdin, sys.stdout) - body = dict([pair.split(":") for pair in body.split(" ")]) - - if body["groupname"] == "concierge": - try: - pidfile = open('/run/supervisor.pid', 'r') - pid = int(pidfile.readline()) - os.kill(pid, signal.SIGQUIT) - except Exception as e: - write_stdout('could not kill supervisor: %s\n' % e.strerror) - - write_stdout('RESULT 2\nOK') - - -if __name__ == '__main__': - main() diff --git a/main.py b/main.py deleted file mode 100755 index f0836aa..0000000 --- a/main.py +++ /dev/null @@ -1,168 +0,0 @@ -#!/usr/bin/env python -import os -import signal -import sys -import time -import requests -import random -from jinja2 import Environment, FileSystemLoader - -# supervisord xml-rpc connection -import xmlrpc.client -svd = xmlrpc.client.ServerProxy('http://127.0.0.1:9001/RPC2') -identity = os.environ.get('CONCIERGE_IDENTITY') -portier_host = os.environ.get('PORTIER_HOST', default="portier.chaoswest.tv") -portier_scheme = os.environ.get('PORTIER_SCHEME', default="https") -base_url = '%s://%s/concierge/api/%s' % (portier_scheme, portier_host, identity) - -skills = [ - 'restream' -] - -edge_nodes = [ - 'rtmp://ingest-nbg.chaoswest.tv:1936/', - 'rtmp://ingest-fsn.chaoswest.tv:1936/', -] - -interval = 2 - -# runtime stuff -claims = [] - - -def svd_update(): - try: - r = svd.supervisor.reloadConfig() - except xmlrpc.client.Fault as e: - if e.faultCode == 6: # SHUTDOWN_STATE - print('svd shutting down') - return - else: - raise - - added, changed, removed = r[0] - - for group in added: - print('adding %s' % group) - svd.supervisor.addProcessGroup(group) - - for group in changed: - svd.supervisor.stopProcessGroup(group) - svd.supervisor.removeProcessGroup(group) - svd.supervisor.addProcessGroup(group) - - for group in removed: - # we don't want to remove ourselves by accident ;) - print('removing %s' % group) - if group == 'concierge': - print('wait, no! :D' % group) - continue - - svd.supervisor.stopProcessGroup(group) - svd.supervisor.removeProcessGroup(group) - - -def sigterm_handler(signum, frame): - print("concierge shutting down.") - # if concierge dies, all tasks need to be released! - # supervisor has a eventlistener and will kill itself (and thus all running - # tasks) if concierge dies. - for claim in claims: - release_task(claim.get('uuid')) - sys.exit(0) - - -def template_tasks(): - j = Environment(loader=FileSystemLoader('tasks.templates')) - for claim in claims: - tpl = j.get_template('%s.conf.j2' % claim.get('type')) - with open("/app/tasks.d/%s.conf" % claim.get('uuid'), "w") as f: - f.write(tpl.render(edge=random.choice(edge_nodes), uuid=claim.get('uuid'), cfg=claim.get('configuration'))) - - -def stop_task(uuid): - global claims - # remove from local claim list - remaining_claims = [claim for claim in claims if claim.get('uuid') != uuid] - claims = remaining_claims - - # remove task config - file = '/app/tasks.d/%s.conf' % uuid - try: - os.remove(file) - except: # noqa - print('error deleting task configfile', file) - - # reload supervisord config - svd_update() - - -def release_task(uuid): - global claims - r = requests.post('%s/release/%s' % (base_url, uuid)) - - if r.status_code != 200: - return - - stop_task(uuid) - - -def claim_task(uuid): - global claims - r = requests.post('%s/claim/%s' % (base_url, uuid)).json() - claims.append({ - 'uuid': r.get('uuid'), - 'type': r.get('type'), - 'configuration': r.get('configuration') - }) - - # rewrite supervisord config files - template_tasks() - - # reload supervisord config - svd_update() - - -def loop(): - global claims - while True: - # portier heartbeat - r = requests.post('%s/heartbeat' % base_url) - resp = r.json() - - # compare local list of claims with portiers list of claims - for pclaim in resp['claims']: - - # search for claims we don't know of - known_claim = ['x' for claim in claims if claim.get('uuid') == pclaim.get('uuid')] - if not known_claim: - # portier thinks we claimed a task, but we don't know this claim. - # we need to release the task, so it can again be picked up. - print('releasing %s' % pclaim.get('uuid')) - release_task(pclaim.get('uuid')) - - for claim in claims: - # search for claims that portier doesn't know of (maybe taken away on purpose) - known_claim = ['x' for pclaim in resp['claims'] if claim.get('uuid') == pclaim.get('uuid')] - if not known_claim: - print('stopping %s' % claim.get('uuid')) - stop_task(claim.get('uuid')) - - # search for new available tasks that we can handle and try to claim one. - for task in resp['available']: - if task.get('type') in skills: - claim_task(task.get('uuid')) - break - - time.sleep(interval) - - -def main(): - # program setup - signal.signal(signal.SIGTERM, sigterm_handler) - - # check connection to supervisord - loop() - - -main() diff --git a/requirements.txt b/requirements.txt index 9c58798..8926412 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,2 +1,3 @@ +docker requests -jinja2 +dynaconf diff --git a/setup.cfg b/setup.cfg deleted file mode 100644 index f6d9df0..0000000 --- a/setup.cfg +++ /dev/null @@ -1,3 +0,0 @@ -[flake8] -exclude = .git -max-line-length = 120 diff --git a/supervisord.conf b/supervisord.conf deleted file mode 100644 index 194092a..0000000 --- a/supervisord.conf +++ /dev/null @@ -1,41 +0,0 @@ -[supervisord] -pidfile=/run/supervisor.pid -logfile=/var/log/supervisord.log ; (main log file;default $CWD/supervisord.log) -logfile_maxbytes=50MB ; (max main logfile bytes b4 rotation;default 50MB) -logfile_backups=10 ; (num of main logfile rotation backups;default 10) -loglevel=info ; (log level;default info; others: debug,warn,trace) -nodaemon=true ; (start in foreground if true;default false) -user=root - -[inet_http_server] -port=127.0.0.1:9001 - -[unix_http_server] -file=/run/supervisor.sock ; the path to the socket file - -[supervisorctl] -serverurl=unix:///run/supervisor.sock ; use a unix:// URL for a unix socket - -[rpcinterface:supervisor] -supervisor.rpcinterface_factory = supervisor.rpcinterface:make_main_rpcinterface - -[program:concierge] -directory=/app -command=/usr/local/bin/python main.py -autostart=true -autorestart=true -priority=5 -stdout_events_enabled=true -stderr_events_enabled=true -stderr_logfile=/dev/stderr -stderr_logfile_maxbytes=0 -stdout_logfile=/dev/stdout -stdout_logfile_maxbytes=0 -user=concierge - -[eventlistener:concierge_exit] -command=/app/kill.py -events=PROCESS_STATE_FATAL,PROCESS_STATE_STOPPED - -[include] -files = /app/tasks.d/*.conf diff --git a/tasks.templates/restream.conf.j2 b/tasks.templates/restream.conf.j2 deleted file mode 100644 index be0ddb5..0000000 --- a/tasks.templates/restream.conf.j2 +++ /dev/null @@ -1,8 +0,0 @@ -[program:{{ uuid }}] -directory=/app -command=/usr/bin/ffmpeg -y -nostats -progress /tmp/ffmpeg/{{ uuid }} -loglevel repeat+level+info -i {{ edge }}{{ cfg["app"] }}/{{ cfg["stream"] }} -c copy -f {{ cfg["format"] }} {{ cfg["target"] }} -autostart=true -autorestart=true -stderr_logfile=/app/tasks.logs/{{ uuid }}.stderr -stdout_logfile=/app/tasks.logs/{{ uuid }}.stdout -user=concierge diff --git a/workerimages/Makefile b/workerimages/Makefile new file mode 100644 index 0000000..c2a8083 --- /dev/null +++ b/workerimages/Makefile @@ -0,0 +1,24 @@ + +DOCKER_TAG := latest + +all: build_base build_restream + +push: push_base push_restream + +build_base: + @echo "Building base image" + cd base && docker build -t git.chaoswest.tv/cwtv/concierge/worker-base:$(DOCKER_TAG) -f Dockerfile . + +push_base: build_base + @echo "Pushing base image" + docker push git.chaoswest.tv/cwtv/concierge/worker-base:$(DOCKER_TAG) + +build_restream: build_base + @echo "Building restream image" + cd restream && docker build -t git.chaoswest.tv/cwtv/concierge/worker-restream:$(DOCKER_TAG) -f Dockerfile . + +push_restream: build_restream + @echo "Pushing restream image" + docker push git.chaoswest.tv/cwtv/concierge/worker-restream:$(DOCKER_TAG) + +.PHONY: all push build_base push_base build_restream push_restream diff --git a/workerimages/base/Dockerfile b/workerimages/base/Dockerfile new file mode 100644 index 0000000..c7d2e87 --- /dev/null +++ b/workerimages/base/Dockerfile @@ -0,0 +1,23 @@ +FROM alpine:edge +RUN apk add --no-cache --repository=http://dl-cdn.alpinelinux.org/alpine/edge/testing/ \ + ffmpeg \ + jq \ + multirun \ + vector + +WORKDIR /app + +ARG UID=10001 + +RUN adduser \ + --disabled-password \ + --gecos "" \ + --home "/nonexistent" \ + --shell "/sbin/nologin" \ + --no-create-home \ + --uid "${UID}" \ + appuser + +USER appuser + +CMD ["/usr/bin/multirun", "-v", "vector", "/app/work.sh"] diff --git a/workerimages/restream/Dockerfile b/workerimages/restream/Dockerfile new file mode 100644 index 0000000..4e6ae73 --- /dev/null +++ b/workerimages/restream/Dockerfile @@ -0,0 +1,2 @@ +FROM git.chaoswest.tv/cwtv/concierge/worker-base:latest +COPY work.sh /app/work.sh diff --git a/workerimages/restream/work.sh b/workerimages/restream/work.sh new file mode 100755 index 0000000..f1eb75d --- /dev/null +++ b/workerimages/restream/work.sh @@ -0,0 +1,16 @@ +#!/bin/sh + +set -eux + +echo $CONCIERGE_CONFIGURATION + +jq -n 'env.CONCIERGE_CONFIGURATION | fromjson' +export stream_source_url="$(jq -r -n 'env.CONCIERGE_CONFIGURATION | fromjson.stream_source_url')" +export stream_target_transport="$(jq -r -n 'env.CONCIERGE_CONFIGURATION | fromjson.stream_target_transport')" +export stream_target_url="$(jq -r -n 'env.CONCIERGE_CONFIGURATION | fromjson.stream_target_url')" + +exec ffmpeg -y -nostats -loglevel repeat+level+info \ + -i "$stream_source_url" \ + -c copy \ + -f "$stream_target_transport" \ + "$stream_target_url"