config

Documentation

Index

• Constants
• type CloudQuery
  • func (c CloudQuery) GetRequiredProvider(name string) (*RequiredProvider, error)
• type Config
  • func (c Config) GetProvider(name string) (*Provider, error)
• type Configuration
• type Connection
• type Option
  • func WithEnvironmentVariables(prefix string, vars []string) Option
  • func WithFS(fs afero.Fs) Option
• type Parser
  • func NewParser(options ...Option) *Parser
  • func (p *Parser) DecodePolicies(body hcl.Body, diags hcl.Diagnostics, basePath string) (*PolicyWrapper, hcl.Diagnostics)
  • func (p *Parser) LoadConfigFile(path string) (*Config, hcl.Diagnostics)
  • func (p *Parser) LoadConfigFromJson(name string, data []byte) (*Config, hcl.Diagnostics)
  • func (p *Parser) LoadConfigFromSource(name string, data []byte) (*Config, hcl.Diagnostics)
  • func (p *Parser) LoadHCLFile(path string) (hcl.Body, hcl.Diagnostics)
• type Policy
• type PolicyProvider
• type PolicyWrapper
• type Provider
• type Query
• type QueryType
• type RequiredProvider
  • func (r RequiredProvider) String() string
• type SourceType
• type View

Constants

const (
	SourceJSON = "json"
	SourceHCL  = "hcl"
)

const EnvVarPrefix = "CQ_VAR_"

EnvVarPrefix is a prefix for environment variable names to be exported for HCL substitution.

Types

type CloudQuery

type CloudQuery struct {
	PluginDirectory string              `hcl:"plugin_directory,optional"`
	PolicyDirectory string              `hcl:"policy_directory,optional"`
	Logger          *logging.Config     `hcl:"logging,block"`
	Providers       []*RequiredProvider `hcl:"provider,block"`
	Connection      *Connection         `hcl:"connection,block"`
}

func (CloudQuery) GetRequiredProvider

func (c CloudQuery) GetRequiredProvider(name string) (*RequiredProvider, error)

type Config

type Config struct {
	CloudQuery CloudQuery  `hcl:"cloudquery,block"`
	Providers  []*Provider `hcl:"provider,block"`
}

func (Config) GetProvider

func (c Config) GetProvider(name string) (*Provider, error)

type Configuration

type Configuration struct {
	Providers []*PolicyProvider `hcl:"provider,block"`
}

type Connection

type Connection struct {
	DSN string `hcl:"dsn,attr"`
}

type Option

type Option func(*Parser)

func WithEnvironmentVariables

func WithEnvironmentVariables(prefix string, vars []string) Option

WithEnvironmentVariables fills hcl.Context with values of environment variables given in vars. Only variables that start with given prefix are considered. Prefix is removed from the name and the name is lower cased then.

func WithFS

func WithFS(fs afero.Fs) Option

type Parser

type Parser struct {
	HCLContext hcl.EvalContext
	// contains filtered or unexported fields
}

Parser is the main interface to read configuration files and other related files from disk.

It retains a cache of all files that are loaded so that they can be used to create source code snippets in diagnostics, etc.

func NewParser

func NewParser(options ...Option) *Parser

NewParser creates and returns a new Parser.

func (*Parser) DecodePolicies

func (p *Parser) DecodePolicies(body hcl.Body, diags hcl.Diagnostics, basePath string) (*PolicyWrapper, hcl.Diagnostics)

func (*Parser) LoadConfigFile

func (p *Parser) LoadConfigFile(path string) (*Config, hcl.Diagnostics)

func (*Parser) LoadConfigFromJson

func (p *Parser) LoadConfigFromJson(name string, data []byte) (*Config, hcl.Diagnostics)

func (*Parser) LoadConfigFromSource

func (p *Parser) LoadConfigFromSource(name string, data []byte) (*Config, hcl.Diagnostics)

func (*Parser) LoadHCLFile

func (p *Parser) LoadHCLFile(path string) (hcl.Body, hcl.Diagnostics)

LoadHCLFile is a low-level method that reads the file at the given path, parses it, and returns the hcl.Body representing its root. In many cases it is better to use one of the other Load*File methods on this type, which additionally decode the root body in some way and return a higher-level construct.

If the file cannot be read at all -- e.g. because it does not exist -- then this method will return a nil body and error diagnostics. In this case callers may wish to ignore the provided error diagnostics and produce a more context-sensitive error instead.

The file will be parsed using the HCL native syntax unless the filename ends with ".json", in which case the HCL JSON syntax will be used.

type Policy

type Policy struct {
	Name        string         `hcl:"name,label"`
	Description string         `hcl:"description,optional"`
	Config      *Configuration `hcl:"configuration,block"`

	Policies []*Policy `hcl:"policy,block"`
	Queries  []*Query  `hcl:"query,block"`
	Views    []*View   `hcl:"view,block"`
}

type PolicyProvider

type PolicyProvider struct {
	Type    string `hcl:"type,label"`
	Version string `hcl:"version,optional"`
}

type PolicyWrapper

type PolicyWrapper struct {
	Policies []*Policy `hcl:"policy,block"`
}

type Provider

type Provider struct {
	Name               string   `hcl:"name,label"`
	Alias              string   `hcl:"alias,optional"`
	EnablePartialFetch bool     `hcl:"enable_partial_fetch,optional"`
	Resources          []string `hcl:"resources,optional"`
	Env                []string `hcl:"env,optional"`
	Configuration      []byte
}

type Query

type Query struct {
	Name         string    `hcl:"name,label"`
	Description  string    `hcl:"description,optional"`
	ExpectOutput bool      `hcl:"expect_output,optional"`
	Type         QueryType `hcl:"type,optional"`
	Query        string    `hcl:"query"`
}

type QueryType

type QueryType string

const (
	ManualQuery    QueryType = "manual"
	AutomaticQuery QueryType = "automatic"
)

type RequiredProvider

type RequiredProvider struct {
	Name    string `hcl:"name,label"`
	Source  string `hcl:"source,optional"`
	Version string `hcl:"version"`
}

func (RequiredProvider) String

func (r RequiredProvider) String() string

type SourceType

type SourceType string

type View

type View struct {
	Name        string `hcl:"name,label"`
	Description string `hcl:"description,optional"`

	Query *Query `hcl:"query,block"`
}