Zap
A simple cross-platform orchestration and configuration management tool.
The main goal for Zap is to a simple mechanism for managing groups of computers with varying configurations and needs. Zap accomplishes this with "tasks" which can be composed into "plans" or run standalone. These tasks can be collections of scripts or a statically linked binaries, which will be pushed to the target machine(s) and executed.
Zap borrows ideas from Puppet Bolt. but leaves some of the Puppet-based legacy from Bolt behind.
Getting Started
Zap is still very early in its development, but if you would like to give it a try you can install it via Rustโs cargo command: cargo install zap-cli.
cargo install zap-cli
mkdir my-zap-project
cd my-zap-project
wget https://github.com/rtyler/zap/archive/v0.1.1.tar.gz
tar -zxvf v0.1.1.tar.gz zap-0.1.1/tasks -C tasks --strip=1
cat > hello.zplan <<EOF
task 'tasks/echo.ztask' {
msg = 'Show them my medal Kif'
}
EOF
You will also need to create an inventory file.
groups: []
targets:
- name: alpha
uri: 192.168.1.1
config:
ssh:
user: root
password: root
config:
transport: ssh
Once this has been set up, you can run:
zap plan hello.zplan -t alpha --dry-run
Command Line
The zap command line interface has a number of subcommands that can help with the development and deployment of tasks and plans.
cmd
check
plan
task
Examples
โฏ zap task tasks/echo.ztask -p msg="Hello World" -t zap-freebsd
Running task with: TaskOpts { task: "tasks/echo.ztask", parameter: ["msg=Hello World"], targets: "zap-freebsd" }
Hello Worldโฏ zap plan ./examples/basic.zplan -t zap-freebsd
Running plan with: PlanOpts { plan: "./examples/basic.zplan", targets: "zap-freebsd" }
Hello from the wonderful world of zplans!
This is niceTask
A task is a simple container of some form of execution. Typically this will be a wrapped shell/ruby/python script which does some specific piece of functionality. Tasks may also take parameters, which allow for some pluggability of new values.
Tasks have some default parameters that should not be overridden in new task definitions.
| Parameter | Description |
|---|---|
|
A relative or absolute path to a file that the task provides. If the file exists, then the task will be skipped. |
|
A script snippet which can determine whether the task should execute. A non-zero exit status causes the task to execute. |
task Echo {
parameters {
msg {
required = true
help = 'String to echo back to the client'
type = string
}
}
script {
inline = 'echo {{msg}}'
}
}Plan
A plan is a collection of tasks which can be applied to a target or targets. Tasks are referenced with the parameters that should be passed into them, and will be executed in the order that they are defined.
task 'tasks/echo' {
msg = 'Hello from the wonderful world of zplans!'
}
task 'tasks/echo' {
msg = 'This is nice'
}Built-in Tasks
Zap comes with a number of tasks that are built into zap itself. These can be referenced in the task declarations in plans via the zap:// URL.
sh
The sh task will execute the given script via /bin/sh on the target.
task 'zap://sh' {
script = '''
pwd
echo ${SHELL}
'''
}| Name | Required | Description |
|---|---|---|
|
yes |
A shell script |
|
no |
When this file is present indicates that the script should not be re-run |
|
no |
When this script returns zero exit status, the script should not be re-run |
5 May 2, 2024
218 Dec 30, 2022
7 Nov 23, 2022
722 Dec 27, 2022
2.1k Jan 1, 2023
6 Nov 3, 2022
51 Jun 7, 2022
13 Oct 10, 2021
8 Mar 13, 2023
4 Aug 31, 2023
2 May 22, 2022
264 Dec 30, 2022
2.2k Dec 30, 2022
3 Dec 16, 2022
1 Oct 19, 2021
24 Dec 13, 2023
17 Feb 9, 2023
2.4k Dec 27, 2022
232 Jan 2, 2023
264 Dec 30, 2022
3 Nov 28, 2022
7 Apr 15, 2022
14 Aug 12, 2022
48 Dec 18, 2022
1.8k Jan 9, 2023
20 Dec 16, 2022
33 Jul 4, 2022
13 Dec 30, 2022