Merge pull request #144 from Kitware/add-aws-deployment-config

Add config class for using AWS

Author: naglepuff

.markdownlint.yaml

@@ -0,0 +1,2 @@
+MD013:
+  line_length: 120

DEPLOYMENT.md

@@ -106,3 +106,21 @@ django-admin interface and make sure you have the trailing '/' on the URL.
 
 There is no email server connected up so users need to be
 individually approved and their email verified by an admin
+
+## Using AWS S3
+
+In order to use AWS S3 as your storage service, you'll need
+to make sure to start the Django application with the correct configuration.
+
+As a starting point for configuring your environment, see [dev/.env.prod.s3.template](dev/.env.prod.s3/template)
+for a list of environment variables that you'll need to populate for your deployment.
+
+- `DJANGO_CONFIGURATION` this is used by
+   [django_configurations](https://django-configurations.readthedocs.io/en/stable/)
+   to read in the correct set of environment variables. The value `AwsProductionConfiguation`
+   should be used when using S3 as storage
+- `DJANGO_DATABASE_*` these variables tell django how to connect to your postgres database.
+   The `_URL` should be a postgres connection string, e.g. `postgres://user:password@postgres:5432/django`
+- `DJANGO_CELERY_BROKER_URL` is used to make sure django can send tasks to the `celery` service.
+   For example, if using [RabbitMQ](https://www.rabbitmq.com/), it might look like this: `amqp://rabbitmq:5672`
+- `AWS_*` and `DJANGO_STORAGE_BUCKET_NAME` are used to make sure the application can connect to your S3 bucket

bats_ai/settings.py

@@ -9,6 +9,7 @@
     DevelopmentBaseConfiguration,
     HerokuProductionBaseConfiguration,
     ProductionBaseConfiguration,
+    S3StorageMixin,
     TestingBaseConfiguration,
 )
 from composed_configuration._configuration import _BaseConfiguration
@@ -115,3 +116,7 @@ class ProductionConfiguration(BatsAiMixin, ProductionBaseConfiguration):
 
 class HerokuProductionConfiguration(BatsAiMixin, HerokuProductionBaseConfiguration):
     pass
+
+
+class AwsProductionConfiguration(BatsAiMixin, S3StorageMixin):
+    pass

dev/.env.prod.s3.template

@@ -0,0 +1,13 @@
+DJANGO_CONFIGURATION=AwsProductionConfiguration
+DJANGO_DATABASE_NAME=django
+DJANGO_DATABASE_PASSWORD=
+DJANGO_DATABASE_URL=
+DJANGO_CELERY_BROKER_URL=
+DJANGO_MINIO_STORAGE_ENDPOINT=
+SERVERHOSTNAME=
+DJANGO_SECRET_KEY=
+DOCKER_POSTGRES_PORT=
+AWS_DEFAULT_REGION=
+AWS_ACCESS_KEY_ID=
+AWS_SECRET_ACCESS_KEY=
+DJANGO_STORAGE_BUCKET_NAME=

setup.py

@@ -49,6 +49,7 @@
         'djangorestframework',
         'drf-yasg',
         'django-click',
+        'django-storages[s3]',
         # Production-only
         'django-composed-configuration[prod]>=0.20',
         'django-s3-file-field[boto3]<1',