-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(README): Add basic info, install instructions & simple example
- Loading branch information
1 parent
1fe564a
commit 8d7f0b7
Showing
1 changed file
with
56 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,56 @@ | ||
# gobble | ||
# Gobble: Like Ansible but in Go | ||
|
||
## What is Gobble? | ||
|
||
Gobble is a config management tool like Ansible but written in Go. It is designed to be simple and easy to use. | ||
|
||
## Installation | ||
|
||
Mac | ||
|
||
``` | ||
brew install sikalabs/tap/gobble | ||
``` | ||
|
||
Linux | ||
|
||
``` | ||
curl -fsSL https://raw.githubusercontent.com/sikalabs/gobble/master/install.sh | sudo sh | ||
``` | ||
|
||
Using [slu](https://github.com/sikalabs/slu) | ||
|
||
``` | ||
slu install-bin gobble | ||
``` | ||
|
||
## Example Usage | ||
|
||
Create `gobblefile.yml` | ||
|
||
```yaml | ||
meta: | ||
schema_version: 2 | ||
hosts: | ||
all: | ||
- ssh_target: root@gobble-example.sikademo.com | ||
vars: | ||
msg: Gobble Gobble! | ||
plays: | ||
- name: Nginx Example | ||
hosts: [all] | ||
tasks: | ||
- name: Install Nginx | ||
apt_install: | ||
name: nginx | ||
- name: Create index.html | ||
templete: | ||
path: /var/www/html/index.html | ||
template: <h1>{{.Vars.msg}}</h1>{{ printf "\n" }} | ||
``` | ||
Run | ||
``` | ||
gobble run | ||
``` |