Deploy para dev
# para saber sua tag:
make get_last_tag ENV=DEV
# para fazer o deploy
make gcp_deploy_dev TAG=XXX
Para desenvolvimento local, use o docker
se for desenvolvimento local, entre na pasta de dev e use o makefile dentro desta pasta
Old? Revisar??
Database as a Service (DBaaS)
Introduction
This is an implementation of a database as a service api written in python + django. It will try to follow some hypermedia concepts throughout the api calls.
Below: Screenshot from the admin user.
image 1: Listing databases and their summary information.
image 2: example database view and all its credentials.
Requirements
DBaaS requires the following:
- python >= 2.7.5
- virtualenv >= 1.7.2
- virtualenvwrapper >= 3.5
- mysql server and client, version 5.5.x
- mongo client = 2.4 (used by the clone feature)
- redis (broker for async tasks with celery)
- and all packages in requirements.txt file (there is a shortcut to install them)
Setup your local environment
Using docker (recommended)
Setup docker and docker-compose
- Install Docker and Docker Compose
Go to the project path and run these following commands:
# create python container
$make dev_docker_build
$make dev_docker_setup [optional_mysql_dump_file_path]
$make dev_docker_migrate
$make dev_docker_run
To generate a migration, you should run:
$make dev_docker_generate_migration app=my_app
And then, to apply the changes to the bank:
$make dev_docker_migrate
You can explore spacific docker settings in this link
without docker
mkvirtualenv dbaas
workon dbaas
Install the required python packages by:
make pip
Database setup for migrations:
-
Connect to the local database.
mysql -u root -p <GENERATED-PASSWORD>
-
Change root password to an empty string.
ALTER USER 'root'@'localhost' IDENTIFIED BY '';
-
Create
dbaas
database.CREATE DATABASE dbaas;
Run migrations to mysql database:
make run_migrate
Install redis and start celery:
make run_celery
Create the tables structure (see the next item)
DB
DBaaS uses south to maintain the migrations up-to-date. However, you can just run syncdb to create the table structures. There is a shortcut to help you with that, including some minimum operational data on DB.
make reset_data
Running all tests on local environment
make pip && make test
Running all test with docker( To run this the docker-compose must be available)
make docker_build && make test_with_docker
Running the project
make run
In your browser open the URL: http://localhost:8000/admin/
Running celery
To run celery locally use the following command:
cd {APP DIR}
make run_celery
Documentation
Listed below are some articles that describe details associated with this project.
Definitions
This guide will help you to understand the basic DBaaS architecture.
Quickstart
The running instructions in the execution order.
API
The documentation of API which allows you to maintain yours databases.
Drivers
About drivers used to support to new databases.
Troubleshooting
Guide to avoid usual problems.
Docker Settings
Guide to use this project with containers.
License
This project is licensed under the BSD 3-Clause "New" or "Revised" License - read LICENSE file for details.