Deploying multiple apps with different versions using a single Ansible command

Problem description

In this article, we will look at how to deal with the following scenario. Our system consists of several applications. Let’s imagine we need to deploy some (or all) of those apps with a single command. We also need to specify a common version for all apps or different versions for each app. The desired command could look like this:

ansible-playbook -i prod app-1.yml app-2.yml app-3.yml -e app_1_version=1.2.3 -e app_version=3.2.1

Such a command should result in the installation of app1 in version
1.2.3 and remaining apps in version 3.2.1.

The main difficulty here is that we use the same tasks (e.g. common role) for deploying all apps, so the app version variable is dynamic. Additionally, our app names can contain dashes (which is an invalid character in variable names) so we need to replace it with an underscore.

How to get a dynamic variable

First things first. We need to have access to all variables if the names of those variables are dynamic. Variables must be passed in a form that allows us to retrieve their value using a dynamic variable name. This is where a vars variable comes to the rescue.

vars is a special variable in the form of a dictionary, where we can get a specific value using the syntax of vars[key]. Now, if we have our app name in a variable app_name we can get that variable using the syntax vars[app_name | replace('-', '_') + '_version']. Alternative syntax for this is lookup('vars', app_name | replace('-', '_') + '_version'), but the first one is more pleasant to us. Anyway, not bad, is it?

Default app version

Here comes our additional requirement – a default app version. That’s
a piece of cake – we just have to check if a variable is defined and
take the default version, right? Both solutions above come with some
default support.

vars[spring_app_name | replace('-', '_') + '_version'] | default(app_version) }}
lookup('vars', spring_app_name | replace('-', '_') + '_version', default = app_version)

All we need to do now is to register it in a fact (like
target_app_version) and we are good to go. This is not very
readable though, with all those braces and filters. Can we do it
better?

Custom filter plugin

We can create our custom filter plugin. Let’s see the usage first and focus on the implementation afterwards. In order to get the app version using a custom filter, we can use
something like this:

app_name | ver(vars)

To create a filter, we must add it in the folder filter_plugins of our role. Filters are written in python, so let’s add the following content to ROLE_NAME/filter_plugins/ver.py:

class FilterModule(object):
    def filters(self):
        return {
            'ver': self.ver
        }

    @staticmethod
    def ver(app_name, vars):
        app_name_version = app_name.replace('-', '_') + '_version'
        if app_name_version in vars:
            return vars[app_name_version]
        elif 'app_version' in vars:
            return vars['app_version']
        else:
            raise Exception('No ' + app_name_version + ' or app_version defined')

This solution also has an additional advantage – it raises a meaningful and descriptive error, which is much better than in previous solutions.

Summary

What we achieved is the ability to retrieve the app version from the command line parameter even if multiple apps were deployed at once. Additionally, we are able to specify the default version if a specific version for the app is not defined. Finally, we simplified playbooks code by moving complicated formulas to a custom plugin, providing a descriptive error as well.

You May Also Like

Log4j and MDC in Grails

Log4j provides very useful feature: MDC - mapped diagnostic context. It can be used to store data in context of current thread. It may sound scary a bit but idea is simple.

My post is based on post http://burtbeckwith.com/blog/?p=521 from Burt Beckwith's excellent blog, it's definitely worth checking if you are interested in Grails.

Short background story...


Suppose we want to do logging our brand new shopping system and we want to have in each log customer's shopping basket number. And our system can be used at once by many users who can perform many transactions, actions like adding items and so on. How can we achieve that? Of course we can add basket number in every place where we do some logging but this task would be boring and error-prone. 

Instead of this we can use MDC to store variable with basket number in map. 

In fact MDC can be treated as map of custom values for current thread that can be used by logger. 


How to do that with Grails?


Using MDC with Grails is quite simple. All we need to do is to create our own custom filter which works for given urls and puts our data in MDC.

Filters in Grails are classes in directory grails-app/conf/* which names end with *Filters.groovy postfix. We can create this class manually or use Grails command: 
grails create-filters info.rnowak.App.Basket

In result class named BasketFilters will be created in grails-app/conf/info/rnowak/UberApp.

Initially filter class looks a little bit empty:
class BasketFilters {
def filters = {
all(controller:'*', action:'*') {
before = {

}
after = { Map model ->

}
afterView = { Exception e ->

}
}
}
}
All we need to do is fill empty closures, modify filter properties and put some data into MDC.

all is the general name of our filter, as class BasketFilters (plural!) can contain many various filters. You can name it whatever you want, for this post let assume it will be named basketFilter

Another thing is change of filter parameters. According to official documentation (link) we can customize our filter in many ways. You can specify controller to be filtered, its actions, filtered urls and so on. In our example you can stay with default option where filter is applied to every action of every controller. If you are interested in filtering only some urls, use uri parameter with expression describing desired urls to be filtered.

Three closures that are already defined in template have their function and they are started in these conditions:

  • before - as name says, it is executed before filtered action takes place
  • after - similarly, it is called after the action
  • afterView - called after rendering of the actions view
Ok, so now we know what are these mysterious methods and when they are called. But what can be done within them? In official Grails docs (link again) under section 7.6.3 there is a list of properties that are available to use in filter.

With that knowledge, we can proceed to implementing filter.

Putting something into MDC in filter


What we want to do is quite easy: we want to retrieve basket number from parameters and put it into MDC in our filter:
class BasketFilters {
def filters = {
basketFilter(controller:'*', action:'*') {
before = {
MDC.put("basketNumber", params.basketNumber ?: "")
}
after = { Map model ->
MDC.remove("basketNumber")
}
}
}
}

We retrieve basket number from Grails params map and then we put in map under specified key ("basketNumber" in this case), which will be later used in logger conversion pattern. It is important to remove custom value after processing of action to avoid leaks.

So we are putting something into MDC. But how make use of it in logs?


We can refer to custom data in MDC in conversion patter using syntax: %X{key}, where key is our key we used in filter to put data, like:
def conversionPattern = "%d{yyyy-MM-dd HH:mm:ss} %-5p %t [%c{1}] %X{basketNumber} - %m%n"


And that's it :) We've put custom data in log4j MDC and successfully used it in logs to display interesting values.