[mod] Switching to rst

This commit is contained in:
Jose Pablo Domingo Aramburo Sanchez 2018-08-16 04:01:26 -06:00 committed by GitHub
parent 78b319a0a3
commit 0558ce048f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 22 additions and 16 deletions

View File

@ -1,16 +0,0 @@
# The database
#### The system has been built with the idea of running everything from within docker containers and due to that the following behaivor should be expected.
#### A new docker image with mysql 5.7 will be created when docker-compose is called which will contain the starting scripts to create the database structure and anything else that is requiered to begin working as well as a config file to change the default port that is exposed.
#### Once this process begins the database will be initialized by running the scripts in alphabetical order in the directory:
```
/docker-entrypoint-initdb.d
```
#### After the database image has been created it'll be accessible by default in the port 3307, the users 'root' and 'sloth' will be usable both of which have the password 12345678
## Data persistence
#### The database details will be stored in the volume mysql-data which is located in the volumes directory at the root of the project.

22
database/README.rst Normal file
View File

@ -0,0 +1,22 @@
================
``The database``
================
.. contents::
About the container
--------------------
The database container is created in two stages to bypass some limitations with docker, firstly a new image will be created based on the Dockerfile which will be based on mysql 5.7 and it'll be passed the .sql scripts to initialize the database as well as a config file to configure the port that will be exposed.
Initializing
-------------
When the database is being created as an image it'll take all the scripts in the **/docker-entrypoint-initdb.d** directory and execute them in alphabetical order which will result in the database with its tables and initial data being created.
Accession
----------
The newly created container will have two users *root** and **sloth** both of which will have the password **12345678** and it'll be accessible in the port 3307
Persistence
-----------
A volume containing the data from **/var/lib/mysql** will be created to persist the information, once its created running the container build again will execute the starting scripts