├── .gitignore ├── Dockerfile ├── LICENSE ├── README.md ├── celery_conf.py ├── celery_status.sh ├── deploy ├── celery-worker.yaml ├── queue-config.yaml └── rabbitmq.yml ├── requirements.txt ├── run.sh └── submit_tasks.py /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | env/ 12 | build/ 13 | develop-eggs/ 14 | dist/ 15 | downloads/ 16 | eggs/ 17 | .eggs/ 18 | lib/ 19 | lib64/ 20 | parts/ 21 | sdist/ 22 | var/ 23 | wheels/ 24 | *.egg-info/ 25 | .installed.cfg 26 | *.egg 27 | 28 | # PyInstaller 29 | # Usually these files are written by a python script from a template 30 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 31 | *.manifest 32 | *.spec 33 | 34 | # Installer logs 35 | pip-log.txt 36 | pip-delete-this-directory.txt 37 | 38 | # Unit test / coverage reports 39 | htmlcov/ 40 | .tox/ 41 | .coverage 42 | .coverage.* 43 | .cache 44 | nosetests.xml 45 | coverage.xml 46 | *.cover 47 | .hypothesis/ 48 | 49 | # Translations 50 | *.mo 51 | *.pot 52 | 53 | # Django stuff: 54 | *.log 55 | local_settings.py 56 | 57 | # Flask stuff: 58 | instance/ 59 | .webassets-cache 60 | 61 | # Scrapy stuff: 62 | .scrapy 63 | 64 | # Sphinx documentation 65 | docs/_build/ 66 | 67 | # PyBuilder 68 | target/ 69 | 70 | # Jupyter Notebook 71 | .ipynb_checkpoints 72 | 73 | # pyenv 74 | .python-version 75 | 76 | # celery beat schedule file 77 | celerybeat-schedule 78 | 79 | # SageMath parsed files 80 | *.sage.py 81 | 82 | # dotenv 83 | .env 84 | 85 | # virtualenv 86 | .venv 87 | venv/ 88 | ENV/ 89 | 90 | # Spyder project settings 91 | .spyderproject 92 | .spyproject 93 | 94 | # Rope project settings 95 | .ropeproject 96 | 97 | # mkdocs documentation 98 | /site 99 | 100 | # mypy 101 | .mypy_cache/ 102 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM alpine 2 | # load any public updates from Alpine packages 3 | RUN apk update 4 | # upgrade any existing packages that have been updated 5 | RUN apk upgrade 6 | # add/install python3 and related libraries 7 | # https://pkgs.alpinelinux.org/package/edge/main/x86/python3 8 | RUN apk add python3 9 | # make a directory for our application 10 | RUN mkdir -p /opt/app 11 | # add our application files 12 | ADD celery_conf.py /opt/app/celery_conf.py 13 | ADD submit_tasks.py /opt/app/submit_tasks.py 14 | # add the wrapper scripts for the primary process and probes 15 | ADD run.sh /opt/app/run.sh 16 | ADD celery_status.sh /opt/app/celery_status.sh 17 | # move requirements file into the container 18 | ADD requirements.txt /opt/app/requirements.txt 19 | # install the library dependencies for this application 20 | RUN pip3 install -r /opt/app/requirements.txt 21 | # set the default directory for commands to be /opt/app 22 | WORKDIR /opt/app 23 | CMD ["/bin/sh", "-c","/opt/app/run.sh"] 24 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # kfd-celery 2 | 3 | example celery worker and deployment specs for Kubernetes for Developers 4 | 5 | # Experimenting with the base image 6 | 7 | To experiment within this image using Kubernetes: 8 | 9 | kubectl run -i --tty \ 10 | --image quay.io/kubernetes-for-developers/celery-worker:0.4.0 \ 11 | --restart=Never --image-pull-policy=Always --rm testing /bin/sh 12 | 13 | ## to rebuild all the container images 14 | 15 | (this may need to be done to resolve any underlying image issues, such 16 | as security updates or vulnerabilities found and resolved in Alpine) 17 | 18 | The container images associated with this repo are available for review at 19 | https://quay.io/repository/kubernetes-for-developers/celery-worker?tab=tags 20 | 21 | git checkout 0.4.0 22 | docker build -t quay.io/kubernetes-for-developers/celery-worker:0.4.0 . 23 | #git checkout master 24 | docker build -t quay.io/kubernetes-for-developers/celery-worker:latest . 25 | docker push quay.io/kubernetes-for-developers/celery-worker 26 | 27 | _Note_: 28 | 29 | you will need to have previously invoked "docker login quay.io" to connect to 30 | quay to send it images... 31 | 32 | -------------------------------------------------------------------------------- /celery_conf.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | 3 | import os 4 | from celery import Celery 5 | from celery.utils.log import get_task_logger 6 | logger = get_task_logger(__name__) 7 | 8 | # set username and password for broker, with overrides from environment variables 9 | rabbitmq_user = os.environ.get('RABBITMQ_USERNAME','user') 10 | rabbitmq_password = os.environ.get('RABBITMQ_PASSWORD','bitnami') 11 | rabbitmq_vhost = os.environ.get('RABBITMQ_VHOST','/') 12 | 13 | # Get Kubernetes-provided address of the broker service 14 | broker_service_host = os.environ.get('MESSAGE_QUEUE_SERVICE_HOST','message-queue') 15 | # could also use DNS name: 'message-queue'|'message-queue.default.svc.cluster.local' 16 | # for our default 17 | 18 | broker_url = 'amqp://%s:%s@%s/%s' % (rabbitmq_user, 19 | rabbitmq_password, broker_service_host, rabbitmq_vhost) 20 | app = Celery('tasks', broker=broker_url, backend='amqp') 21 | 22 | @app.task 23 | def add(x, y): 24 | logger.info('Adding {0} + {1}'.format(x, y)) 25 | return x + y 26 | 27 | @app.task(bind=True) 28 | def dump_context(self, x, y): 29 | logger.info('Executing task id {0.id}, args: {0.args!r} kwargs: {0.kwargs!r}'.format( 30 | self.request)) 31 | -------------------------------------------------------------------------------- /celery_status.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | # make sure we exit this wrapper script with a failure if any of the commands 4 | # we invoke fail to return properly 5 | set -e 6 | 7 | # make sure we're in the correct local directory for celery to 8 | # module load celery_conf within python... 9 | cd /opt/app 10 | 11 | # request status of celery 12 | celery -A celery_conf status 13 | -------------------------------------------------------------------------------- /deploy/celery-worker.yaml: -------------------------------------------------------------------------------- 1 | --- 2 | apiVersion: apps/v1beta1 3 | kind: Deployment 4 | metadata: 5 | name: celery-worker 6 | spec: 7 | replicas: 1 8 | template: 9 | metadata: 10 | labels: 11 | app: celery 12 | tier: async 13 | spec: 14 | containers: 15 | - name: celery-worker 16 | image: quay.io/kubernetes-for-developers/celery-worker:0.4.0 17 | imagePullPolicy: Always 18 | envFrom: 19 | - configMapRef: 20 | name: bitnami-rabbitmq-config 21 | livenessProbe: 22 | exec: 23 | command: 24 | - "/opt/app/celery_status.sh" 25 | initialDelaySeconds: 30 26 | timeoutSeconds: 5 27 | failureThreshold: 6 28 | readinessProbe: 29 | exec: 30 | command: 31 | - "/opt/app/celery_status.sh" 32 | initialDelaySeconds: 5 33 | timeoutSeconds: 3 34 | initContainers: 35 | - name: init-celery-broker 36 | image: busybox 37 | command: ['sh', '-c', 'until nslookup message-queue; do echo waiting for message-queue to be available; sleep 2; done;'] 38 | 39 | -------------------------------------------------------------------------------- /deploy/queue-config.yaml: -------------------------------------------------------------------------------- 1 | --- 2 | apiVersion: v1 3 | kind: ConfigMap 4 | metadata: 5 | name: bitnami-rabbitmq-config 6 | data: 7 | RABBITMQ_USERNAME: "user" 8 | RABBITMQ_PASSWORD: "bitnami" 9 | RABBITMQ_VHOST: "/" 10 | RABBITMQ_NODE_PORT_NUMBER: "5672" 11 | RABBITMQ_MANAGER_PORT_NUMBER: "15672" 12 | WORKER_DEBUG_LEVEL: "info" 13 | -------------------------------------------------------------------------------- /deploy/rabbitmq.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # EXPORT SERVICE INTERFACE 3 | kind: Service 4 | apiVersion: v1 5 | metadata: 6 | name: message-queue 7 | labels: 8 | app: rabbitmq 9 | role: master 10 | tier: queue 11 | spec: 12 | ports: 13 | - port: 5672 14 | targetPort: 5672 15 | selector: 16 | app: rabbitmq 17 | role: master 18 | tier: queue 19 | --- 20 | apiVersion: v1 21 | kind: PersistentVolumeClaim 22 | metadata: 23 | name: rabbitmq-pv-claim 24 | labels: 25 | app: rabbitmq 26 | spec: 27 | accessModes: 28 | - ReadWriteOnce 29 | resources: 30 | requests: 31 | storage: 1Gi 32 | --- 33 | apiVersion: apps/v1beta1 34 | kind: Deployment 35 | metadata: 36 | name: rabbitmq 37 | spec: 38 | replicas: 1 39 | template: 40 | metadata: 41 | labels: 42 | app: rabbitmq 43 | role: master 44 | tier: queue 45 | spec: 46 | containers: 47 | - name: rabbitmq 48 | image: bitnami/rabbitmq:3.7 49 | envFrom: 50 | - configMapRef: 51 | name: bitnami-rabbitmq-config 52 | ports: 53 | - name: queue 54 | containerPort: 5672 55 | - name: queue-mgmt 56 | containerPort: 15672 57 | livenessProbe: 58 | exec: 59 | command: 60 | - rabbitmqctl 61 | - status 62 | initialDelaySeconds: 120 63 | timeoutSeconds: 5 64 | failureThreshold: 6 65 | readinessProbe: 66 | exec: 67 | command: 68 | - rabbitmqctl 69 | - status 70 | initialDelaySeconds: 10 71 | timeoutSeconds: 3 72 | periodSeconds: 5 73 | volumeMounts: 74 | - name: rabbitmq-storage 75 | mountPath: /bitnami 76 | volumes: 77 | - name: rabbitmq-storage 78 | persistentVolumeClaim: 79 | claimName: rabbitmq-pv-claim 80 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | celery 2 | -------------------------------------------------------------------------------- /run.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | # echo all the commands invoked within this shell to STDOUT 4 | # so we can see what is being run in the logs 5 | set -x 6 | 7 | # make sure we exit this wrapper script with a failure if any of the commands 8 | # we invoke fail to return properly 9 | set -e 10 | 11 | # apply a default debug level of info if 12 | # not overridden in the environment variables 13 | DEBUG_LEVEL=${WORKER_DEBUG_LEVEL:-info} 14 | 15 | # make sure we're in the correct local directory for celery to 16 | # module load celery_conf within python... 17 | cd /opt/app 18 | 19 | # initiate the celery worker 20 | /usr/bin/celery -A celery_conf worker -l ${DEBUG_LEVEL} 21 | -------------------------------------------------------------------------------- /submit_tasks.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | 3 | import random 4 | import syslog 5 | import time 6 | 7 | from celery_conf import add 8 | from celery_conf import dump_context 9 | 10 | while True: 11 | x = random.randint(1, 10) 12 | y = random.randint(1, 10) 13 | res = add.delay(x, y) 14 | dump_context.apply_async(args=[x, y]) 15 | time.sleep(5) 16 | if res.ready(): 17 | res.get() --------------------------------------------------------------------------------