config

package
v0.0.0-...-50482f3 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 8, 2026 License: AGPL-3.0 Imports: 15 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var ConfigSchema = config.Schema{
	Types: map[string]config.Key{

		"acme.ca_url": {Validator: validate.Optional(validate.IsHTTPSURL)},

		"acme.domain": {},

		"acme.email": {},

		"acme.agree_tos": {Type: config.Bool, Default: "false"},

		"backups.compression_algorithm": {Default: "gzip", Validator: validate.IsCompressionAlgorithm},

		"cluster.offline_threshold": {Type: config.Int64, Default: offlineThresholdDefault(), Validator: offlineThresholdValidator},

		"cluster.images_minimal_replica": {Type: config.Int64, Default: "3", Validator: imageMinimalReplicaValidator},

		"cluster.healing_threshold": {Type: config.Int64, Default: "0"},

		"cluster.join_token_expiry": {Type: config.String, Default: "3H", Validator: expiryValidator},

		"cluster.max_voters": {Type: config.Int64, Default: "3", Validator: maxVotersValidator},

		"cluster.max_standby": {Type: config.Int64, Default: "2", Validator: maxStandByValidator},

		"core.metrics_authentication": {Type: config.Bool, Default: "true"},

		"core.bgp_asn": {Type: config.Int64, Default: "0", Validator: validate.Optional(validate.IsInRange(0, 4294967294))},

		"core.https_allowed_headers": {},

		"core.https_allowed_methods": {},

		"core.https_allowed_origin": {},

		"core.https_allowed_credentials": {Type: config.Bool, Default: "false"},

		"core.https_trusted_proxy": {},

		"core.proxy_http": {},

		"core.proxy_https": {},

		"core.proxy_ignore_hosts": {},

		"core.remote_token_expiry": {Type: config.String, Default: "15d", Validator: expiryValidator},

		"core.shutdown_timeout": {Type: config.Int64, Default: "5"},

		"core.trust_ca_certificates": {Type: config.Bool, Default: "false"},

		"core.auth_secret_expiry": {Type: config.String, Default: "1m", Validator: func(s string) error {
			now := time.Now().UTC()
			exp, err := shared.GetExpiry(now, s)
			if err != nil {
				return err
			}

			if exp.Sub(now) < 24*time.Hour {
				return errors.New("Auth secret expiry cannot be set to less than one day")
			}

			return nil
		}},

		"images.auto_update_cached": {Type: config.Bool, Default: "true"},

		"images.auto_update_interval": {Type: config.Int64, Default: "6"},

		"images.compression_algorithm": {Default: "gzip", Validator: validate.IsCompressionAlgorithm},

		"images.default_architecture": {Validator: validate.Optional(validate.IsArchitecture)},

		"images.remote_cache_expiry": {Type: config.Int64, Default: "10"},

		"instances.nic.host_name": {Validator: validate.Optional(validate.IsOneOf("random", "mac"))},

		"instances.migration.stateful": {Type: config.Bool, Default: "false"},

		"loki.auth.username": {},

		"loki.auth.password": {},

		"loki.api.ca_cert": {},

		"loki.api.url": {},

		"loki.instance": {},

		"loki.labels": {},

		"loki.loglevel": {Validator: logLevelValidator, Default: logrus.InfoLevel.String()},

		"loki.types": {Validator: validate.Optional(validate.IsListOf(validate.IsOneOf(
			api.EventTypeLifecycle, api.EventTypeLogging, api.EventTypeOVN, api.EventTypeSecurity,
		))), Default: "lifecycle,logging"},

		"oidc.client.id": {},

		"oidc.client.secret": {},

		"oidc.issuer": {},

		"oidc.audience": {},

		"oidc.scopes": {
			Default: strings.Join([]string{oidc.ScopeOpenID, oidc.ScopeEmail, oidc.ScopeOfflineAccess, oidc.ScopeProfile}, " "),
			Validator: validate.Optional(func(value string) error {
				scopes := strings.Fields(value)
				if !slices.Contains(scopes, oidc.ScopeOpenID) || !slices.Contains(scopes, oidc.ScopeEmail) {
					return fmt.Errorf("oidc.scopes requires the %q and %q OpenID Connect scopes", oidc.ScopeOpenID, oidc.ScopeEmail)
				}

				return nil
			}),
		},

		"oidc.groups.claim": {},

		"oidc.session.expiry": {Default: "1w", Validator: func(s string) error {
			now := time.Now().UTC()
			exp, err := shared.GetExpiry(now, s)
			if err != nil {
				return err
			}

			if exp.Sub(now) < time.Hour {
				return errors.New("OIDC session expiry cannot be set to less than one hour")
			}

			return nil
		}},

		"network.ovn.integration_bridge": {Default: "br-int"},

		"network.ovn.northbound_connection": {Default: ""},

		"network.ovn.ca_cert": {Default: ""},

		"network.ovn.client_cert": {Default: ""},

		"network.ovn.client_key": {Default: ""},

		"volatile.uuid": {},
	},
}

ConfigSchema defines available server configuration keys.

Functions

This section is empty.

Types

type Config 

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

Config holds cluster-wide configuration values.

func Load 

func Load(ctx context.Context, tx *db.ClusterTx) (*Config, error)

Load loads a new Config object with the current cluster configuration values fetched from the database.

func (*Config) ACME 

func (c *Config) ACME() (domain string, email string, caURL string, agreeTOS bool)

ACME returns all ACME settings needed for certificate renewal.

func (*Config) AuthSecretExpiry 

func (c *Config) AuthSecretExpiry() string

AuthSecretExpiry returns the time after which an core secret is invalid.

func (*Config) BGPASN 

func (c *Config) BGPASN() int64

BGPASN returns the BGP ASN setting.

func (*Config) BackupsCompressionAlgorithm 

func (c *Config) BackupsCompressionAlgorithm() string

BackupsCompressionAlgorithm returns the compression algorithm to use for backups.

func (*Config) ClusterHealingThreshold 

func (c *Config) ClusterHealingThreshold() time.Duration

ClusterHealingThreshold returns the configured healing threshold, i.e. the number of seconds after which an offline node will be evacuated automatically. If the config key is set but its value is lower than cluster.offline_threshold it returns the value of cluster.offline_threshold instead. If this feature is disabled, it returns 0.

func (*Config) ClusterJoinTokenExpiry 

func (c *Config) ClusterJoinTokenExpiry() string

ClusterJoinTokenExpiry returns the cluster join token expiry.

func (*Config) ClusterUUID 

func (c *Config) ClusterUUID() string

ClusterUUID returns the static cluster UUID.

func (*Config) Dump 

func (c *Config) Dump() map[string]string

Dump current configuration keys and their values. Keys with values matching their defaults are omitted.

func (*Config) HTTPSAllowedCredentials 

func (c *Config) HTTPSAllowedCredentials() bool

HTTPSAllowedCredentials returns the relevant CORS setting.

func (*Config) HTTPSAllowedHeaders 

func (c *Config) HTTPSAllowedHeaders() string

HTTPSAllowedHeaders returns the relevant CORS setting.

func (*Config) HTTPSAllowedMethods 

func (c *Config) HTTPSAllowedMethods() string

HTTPSAllowedMethods returns the relevant CORS setting.

func (*Config) HTTPSAllowedOrigin 

func (c *Config) HTTPSAllowedOrigin() string

HTTPSAllowedOrigin returns the relevant CORS setting.

func (*Config) HTTPSTrustedProxy 

func (c *Config) HTTPSTrustedProxy() string

HTTPSTrustedProxy returns the configured HTTPS trusted proxy setting, if any.

func (*Config) ImagesAutoUpdateCached 

func (c *Config) ImagesAutoUpdateCached() bool

ImagesAutoUpdateCached returns whether or not to auto update cached images.

func (*Config) ImagesAutoUpdateIntervalHours 

func (c *Config) ImagesAutoUpdateIntervalHours() int64

ImagesAutoUpdateIntervalHours returns interval in hours at which to look for update to cached images.

func (*Config) ImagesCompressionAlgorithm 

func (c *Config) ImagesCompressionAlgorithm() string

ImagesCompressionAlgorithm returns the compression algorithm to use for images.

func (*Config) ImagesDefaultArchitecture 

func (c *Config) ImagesDefaultArchitecture() string

ImagesDefaultArchitecture returns the default architecture.

func (*Config) ImagesMinimalReplica 

func (c *Config) ImagesMinimalReplica() int64

ImagesMinimalReplica returns the numbers of nodes for cluster images replication.

func (*Config) ImagesRemoteCacheExpiryDays 

func (c *Config) ImagesRemoteCacheExpiryDays() int64

ImagesRemoteCacheExpiryDays returns the number of days after which an unused cached remote image will be flushed.

func (*Config) InstancesMigrationStateful 

func (c *Config) InstancesMigrationStateful() bool

InstancesMigrationStateful returns the whether or not to auto enable migration.stateful for all VM instances.

func (*Config) InstancesNICHostname 

func (c *Config) InstancesNICHostname() string

InstancesNICHostname returns hostname mode to use for instance NICs.

func (*Config) LokiServer 

func (c *Config) LokiServer() (apiURL string, authUsername string, authPassword string, apiCACert string, instance string, logLevel string, labels []string, types []string)

LokiServer returns all the Loki settings needed to connect to a server.

func (*Config) MaxStandBy 

func (c *Config) MaxStandBy() int64

MaxStandBy returns the maximum number of standby members in a cluster that will be assigned the stand-by role.

func (*Config) MaxVoters 

func (c *Config) MaxVoters() int64

MaxVoters returns the maximum number of members in a cluster that will be assigned the voter role.

func (*Config) MetricsAuthentication 

func (c *Config) MetricsAuthentication() bool

MetricsAuthentication checks whether metrics API requires authentication.

func (*Config) NetworkOVNIntegrationBridge 

func (c *Config) NetworkOVNIntegrationBridge() string

NetworkOVNIntegrationBridge returns the integration OVS bridge to use for OVN networks.

func (*Config) NetworkOVNNorthboundConnection 

func (c *Config) NetworkOVNNorthboundConnection() string

NetworkOVNNorthboundConnection returns the OVN northbound database connection string for OVN networks.

func (*Config) NetworkOVNSSL 

func (c *Config) NetworkOVNSSL() (caCert string, clientCert string, clientKey string)

NetworkOVNSSL returns all three SSL configuration keys needed for a connection.

func (*Config) OIDCServer 

func (c *Config) OIDCServer() (issuer string, clientID string, clientSecret string, scopes []string, audience string, groupsClaim string)

OIDCServer returns all the OpenID Connect settings needed to connect to a server.

func (*Config) OIDCSessionExpiry 

func (c *Config) OIDCSessionExpiry() (expiry string)

OIDCSessionExpiry returns the expiry of an OIDC session. This is separate from OIDCServer as it is passed into the session manager via a function that gets the value as necessary, so we don't need to refresh the oidc.Verifier each time this changes.

func (*Config) OfflineThreshold 

func (c *Config) OfflineThreshold() time.Duration

OfflineThreshold returns the configured heartbeat threshold, i.e. the number of seconds before after which an unresponsive node is considered offline..

func (*Config) Patch 

func (c *Config) Patch(tx *db.ClusterTx, patch map[string]string) (map[string]string, error)

Patch changes only the configuration keys in the given map.

Return what has actually changed.

func (*Config) ProxyHTTP 

func (c *Config) ProxyHTTP() string

ProxyHTTP returns the configured HTTP proxy, if any.

func (*Config) ProxyHTTPS 

func (c *Config) ProxyHTTPS() string

ProxyHTTPS returns the configured HTTPS proxy, if any.

func (*Config) ProxyIgnoreHosts 

func (c *Config) ProxyIgnoreHosts() string

ProxyIgnoreHosts returns the configured ignore-hosts proxy setting, if any.

func (*Config) RemoteTokenExpiry 

func (c *Config) RemoteTokenExpiry() string

RemoteTokenExpiry returns the time after which a remote add token expires.

func (*Config) Replace 

func (c *Config) Replace(tx *db.ClusterTx, values map[string]string) (map[string]string, error)

Replace the current configuration with the given values.

Return what has actually changed.

func (*Config) ShutdownTimeout 

func (c *Config) ShutdownTimeout() time.Duration

ShutdownTimeout returns the number of minutes to wait for running operation to complete before LXD server shut down.

func (*Config) TrustCACertificates 

func (c *Config) TrustCACertificates() bool

TrustCACertificates returns whether client certificates are checked against a CA.

func (*Config) UserMicrocloud 

func (c *Config) UserMicrocloud() bool

UserMicrocloud returns whether the user.microcloud key is set.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.