Changes between Initial Version and Version 1 of DeveloperGuidelines/DeploymentTools

07/31/14 05:17:30 (9 years ago)



  • DeveloperGuidelines/DeploymentTools

    v1 v1  
     1= Developer Guidelines: DeploymentTools =
     3== Introduction ==
     4The coapp needs to allow users to deploy Eden on Linux Servers that may be EC2 instances (preferred). We also need to support features such as:
     5 * 3-tier Deployment
     6 * Amazon AutoScaling
     7 * Management Tasks (Clean Tables/Pull Eden)
     8 * Allow edition of configuration files
     10The requirements demand the need of a library which allows us to communicate with servers and install packages and issue commands remotely. We're using Ansible [] for this task.
     12== Workflow ==
     14 * Deploy the coapp using the instructions at []
     15 * Access the coapp, register a user and create a new Deployment
     16 * User may add a signle role (all) or multiple roles (db, webserver, eden)
     17 * User may only associate a single instance (prod/demo) while creating the deployment. Others may be added after succesful deployment of the first one.
     18 * On form submit, a YML file is generated in the yaml/ directory of the application (examples [] and ansible is ran using the web2py scheduler.
     19 * The success/failure is reported once the scheduler task is completed.
     20 * If successful, the user may further add instances (eg. demo/test) to the same deployment or issue management tasks using tabs/buttons in the rheader (TODO)
     22== Schema ==
     24TODO: ER Diagram?
     25The detailed schema is available at
     27The setup_deployment table is used to store various attributes related to the deployment.
     29The setup_instance table is used to store the type of instances along with its URL and a FK to scheduler_id. Each time an instance is added to the deployment, a YAML file is created in the background and ansible is called using the web2py scheduler.
     31The setup_server_role table is used to store the role (all/db/webserver/eden) of a particular host in the deployment along with its IP and hostname.
     33The setup_host table acts as a link table to link all the 3 tables above.
     35'''Background Workflow'''
     36 * S3SQLInlineComponent/S3SQLInlineLink allows addition of entries in setup_server_role and setup_instance.
     37 * After form submission and record creation, an entry is added to the scheduler_task table to run ansible (row id of scheduler_task is stored in setup_instance table). Ansible playbook (yaml file) takes in the values of variables from the user input in the create form.
     38 * Success/Failure of the deployment is displayed on the "read" method of the deployment