securityhardenedk8s

Documentation

Index

• Constants
• Variables
• type CreateOption
  • func WithConfig(config *rest.Config) CreateOption
  • func WithLogger(logger *slog.Logger) CreateOption
  • func WithNumberOfWorkers(numWorkers int) CreateOption
  • func WithVersion(version string) CreateOption
• type Ruleset
  • func FromGenericConfig(rulesetConfig config.RulesetConfig, managedConfig *rest.Config) (*Ruleset, error)
  • func New(options ...CreateOption) (*Ruleset, error)
  • func (r *Ruleset) AddRules(rules ...rule.Rule) error
  • func (r *Ruleset) ID() string
  • func (r *Ruleset) Logger() *slog.Logger
  • func (r *Ruleset) Name() string
  • func (r *Ruleset) Run(ctx context.Context) (ruleset.RulesetResult, error)
  • func (r *Ruleset) RunRule(ctx context.Context, id string) (rule.RuleResult, error)
  • func (r *Ruleset) Version() string

Constants

const (
	// RulesetID is a constant containing the id of the Security Hardened Kubernetes Cluster Ruleset.
	RulesetID = "security-hardened-k8s"
	// RulesetName is a constant containing the user-friendly name of the Security Hardened Kubernetes ruleset.
	RulesetName = "Security Hardened Kubernetes Cluster"
)

Variables

var (

	// SupportedVersions is a list of available versions for the Security Hardened Kubernetes Cluster Ruleset.
	// Versions are sorted from newest to oldest.
	SupportedVersions = []string{"v0.1.0"}
)

Types

type CreateOption

type CreateOption func(*Ruleset)

CreateOption is a function that acts on a Ruleset and is used to construct such objects.

func WithConfig

func WithConfig(config *rest.Config) CreateOption

WithConfig sets the Config of a Ruleset.

func WithLogger

func WithLogger(logger *slog.Logger) CreateOption

WithLogger the logger of a Ruleset.

func WithNumberOfWorkers

func WithNumberOfWorkers(numWorkers int) CreateOption

WithNumberOfWorkers sets the max number of Workers of a Ruleset.

func WithVersion

func WithVersion(version string) CreateOption

WithVersion sets the version of a Ruleset.

type Ruleset

type Ruleset struct {
	Config *rest.Config
	// contains filtered or unexported fields
}

Ruleset implements Security Hardened Kubernetes Cluster.

func FromGenericConfig

func FromGenericConfig(rulesetConfig config.RulesetConfig, managedConfig *rest.Config) (*Ruleset, error)

FromGenericConfig creates a Ruleset from a RulesetConfig

func New

func New(options ...CreateOption) (*Ruleset, error)

New creates a new Ruleset.

func (*Ruleset) AddRules

func (r *Ruleset) AddRules(rules ...rule.Rule) error

AddRules adds Rules to the Ruleset.

func (*Ruleset) ID

func (r *Ruleset) ID() string

ID returns the id of the Ruleset.

func (*Ruleset) Logger

func (r *Ruleset) Logger() *slog.Logger

Logger returns the Ruleset's logger. If not set it set it to slog.Default().With("ruleset", r.ID(), "version", r.Version() then return it.

func (*Ruleset) Name

func (r *Ruleset) Name() string

Name returns the name of the Ruleset.

func (*Ruleset) Run

func (r *Ruleset) Run(ctx context.Context) (ruleset.RulesetResult, error)

Run executes all known Rules of the Ruleset.

func (*Ruleset) RunRule

func (r *Ruleset) RunRule(ctx context.Context, id string) (rule.RuleResult, error)

RunRule executes specific known Rule of the Ruleset.

func (*Ruleset) Version

func (r *Ruleset) Version() string

Version returns the version of the Ruleset.