polaris

README

Polaris

Package polaris implements GoFrame gcfg.Adapter using polaris service.

Installation

go get -u github.com/joy12825/gf/contrib/config/polaris

Usage

Create a custom boot package

If you wish using configuration from polaris globally, it is strongly recommended creating a custom boot package in very top import, which sets the Adapter of default configuration instance before any other package boots.

package boot

import (
    "github.com/joy12825/gf/contrib/config/polaris"
    "github.com/joy12825/gf/frame/g"
    "github.com/joy12825/gf/os/gctx"
)

func init() {
    var (
        ctx       = gctx.GetInitCtx()
        namespace = "default"
        fileGroup = "goframe"
        fileName  = "config.yaml"
        path      = "testdata/polaris.yaml"
        logDir    = "/tmp/polaris/log"
    )
    // Create polaris Client that implements gcfg.Adapter.
    adapter, err := polaris.New(ctx, polaris.Config{
        Namespace: namespace,
        FileGroup: fileGroup,
        FileName:  fileName,
        Path:      path,
        LogDir:    logDir,
        Watch:     true,
    })
    if err != nil {
        g.Log().Fatalf(ctx, `%+v`, err)
    }
    // Change the adapter of default configuration instance.
    g.Cfg().SetAdapter(adapter)
}

Import boot package on top of main

It is strongly recommended import your boot package in top of your main.go.

Note the top import: _ "github.com/joy12825/gf/example/config/polaris/boot" .

package main

import (
    _ "github.com/joy12825/gf/example/config/polaris/boot"
    
    "github.com/joy12825/gf/frame/g"
    "github.com/joy12825/gf/os/gctx"
)

func main() {
    var ctx = gctx.GetInitCtx()
    
    // Available checks.
    g.Dump(g.Cfg().Available(ctx))
    
    // All key-value configurations.
    g.Dump(g.Cfg().Data(ctx))
    
    // Retrieve certain value by key.
    g.Dump(g.Cfg().MustGet(ctx, "server.address"))
}

License

GoFrame Polaris is licensed under the MIT License, 100% free and open-source, forever.

Documentation

Overview

Package polaris implements gcfg.Adapter using polaris service.

Index

• func New(ctx context.Context, config Config) (adapter gcfg.Adapter, err error)
• type Client
  • func (c *Client) Available(ctx context.Context, resource ...string) (ok bool)
  • func (c *Client) Data(ctx context.Context) (data map[string]interface{}, err error)
  • func (c *Client) Get(ctx context.Context, pattern string) (value interface{}, err error)
  • func (c *Client) LogDir(dir string) error
• type Config

Functions

func New

func New(ctx context.Context, config Config) (adapter gcfg.Adapter, err error)

New creates and returns gcfg.Adapter implementing using polaris service.

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client implements gcfg.Adapter implementing using polaris service.

func (*Client) Available

func (c *Client) Available(ctx context.Context, resource ...string) (ok bool)

Available checks and returns the backend configuration service is available. The optional parameter `resource` specifies certain configuration resource.

Note that this function does not return error as it just does simply check for backend configuration service.

func (*Client) Data

func (c *Client) Data(ctx context.Context) (data map[string]interface{}, err error)

Data retrieves and returns all configuration data in current resource as map. Note that this function may lead to lots of memory usage if configuration data are too large, you can implement this function if necessary.

func (*Client) Get

func (c *Client) Get(ctx context.Context, pattern string) (value interface{}, err error)

Get retrieves and return value by specified `pattern` in current resource. Pattern like: "x.y.z" for map item. "x.0.y" for slice item.

func (*Client) LogDir

func (c *Client) LogDir(dir string) error

LogDir sets the log directory for polaris.

type Config

type Config struct {
	// The namespace of the configuration.
	Namespace string `v:"required"`
	// The group of the configuration.
	FileGroup string `v:"required"`
	// The name of the configuration.
	FileName string `v:"required"`
	// The path of the polaris configuration file.
	Path string `v:"required"`
	// The log directory for polaris.
	LogDir string
	// Watch watches remote configuration updates, which updates local configuration in memory immediately when remote configuration changes.
	Watch bool
}

Config is the configuration for polaris.