Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/iamseth/saltstack-vulcan
Formula build tool for SaltStack.
https://github.com/iamseth/saltstack-vulcan
build devops-tools python saltstack saltstack-formula
Last synced: about 19 hours ago
JSON representation
Formula build tool for SaltStack.
- Host: GitHub
- URL: https://github.com/iamseth/saltstack-vulcan
- Owner: iamseth
- License: mit
- Created: 2017-04-03T18:42:22.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-07-02T19:51:41.000Z (about 5 years ago)
- Last Synced: 2024-09-14T01:50:24.598Z (11 days ago)
- Topics: build, devops-tools, python, saltstack, saltstack-formula
- Language: Python
- Size: 25.4 KB
- Stars: 6
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# saltstack-vulcan
Vulcan is a formula build tool for SaltStack. The idea is to assemble formulas from remote Git repositories to create an atomic 'build' for deployment.
SaltStack has a native [package manager](https://docs.saltstack.com/en/latest/topics/spm/) which is a system package manager (SPM). It assembles formulas from remote locations but is geared towards assembling on the Salt master itself and requires extra metadata.
Salt is also capable of loading formulas from Git using a [fileserver_backend](https://docs.saltstack.com/en/latest/ref/configuration/master.html#std:conf_master-fileserver_backend) however this too is geared towards assembly on the host itself.
The goal of this project is to make it easy to assemble formulas from Git repositories during a build stage running on something like Jenkins. After assembly, all files can be delivered to Salt master(s) in an atomic way. This makes it easier to keep multiple masters sync'd and Docker based Salt master deployments easier.
## Installation
```bash
sudo pip install saltstack-vulcan -U
```
## Configuration
Configuration is handled by a local YAML file. By default, $PWD/vulcan.yaml is used. An alternative path can be set with the --config flag.
Formula configuration is stored as a list of dictionaries. Each formula has the following attributes. Only 'name' and 'url' are required however it is best practice to set the branch and revision as well.
- **name**: A name for the formula for example 'apache' or 'mysql'. This is required.
- **url**: Git URL for the project. This is required.
- **branch**: Name of branch for checkout. Defaults to 'master'.
- **revision**: Git revision to use. If this does not exists, an exception will be thrown. Defaults to 'HEAD'.
- origin_name**: If renaming a formula, the origin_name of the formula must be used to determine the change. Defaults to value of 'name' if not set.
- **install_directory**: Directory to install formula into. Defaults to ./formulas.
### Example vulcan.yaml
```yaml
formulas:
- name: bind
url: https://github.com/saltstack-formulas/bind-formula
branch: master
revision: 29662c0f0452a48e1004038b6a3190b46fc4ed0b
- name: docker
url: https://github.com/saltstack-formulas/docker-formula
branch: master
revision: 0bff590b7bdd9568140c9693ca6e8b6fb4731408
- name: vpn
origin_name: openvpn
url: https://github.com/saltstack-formulas/openvpn-formula
branch: master
revision: b51cd17524cac79274c883bc381f0ba07edff3c7
install_directory: formulas
- name: jenkins
url: https://github.com/saltstack-formulas/jenkins-formula
branch: jenkins_plugins
revision: 407118135d59aa6577085b0570034341fe5f038a
```
## Usage
```bash
Usage: vulcan [OPTIONS] COMMAND [ARGS]...
Formula build tool for SaltStack.
See https://github.com/iamseth/saltstack-vulcan for documentation.
Options:
--debug Enables debug mode.
--config PATH Configuration file path. Defaults to ./vulcan.yaml.
--version Show the version and exit.
--help Show this message and exit.
Commands:
install Install all non-installed formulas.
update Update or install formulas.
```