Skip to content

Latest commit

 

History

History
192 lines (137 loc) · 11.5 KB

README.md

File metadata and controls

192 lines (137 loc) · 11.5 KB
Raw

Vagrant Box & Ansible Scripts

This repository contains files, scripts, and Ansible playbooks for setting up a PHP development and production environments It's primary purpose is for my own development, but also to experiment with the environment itself before pushing it to gocoeup/Codeup-Vagrant-Setup. It contains:

  1. A Vagrantfile definition for local development and testing of LAMP based applications
  2. Ansible playbooks and tasks for deploying those same applications to a production server, in particular those hosted by DigitalOcean

Installation & Setup

  1. Install Vagrant, VirtualBox, and Ansible. These can gotten with Homebrew and Homebrew Cask.
  2. Clone repository
  3. Run vagrant up.

Ansible Playbooks

Included with this repository is a set of playbooks for managing either your vagrant or production environments. You can run these plays from directly on your Mac and Ansible will go into either your Vagrant or production server and perform whatever the required tasks are. We will go into more detail on how to use many of these scripts, but the following is an overview of the included items.

  • vagrant-init.yml
    • Set up the vagrant environment. You should not run this script directly; vagrant up or vagrant provision will run it for you.
  • prod-init.yml
    • Set up a production environment. It will create a new commandline (console) user and a new MySQL administrator, both called codeup. You will be prompted to provide a new password for both. These are the passwords you will use in subsequent sudo or database admin tasks.
  • warpspeed-init.yml
    • If you have created a production server using Warpspeed, this script will add a couple of additional utilities and config files so that ansible can also manage that server.
    • Requires the --ask-sudo-pass flag.
  • create-vagrant-site.yml
    • Create a new site within the Vagrant environment.
  • create-vagrant-mysql-admin.yml
    • Create a new MySQL user in the Vagrant environment with database wide admin privileges.
  • create-vagrant-mysql-db.yml
    • Create a new MySQL database in the Vagrant environment and a dedicated user for it. This user will have full privileges for the database but no access to any others.
  • destroy-vagrant-site.yml
    • Disable a site in the Vagrant environment. Will not delete any user files unless a purge flag is passed.
  • create-production-site.yml
    • Create a new site within the production environment. Will setup git hooks so that you can push your site to production using git.
    • Requires the --ask-sudo-pass flag.
  • create-production-mysql-admin.yml
    • Create a new MySQL user in the production environment with database wide admin privileges.
  • create-production-mysql-db.yml
    • Create a new MySQL database in the production environment and a dedicated user for it. This user will have full privileges for the database but no access to any others.
  • create-production-app.yml
    • Combination of the create-production-site.yml and create-production-mysql-db.yml scripts, for setting up a new site and a dedicated database & user for it. Just like above, it will create git hooks for push deployment.
    • Requires the --ask-sudo-pass flag.
  • deploy-site.yml
    • Push a local site to production using git. It will prompt you for the site you wish to deploy, see below for more information on how to set this up.
  • destroy-production-site.yml
    • Disable a site in the production environment. Will not delete any user files unless a purge flag is passed.
    • Requires the --ask-sudo-pass flag.

Creating a Site in Vagrant

When you first run vagrant up inside this directory, Vagrant will automatically run the necessary Ansible plays to configure your test server and setup your first site. Later on in the course if you need to create additional sites you can do so by running:

ansible-playbook ansible/create-vagrant-site.yml

The create-vagrant-site.yml script can also optionally add your new domain to your local hosts file, facilitating the local deployment process. In order to do so however, you must have administer rights and run the script in the following manner:

sudo ansible-playbook ansible/create-vagrant-site.yml -e "append_host=true"

Setting up a Digital Ocean Server

We use DigitalOcean in part because their signup process is quite straight forward and easy to follow. Simply navigate to the signup page and follow the prompts.

Adding a Key

If you used the LAMP Setup Script provided you should have an SSH key generated for you. You must add that key to your DigitalOcean account in order to connect to your server. In order to do so, follow these steps

  1. Navigate to the SSH Keys section in your DigitalOcean account page.
  2. Click "Add SSH Key"
  3. Copy the contents of the file ~/.ssh/id_rsa.pub (hint, you can do this easily by running cat ~/.ssh/id_rsa.pub | pbcopy)
  4. Give your key a meaningful name (something like "Codeup SSH Key") and then paste your key data into the form.
  5. Now save your changes.

Creating a Droplet

  1. Click the Create button
  2. Give your server a meaningful hostname, such as "Codeup-Server"
  3. Pretty much all of the default options selected are appropriate for your first droplet (512MB / New York 2 / Ubuntu 14.04)
  4. Make sure you select the option to add your SSH key to your new droplet!
  5. Click create and then wait.
  6. Make sure to note your droplet's new IP address

Editing Local Configs

  1. Edit ansible/hosts and remove the ; from the start of the line containing production
  2. Replace the xxx.xxx.xxx.xxx with your droplet's IP address

Provisioning the Server

Run the following command to initialize your server

ansible-playbook ansible/prod-init.yml

This will guide you through the process of setting up the site, as well as initializing a site on your server. You will need to provide it:

  • A password for the default console or shell user, "codeup"
  • An eMail address to receive notifications from the server
  • A password for the default MySQL administrator, also called "codeup"

Adding a Site to Digital Ocean

Adding a site to your DigitalOcean droplet is similar to adding one to your Vagrant box, although we need to tell Ansible to ask for your password first:

ansible-playbook ansible/create-production-site.yml --ask-sudo-pass

Next Steps

  1. As the Ansible script runs, two messages with git commands should be outputted. Run those commands from within your application's root directory.
  2. The init script created a user called "codeup" in your droplet; you will use this user when SSH-ing into your new server.
  3. You must now SSH into your server and run the standard composer and artisan commands to initialize your application.

Creating a Production Application

Most web applications require a combination of domain name and database. Thankfully, ansible can set this up using a single command. Use:

ansible-playbook ansible/create-production-app.yml --ask-sudo-pass

You will be prompted for the following:

  • Your sudo password — this is the password for the command line user codeup
  • Your MySQL admin password — this is the password for the database user codeup
  • Site domain name — what is the domain name for your new site?
  • MySQL database name — the name of the database your application will use
  • MySQL user name — the user your application will connect to MySQL as
  • MySQL password — the password your application will use when connecting to MySQL

Deploying Laravel Applications

Ansible can automatically deploy your local dev sites to production using git. First, you must create the application in production using the above steps. Second, you need to create a new config file in ansible/site_vars. Take the template.yml file and copy it to a new filename (for example, "blog.yml"). Fill in the two parameters in your new file. The local_domain should be your local site's domain name, under the sites directory next to this README. The production_domain is your sites new domain name you specified when running create-production-site.yml or create-production-app.yml. Save your new vars file and then run:

ansible-playbook ansible/deploy-site.yml

You will be prompted for the name of your site to deploy. This is the file name you created just moments ago, without the .yml extension. So, if you created blog.yml in ansible/site_vars, the name of your site is just blog. The script will then do the following:

  • Ensure a proper git remote is set in your local repository
  • Push your site to production using git
  • Copy the .env.php file to production (Make sure this file exists first)
  • Run composer install for your application
  • Run any new migrations for your application

Note: The deploy script will not do any seeding! This is intentional.

Managing a Warpspeed Server

If you have provisioned a server using Warpspeed our ansible scripts can still work with it! You will need to adjust a config file, and run a simple init script, and then the rest of the production ansible script will work just like before. Open ansible/host_vars/production.yml in your favorite editor. There are three sections of variables. The first are the default production parameters. Add a # to the beginning of lines 8 - 12 to comment them out. The second section are parameters for a Warpspeed server. Remove the # from lines 20 - 24 to enable those settings. Once this is done and saved, we need to add just a couple of config files to your server. This is done by running:

ansible-playbook ansible/warpspeed-init.yml --ask-sudo-pass

Once you've run this script, all our existing "production" commands work just like before! The only catch being that the Warpspeed users are warpspeed for both the command line and database, instead of codeup. Ansible is setup to make this switch seamlessly, but beware when this documentation discusses ssh-ing as codeup.

Removing a Site

If you wish to remove a site from either your Vagrant box or Digital Ocean server, you can do so using the following ansible commands

ansible-playbook ansible/destroy-vagrant-site.yml
# or
ansible-playbook ansible/destroy-production-site.yml --ask-sudo-pass

This command will only remove the configuration files for your site, it will in no way delete any of your files on the server or remove any entries to your hosts file. If you would like to delete the actual files in your site, add the option -e "purge=true". Be extremely careful with this option! It really will completely wipe your site from the server! If you wish to delete the site record in your hosts file, run the command with sudo and add -e "purge_host=true".

Managing MySQL

Included with these files is also a script to aide in setting up MySQL users & databases. In order to create a MySQL administrator, use the following command

ansible-playbook ansible/create-vagrant-mysql-admin.yml
# or
ansible-playbook ansible/create-production-mysql-admin.yml

To make a new database & user for your application, use the following:

ansible-playbook ansible/create-vagrant-mysql-db.yml
# or
ansible-playbook ansible/create-production-mysql-db.yml