v1

Documentation

Index

• Variables
• func Asset(name string) ([]byte, error)
• func AssetDir(name string) ([]string, error)
• func AssetInfo(name string) (os.FileInfo, error)
• func AssetNames() []string
• func MustAsset(name string) []byte
• func RestoreAsset(dir, name string) error
• func RestoreAssets(dir, name string) error
• type AnalyzerShared
• type AnalyzerSpec
  • func (a AnalyzerSpec) GetRequirement() Requirement
• type Condition
• type ConditionShared
• type DockerVersionRequirement
  • func (a *DockerVersionRequirement) GetRawSpec() (RawSpec, error)
  • func (a *DockerVersionRequirement) Validate(spec AnalyzerSpec) error
• type EvalCondition
• type EvalOperator
• type KubernetesTotalMemoryRequirement
  • func (a *KubernetesTotalMemoryRequirement) GetRawSpec() (RawSpec, error)
  • func (a *KubernetesTotalMemoryRequirement) Validate(spec AnalyzerSpec) error
• type KubernetesVersionRequirement
  • func (a *KubernetesVersionRequirement) GetRawSpec() (RawSpec, error)
  • func (a *KubernetesVersionRequirement) Validate(spec AnalyzerSpec) error
• type RawRequirement
  • func (r *RawRequirement) GetRawSpec() (RawSpec, error)
  • func (r *RawRequirement) Validate(spec AnalyzerSpec) error
• type RawSpec
• type Requirement
• type SelinuxNotEnforcingRequirement
  • func (a *SelinuxNotEnforcingRequirement) GetRawSpec() (RawSpec, error)
  • func (a *SelinuxNotEnforcingRequirement) Validate(spec AnalyzerSpec) error

Variables

var (
	DockerVersionRequirementSpecTemplate *template.Template
)

var (
	KubernetesTotalMemoryRequirementSpecTemplate *template.Template
)

var (
	KubernetesVersionRequirementSpecTemplate *template.Template
)

var (
	SelinuxNotEnforcingRequirementSpecTemplate *template.Template
)

Functions

func Asset

func Asset(name string) ([]byte, error)

Asset loads and returns the asset for the given name. It returns an error if the asset could not be found or could not be loaded.

func AssetDir

func AssetDir(name string) ([]string, error)

AssetDir returns the file names below a certain directory embedded in the file by go-bindata. For example if you run go-bindata on data/... and data contains the following hierarchy:

data/
  foo.txt
  img/
    a.png
    b.png

then AssetDir("data") would return []string{"foo.txt", "img"} AssetDir("data/img") would return []string{"a.png", "b.png"} AssetDir("foo.txt") and AssetDir("notexist") would return an error AssetDir("") will return []string{"data"}.

func AssetInfo

func AssetInfo(name string) (os.FileInfo, error)

AssetInfo loads and returns the asset info for the given name. It returns an error if the asset could not be found or could not be loaded.

func AssetNames

func AssetNames() []string

AssetNames returns the names of the assets.

func MustAsset

func MustAsset(name string) []byte

MustAsset is like Asset but panics when Asset would return an error. It simplifies safe initialization of global variables.

func RestoreAsset

func RestoreAsset(dir, name string) error

RestoreAsset restores an asset under the given directory

func RestoreAssets

func RestoreAssets(dir, name string) error

RestoreAssets restores an asset under the given directory recursively

Types

type AnalyzerShared

type AnalyzerShared struct {
	Message     string          `json:"message,omitempty" yaml:"message,omitempty" hcl:"message,omitempty"`
	Severity    common.Severity `json:"severity,omitempty" yaml:"severity,omitempty" hcl:"severity,omitempty"`
	Meta        *meta.Meta      `json:"meta,omitempty" yaml:"meta,omitempty" hcl:"meta,omitempty"`
	CollectRefs []meta.Ref      `json:"collect_refs,omitempty" yaml:"collect_refs,omitempty" hcl:"collect_refs,omitempty"`
}

type AnalyzerSpec

type AnalyzerSpec struct {
	AnalyzerShared `json:",inline" yaml:",inline" hcl:",inline"`

	Raw *RawRequirement `json:"raw,omitempty" yaml:"raw,omitempty" hcl:"raw,omitempty"`

	SelinuxNotEnforcing *SelinuxNotEnforcingRequirement `json:"selinux.notenforcing,omitempty" yaml:"selinux.notenforcing,omitempty" hcl:"selinux.notenforcing,omitempty"`

	DockerVersion *DockerVersionRequirement `json:"docker.version,omitempty" yaml:"docker.version,omitempty" hcl:"docker.version,omitempty"`

	KubernetesVersion     *KubernetesVersionRequirement     `json:"kubernetes.version,omitempty" yaml:"kubernetes.version,omitempty" hcl:"kubernetes.version,omitempty"`
	KubernetesTotalMemory *KubernetesTotalMemoryRequirement `json:"kubernetes.total-memory,omitempty" yaml:"kubernetes.total-memory,omitempty" hcl:"kubernetes.total-memory,omitempty"`
}

AnalyzerSpec is a spec to analyze one or more collect assets

func (AnalyzerSpec) GetRequirement

func (a AnalyzerSpec) GetRequirement() Requirement

type Condition

type Condition struct {
	ConditionShared `json:",inline" yaml:",inline" hcl:",inline"`

	Eval *EvalCondition `json:"eval,omitempty" yaml:"eval,omitempty" hcl:"eval,omitempty"`
}

type ConditionShared

type ConditionShared struct {
	Severity common.Severity `json:"severity" yaml:"severity" hcl:"severity"`
	Message  string          `json:"message,omitempty" yaml:"message,omitempty" hcl:"message,omitempty"`
}

type DockerVersionRequirement

type DockerVersionRequirement struct {
	ServerVersionMin string `json:"server_version_minimum" yaml:"server_version_minimum" hcl:"server_version_minimum"`
}

func (*DockerVersionRequirement) GetRawSpec

func (a *DockerVersionRequirement) GetRawSpec() (RawSpec, error)

func (*DockerVersionRequirement) Validate

func (a *DockerVersionRequirement) Validate(spec AnalyzerSpec) error

type EvalCondition

type EvalCondition struct {
	Operator   EvalOperator        `json:"operator,omitempty" yaml:"operator,omitempty" hcl:"operator,omitempty"`
	Statements []string            `json:"statements" yaml:"statements" hcl:"statements"`
	Variables  []map[string]string `json:"variables,omitempty" yaml:"variables,omitempty" hcl:"variables,omitempty"`
}

type EvalOperator

type EvalOperator string

const (
	AndOperator EvalOperator = "and"
	OrOperator  EvalOperator = "or"
)

type KubernetesTotalMemoryRequirement

type KubernetesTotalMemoryRequirement struct {
	Min string `json:"minimum" yaml:"minimum" hcl:"minimum"`
}

func (*KubernetesTotalMemoryRequirement) GetRawSpec

func (a *KubernetesTotalMemoryRequirement) GetRawSpec() (RawSpec, error)

func (*KubernetesTotalMemoryRequirement) Validate

func (a *KubernetesTotalMemoryRequirement) Validate(spec AnalyzerSpec) error

type KubernetesVersionRequirement

type KubernetesVersionRequirement struct {
	SemverMin string `json:"semver_minimum" yaml:"semver_minimum" hcl:"semver_minimum"`
}

func (*KubernetesVersionRequirement) GetRawSpec

func (a *KubernetesVersionRequirement) GetRawSpec() (RawSpec, error)

func (*KubernetesVersionRequirement) Validate

func (a *KubernetesVersionRequirement) Validate(spec AnalyzerSpec) error

type RawRequirement

type RawRequirement struct {
	Conditions []Condition `json:"conditions" yaml:"conditions" hcl:"conditions"`
}

func (*RawRequirement) GetRawSpec

func (r *RawRequirement) GetRawSpec() (RawSpec, error)

func (*RawRequirement) Validate

func (r *RawRequirement) Validate(spec AnalyzerSpec) error

type RawSpec

type RawSpec struct {
	AnalyzerShared `json:",inline" yaml:",inline" hcl:",inline"`

	Raw *RawRequirement `json:"raw,omitempty" yaml:"raw,omitempty" hcl:"raw,omitempty"`
}

RawSpec is a translated spec from an AnalyzerSpec

type Requirement

type Requirement interface {
	Validate(spec AnalyzerSpec) error
	GetRawSpec() (RawSpec, error)
}

type SelinuxNotEnforcingRequirement

type SelinuxNotEnforcingRequirement struct {
}

func (*SelinuxNotEnforcingRequirement) GetRawSpec

func (a *SelinuxNotEnforcingRequirement) GetRawSpec() (RawSpec, error)

func (*SelinuxNotEnforcingRequirement) Validate

func (a *SelinuxNotEnforcingRequirement) Validate(spec AnalyzerSpec) error