ccclient

README

go-cc-client

config center client can pull and push configs in distributed configuration management service

Supported distributed configuration management service:

• ctrip apollo https://github.com/ctripcorp/apollo
• huawei cloud CSE config center https://www.huaweicloud.com/product/cse.html

Example

Get a client of config center

1. import the config client you want to use

_ "github.com/go-chassis/go-cc-client/configcenter"

1. Create a client

c, err := ccclient.NewClient("config_center", ccclient.Options{
		ServerURI: "http://127.0.0.1:30200",
	})

Use huawei cloud

import (
	"github.com/huaweicse/auth"
	"github.com/go-chassis/go-chassis/pkg/httpclient"
	_ "github.com/go-chassis/go-cc-client/configcenter"
)

func main() {
	var err error
	httpclient.SignRequest,err =auth.GetShaAKSKSignFunc("your ak", "your sk", "")
	if err!=nil{
        //handle err
	}
	ccclient.NewClient("config_center",ccclient.Options{
		ServerURI:"the address of CSE endpoint",
	})
}

Documentation

Overview

Package client created on 2017/6/22.

Index

• Constants
• func InstallConfigClientPlugin(name string, f func(options Options) ConfigClient)
• type ConfigClient
  • func NewClient(name string, options Options) (ConfigClient, error)
• type Options

Constants

const (
	LoggerInitFailed            = "logger initialization failed"
	PackageInitError            = "package not initialize successfully"
	ConfigServerMemRefreshError = "error in poulating config server member"
	EmptyConfigServerMembers    = "empty config server member"
	EmptyConfigServerConfig     = "empty config sevrer passed"
	RefreshModeError            = "refreshMode must be 0 or 1."
)

error response constants

Functions

func InstallConfigClientPlugin

func InstallConfigClientPlugin(name string, f func(options Options) ConfigClient)

InstallConfigClientPlugin install a config client plugin

Types

type ConfigClient

type ConfigClient interface {
	//Init the Configuration for the Server
	//PullConfigs pull all configs from remote
	PullConfigs(serviceName, version, app, env string) (map[string]interface{}, error)
	//PullConfig pull one config from remote
	PullConfig(serviceName, version, app, env, key, contentType string) (interface{}, error)
	//PullConfigsByDI pulls the configurations with customized DimensionInfo/Project
	PullConfigsByDI(dimensionInfo, diInfo string) (map[string]map[string]interface{}, error)
	// PushConfigs push config to cc
	PushConfigs(data map[string]interface{}, dimensionInfo string) (map[string]interface{}, error)
	// DeleteConfigsByKeys delete config for cc by keys
	DeleteConfigsByKeys(keys []string, dimensionInfo string) (map[string]interface{}, error)
}

ConfigClient is the interface of config server client, it has basic func to interact with config server

var DefaultClient ConfigClient

DefaultClient is config server's client

func NewClient

func NewClient(name string, options Options) (ConfigClient, error)

Enable enable config server client

type Options

type Options struct {
	ServerURI         string
	Endpoint          string
	ServiceName       string
	ApolloServiceName string
	Cluster           string
	Namespace         string
	App               string
	Env               string
	Version           string
	TLSConfig         *tls.Config
	TenantName        string
	EnableSSL         bool
	APIVersion        string
	AutoDiscovery     bool
}