1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089
|
package config
import (
"context"
"errors"
"fmt"
"maps"
"strconv"
"strings"
"time"
"github.com/sirupsen/logrus"
internalInstance "github.com/lxc/incus/v6/internal/instance"
"github.com/lxc/incus/v6/internal/server/config"
"github.com/lxc/incus/v6/internal/server/db"
scriptletLoad "github.com/lxc/incus/v6/internal/server/scriptlet/load"
"github.com/lxc/incus/v6/shared/validate"
)
// Config holds cluster-wide configuration values.
type Config struct {
tx *db.ClusterTx // DB transaction the values in this config are bound to.
m config.Map // Low-level map holding the config values.
}
// Load loads a new Config object with the current cluster configuration
// values fetched from the database.
func Load(ctx context.Context, tx *db.ClusterTx) (*Config, error) {
// Load current raw values from the database, any error is fatal.
values, err := tx.Config(ctx)
if err != nil {
return nil, fmt.Errorf("cannot fetch node config from database: %w", err)
}
m, err := config.SafeLoad(ConfigSchema, values)
if err != nil {
return nil, fmt.Errorf("failed to load node config: %w", err)
}
return &Config{tx: tx, m: m}, nil
}
// BackupsCompressionAlgorithm returns the compression algorithm to use for backups.
func (c *Config) BackupsCompressionAlgorithm() string {
return c.m.GetString("backups.compression_algorithm")
}
// MetricsAuthentication checks whether metrics API requires authentication.
func (c *Config) MetricsAuthentication() bool {
return c.m.GetBool("core.metrics_authentication")
}
// BGPASN returns the BGP ASN setting.
func (c *Config) BGPASN() int64 {
return c.m.GetInt64("core.bgp_asn")
}
// HTTPSAllowedHeaders returns the relevant CORS setting.
func (c *Config) HTTPSAllowedHeaders() string {
return c.m.GetString("core.https_allowed_headers")
}
// HTTPSAllowedMethods returns the relevant CORS setting.
func (c *Config) HTTPSAllowedMethods() string {
return c.m.GetString("core.https_allowed_methods")
}
// HTTPSAllowedOrigin returns the relevant CORS setting.
func (c *Config) HTTPSAllowedOrigin() string {
return c.m.GetString("core.https_allowed_origin")
}
// HTTPSAllowedCredentials returns the relevant CORS setting.
func (c *Config) HTTPSAllowedCredentials() bool {
return c.m.GetBool("core.https_allowed_credentials")
}
// TrustCACertificates returns whether client certificates are checked
// against a CA.
func (c *Config) TrustCACertificates() bool {
return c.m.GetBool("core.trust_ca_certificates")
}
// ProxyHTTPS returns the configured HTTPS proxy, if any.
func (c *Config) ProxyHTTPS() string {
return c.m.GetString("core.proxy_https")
}
// ProxyHTTP returns the configured HTTP proxy, if any.
func (c *Config) ProxyHTTP() string {
return c.m.GetString("core.proxy_http")
}
// ProxyIgnoreHosts returns the configured ignore-hosts proxy setting, if any.
func (c *Config) ProxyIgnoreHosts() string {
return c.m.GetString("core.proxy_ignore_hosts")
}
// HTTPSTrustedProxy returns the configured HTTPS trusted proxy setting, if any.
func (c *Config) HTTPSTrustedProxy() string {
return c.m.GetString("core.https_trusted_proxy")
}
// OfflineThreshold returns the configured heartbeat threshold, i.e. the
// number of seconds before after which an unresponsive node is considered
// offline..
func (c *Config) OfflineThreshold() time.Duration {
n := c.m.GetInt64("cluster.offline_threshold")
return time.Duration(n) * time.Second
}
// ImagesMinimalReplica returns the numbers of nodes for cluster images replication.
func (c *Config) ImagesMinimalReplica() int64 {
return c.m.GetInt64("cluster.images_minimal_replica")
}
// MaxVoters returns the maximum number of members in a cluster that will be
// assigned the voter role.
func (c *Config) MaxVoters() int64 {
return c.m.GetInt64("cluster.max_voters")
}
// MaxStandBy returns the maximum number of standby members in a cluster that
// will be assigned the stand-by role.
func (c *Config) MaxStandBy() int64 {
return c.m.GetInt64("cluster.max_standby")
}
// ClusterRebalanceBatch returns maximum number of instances to move during one re-balancing run.
func (c *Config) ClusterRebalanceBatch() int64 {
return c.m.GetInt64("cluster.rebalance.batch")
}
// ClusterRebalanceCooldown returns amount of time during which an instance will not be moved again.
func (c *Config) ClusterRebalanceCooldown() string {
return c.m.GetString("cluster.rebalance.cooldown")
}
// ClusterRebalanceInterval returns the interval at which to evaluate re-balanicng.
func (c *Config) ClusterRebalanceInterval() int64 {
return c.m.GetInt64("cluster.rebalance.interval")
}
// ClusterRebalanceThreshold returns load difference between most and least busy server
// needed to trigger a migration.
func (c *Config) ClusterRebalanceThreshold() int64 {
return c.m.GetInt64("cluster.rebalance.threshold")
}
// NetworkOVNIntegrationBridge returns the integration OVS bridge to use for OVN networks.
func (c *Config) NetworkOVNIntegrationBridge() string {
return c.m.GetString("network.ovn.integration_bridge")
}
// NetworkOVNNorthboundConnection returns the OVN northbound database connection string for OVN networks.
func (c *Config) NetworkOVNNorthboundConnection() string {
return c.m.GetString("network.ovn.northbound_connection")
}
// NetworkOVNSSL returns all three SSL configuration keys needed for a connection.
func (c *Config) NetworkOVNSSL() (string, string, string) {
return c.m.GetString("network.ovn.ca_cert"), c.m.GetString("network.ovn.client_cert"), c.m.GetString("network.ovn.client_key")
}
// ShutdownTimeout returns the number of minutes to wait for running operation to complete
// before the server shuts down.
func (c *Config) ShutdownTimeout() time.Duration {
n := c.m.GetInt64("core.shutdown_timeout")
return time.Duration(n) * time.Minute
}
// ImagesDefaultArchitecture returns the default architecture.
func (c *Config) ImagesDefaultArchitecture() string {
return c.m.GetString("images.default_architecture")
}
// ImagesCompressionAlgorithm returns the compression algorithm to use for images.
func (c *Config) ImagesCompressionAlgorithm() string {
return c.m.GetString("images.compression_algorithm")
}
// ImagesAutoUpdateCached returns whether or not to auto update cached images.
func (c *Config) ImagesAutoUpdateCached() bool {
return c.m.GetBool("images.auto_update_cached")
}
// ImagesAutoUpdateIntervalHours returns interval in hours at which to look for update to cached images.
func (c *Config) ImagesAutoUpdateIntervalHours() int64 {
return c.m.GetInt64("images.auto_update_interval")
}
// ImagesRemoteCacheExpiryDays returns the number of days after which an unused cached remote image will be flushed.
func (c *Config) ImagesRemoteCacheExpiryDays() int64 {
return c.m.GetInt64("images.remote_cache_expiry")
}
// InstancesNICHostname returns hostname mode to use for instance NICs.
func (c *Config) InstancesNICHostname() string {
return c.m.GetString("instances.nic.host_name")
}
// InstancesPlacementScriptlet returns the instances placement scriptlet source code.
func (c *Config) InstancesPlacementScriptlet() string {
return c.m.GetString("instances.placement.scriptlet")
}
// AuthorizationScriptlet returns the authorization scriptlet source code.
func (c *Config) AuthorizationScriptlet() string {
return c.m.GetString("authorization.scriptlet")
}
// InstancesLXCFSPerInstance returns whether LXCFS should be run on a per-instance basis.
func (c *Config) InstancesLXCFSPerInstance() bool {
return c.m.GetBool("instances.lxcfs.per_instance")
}
// LokiServer returns all the Loki settings needed to connect to a server.
func (c *Config) LokiServer() (string, string, string, string, string, string, []string, []string) {
var types []string
var labels []string
if c.m.GetString("loki.types") != "" {
types = strings.Split(c.m.GetString("loki.types"), ",")
}
if c.m.GetString("loki.labels") != "" {
labels = strings.Split(c.m.GetString("loki.labels"), ",")
}
return c.m.GetString("loki.api.url"), c.m.GetString("loki.auth.username"), c.m.GetString("loki.auth.password"), c.m.GetString("loki.api.ca_cert"), c.m.GetString("loki.instance"), c.m.GetString("loki.loglevel"), labels, types
}
// ACME returns all ACME settings needed for certificate renewal.
func (c *Config) ACME() (string, string, string, bool, string) {
return c.m.GetString("acme.domain"), c.m.GetString("acme.email"), c.m.GetString("acme.ca_url"), c.m.GetBool("acme.agree_tos"), c.m.GetString("acme.challenge")
}
// ACMEDNS returns all ACME DNS settings needed for DNS-01 challenge.
func (c *Config) ACMEDNS() (string, []string, []string) {
var environment []string
var resolvers []string
if c.m.GetString("acme.provider.environment") != "" {
lines := strings.Split(strings.TrimSpace(c.m.GetString("acme.provider.environment")), "\n")
for _, line := range lines {
if len(strings.TrimSpace(line)) == 0 {
continue
}
parts := strings.SplitN(line, "=", 2)
if len(parts) != 2 {
logrus.Warnf("Malformed line in config string: %q", line)
continue
}
key := strings.TrimSpace(parts[0])
value := strings.TrimSpace(parts[1])
environment = append(environment, strings.Join([]string{key, value}, "="))
}
}
if c.m.GetString("acme.provider.resolvers") != "" {
resolvers = strings.Split(c.m.GetString("acme.provider.resolvers"), ",")
}
return c.m.GetString("acme.provider"), environment, resolvers
}
// ACMEHTTP returns all ACME HTTP settings needed for HTTP-01 challenge.
func (c *Config) ACMEHTTP() string {
return c.m.GetString("acme.http.port")
}
// ClusterJoinTokenExpiry returns the cluster join token expiry.
func (c *Config) ClusterJoinTokenExpiry() string {
return c.m.GetString("cluster.join_token_expiry")
}
// RemoteTokenExpiry returns the time after which a remote add token expires.
func (c *Config) RemoteTokenExpiry() string {
return c.m.GetString("core.remote_token_expiry")
}
// OIDCServer returns all the OpenID Connect settings needed to connect to a server.
func (c *Config) OIDCServer() (string, string, string, string, string) {
return c.m.GetString("oidc.issuer"), c.m.GetString("oidc.client.id"), c.m.GetString("oidc.scopes"), c.m.GetString("oidc.audience"), c.m.GetString("oidc.claim")
}
// 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 (c *Config) ClusterHealingThreshold() time.Duration {
n := c.m.GetInt64("cluster.healing_threshold")
if n == 0 {
return 0
}
healingThreshold := time.Duration(n) * time.Second
offlineThreshold := c.OfflineThreshold()
if healingThreshold < offlineThreshold {
return offlineThreshold
}
return healingThreshold
}
// OpenFGA returns all OpenFGA settings need to interact with an OpenFGA server.
func (c *Config) OpenFGA() (apiURL string, apiToken string, storeID string) {
return c.m.GetString("openfga.api.url"), c.m.GetString("openfga.api.token"), c.m.GetString("openfga.store.id")
}
// Loggers returns a map where the key is the logger name and the value is its type.
func (c *Config) Loggers() (map[string]string, error) {
result := make(map[string]string)
// Backward compatibility with old Loki config keys
if c.m.GetString("loki.api.url") != "" {
result["loki"] = "loki"
}
for k, v := range c.m.Dump() {
if !strings.HasPrefix(k, "logging.") {
continue
}
fields := strings.Split(k, ".")
if len(fields) < 3 {
return nil, fmt.Errorf("%s is not a valid logging config key", k)
}
loggingKey := strings.Join(fields[2:], ".")
if loggingKey != "target.type" {
continue
}
loggerName := fields[1]
_, exists := result[loggerName]
if !exists {
result[loggerName] = v
}
}
return result, nil
}
// LoggingCommonConfig returns the logging configuration common to all types of loggers.
func (c *Config) LoggingCommonConfig(loggerName string) (string, string, string, string) {
if loggerName == "loki" && c.m.GetString("loki.api.url") != "" {
return "", "", c.m.GetString("loki.loglevel"), c.m.GetString("loki.types")
}
prefix := fmt.Sprintf("logging.%s", loggerName)
lifecycleProjectsKey := fmt.Sprintf("%s.%s", prefix, "lifecycle.projects")
lifecycleTypesKey := fmt.Sprintf("%s.%s", prefix, "lifecycle.types")
loggingLevelKey := fmt.Sprintf("%s.%s", prefix, "logging.level")
typesKey := fmt.Sprintf("%s.%s", prefix, "types")
return c.m.GetString(lifecycleProjectsKey), c.m.GetString(lifecycleTypesKey), c.m.GetString(loggingLevelKey), c.m.GetString(typesKey)
}
// LoggingConfigForSyslog returns the logging configuration for the syslog logger type.
func (c *Config) LoggingConfigForSyslog(loggerName string) (string, string) {
prefix := fmt.Sprintf("logging.%s", loggerName)
addressKey := fmt.Sprintf("%s.%s", prefix, "target.address")
facilityKey := fmt.Sprintf("%s.%s", prefix, "target.facility")
return c.m.GetString(addressKey), c.m.GetString(facilityKey)
}
// LoggingConfigForLoki returns all the Loki settings needed to connect to a server.
func (c *Config) LoggingConfigForLoki(loggerName string) (string, string, string, string, string, string, int) {
if loggerName == "loki" && c.m.GetString("loki.api.url") != "" {
return c.m.GetString("loki.api.url"), c.m.GetString("loki.auth.username"), c.m.GetString("loki.auth.password"), c.m.GetString("loki.api.ca_cert"), c.m.GetString("loki.instance"), c.m.GetString("loki.labels"), 3
}
prefix := fmt.Sprintf("logging.%s", loggerName)
addressKey := fmt.Sprintf("%s.%s", prefix, "target.address")
usernameKey := fmt.Sprintf("%s.%s", prefix, "target.username")
passwordKey := fmt.Sprintf("%s.%s", prefix, "target.password")
caCertKey := fmt.Sprintf("%s.%s", prefix, "target.ca_cert")
instanceKey := fmt.Sprintf("%s.%s", prefix, "target.instance")
labelsKey := fmt.Sprintf("%s.%s", prefix, "target.labels")
retryKey := fmt.Sprintf("%s.%s", prefix, "target.retry")
return c.m.GetString(addressKey), c.m.GetString(usernameKey), c.m.GetString(passwordKey), c.m.GetString(caCertKey), c.m.GetString(instanceKey), c.m.GetString(labelsKey), int(c.m.GetInt64(retryKey))
}
// LoggingConfigForWebhook returns the logging configuration for the webhook logger type.
func (c *Config) LoggingConfigForWebhook(loggerName string) (string, string, string, string, int) {
prefix := fmt.Sprintf("logging.%s", loggerName)
addressKey := fmt.Sprintf("%s.%s", prefix, "target.address")
usernameKey := fmt.Sprintf("%s.%s", prefix, "target.username")
passwordKey := fmt.Sprintf("%s.%s", prefix, "target.password")
caCertKey := fmt.Sprintf("%s.%s", prefix, "target.ca_cert")
retryKey := fmt.Sprintf("%s.%s", prefix, "target.retry")
return c.m.GetString(addressKey), c.m.GetString(usernameKey), c.m.GetString(passwordKey), c.m.GetString(caCertKey), int(c.m.GetInt64(retryKey))
}
// Dump current configuration keys and their values. Keys with values matching
// their defaults are omitted.
func (c *Config) Dump() map[string]string {
return c.m.Dump()
}
// Replace the current configuration with the given values.
//
// Return what has actually changed.
func (c *Config) Replace(values map[string]string) (map[string]string, error) {
return c.update(values)
}
// Patch changes only the configuration keys in the given map.
//
// Return what has actually changed.
func (c *Config) Patch(patch map[string]string) (map[string]string, error) {
values := c.Dump() // Use current values as defaults
maps.Copy(values, patch)
return c.update(values)
}
func (c *Config) update(values map[string]string) (map[string]string, error) {
changed, err := c.m.Change(values)
if err != nil {
return nil, err
}
err = c.tx.UpdateClusterConfig(changed)
if err != nil {
return nil, fmt.Errorf("cannot persist configuration changes: %w", err)
}
return changed, nil
}
// ConfigSchema defines available server configuration keys.
var ConfigSchema = config.Schema{
// gendoc:generate(entity=server, group=acme, key=acme.ca_url)
//
// ---
// type: string
// scope: global
// defaultdesc: `https://acme-v02.api.letsencrypt.org/directory`
// shortdesc: URL to the directory resource of the ACME service
"acme.ca_url": {Default: "https://acme-v02.api.letsencrypt.org/directory"},
// gendoc:generate(entity=server, group=acme, key=acme.domain)
//
// ---
// type: string
// scope: global
// shortdesc: Domain for which the certificate is issued
"acme.domain": {},
// gendoc:generate(entity=server, group=acme, key=acme.email)
//
// ---
// type: string
// scope: global
// shortdesc: Email address used for the account registration
"acme.email": {},
// gendoc:generate(entity=server, group=acme, key=acme.agree_tos)
//
// ---
// type: bool
// scope: global
// defaultdesc: `false`
// shortdesc: Agree to ACME terms of service
"acme.agree_tos": {Type: config.Bool, Default: "false"},
// gendoc:generate(entity=server, group=acme, key=acme.challenge)
// Possible values are `DNS-01` and `HTTP-01`.
// ---
// type: string
// scope: global
// defaultdesc: `HTTP-01`
// shortdesc: ACME challenge type to use
"acme.challenge": {Type: config.String, Default: "HTTP-01", Validator: validate.Optional(validate.IsOneOf("DNS-01", "HTTP-01"))},
// gendoc:generate(entity=server, group=acme, key=acme.provider)
//
// ---
// type: string
// scope: global
// defaultdesc: ``
// shortdesc: Backend provider for the challenge (used by DNS-01)
"acme.provider": {Type: config.String, Default: ""},
// gendoc:generate(entity=server, group=acme, key=acme.provider.environment)
//
// ---
// type: string
// scope: global
// defaultdesc: ``
// shortdesc: Environment variables to set during the challenge (used by DNS-01)
"acme.provider.environment": {Type: config.String, Default: ""},
// gendoc:generate(entity=server, group=acme, key=acme.provider.resolvers)
// DNS resolvers to use for performing (recursive) `CNAME` resolving and apex domain determination during DNS-01 challenge.
// ---
// type: string
// scope: global
// defaultdesc: ``
// shortdesc: Comma-separated list of DNS resolvers (used by DNS-01)
"acme.provider.resolvers": {Type: config.String, Default: ""},
// gendoc:generate(entity=server, group=acme, key=acme.http.port)
// Set the port and interface to use for HTTP-01 based challenges to listen on
// ---
// type: string
// scope: global
// defaultdesc: `:80`
// shortdesc: Port and interface for HTTP server (used by HTTP-01)
"acme.http.port": {Default: ":80", Validator: validate.Optional(validate.IsListenAddress(true, true, false))},
// gendoc:generate(entity=server, group=miscellaneous, key=authorization.scriptlet)
// When using scriptlet-based authorization, this option stores the scriptlet.
// ---
// type: string
// scope: global
// shortdesc: Authorization scriptlet
"authorization.scriptlet": {Validator: validate.Optional(scriptletLoad.AuthorizationValidate)},
// gendoc:generate(entity=server, group=miscellaneous, key=backups.compression_algorithm)
// Possible values are `bzip2`, `gzip`, `lz4`, `lzma`, `xz`, `zstd` or `none`.
// ---
// type: string
// scope: global
// defaultdesc: `gzip`
// shortdesc: Compression algorithm to use for backups
"backups.compression_algorithm": {Default: "gzip", Validator: validate.IsCompressionAlgorithm},
// gendoc:generate(entity=server, group=cluster, key=cluster.offline_threshold)
// Specify the number of seconds after which an unresponsive member is considered offline.
// ---
// type: integer
// scope: global
// defaultdesc: `20`
// shortdesc: Threshold when an unresponsive member is considered offline
"cluster.offline_threshold": {Type: config.Int64, Default: offlineThresholdDefault(), Validator: offlineThresholdValidator},
// gendoc:generate(entity=server, group=cluster, key=cluster.images_minimal_replica)
// Specify the minimal number of cluster members that keep a copy of a particular image.
// Set this option to `1` for no replication, or to `-1` to replicate images on all members.
// ---
// type: integer
// scope: global
// defaultdesc: `3`
// shortdesc: Number of cluster members that replicate an image
"cluster.images_minimal_replica": {Type: config.Int64, Default: "3", Validator: imageMinimalReplicaValidator},
// gendoc:generate(entity=server, group=cluster, key=cluster.healing_threshold)
// Specify the number of seconds after which an offline cluster member is to be evacuated.
// To disable evacuating offline members, set this option to `0`.
// ---
// type: integer
// scope: global
// defaultdesc: `0`
// shortdesc: Threshold when to evacuate an offline cluster member
"cluster.healing_threshold": {Type: config.Int64, Default: "0"},
// gendoc:generate(entity=server, group=cluster, key=cluster.join_token_expiry)
//
// ---
// type: string
// scope: global
// defaultdesc: `3H`
// shortdesc: Time after which a cluster join token expires
"cluster.join_token_expiry": {Type: config.String, Default: "3H", Validator: expiryValidator},
// gendoc:generate(entity=server, group=cluster, key=cluster.max_voters)
// Specify the maximum number of cluster members that are assigned the database voter role.
// This must be an odd number >= `3`.
// ---
// type: integer
// scope: global
// defaultdesc: `3`
// shortdesc: Number of database voter members
"cluster.max_voters": {Type: config.Int64, Default: "3", Validator: maxVotersValidator},
// gendoc:generate(entity=server, group=cluster, key=cluster.max_standby)
// Specify the maximum number of cluster members that are assigned the database stand-by role.
// This must be a number between `0` and `5`.
// ---
// type: integer
// scope: global
// defaultdesc: `2`
// shortdesc: Number of database stand-by members
"cluster.max_standby": {Type: config.Int64, Default: "2", Validator: maxStandByValidator},
// gendoc:generate(entity=server, group=cluster, key=cluster.rebalance.batch)
//
// ---
// type: integer
// scope: global
// defaultdesc: `1`
// shortdesc: Maximum number of instances to move during one re-balancing run
"cluster.rebalance.batch": {Type: config.Int64, Default: "1"},
// gendoc:generate(entity=server, group=cluster, key=cluster.rebalance.cooldown)
//
// ---
// type: string
// scope: global
// defaultdesc: `6H`
// shortdesc: Amount of time during which an instance will not be moved again
"cluster.rebalance.cooldown": {Type: config.String, Default: "6H", Validator: validate.Optional(expiryValidator)},
// gendoc:generate(entity=server, group=cluster, key=cluster.rebalance.interval)
//
// ---
// type: integer
// scope: global
// defaultdesc: `0`
// shortdesc: How often (in minutes) to consider re-balancing things. 0 to disable (default)
"cluster.rebalance.interval": {Type: config.Int64, Default: "0"},
// gendoc:generate(entity=server, group=cluster, key=cluster.rebalance.threshold)
//
// ---
// type: integer
// scope: global
// defaultdesc: `20`
// shortdesc: Percentage load difference between most and least busy server needed to trigger a migration
"cluster.rebalance.threshold": {Type: config.Int64, Default: "20", Validator: validate.Optional(rebalanceThresholdValidator)},
// gendoc:generate(entity=server, group=core, key=core.metrics_authentication)
//
// ---
// type: bool
// scope: global
// defaultdesc: `true`
// shortdesc: Whether to enforce authentication on the metrics endpoint
"core.metrics_authentication": {Type: config.Bool, Default: "true"},
// gendoc:generate(entity=server, group=core, key=core.bgp_asn)
//
// ---
// type: string
// scope: global
// shortdesc: BGP Autonomous System Number for the local server
"core.bgp_asn": {Type: config.Int64, Default: "0", Validator: validate.Optional(validate.IsInRange(0, 4294967294))},
// gendoc:generate(entity=server, group=core, key=core.https_allowed_headers)
//
// ---
// type: string
// scope: global
// shortdesc: `Access-Control-Allow-Headers` HTTP header value
"core.https_allowed_headers": {},
// gendoc:generate(entity=server, group=core, key=core.https_allowed_methods)
//
// ---
// type: string
// scope: global
// shortdesc: `Access-Control-Allow-Methods` HTTP header value
"core.https_allowed_methods": {},
// gendoc:generate(entity=server, group=core, key=core.https_allowed_origin)
//
// ---
// type: string
// scope: global
// shortdesc: `Access-Control-Allow-Origin` HTTP header value
"core.https_allowed_origin": {},
// gendoc:generate(entity=server, group=core, key=core.https_allowed_credentials)
// If enabled, the `Access-Control-Allow-Credentials` HTTP header value is set to `true`.
// ---
// type: bool
// scope: global
// defaultdesc: `false`
// shortdesc: Whether to set `Access-Control-Allow-Credentials`
"core.https_allowed_credentials": {Type: config.Bool, Default: "false"},
// gendoc:generate(entity=server, group=core, key=core.https_trusted_proxy)
// Specify a comma-separated list of IP addresses of trusted servers that provide the client's address through the proxy connection header.
// ---
// type: string
// scope: global
// shortdesc: Trusted servers to provide the client's address
"core.https_trusted_proxy": {},
// gendoc:generate(entity=server, group=core, key=core.proxy_http)
// If this option is not specified, the daemon falls back to the `HTTP_PROXY` environment variable (if set).
// ---
// type: string
// scope: global
// shortdesc: HTTP proxy to use
"core.proxy_http": {},
// gendoc:generate(entity=server, group=core, key=core.proxy_https)
// If this option is not specified, the daemon falls back to the `HTTPS_PROXY` environment variable (if set).
// ---
// type: string
// scope: global
// shortdesc: HTTPS proxy to use
"core.proxy_https": {},
// gendoc:generate(entity=server, group=core, key=core.proxy_ignore_hosts)
// Specify this option in a similar format to `NO_PROXY` (for example, `1.2.3.4,1.2.3.5`)
//
// If this option is not specified, the daemon falls back to the `NO_PROXY` environment variable (if set).
// ---
// type: string
// scope: global
// shortdesc: Hosts that don't need the proxy
"core.proxy_ignore_hosts": {},
// gendoc:generate(entity=server, group=core, key=core.remote_token_expiry)
//
// ---
// type: string
// scope: global
// defaultdesc: no expiry
// shortdesc: Time after which a remote add token expires
"core.remote_token_expiry": {Type: config.String, Validator: validate.Optional(expiryValidator)},
// gendoc:generate(entity=server, group=core, key=core.shutdown_timeout)
// Specify the number of minutes to wait for running operations to complete before the daemon shuts down.
// ---
// type: integer
// scope: global
// defaultdesc: `5`
// shortdesc: How long to wait before shutdown
"core.shutdown_timeout": {Type: config.Int64, Default: "5"},
// gendoc:generate(entity=server, group=core, key=core.trust_ca_certificates)
//
// ---
// type: bool
// scope: global
// defaultdesc: `false`
// shortdesc: Whether to automatically trust clients signed by the CA
"core.trust_ca_certificates": {Type: config.Bool, Default: "false"},
// gendoc:generate(entity=server, group=images, key=images.auto_update_cached)
//
// ---
// type: bool
// scope: global
// defaultdesc: `true`
// shortdesc: Whether to automatically update cached images
"images.auto_update_cached": {Type: config.Bool, Default: "true"},
// gendoc:generate(entity=server, group=images, key=images.auto_update_interval)
// Specify the interval in hours.
// To disable looking for updates to cached images, set this option to `0`.
// ---
// type: integer
// scope: global
// defaultdesc: `6`
// shortdesc: Interval at which to look for updates to cached images
"images.auto_update_interval": {Type: config.Int64, Default: "6"},
// gendoc:generate(entity=server, group=images, key=images.compression_algorithm)
// Possible values are `bzip2`, `gzip`, `lz4`, `lzma`, `xz`, `zstd` or `none`.
// ---
// type: string
// scope: global
// defaultdesc: `gzip`
// shortdesc: Compression algorithm to use for new images
"images.compression_algorithm": {Default: "gzip", Validator: validate.IsCompressionAlgorithm},
// gendoc:generate(entity=server, group=images, key=images.default_architecture)
//
// ---
// type: string
// shortdesc: Default architecture to use in a mixed-architecture cluster
"images.default_architecture": {Validator: validate.Optional(validate.IsArchitecture)},
// gendoc:generate(entity=server, group=images, key=images.remote_cache_expiry)
// Specify the number of days after which the unused cached image expires.
// ---
// type: integer
// scope: global
// defaultdesc: `10`
// shortdesc: When an unused cached remote image is flushed
"images.remote_cache_expiry": {Type: config.Int64, Default: "10"},
// gendoc:generate(entity=server, group=miscellaneous, key=instances.lxcfs.per_instance)
// LXCFS is used to provide overlays for common `/proc` and `/sys`
// files which reflect the resource limits applied to the container.
//
// It normally operates through a single file system mount on the host which is then shared by all containers.
// This is very efficient but comes with the downside that a crash of LXCFS will break all containers.
//
// With this option, it's now possible to run a LXCFS instance per
// container instead, using more system resources but reducing the impact
// of a crash.
// ---
// type: bool
// scope: global
// defaultdesc: `false`
// shortdesc: Whether to run LXCFS on a per-instance basis
"instances.lxcfs.per_instance": {Type: config.Bool, Validator: validate.Optional(validate.IsBool)},
// gendoc:generate(entity=server, group=miscellaneous, key=instances.nic.host_name)
// Possible values are `random` and `mac`.
//
// If set to `random`, use the random host interface name as the host name.
// If set to `mac`, generate a host name in the form `inc<mac_address>` (MAC without leading two digits).
// ---
// type: string
// scope: global
// defaultdesc: `random`
// shortdesc: How to set the host name for a NIC
"instances.nic.host_name": {Validator: validate.Optional(validate.IsOneOf("random", "mac"))},
// gendoc:generate(entity=server, group=miscellaneous, key=instances.placement.scriptlet)
// When using custom automatic instance placement logic, this option stores the scriptlet.
// See {ref}`clustering-instance-placement-scriptlet` for more information.
// ---
// type: string
// scope: global
// shortdesc: Instance placement scriptlet for automatic instance placement
"instances.placement.scriptlet": {Validator: validate.Optional(scriptletLoad.InstancePlacementValidate)},
// gendoc:generate(entity=server, group=loki, key=loki.auth.username)
//
// ---
// type: string
// scope: global
// shortdesc: User name used for Loki authentication
"loki.auth.username": {Deprecated: "Use 'logging.*.target.username' instead"},
// gendoc:generate(entity=server, group=loki, key=loki.auth.password)
//
// ---
// type: string
// scope: global
// shortdesc: Password used for Loki authentication
"loki.auth.password": {Deprecated: "Use 'logging.*.target.password' instead"},
// gendoc:generate(entity=server, group=loki, key=loki.api.ca_cert)
//
// ---
// type: string
// scope: global
// shortdesc: CA certificate for the Loki server
"loki.api.ca_cert": {Deprecated: "Use 'logging.*.target.ca_cert' instead"},
// gendoc:generate(entity=server, group=loki, key=loki.api.url)
// Specify the protocol, name or IP and port. For example `https://loki.example.com:3100`. Incus will automatically add the `/loki/api/v1/push` suffix so there's no need to add it here.
// ---
// type: string
// scope: global
// shortdesc: URL to the Loki server
"loki.api.url": {Deprecated: "Use 'logging.*.target.address' instead"},
// gendoc:generate(entity=server, group=loki, key=loki.instance)
// This allows replacing the default instance value (server host name) by a more relevant value like a cluster identifier.
// ---
// type: string
// scope: global
// defaultdesc: Local server host name or cluster member name
// shortdesc: Name to use as the instance field in Loki events.
"loki.instance": {Deprecated: "Use 'logging.*.target.instance' instead"},
// gendoc:generate(entity=server, group=loki, key=loki.labels)
// Specify a comma-separated list of values that should be used as labels for a Loki log entry.
// ---
// type: string
// scope: global
// shortdesc: Labels for a Loki log entry
"loki.labels": {Deprecated: "Use 'logging.*.target.labels' instead"},
// gendoc:generate(entity=server, group=loki, key=loki.loglevel)
//
// ---
// type: string
// scope: global
// defaultdesc: `info`
// shortdesc: Minimum log level to send to the Loki server
"loki.loglevel": {Validator: config.LogLevelValidator, Default: logrus.InfoLevel.String(), Deprecated: "Use 'logging.*.logging.level' instead"},
// gendoc:generate(entity=server, group=loki, key=loki.types)
// Specify a comma-separated list of events to send to the Loki server.
// The events can be any combination of `lifecycle`, `logging`, and `network-acl`.
// ---
// type: string
// scope: global
// defaultdesc: `lifecycle,logging`
// shortdesc: Events to send to the Loki server
"loki.types": {Validator: validate.Optional(validate.IsListOf(validate.IsOneOf("lifecycle", "logging", "network-acl"))), Default: "lifecycle,logging", Deprecated: "Use 'logging.*.types' instead"},
// gendoc:generate(entity=server, group=openfga, key=openfga.api.token)
//
// ---
// type: string
// scope: global
// shortdesc: API token of the OpenFGA server
"openfga.api.token": {},
// gendoc:generate(entity=server, group=openfga, key=openfga.api.url)
//
// ---
// type: string
// scope: global
// shortdesc: URL of the OpenFGA server
"openfga.api.url": {},
// gendoc:generate(entity=server, group=openfga, key=openfga.store.id)
//
// ---
// type: string
// scope: global
// shortdesc: ID of the OpenFGA permission store
"openfga.store.id": {},
// gendoc:generate(entity=server, group=oidc, key=oidc.client.id)
//
// ---
// type: string
// scope: global
// shortdesc: OpenID Connect client ID
"oidc.client.id": {},
// gendoc:generate(entity=server, group=oidc, key=oidc.issuer)
//
// ---
// type: string
// scope: global
// shortdesc: OpenID Connect Discovery URL for the provider
"oidc.issuer": {},
// gendoc:generate(entity=server, group=oidc, key=oidc.scopes)
//
// ---
// type: string
// scope: global
// shortdesc: Comma separated list of OpenID Connect scopes
"oidc.scopes": {Default: "openid, offline_access"},
// gendoc:generate(entity=server, group=oidc, key=oidc.audience)
// This value is required by some providers.
// ---
// type: string
// scope: global
// shortdesc: Expected audience value for the application
"oidc.audience": {},
// gendoc:generate(entity=server, group=oidc, key=oidc.claim)
//
// ---
// type: string
// scope: global
// shortdesc: OpenID Connect claim to use as the username
"oidc.claim": {},
// OVN networking global keys.
// gendoc:generate(entity=server, group=miscellaneous, key=network.ovn.integration_bridge)
//
// ---
// type: string
// scope: global
// defaultdesc: `br-int`
// shortdesc: OVS integration bridge to use for OVN networks
"network.ovn.integration_bridge": {Default: "br-int"},
// gendoc:generate(entity=server, group=miscellaneous, key=network.ovn.northbound_connection)
//
// ---
// type: string
// scope: global
// defaultdesc: `unix:/run/ovn/ovnnb_db.sock`
// shortdesc: OVN northbound database connection string
"network.ovn.northbound_connection": {Default: "unix:/run/ovn/ovnnb_db.sock"},
// gendoc:generate(entity=server, group=miscellaneous, key=network.ovn.ca_cert)
//
// ---
// type: string
// scope: global
// defaultdesc: Content of `/etc/ovn/ovn-central.crt` if present
// shortdesc: OVN SSL certificate authority
"network.ovn.ca_cert": {Default: ""},
// gendoc:generate(entity=server, group=miscellaneous, key=network.ovn.client_cert)
//
// ---
// type: string
// scope: global
// defaultdesc: Content of `/etc/ovn/cert_host` if present
// shortdesc: OVN SSL client certificate
"network.ovn.client_cert": {Default: ""},
// gendoc:generate(entity=server, group=miscellaneous, key=network.ovn.client_key)
//
// ---
// type: string
// scope: global
// defaultdesc: Content of `/etc/ovn/key_host` if present
// shortdesc: OVN SSL client key
"network.ovn.client_key": {Default: ""},
}
func expiryValidator(value string) error {
_, err := internalInstance.GetExpiry(time.Time{}, value)
if err != nil {
return err
}
return nil
}
func offlineThresholdDefault() string {
return strconv.Itoa(db.DefaultOfflineThreshold)
}
func offlineThresholdValidator(value string) error {
minThreshold := 10
// Ensure that the given value is greater than the heartbeat interval,
// which is the lower bound granularity of the offline check.
threshold, err := strconv.Atoi(value)
if err != nil {
return errors.New("Offline threshold is not a number")
}
if threshold <= minThreshold {
return fmt.Errorf("Value must be greater than '%d'", minThreshold)
}
return nil
}
func imageMinimalReplicaValidator(value string) error {
count, err := strconv.Atoi(value)
if err != nil {
return errors.New("Minimal image replica count is not a number")
}
if count < 1 && count != -1 {
return errors.New("Invalid value for image replica count")
}
return nil
}
func maxVotersValidator(value string) error {
n, err := strconv.Atoi(value)
if err != nil {
return errors.New("Value is not a number")
}
if n < 3 || n%2 != 1 {
return errors.New("Value must be an odd number equal to or higher than 3")
}
return nil
}
func maxStandByValidator(value string) error {
n, err := strconv.Atoi(value)
if err != nil {
return errors.New("Value is not a number")
}
if n < 0 || n > 5 {
return errors.New("Value must be between 0 and 5")
}
return nil
}
func rebalanceThresholdValidator(value string) error {
n, err := strconv.Atoi(value)
if err != nil {
return errors.New("Value is not a number")
}
if n < 10 || n > 100 {
return errors.New("Value must be between 10 and 100")
}
return nil
}
|