config

Documentation

Index

• type AntidoteConfig
  • func LoadConfig(configFile string) (AntidoteConfig, error)
  • func (c *AntidoteConfig) IsServiceEnabled(serviceName string) bool
  • func (c *AntidoteConfig) JSON() string
• type BackendConfigs
• type KubernetesConfig

Types

type AntidoteConfig

type AntidoteConfig struct {
	InstanceID string `yaml:"instanceId"`

	Tier string `yaml:"tier"`

	// HepsDomain is the domain on which HEPS hostnames should be provisioned. This domain is used
	// as the direct parent for any subdomains that are configured for ingresses that allow access to
	// HTTP endpoints. Note that these subdomains automatically include the antidote instance ID, so
	// it's safe to have multiple instances of antidote running with the same HepsDomain
	// configured.
	HEPSDomain string `yaml:"hepsDomain"`

	ImageOrg string `yaml:"imageOrg"`
	GRPCPort int    `yaml:"grpcPort"`
	HTTPPort int    `yaml:"httpPort"`

	// Both TTL options are in minutes
	LiveSessionTTL int `yaml:"liveSessionTTL"`
	LiveLessonTTL  int `yaml:"liveLessonTTL"`

	// Limits the number of sessions that can be requested by a single IP address
	LiveSessionLimit int `yaml:"liveSessionLimit"`

	// Less important but still useful. LiveLessons are already bound to a session ID, so the
	// number of livelessons that can be spun up by a single session is bound to the number of
	// lessons in a given curriculum. This option, however, can be used to further limit the number
	// of concurrent livelessons for a single session
	LiveLessonLimit int `yaml:"liveLessonLimit"`

	Stats struct {
		URL      string `yaml:"url"`
		Username string `yaml:"username"`
		Password string `yaml:"password"`
	} `yaml:"stats"`

	AlwaysPull bool `yaml:"alwaysPull"`

	// ALL backends must default to a secure network policy, by restricting traffic outside the smallest unit necessary to
	// make intra-lesson traffic possible. This config option can be used to instruct the backend to change this policy to allow traffic outside
	// this boundary. For the kubernetes backend, this boundary is the namespace.
	AllowEgress bool `yaml:"allowEgress"`

	CurriculumDir     string `yaml:"curriculumDir"`
	CurriculumVersion string `yaml:"curriculumVersion"`

	EnabledServices []string `yaml:"enabledServices"`

	NATSUrl string `yaml:"natsUrl"`

	// ONLY meant to be used for development purposes. Statically sets session ID, and a few other things useful
	// for development purposes.
	DevMode bool `yaml:"devMode"`

	Backend        string         `yaml:"backend"`
	BackendConfigs BackendConfigs `yaml:"backendConfigs"`
}

func LoadConfig

func LoadConfig(configFile string) (AntidoteConfig, error)

func (*AntidoteConfig) IsServiceEnabled

func (c *AntidoteConfig) IsServiceEnabled(serviceName string) bool

IsServiceEnabled checks the config for a given service name, and if included, returns true. Otherwise, returns false.

func (*AntidoteConfig) JSON

func (c *AntidoteConfig) JSON() string

type BackendConfigs

type BackendConfigs struct {
	Kubernetes KubernetesConfig `yaml:"kubernetes"`
}

BackendConfigs holds configuration options that are specific to a particular backend. The field in BackendConfigs should match the backend name it refers to, for consistency.

type KubernetesConfig

type KubernetesConfig struct {
	// InCluster controls whether or not the kubernetes backend uses an in-cluster
	// configuration for communicating with kubernetes. Since this is the typical deployment
	// scenario, this defaults to true.
	//
	// However, for development, it may be useful to use an out of cluster configuration,
	// so you can run antidoted directly instead of packaging it in a container image and deploying
	// to your cluster. In this case, set InCluster to false, and provide the path to
	// your kubeconfig via OutOfClusterConfigPath
	InCluster              bool   `yaml:"inCluster"`
	OutOfClusterConfigPath string `yaml:"outOfClusterConfigPath"`

	SecretsNamespace string `yaml:"secretsNamespace"`
	TLSCertName      string `yaml:"tlsCertName"`
	// https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/
	PullCredName string `yaml:"pullCredName"`
}