settings.py

# -*- coding: utf-8 -*-
#
# OpenCraft -- tools to aid developing and hosting free software projects
# Copyright (C) 2015-2018 OpenCraft <contact@opencraft.com>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as
# published by the Free Software Foundation, either version 3 of the
# License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
#
"""
Django settings for opencraft project.

To configure your instance, set the configuration variables,
using the variable name passed to `env()` below
"""

# Imports #####################################################################

import logging
import os
from urllib.parse import urlparse

import environ


# Functions ###################################################################

env = environ.Env()
root = environ.Path(os.path.dirname(__file__), os.pardir)

SITE_ROOT = root()


# Security ####################################################################

# Keep the secret key used in production secret
SECRET_KEY = env('SECRET_KEY')

ALLOWED_HOSTS = env.json('ALLOWED_HOSTS', default=[])

DEBUG = env.bool('DEBUG', default=False)

ENABLE_DEBUG_TOOLBAR = env.bool('ENABLE_DEBUG_TOOLBAR', default=False)


# Consul #########################################################################
CONSUL_ENABLED = env.bool('CONSUL_ENABLED', default=False)
OCIM_ID = env('OCIM_ID', default='ocim')
CONSUL_PREFIX = env('CONSUL_PREFIX', default='{ocim}/instances/{instance}/')

# Auth ########################################################################

AUTHENTICATION_BACKENDS = (
    'registration.auth_backends.ModelBackend',
)

LOGIN_URL = 'registration:login'
LOGIN_REDIRECT_URL = 'index'


# Database ####################################################################

# Set via the environment variable `DATABASE_URL`
DATABASES = {
    'default': env.db(),
}


# Application definition ######################################################

LOCAL_APPS = (
    'api',
    'instance',
    'email_verification',
    'pr_watch',
    'userprofile',
    'registration',
    'reports',
    'backup_swift'
)

INSTALLED_APPS = (
    'grappelli',
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
    'django_extensions',
    'foundation',
    'compressor',
    'djng',
    'rest_framework',
    'huey.contrib.djhuey',
    'swampdragon',
    'simple_email_confirmation',
) + LOCAL_APPS

MIDDLEWARE = (
    'django.contrib.sessions.middleware.SessionMiddleware',
    'django.middleware.common.CommonMiddleware',
    'django.middleware.csrf.CsrfViewMiddleware',
    'django.contrib.auth.middleware.AuthenticationMiddleware',
    'django.contrib.messages.middleware.MessageMiddleware',
    'django.middleware.clickjacking.XFrameOptionsMiddleware',
    'django.middleware.security.SecurityMiddleware',
)

if DEBUG and ENABLE_DEBUG_TOOLBAR:
    INSTALLED_APPS += ('debug_toolbar',)
    MIDDLEWARE += ('debug_toolbar.middleware.DebugToolbarMiddleware',)
    # Enable in all pages
    DEBUG_TOOLBAR_CONFIG = {
        'SHOW_TOOLBAR_CALLBACK': lambda request: True,
    }


ROOT_URLCONF = 'opencraft.urls'

TEMPLATES = [
    {
        'BACKEND': 'django.template.backends.django.DjangoTemplates',
        'DIRS': [root(p, 'templates') for p in [''] + list(LOCAL_APPS)],
        'APP_DIRS': True,
        'OPTIONS': {
            'context_processors': [
                'django.template.context_processors.debug',
                'django.template.context_processors.request',
                'django.contrib.auth.context_processors.auth',
                'django.contrib.messages.context_processors.messages',
                'django.template.context_processors.request',
            ],
        },
    },
]

WSGI_APPLICATION = 'opencraft.wsgi.application'


# Internationalization ########################################################

# https://docs.djangoproject.com/en/1.8/topics/i18n/

LANGUAGE_CODE = 'en-us'
TIME_ZONE = 'UTC'
USE_I18N = True
USE_L10N = True
USE_TZ = True


# Static files (CSS, JavaScript, Images) ######################################

# https://docs.djangoproject.com/en/1.8/howto/static-files/

STATICFILES_FINDERS = (
    'django.contrib.staticfiles.finders.FileSystemFinder',
    'django.contrib.staticfiles.finders.AppDirectoriesFinder',
    # other finders..
    'compressor.finders.CompressorFinder',
)

STATICFILES_DIRS = (
    root('static'),
)

STATIC_ROOT = root('build/static')
STATIC_URL = '/static/'

COMPRESS_PRECOMPILERS = (
    ('text/x-scss', 'django_libsass.SassCompiler'),
)


# Test runner #################################################################

TEST_RUNNER = env('TEST_RUNNER', default='django.test.runner.DiscoverRunner')


# Django-extensions ###########################################################

SHELL_PLUS = "ipython"
RUNSERVERPLUS_SERVER_ADDRESS_PORT = env('RUNDEV_SERVER_ADDRESS_PORT', default='0.0.0.0:5000')


# Grappelli ###################################################################

GRAPPELLI_ADMIN_TITLE = 'OpenCraft'
GRAPPELLI_SWITCH_USER = True


# REST framework ##############################################################

REST_FRAMEWORK = {
    'DEFAULT_PERMISSION_CLASSES': [
        'instance.api.permissions.ApiInstanceManagerPermission',
    ],
}


# Redis cache & locking #######################################################

REDIS_LOCK_TIMEOUT = env('REDIS_LOCK_TIMEOUT', default=900)
REDIS_URL = env('REDIS_URL', default='redis://localhost:6379/')
REDIS_URL_OBJ = urlparse(REDIS_URL)

CACHES = {
    'default': {
        'BACKEND': 'django_redis.cache.RedisCache',
        'LOCATION': REDIS_URL,
        'OPTIONS': {
            'CLIENT_CLASS': 'django_redis.client.DefaultClient',
        }
    }
}


# Huey (redis task queue) #####################################################

HUEY = {
    'name': env('HUEY_QUEUE_NAME', default='opencraft'),
    'connection': {
        'host': REDIS_URL_OBJ.hostname,
        'port': REDIS_URL_OBJ.port,
        'password': REDIS_URL_OBJ.password,
    },
    'always_eager': env.bool('HUEY_ALWAYS_EAGER', default=False),

    # Options to pass into the consumer when running ``manage.py run_huey``
    'consumer': {'workers': 1, 'loglevel': logging.INFO},
}


# SwampDragon (websocket) #####################################################

SWAMP_DRAGON_REDIS_HOST = REDIS_URL_OBJ.hostname
SWAMP_DRAGON_REDIS_PORT = REDIS_URL_OBJ.port
SWAMP_DRAGON_CONNECTION = ('swampdragon.connections.sockjs_connection.DjangoSubscriberConnection', '/data')
DRAGON_SERVER_ADDRESS_PORT = env('DRAGON_SERVER_ADDRESS_PORT', default='0.0.0.0:2001')
DRAGON_URL = env('DRAGON_URL', default='http://localhost:2001/')


# OpenStack ###################################################################

OPENSTACK_USER = env('OPENSTACK_USER')
OPENSTACK_PASSWORD = env('OPENSTACK_PASSWORD')
OPENSTACK_TENANT = env('OPENSTACK_TENANT')
OPENSTACK_AUTH_URL = env('OPENSTACK_AUTH_URL')
OPENSTACK_REGION = env('OPENSTACK_REGION')

OPENSTACK_SANDBOX_FLAVOR = env.json('OPENSTACK_SANDBOX_FLAVOR', default={"ram": 4096, "disk": 40})
OPENSTACK_SANDBOX_BASE_IMAGE = env.json('OPENSTACK_SANDBOX_BASE_IMAGE', default={"name": "Ubuntu 16.04"})
OPENSTACK_SANDBOX_SSH_KEYNAME = env('OPENSTACK_SANDBOX_SSH_KEYNAME', default='opencraft')
OPENSTACK_SANDBOX_SSH_USERNAME = env('OPENSTACK_SANDBOX_SSH_USERNAME', default='ubuntu')
OPENSTACK_PRODUCTION_INSTANCE_FLAVOR = env.json(
    'OPENSTACK_PRODUCTION_INSTANCE_FLAVOR',
    default={"ram": 8192, "disk": 80}
)

# Separate credentials for Swift.  These credentials are currently passed on to each instance
# when Swift is enabled.

INSTANCE_STORAGE_TYPE = env('INSTANCE_STORAGE_TYPE', default='swift')  # Keeping the previous behaviour for SWIFT_ENABLE

# SWIFT_ENABLE = env.bool('SWIFT_ENABLE', default=True)  # Not used any longer
SWIFT_OPENSTACK_USER = env('SWIFT_OPENSTACK_USER', default=OPENSTACK_USER)
SWIFT_OPENSTACK_PASSWORD = env('SWIFT_OPENSTACK_PASSWORD', default=OPENSTACK_PASSWORD)
SWIFT_OPENSTACK_TENANT = env('SWIFT_OPENSTACK_TENANT', default=OPENSTACK_TENANT)
SWIFT_OPENSTACK_AUTH_URL = env('SWIFT_OPENSTACK_AUTH_URL', default=OPENSTACK_AUTH_URL)
SWIFT_OPENSTACK_REGION = env('SWIFT_OPENSTACK_REGION', default=OPENSTACK_REGION)

BACKUP_SWIFT_ENABLED = env.bool('BACKUP_SWIFT_ENABLED', default=False)

if BACKUP_SWIFT_ENABLED:

    BACKUP_SWIFT_TARGET = env('BACKUP_SWIFT_TARGET', default='/var/cache/swift-data-backup')
    BACKUP_SWIFT_TARSNAP_KEY_LOCATION = env(
        'BACKUP_SWIFT_TARSNAP_KEY_LOCATION', default='/var/www/opencraft/tarsnap.key')
    BACKUP_SWIFT_TARSNAP_CACHE_LOCATION = env('BACKUP_SWIFT_TARSNAP_CACHE_LOCATION', default='/var/cache/tarsnap')
    # Current date will be appended to the archive name:
    BACKUP_SWIFT_TARSNAP_KEY_ARCHIVE_NAME = env('BACKUP_SWIFT_TARSNAP_KEY_ARCHIVE_NAME', default='im-swift-backup')
    BACKUP_SWIFT_SNITCH = env('BACKUP_SWIFT_SNITCH', default=None)


# SWIFT for media files. This configuration is used by Ocim to store files
# uploaded in Ocim forms. It will not be copied to the deployed instance.
MEDIAFILES_SWIFT_ENABLE = env.bool('MEDIAFILES_SWIFT_ENABLE', default=False)
if MEDIAFILES_SWIFT_ENABLE:
    DEFAULT_FILE_STORAGE = 'swift.storage.SwiftStorage'
    SWIFT_AUTH_URL = env('MEDIAFILES_SWIFT_AUTH_URL')
    SWIFT_USERNAME = env('MEDIAFILES_SWIFT_USERNAME')
    SWIFT_TENANT_NAME = env('MEDIAFILES_SWIFT_TENANT_NAME')
    SWIFT_REGION_NAME = env('MEDIAFILES_SWIFT_REGION_NAME')
    SWIFT_KEY = env('MEDIAFILES_SWIFT_KEY')
    SWIFT_CONTAINER_NAME = env('MEDIAFILES_SWIFT_CONTAINER_NAME')


# RabbitMQ ####################################################################

DEFAULT_RABBITMQ_API_URL = env('DEFAULT_RABBITMQ_API_URL', default=None)

# Billing #####################################################################

# This rate is per user per day in euros
BILLING_RATE = env('BILLING_RATE', default=3)

# DNS (Gandi) #################################################################

# See https://www.gandi.net/admin/api_key
GANDI_API_KEY = env('GANDI_API_KEY')


# GitHub - Forks & organizations ##############################################

# The worker queue will watch for PRs from members of a given organization
# and automatically spinup new instances when new commits are pushed to the PRs

# Get it from https://github.com/settings/tokens
GITHUB_ACCESS_TOKEN = env('GITHUB_ACCESS_TOKEN')

# Default github repository to pull code from
DEFAULT_FORK = env('DEFAULT_FORK', default='edx/edx-platform')
DEFAULT_EDX_PLATFORM_REPO_URL = 'https://github.com/{}.git'.format(DEFAULT_FORK)

# Open edX Instance and App Server Settings  ##################################

# Time in seconds to wait before making a force termination for servers.
SHUTDOWN_TIMEOUT = env.int('SHUTDOWN_TIMEOUT', default=600)  # 10 minutes

# Instances will be created as subdomains of this domain by default
DEFAULT_INSTANCE_BASE_DOMAIN = env('DEFAULT_INSTANCE_BASE_DOMAIN')
DEFAULT_STUDIO_DOMAIN_PREFIX = env('DEFAULT_STUDIO_DOMAIN_PREFIX', default='studio-')
DEFAULT_LMS_PREVIEW_DOMAIN_PREFIX = env('DEFAULT_LMS_PREVIEW_DOMAIN_PREFIX', default='preview-')
DEFAULT_DISCOVERY_DOMAIN_PREFIX = env('DEFAULT_DISCOVERY_DOMAIN_PREFIX', default='discovery-')
DEFAULT_ECOMMERCE_DOMAIN_PREFIX = env('DEFAULT_ECOMMERCE_DOMAIN_PREFIX', default='ecommerce-')

# Fork and branch of the Open edX configuration repo used for sandboxes created for PRs.
DEFAULT_CONFIGURATION_REPO_URL = env(
    'DEFAULT_CONFIGURATION_REPO_URL', default='https://github.com/edx/configuration.git'
)

# Default release to use. Should be 'master' or a "named-release/treename.rc" tag, since
# it must be a valid refspec for edx-platform, forum, notifier, xqueue, and certs.
DEFAULT_OPENEDX_RELEASE = env('DEFAULT_OPENEDX_RELEASE', default='master')

# Default version (git branch/commit/tag) of the repo at DEFAULT_CONFIGURATION_REPO_URL to use
# for provisioning Open edX app servers.
DEFAULT_CONFIGURATION_VERSION = env('DEFAULT_CONFIGURATION_VERSION', default=DEFAULT_OPENEDX_RELEASE)

# Git ref for stable Open edX release. Used as a default refspec for
# configuration, edx-platform, forum, notifier, xqueue, and certs when creating production instances.
OPENEDX_RELEASE_STABLE_REF = env('OPENEDX_RELEASE_STABLE_REF', default='open-release/hawthorn.1')

# The edx-platform repository used by default for production instances
STABLE_EDX_PLATFORM_REPO_URL = env(
    'STABLE_EDX_PLATFORM_REPO_URL', default='https://github.com/{}.git'.format(DEFAULT_FORK)
)
STABLE_EDX_PLATFORM_COMMIT = env('STABLE_EDX_PLATFORM_COMMIT', default=OPENEDX_RELEASE_STABLE_REF)

# The configuration repository used by default for production instances
STABLE_CONFIGURATION_REPO_URL = env(
    'STABLE_CONFIGURATION_REPO_URL', default=DEFAULT_CONFIGURATION_REPO_URL
)
STABLE_CONFIGURATION_VERSION = env('STABLE_CONFIGURATION_VERSION', default='opencraft-release/hawthorn.1')

# The name of the security group to use for edxapp App servers.
# This is used to set appropriate firewall rules to prevent external access to
# the AppServers.
# This security group will be created if it doesn't exist, and its rules will
# be managed by OpenCraft IM.
OPENEDX_APPSERVER_SECURITY_GROUP_NAME = env('OPENEDX_APPSERVER_SECURITY_GROUP_NAME', default='edxapp-appserver')
OPENEDX_APPSERVER_SECURITY_GROUP_RULES = [
    # Each entry here must have the keys defined in instance.openstack_utils.SecurityGroupRuleDefinition.
    # The following allows all egress traffic, and only allows ingress on ports 22, 80, and 443
    {
        "direction": "egress",
        "ether_type": "IPv4",
        "protocol": None,
        "port_range_min": None,
        "port_range_max": None,
        "remote_ip_prefix": "0.0.0.0/0",
        "remote_group_id": None
    },
    {
        "direction": "egress",
        "ether_type": "IPv6",
        "protocol": None,
        "port_range_min": None,
        "port_range_max": None,
        "remote_ip_prefix": "::/0",
        "remote_group_id": None,
    },
    # SSH
    {
        "direction": "ingress",
        "ether_type": "IPv4",
        "protocol": "tcp",
        "port_range_min": 22,
        "port_range_max": 22,
        "remote_ip_prefix": "0.0.0.0/0",
        "remote_group_id": None,
    },
    # HTTP
    {
        "direction": "ingress",
        "ether_type": "IPv4",
        "protocol": "tcp",
        "port_range_min": 80,
        "port_range_max": 80,
        "remote_ip_prefix": "0.0.0.0/0",
        "remote_group_id": None,
    },
    # HTTPS
    {
        "direction": "ingress",
        "ether_type": "IPv4",
        "protocol": "tcp",
        "port_range_min": 443,
        "port_range_max": 443,
        "remote_ip_prefix": "0.0.0.0/0",
        "remote_group_id": None,
    },
    {
        "direction": "ingress",
        "ether_type": "IPv4",
        "protocol": "icmp",
        "port_range_min": None,
        "port_range_max": None,
        "remote_ip_prefix": "0.0.0.0/0",
        "remote_group_id": None,
    },
    {
        "direction": "ingress",
        "ether_type": "IPv6",
        "protocol": "icmp",
        "port_range_min": None,
        "port_range_max": None,
        "remote_ip_prefix": "::/0",
        "remote_group_id": None,
    },
    # Consul (TCP)
    {
        "direction": "ingress",
        "ether_type": "IPv4",
        "protocol": "tcp",
        "port_range_min": 8300,
        "port_range_max": 8302,
        "remote_ip_prefix": "0.0.0.0/0",
        "remote_group_id": None,
    },
    # Consul (UDP)
    {
        "direction": "ingress",
        "ether_type": "IPv4",
        "protocol": "udp",
        "port_range_min": 8300,
        "port_range_max": 8302,
        "remote_ip_prefix": "0.0.0.0/0",
        "remote_group_id": None,
    },
    # Prometheus Node Exporter
    {
        "direction": "ingress",
        "ether_type": "IPv4",
        "protocol": "tcp",
        "port_range_min": 19100,
        "port_range_max": 19100,
        "remote_ip_prefix": "0.0.0.0/0",
        "remote_group_id": None,
    },
]

# Enable or disable celery heartbeats on instances managed by Ocim
EDX_WORKERS_ENABLE_CELERY_HEARTBEATS = env.bool('EDX_WORKERS_ENABLE_CELERY_HEARTBEATS', default=False)

# Ansible #####################################################################

# Ansible requires a Python 2 interpreter
ANSIBLE_PYTHON_PATH = env('ANSIBLE_PYTHON_PATH', default='/usr/bin/python')

# Time in seconds to wait for the next log line when running an Ansible playbook.
ANSIBLE_LINE_TIMEOUT = env.int('ANSIBLE_LINE_TIMEOUT', default=1500)  # 25 minutes

# Timeout in seconds for an entire Ansible playbook.
ANSIBLE_GLOBAL_TIMEOUT = env.int('ANSIBLE_GLOBAL_TIMEOUT', default=9000)  # 2.5 hours

# The repository to pull the default Ansible playbook from.
ANSIBLE_APPSERVER_REPO = env('ANSIBLE_APPSERVER_REPO', default='https://github.com/open-craft/ansible-playbooks.git')

# The path to the common appserver playbook to run on all appservers.
ANSIBLE_APPSERVER_PLAYBOOK = env('ANSIBLE_APPSERVER_PLAYBOOK', default='playbooks/appserver.yml')

# The path to the requirements file for the common appserver playbook.
ANSIBLE_APPSERVER_REQUIREMENTS_PATH = env('ANSIBLE_APPSERVER_REQUIREMENTS_PATH', default='requirements.txt')

# The version of the Ansible playbook repository to checkout.
ANSIBLE_APPSERVER_VERSION = env('ANSIBLE_APPSERVER_VERSION', default='master')

# Emails ######################################################################

EMAIL_BACKEND = env('EMAIL_BACKEND',
                    default='django.core.mail.backends.console.EmailBackend')

# From & subject configuration for sent emails
DEFAULT_FROM_EMAIL = env('DEFAULT_FROM_EMAIL', default='opencraft@localhost')
SERVER_EMAIL = env('SERVER_EMAIL', default='opencraft@locahost')
EMAIL_SUBJECT_PREFIX = env('EMAIL_SUBJECT_PREFIX', default='[OpenCraft] ')

# Destination e-mail for notifications like "The user changed the logo"
VARIABLES_NOTIFICATION_EMAIL = env('VARIABLES_NOTIFICATION_EMAIL', default=None)

# SMTP configuration
EMAIL_HOST = env('EMAIL_HOST', default='localhost')
EMAIL_PORT = env('EMAIL_PORT', default=25)
EMAIL_USE_TLS = env('EMAIL_USE_TLS', default=False)
EMAIL_HOST_USER = env('EMAIL_HOST_USER', default='')
EMAIL_HOST_PASSWORD = env('EMAIL_HOST_PASSWORD', default='')

# Email confirmation
SIMPLE_EMAIL_CONFIRMATION_AUTO_ADD = False


# Logging #####################################################################

ADMINS = env.json('ADMINS', default=set())

BASE_HANDLERS = env.json('BASE_HANDLERS', default=["file", "console", "mail_admins"])
HANDLERS = BASE_HANDLERS + ['db']
LOGGING_ROTATE_MAX_KBYTES = env.json('LOGGING_ROTATE_MAX_KBYTES', default=10 * 1024)
LOGGING_ROTATE_MAX_FILES = env.json('LOGGING_ROTATE_MAX_FILES', default=60)
LOGGING = {
    'version': 1,
    'disable_existing_loggers': False,
    'formatters': {
        'verbose': {
            'format': "{asctime} | {levelname:>8.8s} | process={process:<5d} | {name:<25.25s} | {message}",
            'style': '{',
            'datefmt': "%d/%b/%Y %H:%M:%S"
        },
        'db': {
            'format': "{name:<25.25s} | {message}",
            'style': '{',
            'datefmt': "%d/%b/%Y %H:%M:%S"
        },
    },
    'handlers': {
        'console': {
            'level': 'INFO',
            'class': 'logging.StreamHandler',
            'formatter': 'verbose'
        },
        'db': {
            'level': 'INFO',
            'class': 'instance.logging.DBHandler',
            'formatter': 'db'
        },
        'mail_admins': {
            'level': 'ERROR',
            'class': 'django.utils.log.AdminEmailHandler'
        },
    },
    'loggers': {
        '': {
            'handlers': HANDLERS,
            'propagate': True,
            'level': 'DEBUG',
        },
        'django': {
            'handlers': HANDLERS,
            'propagate': False,
            'level': 'INFO',
        },
        'opencraft': {
            'handlers': HANDLERS,
            'propagate': False,
            'level': 'DEBUG',
        },
        'requests': {
            'handlers': HANDLERS,
            'propagate': False,
            'level': 'DEBUG',
        },
        'requests.packages.urllib3': {
            'handlers': HANDLERS,
            'propagate': False,
            'level': 'WARNING',
        }
    }
}

if 'file' in HANDLERS:
    LOGGING['handlers']['file'] = {
        'level': 'INFO',
        'class': 'opencraft.logging.GzipRotatingFileHandler',
        'filename': 'log/im.{}.log'.format(env('HONCHO_PROCESS_NAME', default='main')),
        'maxBytes': LOGGING_ROTATE_MAX_KBYTES * 1024,
        'backupCount': LOGGING_ROTATE_MAX_FILES,
        'formatter': 'verbose'
    }


# Instances ###################################################################

# Configure external databases here
DEFAULT_INSTANCE_MYSQL_URL = env('DEFAULT_INSTANCE_MYSQL_URL', default=None)
DEFAULT_INSTANCE_MONGO_URL = env('DEFAULT_INSTANCE_MONGO_URL', default=None)
DEFAULT_MONGO_REPLICA_SET_NAME = env('DEFAULT_MONGO_REPLICA_SET_NAME', default=None)
DEFAULT_MONGO_REPLICA_SET_PRIMARY = env('DEFAULT_MONGO_REPLICA_SET_PRIMARY', default=None)
DEFAULT_MONGO_REPLICA_SET_HOSTS = env('DEFAULT_MONGO_REPLICA_SET_HOSTS', default=None)
DEFAULT_MONGO_REPLICA_SET_PORT = env('DEFAULT_MONGO_REPLICA_SET_PORT', default=None)
DEFAULT_MONGO_REPLICA_SET_USER = env('DEFAULT_MONGO_REPLICA_SET_USER', default=None)
DEFAULT_MONGO_REPLICA_SET_PASSWORD = env('DEFAULT_MONGO_REPLICA_SET_PASSWORD', default=None)

# The RabbitMQ host must be accessible from both OpenCraft IM as well as well as any instances using it.
DEFAULT_INSTANCE_RABBITMQ_URL = env('DEFAULT_INSTANCE_RABBITMQ_URL', default=None)

# Limit the number of log entries fetched for each instance, for performance
LOG_LIMIT = env.int('LOG_LIMIT', default=10000)

# How old a log entry needs to be before it's deleted.
LOG_DELETION_DAYS = env.int('LOG_DELETION_DAYS', default=60)

# When configured, email sent from instances is relayed via external SMTP provider.
INSTANCE_SMTP_RELAY_HOST = env('INSTANCE_SMTP_RELAY_HOST', default=None)
INSTANCE_SMTP_RELAY_PORT = env.int('INSTANCE_SMTP_RELAY_PORT', default=587)
INSTANCE_SMTP_RELAY_USERNAME = env('INSTANCE_SMTP_RELAY_USERNAME', default='')
INSTANCE_SMTP_RELAY_PASSWORD = env('INSTANCE_SMTP_RELAY_PASSWORD', default='')
INSTANCE_SMTP_RELAY_SENDER_DOMAIN = env('INSTANCE_SMTP_RELAY_SENDER_DOMAIN', default=DEFAULT_INSTANCE_BASE_DOMAIN)

# User interface ##############################################################

# The instance view loads data for at most 5 appservers and shows a button to load more
# The /api/v1/instance/10/ API will also include at most this number of appservers.
# This avoids sending too much information.
NUM_INITIAL_APPSERVERS_SHOWN = env('NUM_INITIAL_APPSERVERS_SHOWN', default=5)

# Subdomain blacklist #########################################################

SUBDOMAIN_BLACKLIST = env.list('SUBDOMAIN_BLACKLIST', default=[])

# Beta test email settings ####################################################

BETATEST_EMAIL_INTERNAL = env('BETATEST_EMAIL_INTERNAL', default='help@example.com')
BETATEST_EMAIL_SENDER = env('BETATEST_EMAIL_SENDER', default='betatest@example.com')
BETATEST_EMAIL_SIGNATURE = env('BETATEST_EMAIL_SIGNATURE', default='The Beta Test Team')
BETATEST_WELCOME_SUBJECT = env(
    'BETATEST_WELCOME_SUBJECT',
    default='Welcome to the OpenCraft Instance Manager free 30-day trial!',
)

# Monitoring ##################################################################

# Set this to a new relic license key to enable instance monitoring
NEWRELIC_LICENSE_KEY = env('NEWRELIC_LICENSE_KEY', default=None)

# A new relic admin user's API key, used to set up availability monitoring
# with Synthetics
NEWRELIC_ADMIN_USER_API_KEY = env('NEWRELIC_ADMIN_USER_API_KEY', default=None)

# The basic auth password needed to access the node exporter.
NODE_EXPORTER_PASSWORD = env('NODE_EXPORTER_PASSWORD', default=None)

# Load balancing ##############################################################

# The load-balancing server given in the form ssh_username@server.domain will be created
# in the database if it does not exist yet.
DEFAULT_LOAD_BALANCING_SERVER = env('DEFAULT_LOAD_BALANCING_SERVER', default=None)

LOAD_BALANCER_FRAGMENT_NAME_PREFIX = env('LOAD_BALANCER_FRAGMENT_NAME_PREFIX', default='opencraft-')
PRELIMINARY_PAGE_SERVER_IP = env('PRELIMINARY_PAGE_SERVER_IP', default=None)

# AWS #########################################################################

# Must be set if `INSTANCE_STORAGE_TYPE = 's3'`.

# Permissions required for this account are:
# iam:PutUserPolicy
# iam:CreateUser
# iam:CreateAccessKey
# iam:DeleteUser
# iam:DeleteAccessKey
# iam:DeleteUserPolicy

AWS_SECRET_ACCESS_KEY = env('AWS_SECRET_ACCESS_KEY', default=None)
AWS_ACCESS_KEY_ID = env('AWS_ACCESS_KEY_ID', default=None)
AWS_S3_BUCKET_PREFIX = env('S3_BUCKET_PREFIX', default='ocim')
AWS_S3_CUSTOM_REGION_HOSTNAME = 's3.{region}.amazonaws.com'
AWS_S3_DEFAULT_HOSTNAME = 's3.amazonaws.com'
AWS_S3_DEFAULT_REGION = env('AWS_S3_DEFAULT_REGION', default='')
AWS_IAM_USER_PREFIX = env('IAM_USER_PREFIX', default='ocim')

# Consul ######################################################################

# The encryption key used to gossip in a Consul cluster.
CONSUL_ENCRYPT = env('CONSUL_ENCRYPT', default='')

# The list of server agents in the Consul cluster.
CONSUL_SERVERS = env.list('CONSUL_SERVERS', default=[])

# Filebeat ####################################################################

# The Logstash hosts to forward logs to.
FILEBEAT_LOGSTASH_HOSTS = env.list('FILEBEAT_LOGSTASH_HOSTS', default=[])

# TLS details that Filebeat needs to connect to the Logstash hosts.
FILEBEAT_CA_CERT = env('FILEBEAT_CA_CERT', default='')
FILEBEAT_CERT = env('FILEBEAT_CERT', default='')
FILEBEAT_KEY = env('FILEBEAT_KEY', default='')

# Common fields for all Filebeat prospectors.
FILEBEAT_COMMON_PROSPECTOR_FIELDS = env.json('FILEBEAT_COMMON_PROSPECTOR_FIELDS', default={})