"How we built Ruby PaaS - Part II: Gem and web interface"
This is the second post of the series on our blog, in which I'll present to you the part of our infrastructure that is visible to the users. Here you can find links to past and, when we publish them, future posts:
- Part I - Overview of the stack
- Part II - Gem and web interface
- Part III - API
- Part IV - Architecture, servers, and virtualization
Cloudfile & Git
Cloudfile is our solution to manage application environments, server layout, and services. Basically, it's a YAML file stored in the project's repository. We parse it during the deployment.
- Convention of a single file where you can always find server layout. A concept similar to Gemfile, Rakefile etc.
- Very easy to understand and manage. There is no problem when you need to add a new service like a new database or increase the number of servers.
- Cloudfile is included in a repository, so it's simple to track the history of infrastructure changes.
- Hard to implement a handy interface for auto-scaling (we plan to do that someday).
Deployment is handled by Git. Developer runs deployment and update code on remote machines by plain
push command. On our side, to make it work we don't use anything more than Git hooks. Repositories storage is replicated and backed up daily.
The main interface to interact with our platform is a CLI written in Ruby. We focus to allow customers to do everything from the shell. That's why we are called Shelly Cloud.
Our gem is named
shelly and hosted as many other gems on RubyGems, and it's open sourced.
Actions available in gem:
- Setting up user's account, clouds and organizations;
- Managing databases, file storage, backups, access to clouds, application logs, deployment logs, configuration files, IP endpoints;
- Cloud statistics;
- Application console and dbconsole (like mongoconsole or redis-cli);
- Connecting to virtual servers by SSH;
- Setting up a tunnel to database;
- Planning any maintenance.
Our gem is built on top of the Thor framework. It's good enough for our needs, but we wouldn't use it again. Anyway, we don't plan to rewrite the CLI now. The biggest issues which we had:
- Thor generates a wrong help message for subcommands
- Customers try to include our gem in Rails app Gemfile. Thor doesn't work well then. We have to validate that.
- Missing action hooks
Communication with API is managed by rest-client. We don't have any special feelings about this, it just works.
For test purposes, we use RSpec with the addition of fakefs gem which simulate a file system and fakeweb gem to mock web requests.
Web interface - shelly-app
Our web interface is a regular Rails application, running on the newest available version, 4.2.x. One specific thing is the lack of a database, everything is done with API. Shelly-app is hosted on Shelly Cloud itself.
We use web app to:
- Display landing page, pricing, documentation, contact details and blog
- Manage billing details
- Manage user account
- Start/stop clouds
- Display statistics
To manage external frontend libraries we use rails-assets.
In backend to communicate with the API we use a gem called her.
Our blog is built on top of the library called postmarkdown. We've added to it a custom implementation of the archive.
From external tools, we have integrated Intercom to manage emails and provide support. Swiftype to search documentation. New Relic for server monitoring. Fontello for custom font icons.
We have a handy set of tools for development. This is a list of libraries which we use daily: autoprefixer, quietassets, bettererrors, rack-livereload and guard-livereload.
Last but not least, popular nowadays is a set of tools to test our Rails app: RSpec, Jasmine and Capybara.