controller

Documentation

Overview

Package controller provides the primary application logic for the Open Keyless controller module.

Index

• Constants
• type Controller
  • func NewController(config ControllerConfig) (*Controller, error)
  • func (c *Controller) Run()
• type ControllerConfig
  • func NewControllerConfig() (ControllerConfig, error)

Constants

const (
	// ErrAirtableAPIKeyNotFound is returned when the Airtable API key is not found in the config.
	ErrAirtableAPIKeyNotFound = "could not find the required airtable API key in the config"

	// ErrAirtableBaseIDNotFound is returned when the Airtable Base ID is not found in the config.
	ErrAirtableBaseIDNotFound = "could not find the required airtable base ID in the config"
)

Types

type Controller

type Controller struct {
	// contains filtered or unexported fields
}

Controller is the primary struct for Open Keyless controller.

func NewController

func NewController(config ControllerConfig) (*Controller, error)

NewController provides an initialized Controller with the provided configuration.

func (*Controller) Run

func (c *Controller) Run()

Run will run the controller in a blocking fashion.

type ControllerConfig

type ControllerConfig struct {
	// AirtableConfig is a configuration object for the Airtable Datastore.
	AirtableConfig datastore.AirtableDatastoreConfig

	// ApplicationConfig is used to configure metrics and logging for the controller.
	ApplicationConfig application.Config

	// TextFileConfig is used to configure the TextFile config.
	TextFileConfig datastore.TextFileConfig
}

ControllerConfig provides configuration for the Controller application.

func NewControllerConfig

func NewControllerConfig() (ControllerConfig, error)

NewControllerConfig provides a populated controller config from a configuration file.