Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/outbrain/consult
Consul helper tool for quick query based SSH and more
https://github.com/outbrain/consult
Last synced: about 1 month ago
JSON representation
Consul helper tool for quick query based SSH and more
- Host: GitHub
- URL: https://github.com/outbrain/consult
- Owner: outbrain
- License: apache-2.0
- Created: 2015-12-29T14:56:47.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2016-02-04T21:36:39.000Z (almost 9 years ago)
- Last Synced: 2024-08-03T02:05:10.641Z (4 months ago)
- Language: Go
- Size: 34.2 KB
- Stars: 44
- Watchers: 21
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
- awesome-consul - consult: Consul helper tool for quick query based SSH and more
README
# Consult
Query Consul from the command line and SSH into a server from Consul catalog.
[](https://travis-ci.org/outbrain/consult)
## Building
```
go get -u github.com/outbrain/consult
```
## Using
`consult` needs to know where Consul's API is, this can be configured using the `CONSUL_URL` environment variable or the `--server` command line flag.
Run `consult -h` or `consult help` for a complete list of flags.
### Misc flags
* `--json`, `-j` - JSON output
* `--detailed`, `-d` - Print detailed results with header line
* `--dc=DC_NAME` - Datacenter to query, can be specified multiple times
* `--all-dcs` - Query all datacenters. Overrides the `--dc` flag
### Query subcommand
To list the node for service and tag:
```
consult query --service=my_awesome_service --tag=some_tag
```
Multiple tags - you can choose to match _any_ or _all_ tags. By default, all tags must be matched.
```
consult query -s my_awesome_service -t tag1 -t tag2 -m any
```
Multiple datacenter support
```
consult query -s service1 --dc dc1 --dc dc2
consult query -s service1 --all-dcs
```
`query` flags also work on `http` and `ssh` subcommands.
### ssh subcommand
```
consult ssh --service=my_awesome_service --tag=some_tag --username=joe
```
`--username` is optional of course
### http subcommand
Perform an HTTP request on endpoints returned from Consul query:
```
consult http -s service1 -t tag1 --all-endpoints --uri="/ping"
```
For other options check out `consul help http`
### List subcommands
```
consult list dc
consult list service --dc dc1 --dc dc2
consult list node -r '^ap.*a' # list node matching regex
```
## License
Apache V2