Ruby on Rails Quickstart

This guide requires that you have:

  • An Aptible account
  • An SSH key associated with your Aptible user account
  • The Aptible Toolbelt installed

1. Provision Your App

Tell the Aptible API that you want to provision an application. Until you push code and trigger a build, Aptible uses this as a placeholder.

Use the apps:create command: aptible apps:create $APP_HANDLE

For example:

1
aptible apps:create rails-quickstart

2. Add a Git Remote

Add a Git remote named “aptible”:

1
git remote add aptible git@beta.aptible.com:$ENVIRONMENT_HANDLE/$APP_HANDLE.git

For example:

1
git remote add aptible git@beta.aptible.com:test-env/rails-quickstart.git

3. Add a Dockerfile and a Procfile

A Dockerfile is a text file that contains the commands you would otherwise execute manually to build a Docker image. Aptible uses the resulting image to run your containers.

A Procfile explicitly declares what processes we should run for your app.

A few guidelines:

  1. The files should be named “Procfile” and “Dockerfile”: One word, initial capital letter, no extension.
  2. Place both files in the root of your repository.
  3. Be sure to commit them to version control.

Here is a sample Dockerfile for a conventional Rails app:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
  # Dockerfile
  FROM quay.io/aptible/ruby:2.3

  RUN apt-get update && apt-get -y install build-essential

  # System prerequisites
  RUN apt-get update && apt-get -y install libpq-dev

  # If you require additional OS dependencies, install them here:
  # RUN apt-get update && apt-get -y install imagemagick nodejs

  # Add Gemfile before rest of repo, for Docker caching purposes
  # See http://ilikestuffblog.com/2014/01/06/
  ADD Gemfile /app/
  ADD Gemfile.lock /app/
  WORKDIR /app
  RUN bundle install

  ADD . /app
  RUN bundle exec rake assets:precompile

  ENV PORT 3000
  EXPOSE 3000

Here is a sample Procfile for a Ruby on Rails app:

1
2
# Procfile
web: bundle exec rails s -b 0.0.0.0 -p $PORT

4. Provision and Connect a Database

By default, aptible db:create $DB_HANDLE will provision a 10GB PostgreSQL database.

aptible db:create will return a connection string on success. The host value is mapped to a private subnet within your stack and cannot be used to connect from the outside Internet. Your containerized app can connect, however.

Add the database connection string to your app as an environment variable:

1
aptible config:set DATABASE_URL=$CONNECTION_STRING

To connect locally, see the aptible db:tunnel command.

Most Rails applications need to run database migrations as part of their setup. Create an .aptible.yml to run migrations automatically when the app is deployed in the next step.

1
2
before_release:
  bundle exec rake db:migrate

5. Deploy Your App

Make sure your code is committed, then push to the master branch of the Aptible Git remote:

1
git push aptible master

Deploy logs will stream to your terminal.

6. Add an Endpoint

To expose your app to the Internet, you’ll want to add an HTTPS Endpoint. In the Aptible dashboard, select your app, then open the “Endpoints” tab.

  1. Service: Select the app service you want to expose (often a web service).
  2. Endpoint type: The quickest option is request a default *.on-aptible.com endpoint address, which will serve the *.on-aptible.com wildcard certificate. With a custom endpoint, you provide a certificate and key for a domain of your choice.
  3. Type: External endpoints are exposed to the Internet, meaning their endpoint addresses resolve to public IP addresses. Internal endpoints receive private IP addresses and are only routable from within your stack.
  4. Save the endpoint, wait for it to provision (usually 2-15 minutes), then test the endpoint address. To test internal endpoints, you can aptible ssh into your app to spin up an ephemeral container, then curl your internal endpoint.

On each subsequent deploy, the Aptible platform will perform a health check on any service with an endpoint. For HTTPS Endpoints, the health check involves making an HTTP request and listening for any response. The service is considered healthy if it responds, regardless of the response status code. Deploys that fail their health checks will not be released.