config

Documentation

Index

• Constants
• Variables
• type Config
  • func New(configFilePath string) (*Config, error)
  • func (c *Config) GetFilePath() string
  • func (c *Config) Refresh() (changed bool, err error)
  • func (c *Config) Validate() error

Constants

const (
	// Name - plugin's executable name, must be the same as in `Makefile`
	Name = "nexentastor-docker-volume-plugin"

	// PluginMountPointsRoot - path inside the plugin container to mount volumes
	// this path must be propagated to host via "propogatedmount" parameter in plugin's "config.json"
	// TODO read this parameter from plugin's "config.json" file "propogatedmount" parameter?
	PluginMountPointsRoot = "/mnt/nexentastor-docker-volume-plugin"

	// path to a log file inside the plugin's container
	LogFile = "/var/log/nexentastor-docker-volume-plugin.log"
)

persistent plugin's config

const (
	// FsTypeNFS - to mount NS filesystem over NFS
	FsTypeNFS string = "nfs"
)

supported mount filesystem types

Variables

var Commit string

Commit - plugin last commit, to set commit set flags: go build -ldflags "-X github.com/Nexenta/nexentastor-docker-volume-plugin/pkg/config.Commit=..."

var DateTime string

DateTime - plugin build datetime, to set commit set flags: go build -ldflags "-X github.com/Nexenta/nexentastor-docker-volume-plugin/pkg/config.DateTime=..."

var Version string

Version - plugin version, to set version set flags: go build -ldflags "-X github.com/Nexenta/nexentastor-docker-volume-plugin/pkg/config.Version=1.0.0"

Types

type Config

type Config struct {
	Address             string `yaml:"restIp"`
	Username            string `yaml:"username"`
	Password            string `yaml:"password"`
	DefaultDataset      string `yaml:"defaultDataset,omitempty"`
	DefaultDataIP       string `yaml:"defaultDataIp,omitempty"`
	Debug               bool   `yaml:"debug,omitempty"`
	DefaultMountOptions string `yaml:"defaultMountOptions,omitempty"`
	// contains filtered or unexported fields
}

Config - plugin config from file

func New

func New(configFilePath string) (*Config, error)

New creates config instance

func (*Config) GetFilePath

func (c *Config) GetFilePath() string

GetFilePath gets filepath of found config file

func (*Config) Refresh

func (c *Config) Refresh() (changed bool, err error)

Refresh reads and validates config, returns `true` if config has been changed

func (*Config) Validate

func (c *Config) Validate() error

Validate validates current config