django-cloudprojects 0.3.0

Cloud Projects for Django

A pluggable Django web application for onboarding and managing applications and microservices on cloud platforms, the DevOps (DevSecOps) way.

Installation

The easiest way to install django-cloudprojects is with pip:

pip install django-cloudprojects

SAML support is available as an installation option:

pip install django-cloudprojects[saml]

Note that SAML support requires additional libraries installed on your target system, e.g. for Debian/Ubuntu- and RedHat/CentOS-based systems:

sudo apt-get install libxml2-dev libxmlsec1-dev libxmlsec1-openssl

sudo yum install libxml2-devel xmlsec1-devel xmlsec1-openssl-devel libtool-ltdl-devel

Basic Usage

1. In your Django project settings, add cloudprojects and its dependencies to INSTALLED_APPS, optionally omitting the authentication providers you don’t intend to use, add the required authentication backends for Allauth and the Django Admin, and make sure SITE_ID is defined, e.g.

INSTALLED_APPS = [
    'django.contrib.auth',
    'django.contrib.messages',
    'django.contrib.sites',
    ...
    # 'django_saml',
    'allauth',
    'allauth.account',
    'allauth.socialaccount',
    # 'allauth.socialaccount.providers.bitbucket_oauth2',
    # 'allauth.socialaccount.providers.github',
    'allauth.socialaccount.providers.gitlab',
    'cloudprojects',
]

AUTHENTICATION_BACKENDS = [
    'django.contrib.auth.backends.ModelBackend',
    'django_saml.backends.SamlUserBackend',
    'allauth.account.auth_backends.AuthenticationBackend',
]

SITE_ID = 1

2. Add cloudprojects to your project’s urls module, e.g.

urlpatterns = [
    ...
    path('', include('cloudprojects.urls')),
]

3. In your Django project settings, configure the authentication providers as described in the Allauth documentation, e.g.

SOCIALACCOUNT_PROVIDERS = {
    'github': {
        'GITHUB_URL': 'https://github.enterprise.local',
        'SCOPE': ['api'],
    },
    'gitlab': {
        'GITLAB_URL': 'https://gitlab.selfhosted.local',
        'SCOPE': ['api'],
    },
}

4. Register the authentication apps with your VCS services as described in the Allauth documentation:

   • Bitbucket provider

   • GitHub provider

   • GitLab provider

   We recommend writing a management command to automatically configure those values during deployment. See our test project for a suggestion on how an implementation may look like.

5. If you intend to use SAML you need to add all required settings to your project’s Django settings, as described in the python3-saml-django docs.

Development

You may use the included test project for developing interactively, e.g.

pip install .[saml]
pip install pip-tools tox
pip-compile  # generates requirements.txt

Set DEBUG = True in Django settings to persist changes in a local database, e.g.

export DJANGO_DEBUG=true

tests/testproject/manage.py migrate
tests/testproject/manage.py runserver

Run the tests using Tox, e.g.

tox -lv
tox -e flake8,py39-django40
tox -e clean