https://github.com/airbnb/gosal
A Sal client written in Go
https://github.com/airbnb/gosal
Last synced: about 1 month ago
JSON representation
A Sal client written in Go
- Host: GitHub
- URL: https://github.com/airbnb/gosal
- Owner: airbnb
- License: apache-2.0
- Created: 2017-05-22T23:48:12.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2023-10-25T11:15:15.000Z (almost 2 years ago)
- Last Synced: 2025-08-29T06:33:20.518Z (about 1 month ago)
- Language: Go
- Homepage:
- Size: 126 KB
- Stars: 35
- Watchers: 9
- Forks: 21
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Gosal (sal-client)
_Due to major changes in Sal4's checkin method, people who run Sal3 should checkout the Sal3 branch and build from there._
## Overview
Gosal is intended to be a multi platform client for sal, Gosal does not provide a complete 1-2-1 mapping of reporting info compared to Sal for macOS PRs are welcome.
## Getting Started
Your configuration file should be `json` formatted as follows:
```json
{
"key": "your gigantic machine group key",
"url": "https://urltoyourserver.com",
"management": {
"tool": "puppet",
"path": "C:\\Program Files\\Puppet Labs\\Puppet\\bin\\puppet.bat",
"command": "facts"
}
}
```
# Running gosal
Gosal requires the configuration file to be passed in as an argument like so...
#### Windows Example
`gosal.exe --config "C:\path\to\config.json"`
# Building Sal3
To build the project after cloning:
```
make deps
make build
```
Gosal OS specific binaries will be added to the `build/` directory.
# Building Sal4
Sal4 (master) is switching to go.mod!
## Dependencies
Gosal uses [go-modules](https://blog.golang.org/using-go-modules) to manage external dependencies. Run `make deps` to install/update the required dependencies.
After adding a new dependency, run `mod verify` & `go mod tidy`, which will update the mod.go & mod.sum file.
## Formatting your code
Go has an exceptional formatter - please use it!
```
gofmt -s -w *.go
gofmt -s -w ./*/*.go
```