https://github.com/teatak/riff
Riff is a tool for service discovery and configuration auto update service from github or gitlab
https://github.com/teatak/riff
autoupdate ci daemon github gitlab golang service-discovery
Last synced: 4 months ago
JSON representation
Riff is a tool for service discovery and configuration auto update service from github or gitlab
- Host: GitHub
- URL: https://github.com/teatak/riff
- Owner: teatak
- License: mit
- Created: 2021-03-14T11:00:09.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2025-09-26T02:44:51.000Z (9 months ago)
- Last Synced: 2025-09-26T04:27:45.168Z (9 months ago)
- Topics: autoupdate, ci, daemon, github, gitlab, golang, service-discovery
- Language: Go
- Homepage:
- Size: 23.2 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# riff
Riff is a tool for service discovery and configuration.
* Service Discovery
* Health Checking
* Web console
## Quick Start
If you wish to work on Riff, you'll first need Go installed (version 1.9+ is required).
If you need Web Console, you'll need npm installed dependencies
Next clone this repository and build Riff or download from [release](https://github.com/teatak/riff/releases)
```bash
make
./riff -v
```
## Commands(CLI)
```bash
$ ./riff
Usage: riff [--version] []
Available commands are:
daem Run Riff as service
query Query
quit Quit Riff
reload Reload Riff config
restart Restart service
run Run Riff
start Start service
stop Stop service
update Update Riff
version Prints the Riff version
```
### run
run Riff
```bash
$ ./riff run -h
Usage: run [options]
Run riff service
Options:
-name Node name
-dc DataCenter name
-http Http address of riff (-http 127.0.0.1:8610)
-rpc RPC address of riff (-rpc [::]:8630)
-join Join RPC address (-join 192.168.1.1:8630,192.168.1.2:8630,192.168.1.3:8630)
```
## API
### graphql
> POST /api
you can use explorer in Web console to discover api
```graphql
{
service(name: "mongod") {
name
nodes {
name
}
}
}
```
```bash
curl --request POST \
--url http://localhost:8610/api \
--header 'content-type: application/json' \
--data '{"query":"{\n service(name: \"mongod\") {\n name\n nodes {\n name\n }\n }\n}\n"}'
```
### logs
> GET /api/logs
watch logs
```bash
curl --request GET \
--url http://localhost:8610/api/logs
```
### watch
> POST /api/watch?name={watchName}&type={node|service}
watch node or service
```bash
curl --request POST \
--url 'http://localhost:8610/api/watch?type=service&name=mongod' \
--header 'content-type: application/json' \
--data '{"query":"{\n service(name: \"mongod\") {\n name\n nodes {\n name\n }\n }\n}\n"}'
```
## Web Console
> http://localhost:8610
## Service Config
config files in config/*.yml
ping.yml config file
```yaml
#name: service name
#port: service port
#env:
# - CART_MODE=release
#command:
# - ./home/cartdemo/cartdemo
#pid_file: ./home/cartdemo/cartdemo.pid
#std_out_file: ./home/cartdemo/logs/out.log
#std_err_file: ./home/cartdemo/logs/err.log
#grace: true
#run_at_load: false
#keep_alive: false
#deploy:
# service_path: (service path e.g /home/riff)
# provider: github (only support github gitlab)
# token: Personal access tokens (visit https://github.com/settings/tokens or https://gitlab.com/profile/personal_access_tokens and generate a new token)
# repository: repository address (https://github.com/teatak/cartdemo)
# version: branchName (e.g branch:master), latest release (e.g release:latest or tag:latest）,or (content:master:version.txt txt content is download url or version)
# payload: payload url when update success
name: ping
env:
- CART_MODE=release
command:
- ping
- 192.168.3.1
grace: false
run_at_load: true
```