summaryrefslogtreecommitdiff
path: root/doc/ci/examples/test-and-deploy-python-application-to-heroku.md
diff options
context:
space:
mode:
authorKamil Trzciński <ayufan@ayufan.eu>2015-09-16 11:57:40 +0000
committerKamil Trzciński <ayufan@ayufan.eu>2015-09-16 11:57:40 +0000
commitcccd269da3f5d82c5d14289980d9b52c9cad08db (patch)
tree2947658dfff44a3873f7d350f0353dbdb7b9b541 /doc/ci/examples/test-and-deploy-python-application-to-heroku.md
parent7d59ba00b9aa1a8be28f1b7ccaa1c628be90aabb (diff)
parentac8d2eb065e9522679d4eae4649c6815daa5460c (diff)
downloadgitlab-ce-cccd269da3f5d82c5d14289980d9b52c9cad08db.tar.gz
Merge branch 'ci-and-ce-sitting-in-a-tree-k-i-s-s-i-n-g' into 'master'
Merge CI into CE First step of #2164. - [x] Merge latest CE master - [x] Make application start - [x] Re-use gitlab sessions (remove CI oauth part) - [x] Get rid of gitlab_ci.yml config - [x] Make tests start - [x] Make most CI features works - [x] Make tests green - [x] Write migration documentation - [x] Add CI builds to CE backup See merge request !1204
Diffstat (limited to 'doc/ci/examples/test-and-deploy-python-application-to-heroku.md')
-rw-r--r--doc/ci/examples/test-and-deploy-python-application-to-heroku.md72
1 files changed, 72 insertions, 0 deletions
diff --git a/doc/ci/examples/test-and-deploy-python-application-to-heroku.md b/doc/ci/examples/test-and-deploy-python-application-to-heroku.md
new file mode 100644
index 00000000000..036b03dd6b9
--- /dev/null
+++ b/doc/ci/examples/test-and-deploy-python-application-to-heroku.md
@@ -0,0 +1,72 @@
+## Test and Deploy a python application
+This example will guide you how to run tests in your Python application and deploy it automatically as Heroku application.
+
+You can checkout the example [source](https://gitlab.com/ayufan/python-getting-started) and check [CI status](https://ci.gitlab.com/projects/4080).
+
+### Configure project
+This is what the `.gitlab-ci.yml` file looks like for this project:
+```yaml
+test:
+ script:
+ # this configures django application to use attached postgres database that is run on `postgres` host
+ - export DATABASE_URL=postgres://postgres:@postgres:5432/python-test-app
+ - apt-get update -qy
+ - apt-get install -y python-dev python-pip
+ - pip install -r requirements.txt
+ - python manage.py test
+
+staging:
+ type: deploy
+ script:
+ - apt-get update -qy
+ - apt-get install -y ruby-dev
+ - gem install dpl
+ - dpl --provider=heroku --app=gitlab-ci-python-test-staging --api-key=$HEROKU_STAGING_API_KEY
+ only:
+ - master
+
+production:
+ type: deploy
+ script:
+ - apt-get update -qy
+ - apt-get install -y ruby-dev
+ - gem install dpl
+ - dpl --provider=heroku --app=gitlab-ci-python-test-prod --api-key=$HEROKU_PRODUCTION_API_KEY
+ only:
+ - tags
+```
+
+This project has three jobs:
+1. `test` - used to test rails application,
+2. `staging` - used to automatically deploy staging environment every push to `master` branch
+3. `production` - used to automatically deploy production environmnet for every created tag
+
+### Store API keys
+You'll need to create two variables in `Project > Variables`:
+1. `HEROKU_STAGING_API_KEY` - Heroku API key used to deploy staging app,
+2. `HEROKU_PRODUCTION_API_KEY` - Heroku API key used to deploy production app.
+
+Find your Heroku API key in [Manage Account](https://dashboard.heroku.com/account).
+
+### Create Heroku application
+For each of your environments, you'll need to create a new Heroku application.
+You can do this through the [Dashboard](https://dashboard.heroku.com/).
+
+### Create runner
+First install [Docker Engine](https://docs.docker.com/installation/).
+To build this project you also need to have [GitLab Runner](https://about.gitlab.com/gitlab-ci/#gitlab-runner).
+You can use public runners available on `gitlab.com/ci`, but you can register your own:
+```
+gitlab-ci-multi-runner register \
+ --non-interactive \
+ --url "https://gitlab.com/ci/" \
+ --registration-token "PROJECT_REGISTRATION_TOKEN" \
+ --description "python-3.2" \
+ --executor "docker" \
+ --docker-image python:3.2 \
+ --docker-postgres latest
+```
+
+With the command above, you create a runner that uses [python:3.2](https://registry.hub.docker.com/u/library/python/) image and uses [postgres](https://registry.hub.docker.com/u/library/postgres/) database.
+
+To access PostgreSQL database you need to connect to `host: postgres` as user `postgres` without password.