consul

package
v3.1.4 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 13, 2023 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Overview

Package consul work for service register and find.

Index

Constants

View Source
const (
	OptAddr     = "addr"
	OptAddrByte = 'a'
	OptAddrDesc = "Consul server address, such as: 127.0.0.1, consul.example.com"

	OptKey     = "name"
	OptKeyByte = 'n'
	OptKeyDesc = "Consul key name"

	OptScheme        = "scheme"
	OptSchemeByte    = 's'
	OptSchemeDefault = "http"
	OptSchemeDesc    = "Consul server scheme, accept http or https"

	OptOverride        = "override"
	OptOverrideByte    = 'o'
	OptOverrideDefault = false
	OptOverrideDesc    = "Override config files if exists"

	OptPath        = "path"
	OptPathByte    = 'p'
	OptPathDefault = "./config"
	OptPathDesc    = "Config file storage location"

	OptServiceAddr     = "service-addr"
	OptServiceAddrDesc = "Consul service address, such as: 172.16.0.100, app.example.com"

	OptServiceId     = "service-id"
	OptServiceIdDesc = "Consul service id, such as: myapp-hash"

	OptServiceName     = "service-name"
	OptServiceNameDesc = "Consul service name, such as: myapp"

	OptServicePort     = "service-port"
	OptServicePortDesc = "Consul service port, such as: 80, 8080"
)

Variables

View Source
var (
	RegexDepth          = regexp.MustCompile(`kv://([._a-zA-Z0-9-/]+)`)
	RegexFilename       = regexp.MustCompile(`^([a-zA-Z][._a-zA-Z0-9-]*\.ya?ml)$`)
	RegexFilenameRemote = regexp.MustCompile(`^([a-zA-Z][._a-zA-Z0-9-]*\.ya?ml):[^\n]*`)
)

Functions

This section is empty.

Types

type ClientManager

type ClientManager struct{}

ClientManager for consul agent manager.

var (
	// Client
	// instance for consul.
	Client *ClientManager
)

func (*ClientManager) Deregister

func (o *ClientManager) Deregister(cfg *api.Config, serviceName, serviceId string) (res map[string]interface{}, err error)

Deregister remove service of consul.

func (*ClientManager) Download

func (o *ClientManager) Download(cfg *api.Config, key, path string, override bool) (res map[string]interface{}, err error)

Download remote configuration from consul and store as local files.

func (*ClientManager) Register

func (o *ClientManager) Register(cfg *api.Config, req *api.AgentServiceRegistration) (res map[string]interface{}, err error)

Register add new service to consul.

func (*ClientManager) Upload

func (o *ClientManager) Upload(cfg *api.Config, key, path string) (res map[string]interface{}, err error)

Upload read local config files contents and put to consul.

Directories

Path Synopsis
kv
Package kv read and write configuration by consul kv pair.
Package kv read and write configuration by consul kv pair.
download
Package download read configurations from consul kv storage and store to local yaml files.
Package download read configurations from consul kv storage and store to local yaml files.
upload
Package upload scan and read local config files and put to consul kv storage.
Package upload scan and read local config files and put to consul kv storage.
Package service register and deregister service on consul service storage.
Package service register and deregister service on consul service storage.
deregister
Package deregister remove registered service on consul.
Package deregister remove registered service on consul.
register
Package register build service and register to consul.
Package register build service and register to consul.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL