Sonatina

Sonatina is an infrastructure as code framework based on Terraform, that adds some useful functionality to organize and work with terraform modules and variables in an opinionated way.

The key features of Sonatina are:

• Based on Hashicorp Terraform (Opensource version).

Warning: private repository are not supported yet, but it will very soon.

Concepts

• Code Tree Definition (CTD): file and directory structure of HCL code standarized by Sonatina. It allows combination with other CTDs to enable the addition of plugins.
• Variables Tree Definition (VTD): variable file structure that allows the identification of them by kind, enabling priorization.
• Deployment: concrete infrastructure to be managed based on the code defined on CTDs.
• Modules: are the Terraform modules that describes the infraestructure.
• Code repository: GIT repository where the code that defines the infrastructure is stored.
• State repository: GIT repositiory where state and variables of a specified deployment are stored.
• Workdir: temporal folder where Sonatina merges all CTDs that will be applied before passing them to Terraform.
• Variables: terraform variables for the infrastructure. In Sonatina, three kind of variables are defined: config, flavour and static. Config variables can be customized for each deployment. Flavour variables defines the size of the infrastructure components. Static variables are linked to the infrastructure version, and tipically defines the software version to be used.
• State: file that registers the current state of Terraform managed infrastructure. Each component (global or user component) will have its own state file.
• User component: set of resources that are deployed specifically for an user. Multiple of them can be created on each deployment. The resources that doesn't belong to a specified user are part of the global component.
• Flavour: identifies a set of variables that will be used on the deployment. Usually this set are used to define de infrastructure size, allowing the use of flavours with more or less resources.
• Plugins: are CTDs that, combined with the base code CTD, can increment or modify the infrastructure features.

Getting Started

Get sonatina

Using sonatina is easy. First, clone the repository:

git clone https://github.com/arodriguezdlc/sonatina.git

Sonatina uses native Go Modules to manage dependencies, so you only have to execute go build and every dependencies will be fetched for you

cd sonatina
go build 

As result, you will have a sonatina binary ready to work. Optionally, you can move it to a directory in your $PATH:

mv sonatina /usr/local/bin/

Create your first deployment

Sonatina stores deployment state, variables and metadata on a git repository. For this example we are going to create a local repository, but you also could create one on github for example. Let's assume we hace created this repo: https://github.com/arodriguezdlc/sonatina-example-local-docker-storage.git

Also we need a repository with the Terraform code we are going to deploy. We are going to use an example repository

Finally, we can create the deployment with the following sonatina command:

sonatina create deployment example-local-docker -s https://github.com/arodriguezdlc/sonatina-example-local-docker-state.git -c https://github.com/arodriguezdlc/sonatina-example-local-docker.git

You can see the created deployment with:

sonatina list deployments

Now we can start working with deployment variables:

sonatina init
sonatina edit

Let's assign a name for your deployment (the required variable), and deploy it:

sonatina apply

And this is all! You have deployed a local docker with a http server listening to the 8080 port. Using variables you can customize other configurations like the port or the sentence that is being shown.

This has been a global deployment but you can deploy one customized server for a specific client. Let's do that creating an user component:

sonatina create usercomponent my-special-client
sonatina init -c my-special-client

Let's specify a custom sentence ("Hello my special client") for him editing the sentence variable. In addition, modify the port variable to 8081 to avoid port conflict with global component.

sonatina edit

And finally, apply changes:

sonatina apply -c my-special-client

Cleanup

To perform the undeploy, you simply have to execute a sonatina destroy command:

sonantina destroy -c my-special-client
sonatina destroy

Also you can delete the deployment from Sonatina. Note that this operation won't delete the storage repository, so you recover by cloning it.

sonantina delete deployment example-local-docker