forked from rancher/rancher
-
Notifications
You must be signed in to change notification settings - Fork 0
/
setting.go
588 lines (502 loc) · 28.7 KB
/
setting.go
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
// Package settings is used to access various server settings
package settings
import (
"encoding/json"
"fmt"
"os"
"regexp"
"strconv"
"strings"
v32 "github.com/rancher/rancher/pkg/apis/management.cattle.io/v3"
authsettings "github.com/rancher/rancher/pkg/auth/settings"
"github.com/rancher/rancher/pkg/buildconfig"
fleetconst "github.com/rancher/rancher/pkg/fleet"
"github.com/sirupsen/logrus"
v1 "k8s.io/api/core/v1"
)
const (
RancherVersionDev = "2.10.99"
DefaultMaxUIPluginFileSizeInBytes = 30 * 1024 * 1024 // 30MB
AgentTLSModeStrict = "strict"
AgentTLSModeSystemStore = "system-store"
)
var (
releasePattern = regexp.MustCompile("^v[0-9]")
settings = map[string]Setting{}
provider Provider
InjectDefaults string
systemNamespaces = []string{
"kube-system",
"kube-public",
"cattle-system",
"cattle-alerting",
"cattle-logging",
"cattle-prometheus",
"ingress-nginx",
"cattle-global-data",
"cattle-istio",
"kube-node-lease",
"cert-manager",
"cattle-global-nt",
"security-scan",
"cattle-fleet-system",
"cattle-fleet-local-system",
"calico-system",
"tigera-operator",
"cattle-impersonation-system",
"rancher-operator-system",
"cattle-csp-adapter-system",
"calico-apiserver",
"cattle-elemental-system",
}
AgentImage = NewSetting("agent-image", "rancher/rancher-agent:head")
AgentRolloutTimeout = NewSetting("agent-rollout-timeout", "300s")
AgentRolloutWait = NewSetting("agent-rollout-wait", "true")
// AgentTLSMode is translated to the environment variable STRICT_VERIFY when rendering the cluster/node agent manifests and should not be specified as a default agent setting as it has no direct effect on the agent itself.
AgentTLSMode = NewSetting("agent-tls-mode", AgentTLSModeStrict).WithDefaultOnUpgrade(AgentTLSModeSystemStore)
AuthImage = NewSetting("auth-image", v32.ToolsSystemImages.AuthSystemImages.KubeAPIAuth)
AuthorizationCacheTTLSeconds = NewSetting("authorization-cache-ttl-seconds", "10")
AuthorizationDenyCacheTTLSeconds = NewSetting("authorization-deny-cache-ttl-seconds", "10")
AzureGroupCacheSize = NewSetting("azure-group-cache-size", "10000")
CACerts = NewSetting("cacerts", "")
CLIURLDarwin = NewSetting("cli-url-darwin", "https://releases.rancher.com/cli/v1.0.0-alpha8/rancher-darwin-amd64-v1.0.0-alpha8.tar.gz")
CLIURLLinux = NewSetting("cli-url-linux", "https://releases.rancher.com/cli/v1.0.0-alpha8/rancher-linux-amd64-v1.0.0-alpha8.tar.gz")
CLIURLWindows = NewSetting("cli-url-windows", "https://releases.rancher.com/cli/v1.0.0-alpha8/rancher-windows-386-v1.0.0-alpha8.zip")
ClusterControllerStartCount = NewSetting("cluster-controller-start-count", "50")
EngineInstallURL = NewSetting("engine-install-url", "https://releases.rancher.com/install-docker/27.2.sh")
EngineISOURL = NewSetting("engine-iso-url", "https://releases.rancher.com/os/latest/rancheros-vmware.iso")
EngineNewestVersion = NewSetting("engine-newest-version", "v17.12.0")
EngineSupportedRange = NewSetting("engine-supported-range", "~v1.11.2 || ~v1.12.0 || ~v1.13.0 || ~v17.03.0 || ~v17.06.0 || ~v17.09.0 || ~v18.06.0 || ~v18.09.0 || ~v19.03.0 || ~v20.10.0 || ~v23.0.0 || ~v24.0.0 || ~v25.0.0 || ~v26.0.0 || ~v26.1.0|| ~v27.0.0|| ~v27.1.0|| ~v27.2.0")
FirstLogin = NewSetting("first-login", "true")
GlobalRegistryEnabled = NewSetting("global-registry-enabled", "false")
GithubProxyAPIURL = NewSetting("github-proxy-api-url", "https://api.github.com")
HelmVersion = NewSetting("helm-version", "dev")
HelmMaxHistory = NewSetting("helm-max-history", "10")
IngressIPDomain = NewSetting("ingress-ip-domain", "sslip.io")
InstallUUID = NewSetting("install-uuid", "")
InternalServerURL = NewSetting("internal-server-url", "")
InternalCACerts = NewSetting("internal-cacerts", "")
IsRKE = NewSetting("is-rke", "")
JailerTimeout = NewSetting("jailer-timeout", "60")
KubernetesVersion = NewSetting("k8s-version", "")
KubernetesVersionToServiceOptions = NewSetting("k8s-version-to-service-options", "")
KubernetesVersionToSystemImages = NewSetting("k8s-version-to-images", "")
KubernetesVersionsCurrent = NewSetting("k8s-versions-current", "")
KubernetesVersionsDeprecated = NewSetting("k8s-versions-deprecated", "")
KDMBranch = NewSetting("kdm-branch", "dev-v2.10")
MachineVersion = NewSetting("machine-version", "dev")
Namespace = NewSetting("namespace", os.Getenv("CATTLE_NAMESPACE"))
PasswordMinLength = NewSetting("password-min-length", "12")
PeerServices = NewSetting("peer-service", os.Getenv("CATTLE_PEER_SERVICE"))
RkeVersion = NewSetting("rke-version", "")
RkeMetadataConfig = NewSetting("rke-metadata-config", getMetadataConfig())
ServerImage = NewSetting("server-image", "rancher/rancher")
ServerURL = NewSetting("server-url", "")
ServerVersion = NewSetting("server-version", "dev")
SystemAgentVersion = NewSetting("system-agent-version", "")
WinsAgentVersion = NewSetting("wins-agent-version", "")
CSIProxyAgentVersion = NewSetting("csi-proxy-agent-version", "")
CSIProxyAgentURL = NewSetting("csi-proxy-agent-url", "https://acs-mirror.azureedge.net/csi-proxy/%[1]s/binaries/csi-proxy-%[1]s.tar.gz")
SystemAgentInstallScript = NewSetting("system-agent-install-script", "https://github.com/rancher/system-agent/releases/download/v0.3.11/install.sh") // To ensure consistency between SystemAgentInstallScript default value and CATTLE_SYSTEM_AGENT_INSTALL_SCRIPT to utilize the local system-agent-install.sh script when both values are equal.
WinsAgentInstallScript = NewSetting("wins-agent-install-script", "https://raw.githubusercontent.com/rancher/wins/v0.4.20/install.ps1")
SystemAgentInstallerImage = NewSetting("system-agent-installer-image", "") // Defined via environment variable
SystemAgentUpgradeImage = NewSetting("system-agent-upgrade-image", "") // Defined via environment variable
WinsAgentUpgradeImage = NewSetting("wins-agent-upgrade-image", "")
SystemNamespaces = NewSetting("system-namespaces", strings.Join(systemNamespaces, ","))
SystemUpgradeControllerChartVersion = NewSetting("system-upgrade-controller-chart-version", "")
TLSMinVersion = NewSetting("tls-min-version", "1.2")
TLSCiphers = NewSetting("tls-ciphers", "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305")
WhitelistDomain = NewSetting("whitelist-domain", "forums.rancher.com")
WhitelistEnvironmentVars = NewSetting("whitelist-envvars", "HTTP_PROXY,HTTPS_PROXY,NO_PROXY")
AuthUserInfoResyncCron = NewSetting("auth-user-info-resync-cron", "0 0 * * *")
APIUIVersion = NewSetting("api-ui-version", "1.1.11") // Please update the CATTLE_API_UI_VERSION in package/Dockerfile when updating the version here.
RotateCertsIfExpiringInDays = NewSetting("rotate-certs-if-expiring-in-days", "7") // 7 days
ClusterTemplateEnforcement = NewSetting("cluster-template-enforcement", "false")
InitialDockerRootDir = NewSetting("initial-docker-root-dir", "/var/lib/docker")
SystemCatalog = NewSetting("system-catalog", "external") // Options are 'external' or 'bundled'
ChartDefaultBranch = NewSetting("chart-default-branch", "dev-v2.10")
SystemManagedChartsOperationTimeout = NewSetting("system-managed-charts-operation-timeout", "300s")
FleetDefaultWorkspaceName = NewSetting("fleet-default-workspace-name", fleetconst.ClustersDefaultNamespace) // fleetWorkspaceName to assign to clusters with none
ShellImage = NewSetting("shell-image", buildconfig.DefaultShellVersion)
IgnoreNodeName = NewSetting("ignore-node-name", "") // nodes to ignore when syncing v1.node to v3.node
NoDefaultAdmin = NewSetting("no-default-admin", "")
AKSUpstreamRefresh = NewSetting("aks-refresh", "300")
EKSUpstreamRefreshCron = NewSetting("eks-refresh-cron", "*/5 * * * *") // EKSUpstreamRefreshCron is deprecated and will be replaced by EKSUpstreamRefresh
EKSUpstreamRefresh = NewSetting("eks-refresh", "300")
GKEUpstreamRefresh = NewSetting("gke-refresh", "300")
HideLocalCluster = NewSetting("hide-local-cluster", "false")
MachineProvisionImage = NewSetting("machine-provision-image", "rancher/machine:v0.15.0-rancher124")
SystemFeatureChartRefreshSeconds = NewSetting("system-feature-chart-refresh-seconds", "21600")
ClusterAgentDefaultAffinity = NewSetting("cluster-agent-default-affinity", ClusterAgentAffinity)
FleetAgentDefaultAffinity = NewSetting("fleet-agent-default-affinity", FleetAgentAffinity)
MaxUIPluginFileByteSize = NewSetting("max-ui-plugin-file-byte-size", strconv.Itoa(DefaultMaxUIPluginFileSizeInBytes)) // Max file size in bytes for ui plugins
Rke2DefaultVersion = NewSetting("rke2-default-version", "")
K3sDefaultVersion = NewSetting("k3s-default-version", "")
// AuthTokenMaxTTLMinutes is the max allowable time to live for tokens. Excluding those created for UI sessions which is controlled by AuthUserSessionTTLMinutes.
AuthTokenMaxTTLMinutes = NewSetting("auth-token-max-ttl-minutes", "129600") // 90 days
// AuthUserInfoMaxAgeSeconds represents the maximum age of a users auth tokens before an auth provider group membership sync will be performed.
AuthUserInfoMaxAgeSeconds = NewSetting("auth-user-info-max-age-seconds", "3600") // 1 hour
// AuthUserSessionTTLMinutes represents the time to live for tokens used for login sessions in minutes.
AuthUserSessionTTLMinutes = NewSetting("auth-user-session-ttl-minutes", "960") // 16 hours
// ChartDefaultURL represents the default URL for the system charts repo. It should only be set for test or
// debug purposes.
ChartDefaultURL = NewSetting("chart-default-url", "https://git.rancher.io/")
// DisableInactiveUserAfter is the duration a user can be inactive after which it's disabled by the user retention process.
// The value should be expressed in valid time.Duration units and truncated to a second e.g. "168h". See https://pkg.go.dev/time#ParseDuration
// DisableInactiveUserAfter should be greater than AuthUserSessionTTLMinutes.
// An empty string or a zero value means the feature is disabled.
DisableInactiveUserAfter = NewSetting("disable-inactive-user-after", "")
// DeleteInactiveUserAfter is the duration a user can be inactive after which it's deleted by the user retention process.
// The value should be expressed in valid time.Duration units and truncated to a second e.g. "168h". See https://pkg.go.dev/time#ParseDuration
// DeleteInactiveUserAfter should be greater than AuthUserSessionTTLMinutes.
// An empty string or a zero value means the feature is disabled.
DeleteInactiveUserAfter = NewSetting("delete-inactive-user-after", "")
// UserRetentionDryRun determines if the user retention process should actually disable and delete users.
// Valid values are "true" and "false". An empty string means "false".
UserRetentionDryRun = NewSetting("user-retention-dry-run", "false")
// UserLastLoginDefault is used if UserAttribute.LastLogin is not set.
// The value should be a date and time truncated to a second and formatted according to RFC3339 e.g. "2023-03-01T00:00:00Z".
// If the value is an empty string or time.Time zero value this settings is not used.
UserLastLoginDefault = NewSetting("user-last-login-default", "")
// UserRetentionCron determines how often the user retention process should run.
// The value should be a valid cron expression e.g. "0 * * * *" (every hour)
UserRetentionCron = NewSetting("user-retention-cron", "")
// ConfigMapName name of the configmap that stores rancher configuration information.
// Deprecated: to be removed in 2.8.0
ConfigMapName = NewSetting("config-map-name", "rancher-config")
// CSPAdapterMinVersion is used to determine if an existing installation of the CSP adapter should be upgraded to a new version
// has no effect if the csp adapter is not installed.
CSPAdapterMinVersion = NewSetting("csp-adapter-min-version", "")
// FleetMinVersion is the minimum version of the Fleet chart that Rancher will install.
// Deprecated in favor of FleetVersion, kept for backward compatibility purposes.
FleetMinVersion = NewSetting("fleet-min-version", "")
// FleetVersion is the exact version of the Fleet chart that Rancher will install.
FleetVersion = NewSetting("fleet-version", "")
// AksOperatorVersion is the exact version of the aks-operator and aks-operator-crd charts that Rancher will install.
AksOperatorVersion = NewSetting("aks-operator-version", "")
// EksOperatorVersion is the exact version of the eks-operator and eks-operator-crd chart that Rancher will install.
EksOperatorVersion = NewSetting("eks-operator-version", "")
// GkeOperatorVersion is the exact version of the gke-operator and gke-operator-crd chart that Rancher will install.
GkeOperatorVersion = NewSetting("gke-operator-version", "")
// KubeconfigDefaultTokenTTLMinutes is the default time to live applied to kubeconfigs created for users.
// This setting will take effect regardless of the kubeconfig-generate-token status.
KubeconfigDefaultTokenTTLMinutes = NewSetting("kubeconfig-default-token-ttl-minutes", "43200") // 30 days
// KubeconfigGenerateToken determines whether the UI will return a generate token with kubeconfigs.
// If set to false the kubeconfig will contain a command to login to Rancher.
KubeconfigGenerateToken = NewSetting("kubeconfig-generate-token", "true")
// PartnerChartDefaultBranch represents the default branch for the partner charts repo.
PartnerChartDefaultBranch = NewSetting("partner-chart-default-branch", "main")
// PartnerChartDefaultURL represents the default URL for the partner charts repo. It should only be set for test
// or debug purposes.
PartnerChartDefaultURL = NewSetting("partner-chart-default-url", "https://git.rancher.io/")
// RancherWebhookVersion is the exact version of the webhook that Rancher will install.
RancherWebhookVersion = NewSetting("rancher-webhook-version", "")
// RancherProvisioningCAPIVersion is the exact version of the cluster api controller that Rancher will install.
RancherProvisioningCAPIVersion = NewSetting("rancher-provisioning-capi-version", "")
// RKE2ChartDefaultBranch represents the default branch for the RKE2 charts repo.
RKE2ChartDefaultBranch = NewSetting("rke2-chart-default-branch", "main")
// RKE2ChartDefaultURL represents the default URL for the RKE2 charts repo. It should only be set for test or
// debug purposes.
RKE2ChartDefaultURL = NewSetting("rke2-chart-default-url", "https://git.rancher.io/")
// SystemDefaultRegistry is the default container registry used for images.
// The environmental variable "CATTLE_BASE_REGISTRY" controls the default value of this setting.
SystemDefaultRegistry = NewSetting("system-default-registry", os.Getenv("CATTLE_BASE_REGISTRY"))
// K3sBasedUpgraderUninstallConcurrency defines the maximum number of clusters
// for which the K3s-based-upgrade handler can simultaneously uninstall the legacy K3s-based upgrade app.
K3sBasedUpgraderUninstallConcurrency = NewSetting("k3s-based-upgrader-uninstall-concurrency", "5")
// UIBanners holds configuration to display a custom fixed banner in the header, footer, or both
UIBanners = NewSetting("ui-banners", "{}")
// UIBrand High level 'brand' value, for example `suse`.
// Fallback env, not a user-facing setting, used to indicate if this is a Prime install
UIBrand = NewSetting("ui-brand", os.Getenv("CATTLE_BASE_UI_BRAND"))
// UICommunityLinks displays community links in the UI.
// Deprecated in favour of UICustomLinks.
UICommunityLinks = NewSetting("ui-community-links", "true")
// UICustomLinks Key(display text), value(url) for user customisable links to display in homepage and support pages.
UICustomLinks = NewSetting("ui-custom-links", "")
// UIDashboardPath path within Rancher Manager where the dashboard files are found.
UIDashboardPath = NewSetting("ui-dashboard-path", "/usr/share/rancher/ui-dashboard")
// UIDashboardIndex depends on ui-offline-preferred, use this version of the dashboard instead of the one contained in Rancher Manager.
UIDashboardIndex = NewSetting("ui-dashboard-index", "https://releases.rancher.com/dashboard/release-2.10/index.html")
// UIDashboardHarvesterLegacyPlugin depending on ui-offline-preferred and if a Harvester Cluster does not contain it's own Harvester plugin, use this version of the plugin instead.
UIDashboardHarvesterLegacyPlugin = NewSetting("ui-dashboard-harvester-legacy-plugin", "https://releases.rancher.com/harvester-ui/plugin/harvester-1.0.3-head/harvester-1.0.3-head.umd.min.js")
// UIDefaultLanding the default page users land on after login.
UIDefaultLanding = NewSetting("ui-default-landing", "vue")
// UIFavicon custom favicon.
UIFavicon = NewSetting("ui-favicon", "")
// UIFeedBackForm Ember UI specific.
UIFeedBackForm = NewSetting("ui-feedback-form", "")
// UIIndex depends on ui-offline-preferred, use this version of the old ember UI instead of the one contained in Rancher Manager.
UIIndex = NewSetting("ui-index", "https://releases.rancher.com/ui/release-2.10/index.html")
// UIIssues use a url address to send new 'File an Issue' reports instead of sending users to the Github issues page.
// Deprecated in favour of UICustomLinks = NewSetting("ui-custom-links", {}).
UIIssues = NewSetting("ui-issues", "")
// UIKubernetesDefaultVersion Ember UI specific.
UIKubernetesDefaultVersion = NewSetting("ui-k8s-default-version-range", "<=1.14.x")
// UIKubernetesSupportedVersions Ember UI specific.
UIKubernetesSupportedVersions = NewSetting("ui-k8s-supported-versions-range", ">= 1.11.0 <=1.14.x")
// UIOfflinePreferred controls whether UI assets are served locally by the server container ('true') or from the remote URL defined in the ui-index and ui-dashboard-index settings ('false).
// The `dynamic` option will use remote assets for `-head` builds, otherwise the local assets for production builds.
UIOfflinePreferred = NewSetting("ui-offline-preferred", "dynamic")
// UIPath path within Rancher Manager where the old ember UI files are found.
UIPath = NewSetting("ui-path", "/usr/share/rancher/ui")
// UIPerformance experimental settings for UI functionality to improve the UX with large numbers of resources.
UIPerformance = NewSetting("ui-performance", "")
// UIPL the vendor/company name.
UIPL = NewSetting("ui-pl", "rancher")
// UIPrimaryColor UI primary color for branding customisation
UIPrimaryColor = NewSetting("ui-primary-color", "")
// UILinkColor UI link color for branding customisation
UILinkColor = NewSetting("ui-link-color", "")
// UILoginBackground the custom background in the login page.
UILoginBackgroundLight = NewSetting("ui-login-background-light", "")
UILoginBackgroundDark = NewSetting("ui-login-background-dark", "")
// UIBanner the custom background image in the home page.
UIBannerLight = NewSetting("ui-banner-light", "")
UIBannerDark = NewSetting("ui-banner-dark", "")
// UIExtensions - setting for configuring UI Extensions (e.g. allow users to enable/disable extensions)
UIExtensions = NewSetting("ui-extensions", "")
// UI Settings for allowing separate configuration of page banners
UIBannerHeader = NewSetting("ui-banner-header", "")
UIBannerFooter = NewSetting("ui-banner-footer", "")
UIBannerLoginConsent = NewSetting("ui-banner-login-consent", "")
// UIPreferred Ensure that the new Dashboard is the default UI.
UIPreferred = NewSetting("ui-preferred", "vue")
// SkipHostedClusterChartInstallation controls whether the hosted cluster chart is installed on the server. Defaults to false.
// This setting is for development purposes only.
SkipHostedClusterChartInstallation = NewSetting("skip-hosted-cluster-chart-installation", os.Getenv("CATTLE_SKIP_HOSTED_CLUSTER_CHART_INSTALLATION"))
MachineProvisionImagePullPolicy = NewSetting("machine-provision-image-pull-policy", string(v1.PullAlways))
// The following settings are only used outside of Rancher (for example,
// by the UI) but need to be known so that Rancher doesn't remove them
// on startup.
_ = NewSetting("eula-agreed", "")
_ = NewSetting("display-add-extension-repos-banner", "")
_ = NewSetting("ui-logo-light", "")
_ = NewSetting("ui-logo-dark", "")
_ = NewSetting("ui-theme", "")
_ = NewSetting("cli-version", "")
_ = NewSetting("has-support", "")
_ = NewSetting("auth-password-requirements-description", "")
_ = NewSetting("api-host", "")
// UnprivilegedJailUser controls whether jailed commands execute under a separate (unprivileged/non-root) user
// account. Setting it to false is only recommended for testing and development environments.
UnprivilegedJailUser = NewSetting("unprivileged-jail-user", "true")
)
// FullShellImage returns the full private registry name of the rancher shell image.
func FullShellImage() string {
return PrefixPrivateRegistry(ShellImage.Get())
}
// PrefixPrivateRegistry prefixes the given image name with the stored private registry path.
func PrefixPrivateRegistry(image string) string {
private := SystemDefaultRegistry.Get()
if private == "" {
return image
}
return private + "/" + image
}
// IsRelease returns true if the running server is a released version of rancher.
func IsRelease() bool {
return !strings.Contains(ServerVersion.Get(), "head") && releasePattern.MatchString(ServerVersion.Get())
}
func init() {
// setup auth setting
authsettings.AuthUserInfoResyncCron = AuthUserInfoResyncCron
authsettings.AuthUserSessionTTLMinutes = AuthUserSessionTTLMinutes
authsettings.AuthUserInfoMaxAgeSeconds = AuthUserInfoMaxAgeSeconds
authsettings.FirstLogin = FirstLogin
if InjectDefaults == "" {
return
}
defaults := map[string]string{}
if err := json.Unmarshal([]byte(InjectDefaults), &defaults); err != nil {
return
}
for name, defaultValue := range defaults {
value, ok := settings[name]
if !ok {
continue
}
value.Default = defaultValue
settings[name] = value
}
}
// Provider is an interfaced used to get and set Settings.
// NOTE: The behavior for treating unknown settings is undefined.
// A provider may choose to remove settings which it has a record of,
// but are not provided in SetAll call.
type Provider interface {
Get(name string) string
Set(name, value string) error
SetIfUnset(name, value string) error
SetAll(settings map[string]Setting) error
}
// Setting stores information about a specific server setting.
type Setting struct {
Name string
// Default represents a value to be used in the absence of an actual Value stored in etcd on the Setting resource.
Default string
// DefaultOnUpgrade represents a desired Default value that the setting should have on upgrade from a previous minor
// or major version of Rancher. This is used for special cases where the value of the setting must stay the same
// on upgraded setups but use a new value for fresh installations for backward compatibility.
DefaultOnUpgrade string
ReadOnly bool
}
// SetIfUnset will store the given value of the setting if it was not already stored.
func (s Setting) SetIfUnset(value string) error {
if provider == nil {
return s.Set(value)
}
return provider.SetIfUnset(s.Name, value)
}
// Set will store the given value for the setting
func (s Setting) Set(value string) error {
if provider == nil {
s, ok := settings[s.Name]
if ok {
s.Default = value
settings[s.Name] = s
}
} else {
return provider.Set(s.Name, value)
}
return nil
}
// Get will return the currently stored value of the setting.
func (s Setting) Get() string {
if provider == nil {
s := settings[s.Name]
return s.Default
}
return provider.Get(s.Name)
}
// GetInt will return the currently stored value of the setting as an integer.
// If the stored value is not an integer then the default value will be returned as an integer.
// If the default value is not an integer then the function will return 0
func (s Setting) GetInt() int {
v := s.Get()
i, err := strconv.Atoi(v)
if err == nil {
return i
}
logrus.Errorf("failed to parse setting %s=%s as int: %v", s.Name, v, err)
i, err = strconv.Atoi(s.Default)
if err != nil {
return 0
}
return i
}
// SetProvider will set the given provider as the global provider for all settings.
func SetProvider(p Provider) error {
if err := p.SetAll(settings); err != nil {
return err
}
provider = p
return nil
}
// NewSetting will create and store a new server setting.
func NewSetting(name, def string) Setting {
s := Setting{
Name: name,
Default: def,
}
settings[s.Name] = s
return s
}
// WithDefaultOnUpgrade takes a setting and returns a new setting with the default value on upgrade set.
func (s Setting) WithDefaultOnUpgrade(defOnUpgrade string) Setting {
s.DefaultOnUpgrade = defOnUpgrade
settings[s.Name] = s
return s
}
// GetEnvKey will return the given string formatted as a rancher environmental variable.
func GetEnvKey(key string) string {
return "CATTLE_" + strings.ToUpper(strings.Replace(key, "-", "_", -1))
}
func getMetadataConfig() string {
branch := KDMBranch.Get()
data := map[string]interface{}{
"url": fmt.Sprintf("https://releases.rancher.com/kontainer-driver-metadata/%s/data.json", branch),
"refresh-interval-minutes": "1440",
}
ans, err := json.Marshal(data)
if err != nil {
logrus.Errorf("error getting metadata config %v", err)
return ""
}
return string(ans)
}
// GetSettingByID returns a setting that is stored with the given id.
func GetSettingByID(id string) string {
if provider == nil {
s := settings[id]
return s.Default
}
return provider.Get(id)
}
// DefaultAgentSettings will return a list of default agent settings
func DefaultAgentSettings() []Setting {
return []Setting{
ServerVersion,
InstallUUID,
IngressIPDomain,
}
}
// DefaultAgentSettingsAsEnvVars will return a list of default agent settings as environmental variables.
func DefaultAgentSettingsAsEnvVars() []v1.EnvVar {
defaultAgentSettings := DefaultAgentSettings()
envVars := make([]v1.EnvVar, 0, len(defaultAgentSettings))
for _, s := range defaultAgentSettings {
envVars = append(envVars, v1.EnvVar{
Name: GetEnvKey(s.Name),
Value: s.Get(),
})
}
return envVars
}
func IsReleaseServerVersion(serverVersion string) bool {
if strings.HasPrefix(serverVersion, "dev") ||
strings.HasPrefix(serverVersion, "master") ||
serverVersion == "" ||
strings.HasSuffix(serverVersion, "-head") ||
strings.HasSuffix(serverVersion, "-main") {
return false
}
return true
}
// GetRancherVersion will return the stored server version without the 'v' prefix.
func GetRancherVersion() string {
rancherVersion := ServerVersion.Get()
if !IsReleaseServerVersion(rancherVersion) {
return RancherVersionDev
}
return strings.TrimPrefix(rancherVersion, "v")
}
// IterateWhitelistedEnvVars iterates over the environment variables whitelisted
// by CATTLE_WHITELIST_ENVVARS. If a variable is whitelisted but unset or empty,
// the handler function will not be called for it.
func IterateWhitelistedEnvVars(handler func(name, value string)) {
wl := WhitelistEnvironmentVars.Get()
envWhiteList := strings.Split(wl, ",")
for _, wlVar := range envWhiteList {
wlVar = strings.TrimSpace(wlVar)
if val := os.Getenv(wlVar); val != "" {
handler(wlVar, val)
}
}
}
// GetMachineProvisionImagePullPolicy will return the pull policy to be used on MachineProvisioning job.
// If an invalid value is set it will return the default value: v1.PullAlways
func GetMachineProvisionImagePullPolicy() v1.PullPolicy {
machineProvisionImagePullPolicy := MachineProvisionImagePullPolicy.Get()
switch v1.PullPolicy(machineProvisionImagePullPolicy) {
case v1.PullAlways:
return v1.PullAlways
case v1.PullIfNotPresent:
return v1.PullIfNotPresent
case v1.PullNever:
return v1.PullNever
default:
logrus.Warnf("failed to parse setting machine-provision-image-pull-policy value: %s defaulting to: %s", machineProvisionImagePullPolicy, v1.PullAlways)
return v1.PullAlways
}
}