env

Documentation

Index

• type AuditClient
• type Clients
• type Configuration
• type DockerClient
• type Env
• type KubeClient
• type RegoConfiguration

Types

type AuditClient

type AuditClient interface {
	GetFileWatchRules() ([]*rule.FileWatchRule, error)
	Close() error
}

AuditClient defines the interface for interacting with the auditd client

type Clients

type Clients interface {
	DockerClient() DockerClient
	AuditClient() AuditClient
	KubeClient() KubeClient
}

Clients provides an abstraction for accessing various clients needed by checks

type Configuration

type Configuration interface {
	Hostname() string
	MaxEventsPerRun() int
	EtcGroupPath() string
	NormalizeToHostRoot(path string) string
	RelativeToHostRoot(path string) string
	EvaluateFromCache(e eval.Evaluatable) (interface{}, error)
	IsLeader() bool
	NodeLabels() map[string]string
}

Configuration provides an abstraction for various environment methods used by checks

type DockerClient

type DockerClient interface {
	client.ConfigAPIClient
	client.ContainerAPIClient
	client.ImageAPIClient
	client.NodeAPIClient
	client.NetworkAPIClient
	client.SystemAPIClient
	client.VolumeAPIClient
	ServerVersion(ctx context.Context) (types.Version, error)
	Close() error
}

DockerClient abstracts Docker API client

type Env

type Env interface {
	Clients
	Configuration
	RegoConfiguration
	Reporter() event.Reporter
}

Env provides environment methods for compliance checks execution

type KubeClient

type KubeClient interface {
	dynamic.Interface
	ClusterID() (string, error)
}

KubeClient is the Kubernetes (API server) client interface

type RegoConfiguration

type RegoConfiguration interface {
	ProvidedInput(ruleID string) eval.RegoInputMap
	DumpInputPath() string
}

RegoConfiguration provides the rego specific configuration