commons

Documentation

Index

• Constants
• func GetServiceVersion() string
• func GetVersionJSON() (string, error)
• type Config
  • func NewConfigFromENV() (*Config, error)
  • func NewConfigFromYAML(yamlBytes []byte) (*Config, error)
  • func NewDefaultConfig() *Config
  • func (config *Config) Validate() error
• type VersionInfo
  • func GetVersion() VersionInfo

Constants

const (
	ServiceHostDefault      string = ""
	ServicePortDefault      int    = 1389
	IRODSPortDefault        int    = 1247
	IRODSUserGroupDefault   string = ""
	AuthCacheTimeoutDefault int    = 60 * 5 // 5min
	LDAPBaseDNDefault       string = "dc=iplantcollaborative,dc=org"
	LogFilePathDefault      string = "/tmp/ldap-irods-auth.log"
)

Functions

func GetServiceVersion

func GetServiceVersion() string

GetServiceVersion returns service version in string

func GetVersionJSON

func GetVersionJSON() (string, error)

GetVersionJSON returns VersionInfo object in JSON string

Types

type Config

type Config struct {
	ServiceHost string `envconfig:"LDAP_IRODS_AUTH_SERVICE_HOST" yaml:"service_host"`
	ServicePort int    `envconfig:"LDAP_IRODS_AUTH_SERVICE_PORT" yaml:"service_port"`

	IRODSHost      string `envconfig:"LDAP_IRODS_AUTH_IRODS_HOST" yaml:"irods_host"`
	IRODSPort      int    `envconfig:"LDAP_IRODS_AUTH_IRODS_PORT" yaml:"irods_port"`
	IRODSZone      string `envconfig:"LDAP_IRODS_AUTH_IRODS_ZONE" yaml:"irods_zone"`
	IRODSUserGroup string `envconfig:"LDAP_IRODS_AUTH_IRODS_USER_GROUP" yaml:"irods_user_group"`

	AuthCacheTimeout int `envconfig:"LDAP_IRODS_AUTH_CACHE_TIMEOUT" yaml:"auth_cache_timeout"`

	LDAPBaseDN string `envconfig:"LDAP_IRODS_AUTH_LDAP_BASE_DN" yaml:"ldap_base_dn"`

	LogPath string `envconfig:"LDAP_IRODS_AUTH_LOG_PATH" yaml:"log_path,omitempty"`

	Foreground   bool `yaml:"foreground,omitempty"`
	ChildProcess bool `yaml:"childprocess,omitempty"`
}

Config holds the parameters list which can be configured

func NewConfigFromENV

func NewConfigFromENV() (*Config, error)

NewConfigFromENV creates Config from Environmental Variables

func NewConfigFromYAML

func NewConfigFromYAML(yamlBytes []byte) (*Config, error)

NewConfigFromYAML creates Config from YAML

func NewDefaultConfig

func NewDefaultConfig() *Config

NewDefaultConfig creates DefaultConfig

func (*Config) Validate

func (config *Config) Validate() error

Validate validates configuration

type VersionInfo

type VersionInfo struct {
	ServiceVersion string `json:"serviceVersion"`
	GitCommit      string `json:"gitCommit"`
	BuildDate      string `json:"buildDate"`
	GoVersion      string `json:"goVersion"`
	Compiler       string `json:"compiler"`
	Platform       string `json:"platform"`
}

VersionInfo object contains version related info

func GetVersion

func GetVersion() VersionInfo

GetVersion returns VersionInfo object