How to Deploy Phalcon Applications to Vultr with Nanobox

Phalcon is a high-performance PHP MVC web framework written in Zephir and C and implemented as a PHP extension. It's fast, resource-light, and handles concurrency well. Vultr is relatively new cloud provider (with tons of experience) that offers high-performance SSD servers in datacenters around the world. Its simple UI makes it easy to use and love.

In this article, I'm going to walk through deploying a Phalcon application to Vultr using Nanobox. Nanobox uses Docker to build local development and staging environments, as well as scalable, highly-available production environments on Vultr.

Download Nanobox

Go ahead and create a Nanobox account and download Nanobox Desktop, the Nanobox CLI.

Setup Your Phalcon Project

Whether you have an existing Phalcon project or are starting from scratch, the process of configuring it for Nanobox is the same.

Add a boxfile.yml

Nanobox uses the boxfile.yml to build and configure your app's environment both locally and in production. Create a boxfile.yml in the root of your project with the following:

run.config:
  engine: php
  engine.config:
    runtime: php-7.1
    webserver: apache
    document_root: public
    extensions:
      - curl
      - gettext
      - gd
      - json
      - mbstring
      - bz2
      - zlib
      - hash
      - pdo
      - pdo_mysql
      - fileinfo
      - phalcon
  extra_steps:
    - echo "alias phalcon=\'phalcon.php\'" >> /data/var/home/gonano/.bashrc

web.main:
  start:
    php: start-php
    apache: start-apache
  writable_dirs:
    - cache

data.mysql:
  image: nanobox/mysql:5.7

This boxfile.yml will:

  • Provide a PHP runtime with PHP 7.1.
  • Include and use Apache as the webserver.
  • Set the document root to public.
  • Install the Phalcon PHP extension along with other required extensions.
  • Add phalcon as an alias for phalcon.php for convenience.
  • Provide a publicly accessible webserver when deployed.
  • Make cache writable.
  • Provide a MySQL database.

Depending on packages and functionality in your app, you may need to add other extensions, PHP settings, etc. The following guides show how to modify PHP settings, add extensions, and modify other settings:

PHP Settings
PHP Extensions
PHP Webserver Config

Start the Local Dev Environment

With the boxfile.yml in place, you can fire up a virtualized local development environment. I recommend adding a DNS alias just so the app will be easier to access from a browser.

# Add a convenient way to access the app from a browser
nanobox dns add local phalcon.local

# Start the dev environment
nanobox run

Nanobox will provision a local development environment, mount your local codebase into the VM, provision a containerized MySQL database, load your app's dependencies (if a composer.json is present), then drop you into a console inside the VM.

Generate a New Phalcon Project

If you have an existing Phalcon project, you can skip this section. To generate a new Phalcon project from scratch, add the following to your composer.json:

{
    "require-dev": {
        "phalcon/devtools": "~3.0.3"
    }
}

Run the following from inside the Nanobox console:

# Install phalcon dev tools
composer install

# cd into /tmp
cd /tmp

# generate a new phalcon app
phalcon project myapp

# change back to the /app dir
# enable the dotglob shell option to interact with hidden files
# copy the generated app into your project folder
cd -
shopt -s dotglob
cp -a /tmp/myapp/* .

Your project's current working directory is mounted into the /app directory in the VM, so all the Phalcon files written there will propagate back down to your machine's filesystem and vice versa.

Update the Database Connection

In this example, I'm using MySQL, but you can use any of the officially supported data services. When Nanobox spins up a data service, it generates environment variables for the necessary connection credentials. For MySQL, host, user, and password environment variables are provided. Also, Nanobox provides a default gonano database.

Update your app/config/config.php to use the auto-generated environment variables in your connection config.

'database' => [
    'adapter'     => 'Mysql',
    'host'        => $_ENV['DATA_MYSQL_HOST'],
    'username'    => $_ENV['DATA_MYSQL_USER'],
    'password'    => $_ENV['DATA_MYSQL_PASS'],
    'dbname'      => 'gonano',
    'charset'     => 'utf8',
],

Adding Other Data Components

Note: The process for adding other data components such as Redis, Memcached, Postgres, etc. is the same:

  1. Add the data component to your boxfile.yml.
  2. Add the necessary PHP extensions.
  3. Update your connection config to use the auto-generated environment variables.
  4. nanobox build to apply the changes and provision the data component.

Run Phalcon Locally

Ok, you should be ready to fire Phalcon up locally. Nanobox's PHP engine includes a php-server helper script that starts your app using settings defined in the boxfile.yml. For this example, it'll start Nginx and PHP-FPM. Just run the following from the root of your project in the Nanobox console:

php-server

You'll then be able to access your running Phalcon app at phalcon.local.

Any changes you make to your codebase will be reflected in the running app. Once you're done hacking, exit out of the Nanobox console and your local dev environment will shutdown.

Alright! Now to the fun part!

Setup Your Vultr Account

If you haven't already, create a Vultr account. In your Vultr admin, select "Account" in the left-nav and open the "API" section. By default, Vultr API access is disabled. When you enable it, they will provide you with an API key.

Vultr Access Token

Vultr lets you whitelist subnets that can access the Vultr API using the generated key. To use the Nanobox Vultr integration, go ahead and click "Allow All IPv4".

Vultr IP Whitelist

Note: If you're uncomfortable whitelisting all IPv4 addresses, you can whitelist 138.197.215.155/32. This is the subnet on which the Nanobox Vultr adapter is hosted, but this subnet is subject to change. If/when it changes, you will need to manually update your Vultr account with the new subnet.

Add a New Provider to Your Nanobox Account

Add New Provider Account

Select Vultr and click "Proceed."

Select Vultr

Nanobox needs your Vultr access token to authenticate with your Vultr account. Paste in your token and click "Verify & Proceed."

Enter your Vultr access token

Name your provider and choose a default region. The name is arbitrary and only meant to help you identify it in your list of provider accounts.

Name your provider and select a default region

Launch a New App

Go to the home page of your Nanobox dashboard and click the "Launch New App" button. Select your Vultr provider from the dropdown and choose the region in which you'd like to deploy your app.

Select your Vultr provider

Confirm and click "Let's Go!" Nanobox will order a VC2 instance under your Vultr account. When the instance is up, Nanobox will provision platform components necessary for your app to run:

  • Load-Balancer: The public endpoint for your application. Routes and load-balances requests to web nodes.
  • Monitor: Monitors the health of your server(s) and application components.
  • Logger: Streams and stores your app's aggregated log stream.
  • Message Bus: Sends app information to the Nanobox dashboard.
  • Warehouse: Storage used for deploy packages, backups, etc.

Once all the platform components are provisioned and running, you're ready to deploy your app.

Stage Your App Locally

Nanobox provides "dry-run" functionality that simulates a full production deploy on your local machine. This step is optional, but recommended. If the app deploys successfully in a dry-run environment, it will work when deployed to your live environment.

nanobox deploy dry-run

More information about dry-run environments is available in the Dry-Run documentation.

Deploy

Add Your New App as a Remote

From the root of your project directory, add your newly created app as a remote.

nanobox remote add app-name

This connects your local codebase to your live app. More information about the remote command is available in the Nanobox Documentation.

Deploy to Your Live App

With your app added as a remote, you're ready to deploy.

nanobox deploy

Nanobox will compile and package your application code, send it up to your live app, provision all your app's components inside your live VC2 instance, network everything together, and BOOM! Your app will be live on Vultr.

Manage & Scale

Once your app is deployed, Nanobox makes it easy to manage and scale your production infrastructure. In your Nanobox dashboard you'll find health metrics for all your app's instances/containers. Your application logs are streamed in your dashboard and can be streamed using the Nanobox CLI.

Although every app starts out on a single VC2 instance with containerized components, you can break components out into individual servers and/or scalable clusters through the Nanobox dashboard. Nanobox handles the deep DevOps stuff so you don't have to. Enjoy!

Posted in PHP, Vultr, Phalcon, Deployment