configuration

Documentation

Overview

Package configuration implements configuration service required by the edge-core service

Package configuration implements configuration service required by the edge-core service

Index

• type ClusterType
• type ConfigurationContract
  • func NewEnvConfigurationService() (ConfigurationContract, error)

Types

type ClusterType

type ClusterType int

ClusterType is the edge cluster type

const (
	// Unknown determines that configuration service could not determine edge cluster type
	Unknown ClusterType = iota
	// K3S is an edge cluster using K3S server and agent nodes
	K3S
)

type ConfigurationContract

type ConfigurationContract interface {
	// GetHttpHost returns HTTP host name
	// Returns the HTTP host name
	GetHttpHost() string

	// GetHttpPort returns HTTP port number
	// Returns the HTTP port number or error if something goes wrong
	GetHttpPort() (int, error)

	// GetRunningNodeName returns the name of the node that currently running the pod
	// Returns the name of the node that currently running the pod or error if something goes wrong
	GetRunningNodeName() (string, error)

	// GetEdgeClusterType returns the type of edge cluster such as K3S
	// Returns the type of edge cluster or error if something goes wrong
	GetEdgeClusterType() (ClusterType, error)

	// ShouldUpdatePublciIPAndGeolocationDetails determines whether the edge-core should periodically check
	// for the node public IP address and geolocation details
	// Returns true if the edge-core should periodically check for the node public IP address and
	// geolocation details otherwise returns false
	ShouldUpdatePublciIPAndGeolocationDetails() bool

	// GetGeolocationUpdaterCronSpec returns Geolocation Updater updating interval
	// Returns the Geolocation Updater updating interval or error if something goes wrong
	GetGeolocationUpdaterCronSpec() (string, error)

	// GetIpinfoUrl returns the URL to the Ipinfo website that returns the node public IP address
	// Returns the URL to the Ipinfo website that returns the node public IP address or error if something goes wrong
	GetIpinfoUrl() (string, error)

	// GetIpinfoAccessToken returns the access token to be used when making request to the Ipinfo website
	// to return the node public IP address
	// Returns the access token to be used when making request to the Ipinfo website to return the node
	// public IP address or error if something goes wrong
	GetIpinfoAccessToken() (string, error)
}

ConfigurationContract declares the service that provides configuration required by different Tenat modules

func NewEnvConfigurationService

func NewEnvConfigurationService() (ConfigurationContract, error)

NewEnvConfigurationService creates new instance of the EnvConfigurationService, setting up all dependencies and returns the instance Returns the new service or error if something goes wrong