How I Used Serverless Infrastructure to Build a Large-Scale Petition System
An example web app using OpenWhisk and Cloudant
Is it possible to create a web application that collects data from a web form without using any servers? Of course not, but you would be forgiven for thinking that when reading the word “serverless”. “Serverless” means that instead of having fixed numbers of dedicated machines sitting in data centres waiting for traffic to come in, we can supply the code that handles a single piece of work (e.g. the submission of a web form) to an application framework like IBM OpenWhisk and let it scale out the computing power required. If no traffic arrives, you don’t pay anything — no fixed costs!
Let’s take an example. In the UK, there is a government petitions website where members of the public can gather support for issues they would like debated in the House of Commons. Recently, over 1.8m signatures were collected on a petition urging the government to rescind Donald Trump’s state visit invitation.
If you were building an IT system to collect large-scale public petitions, you would have no idea how popular each was going to be or how much computing power you’d need to make the site performant. The “serverless” paradigm is compelling in this use-case, as you only pay for the traffic you generate.
Let’s build a large-scale petition system
Modelling our system on the UK model, our petition system would have a public-facing website with a simple form detailing the issue being “signed”. The user supplies their name, location, email address, confirms that they are a resident of the country in question, and submits the form. Our app saves the data in a Cloudant database and sends a verification email to the signatory.
When the email arrives, the user clicks on the link to confirm and sign the petition
At some future date, we can count the confirmed records in the database to see if the petition has reached the 100,000 records needed to trigger a debate in parliament.
We want our whole infrastructure to be “serverless” i.e. we won’t stand up our own servers to run the website — the hosting, form handling, email sending, and database will be run by others with minimal or ideally no fixed costs.
I already built this solution (spoiler alert!), and you can find all the code in my online-petition repo on GitHub. To help you understand what’s possible, I’ll give a quick, high-level explanation of the architecture, technologies, and how it all works together.
gh-pages branch. Your website will be served out at
http://USERNAME.github.io/REPO/. You can even point your custom domain name to GitHub and it serves out your pages on that domain e.g.
Serverless transactional email
In order to send emails to signatories, you need a transactional email service. I set up an email template with placeholders for the content that changes between recipients. The email provider ensures that the emails are sent, avoiding each users’ spam filter. I used SendGrid because they let you send a templated email via a simple API call.
Serverless database storage
Ultimately we need to store our data somewhere. So someone is going to have to manage some servers and disks. By using the Cloudant database-as-a-service, we don’t have to have fixed servers dedicated to us; we can simply consume a database service on a shared cluster and pay only for the requests and storage that we use.
Designing our data flows
OpenWhisk computing tasks are built up from actions. You can combine many actions into sequences of actions and activate them with incoming data (such as an API call).
Create two API calls that activate OpenWhisk computing resources:
POST /petition/submit- to verify a form submission, save the data to Cloudant, and dispatch the email.
POST /petition/confirm- to confirm that the user has clicked on a link from the email. Another GitHub pages page renders on the browser, which makes an API call to OpenWhisk. The database record updates to mark the signature as "confirmed".
POST /petition/submit is actually three separate OpenWhisk actions chained in a sequence, whereas
POST /petition/confirm is configured as a single OpenWhisk action.
OpenWhisk uses IBM’s API Connect to map actions and action sequences to public-facing API calls.
Sign up for the services
Going serverless means you don’t have to deal with equipment, virtual servers, operating systems or networking, but you still have to sign up for some accounts:
- sign up for an IBM Bluemix account
- follow Getting started with OpenWhisk to get the
wsktool installed and authenticated
- inside Bluemix, sign up for a Cloudant service. Make a note of the Cloudant URL, including username and password.
- setup a SendGrid account, create an API key that has permissions to send transactional emails and create an email template
- create a Github repository with your web site in it and branch to a
Deploying OpenWhisk code
OpenWhisk has nice dashboard where you can paste your code, build sequences, and try your code. This is fine when taking your first few steps with OpenWhisk but very soon you’ll want to script the deployment of your code so that it can be automated and reproduced easily.
Assuming you have the
wsk tool installed and it is authenticated against your Bluemix service, then installing our code is a breeze. Just clone the git repository https://github.com/ibm-cds-labs/online-petition.git and run the
deploy.sh script from the
This script assumes that you have the following environment variables set up:
COUCH_URL= the URL of the Cloudant service e.g.
COUCH_DBNAME= the name of the Cloudant database e.g. petition
SENDGRIDBEARER= the SendGrid API key
SENDGRIDSENDER= the email address that emails will appear to come from
SENDGRIDTEMPLATEID= the SendGrid email template id to email
It’s worth understanding each step in the deployment script. Notice how the credentials are encapsulated into a ‘package’ called ‘petition’ to which each of the actions is added. Then three of the actions are combined into a sequence before they are finally exposed as public API calls using the
api-experimental command. Each API call also has an 'OPTIONS' method - this is quirk of CORS restrictions (the rules that prevent a website from making API calls to other servers). We need the dummy 'OPTIONS' API call to convince the browser that the main 'POST' request is permitted.
Try it yourself
Who’s paying the bill?
So I have a totally “serverless” system with Github serving the static content, OpenWhisk handling the form submissions, SendGrid sending emails, and Cloudant storing the data. But is serverless free?
Not free — it’s pay-as-you-go.
- GitHub reserves the right to disable or throttle your site’s usage if your content is very popular
- SendGrid has a range of plans that start at free for the first month but typically allow you to send tens of thousands of emails from $10 per month.
- OpenWhisk has a free tier and then takes payment depending on the volume, memory, and execution time of your actions.
- Cloudant’s default Lite Plan offers a limited API call limit for free, or increased capacity for additional dollars per month.
So it’s possible to create something like this and run it for free for a while (until your free trial runs out!) and up to a certain amount of traffic (depending on whether you run out of hosting, email capacity, or database storage first).
The important point is that you can setup an IT system with $0 fixed costs, paying extra money to add extra capacity. OpenWhisk lets you scale your application to deal with spikes in traffic but have no fixed costs for when there is no demand.