Deployment on Cloud Foundry
===========================

.. index:: cloud foundry

Prerequisites
-------------

* Postgres service provisioned
* Redis service provisioned 
* Object storage provisioned, and bucket created
* PlantUML server provisioned
* SMTP Service provisioned 
* GitLab Server (for OAuth2 authentication), GitLab project created (for synchronization)

Prepare manifest.yml
--------------------
Prepare manifest.yaml file in the root folder and adjust environment variables according to your environment.
Refer to ``manifest.yaml.example`` file for the format.

Push the app
------------

The Procfile indicates that there are 4 processes in the app. Please refer to `Pushing an App with Multiple Processes`_ for a better understanding. After pushing the app, you need to scale up the processes other than the web process.

.. _`Pushing an App with Multiple Processes`: https://docs.cloudfoundry.org/devguide/multiple-processes.html

Create super user 
-----------------
::

    cf enable-ssh architecture-tool
    cf ssh architecture-tool
    /tmp/lifecycle/shell app
    python manage.py createsuperuser


Gitlab Authentication
---------------------

Add application in Gitlab as per `GitLab as OAuth2 authentication service provider`_.

Perform steps as described in `django-allauth Post-Installation`_.

.. _`GitLab as OAuth2 authentication service provider`: https://docs.gitlab.com/ee/integration/oauth_provider.html
.. _`django-allauth Post-Installation`: https://django-allauth.readthedocs.io/en/latest/installation.html#post-installation