enforcement

Documentation

Overview

Package enforcement implements filesystem watching for configured required updates.

Index

• func Watcher(file chan<- string) error
• type DriverExclude
• type Enforcements
  • func Get() (Enforcements, error)

Functions

func Watcher

func Watcher(file chan<- string) error

Watcher runs a filesystem watcher for required updates. This is meant to install required updates as soon as they are configured. All configured required updates are read on a schedule (see cabbie.go t.Enforcement ticker usage) to ensure required updates are installed even if a filesystem event is missed.

Types

type DriverExclude

type DriverExclude struct {
	DriverClass string `json:"driver-class"`
	UpdateID    string `json:"update-id"`
}

DriverExclude specifies criteria to exclude certain driver updates. A driver update is ignored by Cabbie if it matches all criteria.

type Enforcements

type Enforcements struct {
	Required        []string        `json:"required"`
	ExcludedDrivers []DriverExclude `json:"excluded-drivers"`
	Hidden          []string        `json:"hidden"`
}

Enforcements track any externally configured update enforcements.

func Get

func Get() (Enforcements, error)

Get attempts to return all known external enforcements.