https://github.com/seashell/agent
Seashell device synchronization agent
https://github.com/seashell/agent
Last synced: 4 months ago
JSON representation
Seashell device synchronization agent
- Host: GitHub
- URL: https://github.com/seashell/agent
- Owner: seashell
- License: apache-2.0
- Created: 2021-02-18T14:03:40.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-03-05T17:50:34.000Z (over 4 years ago)
- Last Synced: 2024-12-27T03:11:58.932Z (6 months ago)
- Language: Go
- Homepage:
- Size: 82 KB
- Stars: 2
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# agent
The Seashell Agent
------------------
Agent meant for executing on edge devices and synchronizing their configurations with those defined in the Seashell Platform.
## Requirements
- Golang 1.16+
## Usage
```bash
seashell agent --config=
```
An example configuration can be found in `/dist/seashell.hcl`
## Overview
## Supported modules
## Configuration
- `log_level` :
- `name` : Device name for identifying it in Nomad and Consul
- `data_dir` :
## API
The Seashell agent exposes a simple REST API that allows for simple system information queries.
- `GET /status` :reports modules' `systemd` services current active state and substate.
Sample response:
```bash
$ curl -X GET localhost:5345/status
Nomad: active running
Consul: failed failed
```
#### Coming soon :clock1:
`TODO`
## Contributing
- Fork it
- Download your fork (git clone https://github.com/your_username/agent && cd agent)
- Create your feature branch (git checkout -b my-new-feature)
- Make changes and stage them (git add .)
- Commit your changes (git commit -m 'Add some feature')
- Push to the branch (git push origin my-new-feature)
- Create new pull request
## Roadmap
- [ ] Code coverage
## License
The Seashell Agent is released under the Apache 2.0 license. See LICENSE.txt