django-cloudprojects 0.3.0

适用于Django的云项目

这是一个可插入的Django网络应用程序，用于以DevOps（DevSecOps）的方式在云平台上注册和管理应用程序和微服务。

安装

安装 django-cloudprojects 最简单的方法是使用 pip

pip install django-cloudprojects

作为安装选项，支持 SAML

pip install django-cloudprojects[saml]

请注意，SAML 支持需要在您的目标系统上安装额外的库，例如 Debian/Ubuntu 和 RedHat/CentOS 基于的系统

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

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

基本用法

1. 在您的 Django 项目设置中，将 cloudprojects 和其依赖项添加到 INSTALLED_APPS，可选地省略您不打算使用的身份验证提供者，添加 Allauth 和 Django Admin 所需的身份验证后端，并确保 SITE_ID 已定义，例如：

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. 将 cloudprojects 添加到您的项目的 urls 模块中，例如：

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

3. 在您的 Django 项目设置中，根据 Allauth 文档 中所述配置身份验证提供者，例如：

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

4. 根据 Allauth 文档中所述，将身份验证应用程序注册到您的 VCS 服务

   • Bitbucket 提供商

   • GitHub 提供商

   • GitLab 提供商

   我们建议编写一个管理命令，在部署期间自动配置这些值。请参阅我们的 测试项目 了解实现可能的样子。

5. 如果您打算使用 SAML，则需要将所有必需的设置添加到您的项目 Django 设置中，如 python3-saml-django 文档 中所述。

开发

您可以使用包含的 测试项目 进行交互式开发，例如。

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

在 Django 设置中将 DEBUG = True 设置为在本地数据库中持久化更改，例如。

export DJANGO_DEBUG=true

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

使用 Tox 运行测试，例如。

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