Руководство для разработчиков по запуску приложений Django на Heroku

Heroku, компания платформы как услуги (PAAS), очень популярная в сообществе Ruby on Rails, теперь начала открывать свою платформу для языков помимо Ruby. Теперь они предлагают поддержку Python, Java, Clojure, Node.js и Scala в своем новом стеке Cedar. Стек Cedar от Heroku все еще находится в бета-версии, но это не должно помешать вам опробовать его, и это именно то, что я собираюсь сделать.

6 месяцев назад я написал серию постов в блоге, в которых рассказывалось обо всех новых интересных хостингах django, которые появлялись. Моя цель состояла в том, чтобы посмотреть на них всех и сравнить их, чтобы узнать, что они могут предложить, и посмотреть, смогу ли я использовать их в своих будущих проектах. Я собираюсь проверить Heroku, используя тот же процесс, который я использовал для проверки других сервисов, чтобы я мог сравнить яблоки с яблоками.

Для тех из вас, кто не знаком с моими другими постами в блоге, не стесняйтесь проверять их сейчас ep.io , apphosted.com , gondor.io , dotcloud.com , DjangoZoom.com , обзор Django для хостинга .

Для тех из вас, кто ленив, я подведу итоги довольно быстро. То, что я пытаюсь сделать, довольно просто, я подписываюсь на сервис и просто просматриваю доступную документацию, могу ли я запустить свое приложение для блога и что мне нужно было сделать, чтобы оно работало , Я опишу каждый шаг на этом пути в качестве полезного руководства для тех, кто может попытаться сделать то же самое со своим приложением. Если я столкнусь с ошибкой, я сообщу вам, что это была за ошибка и как я ее исправил, так что если вы получите ту же ошибку, надеюсь, что то, что я сделал для решения моей проблемы, также исправит вашу.

Heroku Django Документация

Прежде чем вы начнете использовать любую новую платформу, вы должны уделить время чтению документации. Я знаю, это не похоже на веселье, но поверьте мне, это избавит вас от боли и разочарования в дальнейшем. Вот несколько ссылок, которые я нашел полезными.

• Краткое руководство : http://devcenter.heroku.com/articles/quickstart
• Статьи на Python : http://devcenter.heroku.com/articles/python
• Статья Джанго : http://devcenter.heroku.com/articles/django
• Центр разработки : http://devcenter.heroku.com/

Авторизуйтесь в heroku из командной строки клиента

Зайдя в клиент, мы попытаемся найти ваш ключ ssh и загрузить его на сайт heroku для последующей загрузки кода. Если у вас нет ключа, он предложит создать его. Если у вас есть более одного, он спросит вас, какой из них вы хотите использовать.

Пример ключа не найден

$ heroku login
Enter your Heroku credentials.
Email: [email protected]:
Could not find an existing public key.
Would you like to generate one? [Yn]
Generating new SSH public key.
Uploading ssh public key /Users/adam/.ssh/id_rsa.pub

Найдено более одного ключевого примера

$ heroku login
Enter your Heroku credentials.
Email: <my email>
Password:
Found the following SSH public keys:
1) apphosted.key.pub
2) id_rsa.pub
Which would you like to use with your Heroku account? 2
Uploading ssh public key /Users/ken/.ssh/id_rsa.pub

Готовим ваше приложение Django

Теперь, когда у вас есть учетная запись и установленный клиент, вы готовы начать работу. Если вы начинаете с нуля, я рекомендую выполнить действия, описанные в этом руководстве. http://devcenter.heroku.com/articles/django . Если вы похожи на меня и у вас уже есть приложение, которое вы хотите установить на Heroku, продолжайте читать.

Поскольку у меня уже есть проект, я собираюсь рассказать вам, что мне нужно было сделать, чтобы мое приложение для блога было запущено и запущено на heroku. Я следовал инструкциям из руководства по героку и пошел оттуда. Heroku зависит от git, поэтому я использую копию моего блогового приложения, размещенного на github: https://github.com/kencochrane/kencochrane_blog_heroku

$ cd /Users/ken/projects/github

$ git clone https://[email protected]/kencochrane/kencochrane_blog_heroku.git kencochrane_heroku
$ cd kencochrane_heroku

# making a new virtual environment using virtualenvwrapper.
$ mkvirtualenv --no-site-packages --distribute kencochrane_heroku

Он должен автоматически активировать среду для вас. Если это не так, запустите эту команду.

$ workon kencochrane_heroku

Теперь, когда у меня есть virtualenv, мне нужно установить свои требования с помощью pip.

$ pip install -r requirements.txt

Создание приложения django на героку

Создать приложение на heroku очень просто, нужно просто запустить следующую команду.

$ heroku create --stack cedar
Creating some-name-4741... done, stack is cedar
http://some-name-4741.herokuapp.com/ | [email protected]:some-name-4741.git
Git remote heroku added

Развертывание приложения Django в Heroku

Когда вы будете готовы, вы можете развернуть приложение django в Heroku.

$ git push heroku master

Если все прошло хорошо, это должно выглядеть примерно так.

$ git push heroku master
Counting objects: 209, done.
Delta compression using up to 4 threads.
Compressing objects: 100% (176/176), done.
Writing objects: 100% (209/209), 271.89 KiB, done.
Total 209 (delta 28), reused 192 (delta 23)

-----> Heroku receiving push
-----> Python/Django app detected
-----> Preparing virtualenv version 1.6.4
       New python executable in ./bin/python
       Installing setuptools............done.
       Installing pip...............done.
-----> Django settings injection
       Injecting code into blog/settings.py to read from DATABASE_URL

<removed a lot of output that doesn't need to be shown>

       Successfully installed South django-activitysync django-debug-toolbar django-disqus django-memcache-status django-tagging django-xmlrpc feedparser httplib2 oauth2 python-memcached python-twitter simplejson yolk docutils Pygments psycopg2 Django
       Cleaning up...
-----> Discovering process types
       Procfile declares types         -> (none)
       Default types for Python/Django -> web
-----> Compiled slug size is 10.3MB
-----> Launching... done, v5
       http://some-name-4741.herokuapp.com deployed to Heroku

Развертывание приложения на Heroku не удалось, что теперь?

В первый раз, когда вы добьетесь мастерства, вы получите нечто подобное.

$ git push heroku master

The authenticity of host 'heroku.com (50.19.85.132)' can't be established.
RSA key fingerprint is 8b:48:5e:67:0e:c9:16:47:32:f2:87:0c:1f:c8:60:ad.
Are you sure you want to continue connecting (yes/no)? yes

Это нормально, просто введите «да», и вам никогда не будет предложено это снова.

Приложение Django должно находиться в подкаталоге пакета

Если ваш django-проект не настроен правильно, вы получите такую ​​ошибку.

$ git push heroku master
Counting objects: 199, done.
Delta compression using up to 4 threads.
Compressing objects: 100% (167/167), done.
Writing objects: 100% (199/199), 270.86 KiB, done.
Total 199 (delta 26), reused 192 (delta 23)


-----> Heroku receiving push
-----> Python app detected
 !     Django app must be in a package subdirectory
 !     Heroku push rejected, failed to compile Python app


To [email protected]:some-name-4741.git
 ! [remote rejected] master -> master (pre-receive hook declined)
error: failed to push some refs to '[email protected]:some-name-4741.git'

This failed, because django app must be in a package subdirectory.. So you need to change the way my django app is setup. Move all of the files under a django project directory except the .git directory and .gitignore and requirements.txt files. For an example of what this looks like, check out the project directory structure on my repo in github.

Heroku push rejected, no Cedar-supported app detected

Another error you can get is this one. «Heroku push rejected, no Cedar-supported app detected»

$ git push heroku master
Counting objects: 204, done.
Delta compression using up to 4 threads.
Compressing objects: 100% (171/171), done.
Writing objects: 100% (204/204), 271.34 KiB, done.
Total 204 (delta 27), reused 192 (delta 23)

-----> Heroku receiving push
 !     Heroku push rejected, no Cedar-supported app detected

To [email protected]:cold-summer-4741.git
 ! [remote rejected] master -> master (pre-receive hook declined)
error: failed to push some refs to '[email protected]:cold-summer-4741.git'

I had this error and I couldn’t figure it out. After searching through all of the heroku python docs (all 2 of them), I didn’t find anything, so I started doing some trial and error testing, and I finally figure out what was wrong. My django project directory was kencochrane_blog, and this had an underscore, and when I changed it to just kenblog (no more underscore), it worked. I couldn’t find anything anywhere that said you can’t use underscores for your django app name, so they might want to update their documentation, or possibly fix the bug. I’m not sure if this is by design or not, maybe someone can let me know.

Check Django application status on heroku

Now that you have pushed your application out onto Heroku how do you know if it is actually running? The Heroku client has a command called ps, which will tell you what your processes are doing.

$ heroku ps

Process       State               Command
------------  ------------------  ------------------------------
web.1         crashed for 2m      python kenblog/manage.py runserver 0...

My django application looks like it crashed. Most likely because I didn’t setup the database yet, lets look at the logs to see what is causing the problems to be sure.

Checking Django application logs on Heroku

The Heroku client has a nifty logs command that you can use to view the last chunk of logs for your application. It will combine all of your logs into one view, so that you don’t have to have more then one log process running. You can call it directly and get an output similar to the shell command ‘tail’ and you can all use the ‘—tail’ option to follow the logs.

$ heroku logs --tail
2011-11-27T18:40:00+00:00 heroku[api]: Deploy 5f194d2 by kencochrane@2011-11-27T18:40:00+00:00 heroku[api]: Release v7 created by kencochrane@
2011-11-27T18:40:00+00:00 heroku[web.1]: State changed from crashed to created
2011-11-27T18:40:00+00:00 heroku[web.1]: State changed from created to starting
2011-11-27T18:40:00+00:00 heroku[slugc]: Slug compilation finished
2011-11-27T18:40:03+00:00 heroku[web.1]: Starting process with command `python kenblog/manage.py runserver 0.0.0.0:12033 --noreload`
2011-11-27T18:40:04+00:00 app[web.1]: Unexpected error: (<type 'exceptions.NameError'>, NameError("name 'DATABASES' is not defined",), <traceback object at 0x1a7b128>)
2011-11-27T18:40:05+00:00 app[web.1]: There is no South database module 'south.db.None' for your database. Please either choose a supported database, check for SOUTH_DATABASE_ADAPTER[S] settings, or remove South from INSTALLED_APPS.
2011-11-27T18:40:06+00:00 heroku[web.1]: State changed from starting to crashed

Looks like it is an issue with the settings file. If you wanted to take a look at the settings file to see if we can find out what is wrong you can run the following command.

# (your path will be different)
$ heroku run cat kenblog/settings.py

<normal settings file stuff with the following added at the end.>

import os, sys, urlparse
urlparse.uses_netloc.append('postgres')
urlparse.uses_netloc.append('mysql')
try:
    if os.environ.has_key('DATABASE_URL'):
        url = urlparse.urlparse(os.environ['DATABASE_URL'])
        DATABASES['default'] = {
            'NAME':     url.path[1:],
            'USER':     url.username,
            'PASSWORD': url.password,
            'HOST':     url.hostname,
            'PORT':     url.port,
        }
        if url.scheme == 'postgres':
            DATABASES['default']['ENGINE'] = 'django.db.backends.postgresql_psycopg2'
        if url.scheme == 'mysql':
            DATABASES['default']['ENGINE'] = 'django.db.backends.mysql'
except:
    print "Unexpected error:", sys.exc_info()

This is odd, not sure why this is like this since I’m seeing the DATABASES variable above. Let’s check to see if the environment variables are there. (the output has been changed to protect the innocent, but you still get the picture). You can also use the command ‘heroku config’ if you just want to see your application configuration options.

$ heroku run env
Running env attached to terminal... up, run.6
DATABASE_URL=postgres://blah:[email protected]/morestuff
PORT=37265
HOME=/app
PYTHONUNBUFFERED=true
TERM=xterm
COLUMNS=153

PATH=bin:/usr/local/bin:/usr/bin:/bin
PWD=/app
SHARED_DATABASE_URL=postgres://blah:[email protected]/morestuff
LINES=32

This output looks good the DATABASE_URL env variable is there, so that is OK. Looking more closely at my settings.py file I didn’t have a DATABASES variable because the last time I used this project, the other hosting provider didn’t require that I have one. So I have added a blank DATABASES variable, and that seems to have fixed my issue. Heroku, should make the error message a little nicer, add more notes to their documentation, or even better make their code handle the case when there is no DATABASES variable in the settings file. I have submitted a patch to fix this, so hopefully that will get rolled out in the near future. (https://github.com/heroku/heroku-buildpack-python/pull/8)

Now if we redeploy the app and look at the logs, they look much better.

$ heroku logs
2011-11-27T18:59:25+00:00 heroku[api]: Deploy 96be00f by kencochrane@
2011-11-27T18:59:25+00:00 heroku[api]: Release v8 created by kencochrane@
2011-11-27T18:59:25+00:00 heroku[web.1]: State changed from crashed to created
2011-11-27T18:59:26+00:00 heroku[web.1]: State changed from created to starting
2011-11-27T18:59:26+00:00 heroku[slugc]: Slug compilation finished
2011-11-27T18:59:31+00:00 app[web.1]: 0 errors found
2011-11-27T18:59:31+00:00 heroku[web.1]: State changed from starting to up

Running django management commands on Heroku

Running django management commands are easy you just need to run the following command and replace <command> with the management command you want to run. There are a few examples below.

$ heroku run python kenblog/manage.py <command>

Running django shell on Heroku

If you need to use the interactive python shell with django, you still can, you just need to run the following command.

$ heroku run python kenblog/manage.py shell

Syncing Django Database on Heroku

Now that our application is starting like it should let’s sync the db.

$ heroku run python kenblog/manage.py syncdb

Running Django South Migrations on Heroku

$ heroku run python kenblog/manage.py migrate

Now lets look at our processes now

$ heroku ps
Process       State               Command
------------  ------------------  ------------------------------
run.5         complete for 21m    cat kenblog/settings.py
run.6         complete for 18m    env
run.7         complete for 1m     python kenblog/manage.py syncdb
run.8         complete for 1m     python kenblog/manage.py migrate
web.1         up for 4m           python kenblog/manage.py runserver..

Things are looking better, we are up, and it also shows our old commands that we ran.

if you need to work with the processes you have the following options.

ps:dynos [QTY]                 # scale to QTY web processes
ps:restart [PROCESS]           # restart an app process
ps:scale PROCESS1=AMOUNT1 ...  # scale processes by the given amount
ps:stop PROCESS                # stop an app process
ps:workers [QTY]               # scale to QTY background processes

Opening your django application in a web browser

If you run this command it will open a web browser and hopefully your site is running as it should

$ heroku open

Running django and gunicorn on heroku

По умолчанию heroku развертывается с помощью встроенного сервера запуска django, который не рекомендуется для производства. Если вы играете вокруг, это нормально, но как только вы это пройдете, первое, что вы должны сделать, — это переключиться на что-то лучшее, например, guincorn. Переключение происходит быстро и безболезненно, и вы будете рады, что сделали это.

1. Добавьте gunicorn == 0.13.4 в файл требований.
2. создайте новый файл с именем Procfile на том же уровне, что и ваш файл needs.txt, в котором содержится следующее.

web: python kenblog/manage.py run_gunicorn -b "0.0.0.0:$PORT" -w 3

Добавьте gunicorn в установленные_apps в settings.py

затем

$ git commit -am "use gunicorn"
$ git push heroku master

Просматривая ваши логи, вы увидите, что все работает

$ heroku logs
2011-11-27T21:06:24+00:00 heroku[slugc]: Slug compilation started
2011-11-27T21:06:32+00:00 heroku[api]: Deploy 7b2eec1 by kencochrane@
2011-11-27T21:06:32+00:00 heroku[api]: Release v8 created by kencochrane@
2011-11-27T21:06:32+00:00 heroku[web.1]: State changed from created to starting
2011-11-27T21:06:35+00:00 heroku[web.1]: Starting process with command `python kenblog/manage.py run_gunicorn -b "0.0.0.0:4075" -w 3`
2011-11-27T21:06:36+00:00 app[web.1]: Validating models...
2011-11-27T21:06:37+00:00 heroku[web.1]: State changed from starting to up

Setting up Django Caching on Herku

To use memcache on Heroku, I went to the add-on page and installed the free memcache addon. Once I did this I can run the heroku config command to find out my config settings. I then use that information in my django settings file so that I can have access to caching in my app.

$ heroku config
...
MEMCACHE_PASSWORD    => xxxxxxxxxxxx
MEMCACHE_SERVERS     => instance.hostname.net
MEMCACHE_USERNAME    => xxxxxxxxxxxx
...

They also offer redis if you prefer that.

Source: http://kencochrane.net/blog/2011/11/developers-guide-for-running-django-apps-on-heroku/