settings

package
v0.6.0 Latest Latest
Warning

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

Go to latest
Published: Mar 19, 2026 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Index

Constants

View Source
const (
	// DefaultResolverTimeout is the default timeout for individual resolver execution.
	DefaultResolverTimeout = 30 * time.Second

	// DefaultPhaseTimeout is the default timeout for resolver phase execution.
	DefaultPhaseTimeout = 5 * time.Minute

	// DefaultActionTimeout is the default timeout for action execution.
	DefaultActionTimeout = 5 * time.Minute

	// DefaultGracePeriod is the default grace period for action cancellation.
	DefaultGracePeriod = 30 * time.Second
)

Timeout defaults

View Source
const (
	// DefaultConflictStrategy is the default conflict resolution strategy for file writes.
	DefaultConflictStrategy = "skip-unchanged"

	// DefaultMaxBackups is the maximum number of backup files (.bak, .bak.1, etc.) per source file.
	DefaultMaxBackups = 5
)

File conflict defaults

View Source
const (
	// DefaultHTTPTimeout is the default timeout for HTTP requests.
	DefaultHTTPTimeout = 30 * time.Second

	// DefaultHTTPRetryMax is the default maximum number of HTTP retries.
	DefaultHTTPRetryMax = 3

	// DefaultHTTPRetryWaitMinimum is the minimum wait time between HTTP retries.
	DefaultHTTPRetryWaitMinimum = 1 * time.Second

	// DefaultHTTPRetryWaitMaximum is the maximum wait time between HTTP retries.
	DefaultHTTPRetryWaitMaximum = 30 * time.Second

	// DefaultHTTPCacheTTL is the default TTL for HTTP cache entries.
	DefaultHTTPCacheTTL = 10 * time.Minute

	// DefaultHTTPCacheKeyPrefix is the default prefix for HTTP cache keys.
	DefaultHTTPCacheKeyPrefix = "scafctl:"

	// DefaultArtifactCacheTTL is the default TTL for the artifact cache.
	// Catalog artifacts are cached for 24 hours by default.
	DefaultArtifactCacheTTL = 24 * time.Hour
)

HTTP client defaults

View Source
const (
	// DefaultMaxResponseBodySize is the maximum HTTP response body size the
	// HTTP provider will read into memory (100 MB). This prevents denial of
	// service via unbounded response bodies from malicious or misconfigured
	// servers. Configurable per-deployment via httpClient.maxResponseBodySize.
	DefaultMaxResponseBodySize int64 = 100 * 1024 * 1024

	// DefaultMaxCacheFileSize is the maximum size for a single cached file (10MB).
	DefaultMaxCacheFileSize = 10 * 1024 * 1024

	// DefaultMemoryCacheSize is the maximum number of entries in memory caches.
	DefaultMemoryCacheSize = 1000

	// DefaultWarnValueSize is the threshold for warning about large resolver values (1MB).
	DefaultWarnValueSize = 1024 * 1024

	// DefaultMaxValueSize is the maximum allowed resolver value size (10MB).
	DefaultMaxValueSize = 10 * 1024 * 1024
)

Size limits

View Source
const (
	// DefaultOTelSamplerType is the default trace sampler. always_on means every
	// span is recorded (appropriate for a CLI tool with low call volume).
	DefaultOTelSamplerType = "always_on"

	// DefaultOTelSamplerArg is the default argument for the sampler.
	// For traceidratio this is the sampling probability (0.0–1.0).
	DefaultOTelSamplerArg = 1.0
)

OTel / telemetry defaults

View Source
const (
	// DefaultCELCacheSize is the default size for the CEL program cache.
	DefaultCELCacheSize = 10000

	// DefaultCELCostLimit is the default cost limit for CEL expression evaluation.
	// Set to 0 to disable cost limiting.
	DefaultCELCostLimit = 1000000
)

CEL defaults

View Source
const (
	// DefaultCircuitBreakerMaxFailures is the number of consecutive failures before opening the circuit.
	DefaultCircuitBreakerMaxFailures = 5

	// DefaultCircuitBreakerOpenTimeout is how long to wait before transitioning from Open to HalfOpen.
	DefaultCircuitBreakerOpenTimeout = 30 * time.Second

	// DefaultCircuitBreakerHalfOpenRequests is the number of successful requests in HalfOpen before closing.
	DefaultCircuitBreakerHalfOpenRequests = 1
)

Circuit breaker defaults

View Source
const (
	CliBinaryName = "scafctl"
)
View Source
const (
	// DefaultGoTemplateCacheSize is the default size for the Go template compilation cache.
	DefaultGoTemplateCacheSize = 10000
)

Go template defaults

Variables

View Source
var (
	RootSolutionFolders = []string{
		CliBinaryName,
		fmt.Sprintf(".%s", CliBinaryName),
		"",
	}
	SolutionFileNames = []string{
		"solution.yaml",
		"solution.yml",
		fmt.Sprintf("%s.yaml", CliBinaryName),
		fmt.Sprintf("%s.yml", CliBinaryName),
		"solution.json",
		fmt.Sprintf("%s.json", CliBinaryName),
	}
)
View Source
var VersionInformation = VersionInfo{
	Commit:       "unknown",
	BuildVersion: "v0.0.0-nightly",
	BuildTime:    "unknown",
}

Functions

func DefaultBuildCacheDir added in v0.3.0

func DefaultBuildCacheDir() string

DefaultBuildCacheDir returns the default directory for build cache. Uses XDG Base Directory Specification:

  • Linux: ~/.cache/scafctl/build-cache/
  • macOS: ~/.cache/scafctl/build-cache/
  • Windows: %LOCALAPPDATA%\cache\scafctl\build-cache\

func DefaultHTTPCacheDir

func DefaultHTTPCacheDir() string

DefaultHTTPCacheDir returns the default directory for HTTP cache. Uses XDG Base Directory Specification:

  • Linux: ~/.cache/scafctl/http-cache/
  • macOS: ~/.cache/scafctl/http-cache/
  • Windows: %LOCALAPPDATA%\cache\scafctl\http-cache\

func DefaultPluginCacheDir added in v0.3.0

func DefaultPluginCacheDir() string

DefaultPluginCacheDir returns the default directory for cached plugin binaries. Uses XDG Base Directory Specification:

  • Linux: ~/.cache/scafctl/plugins/
  • macOS: ~/.cache/scafctl/plugins/
  • Windows: %LOCALAPPDATA%\cache\scafctl\plugins\

func IntoContext

func IntoContext(ctx context.Context, s *Run) context.Context

IntoContext stores a Settings object in the context

Types

type EntryPointSettings

type EntryPointSettings struct {
	FromAPI bool   `json:"fromAPI" yaml:"fromAPI" doc:"Whether the entry point is provided via API"`
	FromCli bool   `json:"fromCli" yaml:"fromCli" doc:"Whether the entry point is provided via CLI"`
	Path    string `json:"path,omitempty" yaml:"path,omitempty" doc:"Path to the entry point" maxLength:"512" example:"./solution.yaml"`
}

EntryPointSettings holds configuration options for determining the entry point source. It specifies whether the entry point is provided via an API or CLI, and the path to the entry point.

type Run

type Run struct {
	MinLogLevel        string             `json:"minLogLevel" yaml:"minLogLevel" doc:"Minimum log level" maxLength:"16" example:"info"`
	EntryPointSettings EntryPointSettings `json:"entryPointSettings" yaml:"entryPointSettings" doc:"Entry point configuration"`
	IsQuiet            bool               `json:"isQuiet" yaml:"isQuiet" doc:"Whether to suppress non-essential output"`
	NoColor            bool               `json:"noColor" yaml:"noColor" doc:"Whether to disable colored output"`
	ExitOnError        bool               `json:"exitOnError" yaml:"exitOnError" doc:"Whether to exit on error"`
}

Run holds configuration settings for a single execution of the application. It includes options for logging, entry point configuration, output formatting, and error handling behavior.

func FromContext

func FromContext(ctx context.Context) (*Run, bool)

FromContext retrieves a Settings object from the context

func NewCliParams

func NewCliParams() *Run

NewCliParams initializes and returns a pointer to a Run struct with default CLI parameters. It sets logging level to "none" (no structured logs by default), configures entry point settings for CLI usage, and sets default flags for quiet mode, color output, and error handling.

type VersionInfo

type VersionInfo struct {
	Commit       string `json:"commit" yaml:"commit" doc:"Git commit hash" maxLength:"64" example:"abc1234"`
	BuildVersion string `json:"buildVersion" yaml:"buildVersion" doc:"Build version string" maxLength:"64" example:"v1.2.3"`
	BuildTime    string `json:"buildTime" yaml:"buildTime" doc:"Build timestamp" maxLength:"64" example:"2025-01-01T00:00:00Z"`
}

VersionInfo holds metadata about the build, including the commit hash, build version, and build timestamp.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL