diff --git a/apps/common/README.md b/apps/common/README.md new file mode 100644 index 000000000..67d9d5a95 --- /dev/null +++ b/apps/common/README.md @@ -0,0 +1,55 @@ +## Celery usage + +---- + +Jumpserver use celery to run task async. Using redis as the broker, so +you should run a redis instance + +#### Run redis + + $ yum -y install redis + + or + + $ docker run -name jumpserver-redis -d -p 6379:6379 redis redis-server + + +#### Write tasks in app_name/tasks.py + +ops/tasks.py + +``` +from __future__ import absolute_import + +import time +from celery import shared_task + + +@shared_task +def longtime_add(x, y): + print 'long time task begins' + # sleep 5 seconds + time.sleep(5) + print 'long time task finished' + return x + y +``` + +#### Run celery in development + +``` +$ cd apps +$ celery -A common worker -l info +``` + +#### Test using task + +``` +$ ./manage.py shell +>>> from ops.tasks import longtime_add +>>> res = longtime_add.delay(1, 2) +>>> res.get() +``` + + + + diff --git a/apps/common/README.rst b/apps/common/README.rst deleted file mode 100644 index 18a0db578..000000000 --- a/apps/common/README.rst +++ /dev/null @@ -1,55 +0,0 @@ -## Celery - -Jumpserver use celery to run task async. Using redis as the broker, so -you should run a redis instance - -* Run redis -``` -# yum -y install redis -or -# docker run -name jumpserver-redis -d -p 6379:6379 redis redis-server -``` - -* Write tasks in app_name/tasks.py - -``` -ops/tasks.py - -from __future__ import absolute_import - -import time -from celery import shared_task - - -@shared_task -def longtime_add(x, y): - print 'long time task begins' - # sleep 5 seconds - time.sleep(5) - print 'long time task finished' - return x + y -``` - -* Run celery in development -``` -# cd apps -# celery -A common worker -l info -``` - -* Test using task -``` -# ./manage.py shell ->>> from ops.tasks import longtime_add ->>> res = longtime_add.delay(1, 2) ->>> res.get() -``` - -### celery usage of jumpserver -Jumpserver use celery to run task async. Using redis as the broker, so you should run a redis instance, Let’s start it - -**Run redis server ** -'' $ yum -y install redis -'' or -'' $ docker run -name jumpserver-redis -d -p 6379:6379 redis redis-server - -** \ No newline at end of file