Skip to content

Commit 621fb2e

Browse files
Fabian Hollerfho
authored andcommitted
readme: extend introduction
1 parent 7de6795 commit 621fb2e

1 file changed

Lines changed: 13 additions & 2 deletions

File tree

README.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,19 @@
33
[![Go Report Card](https://goreportcard.com/badge/github.com/simplesurance/grpcconsulresolver)](https://goreportcard.com/report/github.com/simplesurance/grpcconsulresolver)
44
[![GoDoc](https://img.shields.io/badge/godoc-reference-blue.svg)](https://pkg.go.dev/github.com/simplesurance/grpcconsulresolver)
55

6-
The repository provides a consul resolver for the
7-
[GRPC-Go Package](https://github.com/grpc/grpc-go).
6+
The repository provides a [Consul](https://www.consul.io/) service resolver for
7+
the [grpc-go Package](https://github.com/grpc/grpc-go).
8+
9+
It uses uses [Blocking Queries](https://developer.hashicorp.com/consul/api-docs/features/blocking)
10+
to watch Service Catalog entries for changes. By default it only resolves to
11+
services with `passing` check status. It can be configured to fallback resolving
12+
to unhealthy services if no healthy ones are available.
13+
14+
Configuration is possible via the standard
15+
[Consul Environment
16+
Variables](https://developer.hashicorp.com/consul/commands#environment-variables)
17+
and via the target URI passed to
18+
[`grpc.Dial`](https://pkg.go.dev/google.golang.org/grpc#Dial).
819

920
To register the resolver with the grpc-go run:
1021

0 commit comments

Comments
 (0)