dodevops 0.1.18

Devops tool for deploying and managing resources on DigitalOcean

DoDevOps

DoDevOps is a tool for creating and managing Django apps on DigitalOcean's App Platform. It accesses DigitalOcean through the API, so it requires a DigitalOcean API token, and it requires a DigitalOcean Spaces key for storing media uploads. Additionally, you must authorize DigitalOcean to pull your GitHub repos.

Prerequisites:

1. Python 3.9 on Linux or Mac
2. DigitalOcean account https://www.digitalocean.com/?refcode=9ef6f738fd8a
3. DigitalOcean API token: https://cloud.digitalocean.com/account/api/tokens
4. DigitalOcean S3 keys: https://cloud.digitalocean.com/account/api/spaces
5. Authorize DigitalOcean to pull your GitHub repos: https://cloud.digitalocean.com/apps/github/install

Installation

This tool can be installed with pip. If installed in a Django project, it will try to detect some settings from the project such as repo and branch, as well as enable migration of db.json files and media uploads.

pip install dodevops

To run the tool:

dodevops

Quickstart

Migrate an existing Django project to DigitalOcean App Platform

1. Create a virtual environment mkvirtualenv dodevops
2. Make sure pip is up to date pip install --upgrade pip
3. Install dodevops pip install dodevops
4. Change directory to wherever your Django app is
5. Export environment variables

   export DIGITALOCEAN_API_TOKEN=dop_v1_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
   export AWS_ACCESS_KEY_ID=xxxxxxxxxxxxxxxxxxx
   export AWS_SECRET_ACCESS_KEY=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
   export MIGRATE_SCRIPT_1="python manage.py shell -c \"import some_module; some_module.some_function()\""
   export MIGRATE_SCRIPT_2=""
   

6. Run dodevops dodevops

Technically the DoDevOps doesn't need it's own environment and can be installed in existing environments, but sometimes isolation is nice.

DoDevOps doesn't have to be run from within a Django folder, but if .env or .git are available it will try and guess some of your settings for your. It does require a /media folder in order to upload media folder to s3, and it does require db.json if migrating a previous database. Exporting environment variables isn't required, if not supplied DoDevOps will ask the user to enter them at runtime.

The environment variables MIGRATE_SCRIPT_x can be used to hold lines of user supplied scripts for the migration job. These are single shell lines executed as a pre-deploy task on the live DO server.

Details

Generating DO API token

In order for this app to work it needs a valid DigitalOcean Personal Access Token. The token is not required after this is run, so it is okay to recyle the token when finished. The token can either be stored in a .env file or env variable, or it can be pasted into the app at run time.

To generating a new token

Go here: https://cloud.digitalocean.com/account/api/tokens

Pick whatever name you want for the token, it doesn't matter. Pick whatever token expiration you want depending on your personal paranoia level. Write permissions are required.

Once the token is generated copy it and paste it somewhere safe like a password manager such as 1password. The token won't be displayed again, so if you don't get it saved somewhere safe you'll have to regenerate it.

Protect your token well. Anyone with access to your token has the ability to create and destroy things and incur you costs, so be careful with it. This is opensource so that you can read the code if you want and verify how the token is used. Storing the token in the .env file is convenient, but it is not the most secure, so if you feel paranoid don't do that.

If you want more info about DO tokens, see here: https://docs.digitalocean.com/reference/api/create-personal-access-token/

Generating DO Spaces Key

A DO Spaces key is required for storing a media upload folder, as app platform doesn't have storage.

To generate an app spaces key

Go here: https://cloud.digitalocean.com/account/api/spaces

You can use whatever name you want for the key, it doesn't matter. It will display two values, a key ID and a longer access key, save both somewhere safe like a password manager. It won't display the access key again, so if you don't save it you'll have to regenerate it.

You can put the values in an .env file, or enter it at runtime.

Protect the token well.

To learn more about DO Spaces keys, go here: https://docs.digitalocean.com/products/spaces/how-to/manage-access/#access-keys

Filling out .env file

A .env file isn't required, but if you store values in it then it will save effort. But if you feel storing values in the .env file isn't secure enough for your personal paranoia levels you can instead enter things at runtime.

The format of the env file is:

DIGITALOCEAN_TOKEN=dop_v1_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
AWS_ACCESS_KEY_ID=DOxxxxxxxxxxxxxxxxxxx
AWS_SECRET_ACCESS_KEY=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
# AWS_REGION=ams3
# APP_NAME=example-rest-app
# COMPONENT_NAME=example-rest
# APP_PREFIX=example
# GH_REPO=xusernamex/xrepox
# GH_BRANCH=main
# DJANGO_ROOT_MODULE=example
# DJANGO_USER_MODULE=core
# SECRET_KEY_ENV_KEY=SECRET_KEY
# SECRET_KEY=change_me
# ALLOWED_HOSTS_ENV_KEY=ALLOWED_HOSTS
# DEBUG=1
# DOMAIN=rest.example.com
# PARENT_DOMAIN=example.com
# OIDC="\"-----BEGIN RSA PRIVATE KEY-----\\n_xxx_\\n-----END RSA PRIVATE KEY-----\\n\""

Linux and Mac

This project uses inquirer to get user input. As far as I know it only works on linux and mac. When debugging in pycharm, you may need to set the run/debug settings to use the terminal emulation. You can find a link with more info here: https://intellij-support.jetbrains.com/hc/en-us/community/posts/360003383619-Pycharm-2019-termios-error-25-Inappropriate-ioctl-for-device-?page=1#community_comment_6589796593042 and here https://github.com/magmax/python-readchar/issues/11