README
¶
sail
sail is an operation framework based on Ansible/Helm. sail follows the principles of Infrastructure as Code (IaC), Operation as Code (OaC)，and Everything as Code. So it is a tool for DevOps.
sailis especially suitable for the privatization delivery of software products.
Although sail strongly utilizes Ansible and Helm, sail does not write the ansible tasks or helm chart templates for you. It's still your responsibility to develop ansible tasks and helm templates files.
Ansibleis for deploying to normal servers.Helmis for deploying to Kubernetes.
Product and Target and Package
sail has three main concepts: Product, Target, and Package
Product
Product is a specific software product. It is composed of components.
A Product can be simple and small with just several components, or can be big and complex with hunderds of components.
When you are responsible for managing and operating a software product, you should prepare the product operation code. The operation code of a product is not the functional code that written by product developers. It is code that direct the operators to install and manage the product.
Target
Target represents the environment where the product softwares are installed and run.
In sail, we used two hierarchies to arrange environments.
The two hierarchies are:
targetzone
A zone must be created under a specific target and there can be multiple zone(s) under a target. The target(s) are totally isolated from each other in sail.
Package
Package(s) are real software artifacts. They are normally compressed in some format, like .rpm, .tar.gz, .gzip ....
Use sail
Generally, you run sail on a centralized machine (deploy machine).
# Download sail binary file
# Move sail binary file to a $PATH directory
$ mv sail /usr/local/bin/
$ chmod +x /usr/local/bin/sail
The sail command uses three directories to do its job.
- products-dir Store the operation code of product(s).
- targets-dir Store the environment informations.
- packages-dir Store package files.
You can specify them by command line options when running sail, like:
$ sail --products-dir /path/to/products --targets-dir /path/to/targets --packages-dir /path/to/packages <subcommand>
You can also set them in ~/.sailrc.yaml file to avoid typing them every time.
# cat ~/.sailrc.yaml
products-dir: /path/to/products
targets-dir: /path/to/targets
packages-dir: /path/to/packages
Note, these three directories can be located at different places (that is not under a same parent dir).
The
products-dircontains all operation code of products(s). You should put your specific<productName>dir underproducts-direven if you only have one product. Normally, the content of products dir should be managed by git.
The
targets-dirkeeps all configurations of environments. This dir should exists on the deploy machine.
The
packages-dirholds all package files. You can create recursive directories under it to store any files.
To use sail to do operation, you need to understand how to declare product and how to define the component(s) that make up of the product.
Why use sail
Using sail, you can change the operations of any products into the following commands:
# Create a target environment (target/zone)
$ sail conf-create -t <targetname> -z <zonename> \
-p <productname> \
--hosts <hosts-for-components> \
--hosts <hosts-for-components> \
...
# Deploy
$ sail apply -t <targetname> -z <zonename>
# Upgrade specific components
$ sail upgrade -t <targetname> -z <zonename> \
-c <componentName1>/<componentVersion1> \
-c <componentName2>/<componentVersion2>
Directories