configuration

Documentation

Overview

Package configuration provides reader for perun configuration.

Index

• func GetLinterConfigurationFile(linterFile *string, logger logger.LoggerInt) (rawLintConfiguration string)
• func SaveToFile(config Configuration, path string, logger logger.LoggerInt)
• type Configuration
  • func GetConfiguration(cliArguments cliparser.CliArguments, logger logger.LoggerInt) (config Configuration, err error)
  • func (config Configuration) GetSpecificationFileURLForCurrentRegion() (string, error)
• type InconsistencyConfiguration
  • func ReadInconsistencyConfiguration(logger logger.LoggerInt) (config InconsistencyConfiguration)
• type Property

Functions

func GetLinterConfigurationFile

func GetLinterConfigurationFile(linterFile *string, logger logger.LoggerInt) (rawLintConfiguration string)

GetLinterConfigurationFile reads configuration from file.

func SaveToFile

func SaveToFile(config Configuration, path string, logger logger.LoggerInt)

Types

type Configuration

type Configuration struct {
	// AWS credentials profile.
	DefaultProfile string
	// AWS region (e.g. us-east-1).
	DefaultRegion string
	// Map of resource specification CloudFront URL per region.
	SpecificationURL map[string]string
	// Decision regarding if we use MFA token or not.
	DefaultDecisionForMFA bool
	// Duration for MFA token.
	DefaultDurationForMFA int64
	// Logger verbosity.
	DefaultVerbosity string
	// Directory for temporary files.
	DefaultTemporaryFilesDirectory string
}

Perun configuration.

func GetConfiguration

func GetConfiguration(cliArguments cliparser.CliArguments, logger logger.LoggerInt) (config Configuration, err error)

Return perun configuration read from file.

func (Configuration) GetSpecificationFileURLForCurrentRegion

func (config Configuration) GetSpecificationFileURLForCurrentRegion() (string, error)

Return URL to specification file. If there is no specification file for selected region, return error.

type InconsistencyConfiguration

type InconsistencyConfiguration struct {
	SpecificationInconsistency map[string]Property
}

InconsistencyConfiguration describes inconsistencies between specification and documentation.

func ReadInconsistencyConfiguration

func ReadInconsistencyConfiguration(logger logger.LoggerInt) (config InconsistencyConfiguration)

ReadInconsistencyConfiguration gets configuration from file, if could not read return warning.

type Property

type Property map[string][]string

Property of inconsistency.