beacon

Documentation

Index

• Constants
• Variables
• func Address(ctx context.Context, lockFile string) (string, error)
• func DeleteLockFile(lockFile string) error
• func Identifier(s string) string
• func LockFilePath() string
• func StoreAddressToLockFile(lockFile, addr string) error
• func ValidResourcePolicy(s string) bool
• type Connection
  • func Connect(ctx context.Context) (*Connection, error)
  • func (c *Connection) Close() error
  • func (c *Connection) Enabled() bool

Constants

const (
	AddressEnv        = "CFT_BEACON_ADDR"
	LockFileEnv       = "CFT_LOCKFILE"
	IdentifierEnv     = "CFT_IDENTIFIER"
	NamespaceEnv      = "CFT_NAMESPACE"
	ResourcePolicyEnv = "CFT_RESOURCE_POLICY"
	LogLevelEnv       = "CFT_LOG_LEVEL"
)

const (
	ResourcePolicyError    = "error"
	ResourcePolicyReuse    = "reuse"
	ResourcePolicyReusable = "reusable"
	ResourcePolicyTakeOver = "takeover"
)

const (
	LabelIdentifier = "daichitakahashi.confort.beacon.identifier"
)

const LockFile = ".confort.lock"

LockFile is default file name of lock file.

Variables

var ErrIntegrationDisabled = errors.New("the integration with beacon server is disabled")

Functions

func Address

func Address(ctx context.Context, lockFile string) (string, error)

Address returns address of beacon server. It returns value of CFT_BEACON_ADDR if exists. If the value of CFT_BEACON_ADDR equals "disabled", this returns ErrIntegrationDisabled.

If the variable not exists, Address try to read from lockFile.

func DeleteLockFile

func DeleteLockFile(lockFile string) error

func Identifier

func Identifier(s string) string

func LockFilePath

func LockFilePath() string

LockFilePath returns file name of lock file. If CFT_LOCKFILE is set, return its value, or else return LockFile.

func StoreAddressToLockFile

func StoreAddressToLockFile(lockFile, addr string) error

func ValidResourcePolicy

func ValidResourcePolicy(s string) bool

Types

type Connection

type Connection struct {
	Conn *grpc.ClientConn
	Addr string
}

func Connect

func Connect(ctx context.Context) (*Connection, error)

func (*Connection) Close

func (c *Connection) Close() error

func (*Connection) Enabled

func (c *Connection) Enabled() bool