etcd

README

registry-etcd (This is a community driven project)

Some application runtime use etcd for service discovery.

How to use with Kitex server?

import (
    ...
    "github.com/cloudwego/kitex/pkg/rpcinfo"
    "github.com/cloudwego/kitex/server"
    etcd "github.com/kitex-contrib/registry-etcd"
    ...
)

func main() {
    ...
    r, err := etcd.NewEtcdRegistry([]string{"127.0.0.1:2379"}) // r should not be reused.
    if err != nil {
        log.Fatal(err)
    }
    // https://www.cloudwego.io/docs/tutorials/framework-exten/registry/#integrate-into-kitex
    server, err := echo.NewServer(new(EchoImpl), server.WithServerBasicInfo(&rpcinfo.EndpointBasicInfo{ServiceName: "echo"}, server.WithRegistry(r)))
    if err != nil {
        log.Fatal(err)
    }
    err = server.Run()
    if err != nil {
        log.Fatal(err)
    }
    ...
}

How to use with Kitex client?

import (
    ...
    "github.com/cloudwego/kitex/client"
    etcd "github.com/kitex-contrib/registry-etcd"
    ...
)

func main() {
    ...
    r, err := etcd.NewEtcdResolver([]string{"127.0.0.1:2379"})
    if err != nil {
        log.Fatal(err)
    }
    client, err := echo.NewClient("echo", client.WithResolver(r))
    if err != nil {
        log.Fatal(err)
    }
    ...
}

Authentication

server

package main

import (
    ...
	"github.com/cloudwego/kitex/server"
	etcd "github.com/kitex-contrib/registry-etcd"
)

type HelloImpl struct{}

func (h *HelloImpl) Echo(ctx context.Context, req *api.Request) (resp *api.Response, err error) {
	resp = &api.Response{
		Message: req.Message,
	}
	return
}

func main() {
	// creates a etcd based registry with given username and password
	r, err := etcd.NewEtcdRegistryWithAuth([]string{"127.0.0.1:2379"}, "username", "password")
	if err != nil {
		log.Fatal(err)
	}
	server := hello.NewServer(new(HelloImpl), server.WithRegistry(r), server.WithServerBasicInfo(&rpcinfo.EndpointBasicInfo{
		ServiceName: "Hello",
	}))
	err = server.Run()
	if err != nil {
		log.Fatal(err)
	}
}

client

package main

import (
    ...
	"github.com/cloudwego/kitex/client"
	etcd "github.com/kitex-contrib/registry-etcd"
)

func main() { 
	// creates a etcd based resolver with given username and password
	r, err := etcd.NewEtcdResolverWithAuth([]string{"127.0.0.1:2379"}, "username", "password")
	if err != nil {
		log.Fatal(err)
	}
	client := hello.MustNewClient("Hello", client.WithResolver(r))
	for {
		ctx, cancel := context.WithTimeout(context.Background(), time.Second*3)
		resp, err := client.Echo(ctx, &api.Request{Message: "Hello"})
		cancel()
		if err != nil {
			log.Fatal(err)
		}
		log.Println(resp)
		time.Sleep(time.Second)
	}
}

More info

See example.

Compatibility

Compatible with etcd server v3.

maintained by: lizheming

Documentation

Overview

Package etcd resolver

Package etcd resolver

Index

• func NewEtcdRegistry(endpoints []string, opts ...Option) (registry.Registry, error)
• func NewEtcdRegistryWithAuth(endpoints []string, username, password string) (registry.Registry, error)
• func NewEtcdResolver(endpoints []string, opts ...Option) (discovery.Resolver, error)
• func NewEtcdResolverWithAuth(endpoints []string, username, password string) (discovery.Resolver, error)
• type Option
  • func WithAuthOpt(username, password string) Option
  • func WithTLSOpt(certFile, keyFile, caFile string) Option

Functions

func NewEtcdRegistry

func NewEtcdRegistry(endpoints []string, opts ...Option) (registry.Registry, error)

NewEtcdRegistry creates a etcd based registry.

func NewEtcdRegistryWithAuth

func NewEtcdRegistryWithAuth(endpoints []string, username, password string) (registry.Registry, error)

NewEtcdRegistryWithAuth creates a etcd based registry with given username and password. Deprecated: Use WithAuthOpt instead.

func NewEtcdResolver

func NewEtcdResolver(endpoints []string, opts ...Option) (discovery.Resolver, error)

NewEtcdResolver creates a etcd based resolver.

func NewEtcdResolverWithAuth

func NewEtcdResolverWithAuth(endpoints []string, username, password string) (discovery.Resolver, error)

NewEtcdResolverWithAuth creates a etcd based resolver with given username and password. Deprecated: Use WithAuthOpt instead.

Types

type Option

type Option func(cfg *clientv3.Config)

Option sets options such as username, tls etc.

func WithAuthOpt

func WithAuthOpt(username, password string) Option

WithAuthOpt returns a option that authentication by usernane and password.

func WithTLSOpt

func WithTLSOpt(certFile, keyFile, caFile string) Option

WithTLSOpt returns a option that authentication by tls/ssl.