Documentation
¶
Index ¶
- Constants
- Variables
- func CurrentConfig() *currentConfig
- func FileExists(path string) (bool, error)
- func NewLoggerConfig(configPath Path, overrides Overrider) (*logger.Config, error)
- func SetEnvVars(fileContents string) (string, error)
- type AuthnConfig
- type CallOptions
- type CommandMode
- type Common
- type Config
- type DecisionLogConfig
- type Generator
- func (g *Generator) CreateCertsDir() (string, error)
- func (g *Generator) CreateConfigDir() (string, error)
- func (g *Generator) CreateDataDir() (string, error)
- func (g *Generator) GenerateConfig(w io.Writer, templateData string) error
- func (g *Generator) WithEdgeDirectory(enabled bool) *Generator
- func (g *Generator) WithEnableDirectoryV2(enabled bool) *Generator
- func (g *Generator) WithLocalPolicyImage(image string) *Generator
- func (g *Generator) WithPolicyName(policyName string) *Generator
- func (g *Generator) WithResource(resource string) *Generator
- func (g *Generator) WithVersion(version int) *Generator
- type Loader
- type LoggerConfig
- type OptionOverrides
- type Options
- type Overrider
- type Path
- type ServicesConfig
Constants ¶
View Source
const ConfigFileVersion = 2
View Source
const LocalImageTemplate = templatePreamble + `
opa:
instance_id: "-"
graceful_shutdown_period_seconds: 2
# max_plugin_wait_time_seconds: 30 set as default
local_bundles:
local_policy_image: {{ .LocalPolicyImage }}
watch: true
skip_verification: true
`
View Source
const Template = templatePreamble + `
opa:
instance_id: "-"
graceful_shutdown_period_seconds: 2
# max_plugin_wait_time_seconds: 30 set as default
local_bundles:
paths: []
skip_verification: true
config:
services:
ghcr:
url: https://ghcr.io
type: "oci"
response_header_timeout_seconds: 5
bundles:
{{ .PolicyName }}:
service: ghcr
resource: "{{ .Resource }}"
persist: false
config:
polling:
min_delay_seconds: 60
max_delay_seconds: 120
`
Variables ¶
View Source
var ( DefaultTLSGenDir = os.ExpandEnv("$HOME/.config/topaz/certs") CertificateSets = []string{"grpc", "gateway"} )
Functions ¶
func CurrentConfig ¶ added in v0.31.5
func CurrentConfig() *currentConfig
func FileExists ¶ added in v0.30.25
func NewLoggerConfig ¶
NewLoggerConfig creates a new LoggerConfig.
func SetEnvVars ¶ added in v0.30.29
Types ¶
type AuthnConfig ¶
type AuthnConfig struct {
APIKeys map[string]string `json:"api_keys"`
Options CallOptions `json:"options"`
}
type CallOptions ¶
type CallOptions struct {
Default Options `json:"default"`
Overrides []OptionOverrides `json:"overrides"`
}
func (*CallOptions) ForPath ¶
func (co *CallOptions) ForPath(path string) *Options
type CommandMode ¶
type CommandMode int
CommandMode -- enum type.
const ( CommandModeUnknown CommandMode = 0 + iota CommandModeRun CommandModeBuild )
CommandMode -- enum constants.
type Common ¶
type Common struct {
Version int `json:"version"`
Logging logger.Config `json:"logging"`
Command struct {
Mode CommandMode
} `json:"-"`
APIConfig ServicesConfig `json:"api"`
JWT struct {
// Specifies the duration in which exp (Expiry) and nbf (Not Before)
// claims may differ by. This value should be positive.
AcceptableTimeSkewSeconds int `json:"acceptable_time_skew_seconds"`
} `json:"jwt"`
// Directory configuration
Edge directory.Config `json:"directory"`
// Authorizer directory resolver configuration
DirectoryResolver client.Config `json:"remote_directory"`
// Default OPA configuration
OPA runtime.Config `json:"opa"`
}
Config holds the configuration for the app.
type Config ¶
type Config struct {
Common `json:",squash"` // nolint:staticcheck // squash is used by mapstructure
Auth AuthnConfig `json:"auth"`
DecisionLogger DecisionLogConfig `json:"decision_logger"`
ControllerConfig *controller.Config `json:"controller"`
}
type DecisionLogConfig ¶ added in v0.25.6
type Generator ¶ added in v0.30.29
type Generator struct {
ConfigName string
// contains filtered or unexported fields
}
func NewGenerator ¶ added in v0.30.29
func (*Generator) CreateCertsDir ¶ added in v0.30.29
func (*Generator) CreateConfigDir ¶ added in v0.30.29
func (*Generator) CreateDataDir ¶ added in v0.30.29
func (*Generator) GenerateConfig ¶ added in v0.30.29
func (*Generator) WithEdgeDirectory ¶ added in v0.30.29
func (*Generator) WithEnableDirectoryV2 ¶ added in v0.30.29
func (*Generator) WithLocalPolicyImage ¶ added in v0.30.29
func (*Generator) WithPolicyName ¶ added in v0.30.29
func (*Generator) WithResource ¶ added in v0.30.29
func (*Generator) WithVersion ¶ added in v0.30.29
type Loader ¶ added in v0.30.29
type Loader struct {
Configuration *Config
}
func LoadConfiguration ¶ added in v0.30.29
type LoggerConfig ¶
type LoggerConfig Config
LoggerConfig is a basic Config copy that gets loaded before everything else, so we can log during resolving configuration.
type OptionOverrides ¶
type ServicesConfig ¶ added in v0.30.0
type ServicesConfig struct {
Health struct {
ListenAddress string `json:"listen_address"`
Certificates *certs.TLSCredsConfig `json:"certs"`
} `json:"health"`
Metrics struct {
ListenAddress string `json:"listen_address"`
Certificates *certs.TLSCredsConfig `json:"certs"`
ZPages bool `json:"zpages"`
} `json:"metrics"`
Services map[string]*builder.API `json:"services"`
}
Click to show internal directories.
Click to hide internal directories.