settings

package

v3.7.2 Latest Latest Go to latest Published: Feb 26, 2026 License: MIT Imports: 18 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/formancehq/operator

Links

Open Source Insights

Documentation ¶

Index ¶

func CreateOrUpdate(ctx core.Context, name, key string, value any, stacks ...string) (*v1beta1.Settings, error)
func Get(ctx core.Context, stack string, keys ...string) (*string, error)
func GetAWSServiceAccount(ctx core.Context, stackName string) (string, error)
func GetAs[T any](ctx core.Context, stack string, keys ...string) (*T, error)
func GetBool(ctx core.Context, stack string, keys ...string) (*bool, error)
func GetBoolOrDefault(ctx core.Context, stack string, defaultValue bool, keys ...string) (bool, error)
func GetBoolOrFalse(ctx core.Context, stack string, keys ...string) (bool, error)
func GetBoolOrTrue(ctx core.Context, stack string, keys ...string) (bool, error)
func GetInt(ctx core.Context, stack string, keys ...string) (*int, error)
func GetInt32(ctx core.Context, stack string, keys ...string) (*int32, error)
func GetInt32OrDefault(ctx core.Context, stack string, defaultValue int32, keys ...string) (int32, error)
func GetInt64(ctx core.Context, stack string, keys ...string) (*int64, error)
func GetIntOrDefault(ctx core.Context, stack string, defaultValue int, keys ...string) (int, error)
func GetMap(ctx core.Context, stack string, keys ...string) (map[string]string, error)
func GetMapOrEmpty(ctx core.Context, stack string, keys ...string) (map[string]string, error)
func GetOTELEnvVars(ctx core.Context, stack, serviceName string, sliceStringSeparator string) ([]v1.EnvVar, error)
func GetResourceList(ctx core.Context, stack string, keys ...string) (v1.ResourceList, error)
func GetResourceRequirements(ctx core.Context, stack string, keys ...string) (*v1.ResourceRequirements, error)
func GetString(ctx core.Context, stack string, keys ...string) (*string, error)
func GetStringOrDefault(ctx core.Context, stack, defaultValue string, keys ...string) (string, error)
func GetStringOrEmpty(ctx core.Context, stack string, keys ...string) (string, error)
func GetStringSlice(ctx core.Context, stack string, keys ...string) ([]string, error)
func GetTrimmedStringSlice(ctx core.Context, stack string, keys ...string) ([]string, error)
func GetUInt(ctx core.Context, stack string, keys ...string) (*uint, error)
func GetUInt16(ctx core.Context, stack string, keys ...string) (*uint16, error)
func GetUInt16OrDefault(ctx core.Context, stack string, defaultValue uint16, keys ...string) (uint16, error)
func GetUInt64(ctx core.Context, stack string, keys ...string) (*uint64, error)
func GetURL(ctx core.Context, stack string, keys ...string) (*v1beta1.URI, error)
func HasOpenTelemetryTracesEnabled(ctx core.Context, stack string) (bool, error)
func IsTrue(v string) bool
func New(name, key, value string, stacks ...string) *v1beta1.Settings
func RequireString(ctx core.Context, stack string, keys ...string) (string, error)
func RequireURL(ctx core.Context, stack string, keys ...string) (*v1beta1.URI, error)
func SplitKeywordWithDot(key string) []string
type MonitoringType

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func CreateOrUpdate ¶

func CreateOrUpdate(ctx core.Context, name, key string, value any, stacks ...string) (*v1beta1.Settings, error)

func Get ¶

func Get(ctx core.Context, stack string, keys ...string) (*string, error)

func GetAWSServiceAccount ¶

func GetAWSServiceAccount(ctx core.Context, stackName string) (string, error)

func GetAs ¶

func GetAs[T any](ctx core.Context, stack string, keys ...string) (*T, error)

TODO(gfyrag): GetAs only allow to map to structure containing only strings. With a bit of reflection, we could be able to have a more smart mapping to structure with usefull types.

func GetBool ¶

func GetBool(ctx core.Context, stack string, keys ...string) (*bool, error)

func GetBoolOrDefault ¶

func GetBoolOrDefault(ctx core.Context, stack string, defaultValue bool, keys ...string) (bool, error)

func GetBoolOrFalse ¶

func GetBoolOrFalse(ctx core.Context, stack string, keys ...string) (bool, error)

func GetBoolOrTrue ¶

func GetBoolOrTrue(ctx core.Context, stack string, keys ...string) (bool, error)

func GetInt ¶

func GetInt(ctx core.Context, stack string, keys ...string) (*int, error)

func GetInt32 ¶

func GetInt32(ctx core.Context, stack string, keys ...string) (*int32, error)

func GetInt32OrDefault ¶

func GetInt32OrDefault(ctx core.Context, stack string, defaultValue int32, keys ...string) (int32, error)

func GetInt64 ¶

func GetInt64(ctx core.Context, stack string, keys ...string) (*int64, error)

func GetIntOrDefault ¶

func GetIntOrDefault(ctx core.Context, stack string, defaultValue int, keys ...string) (int, error)

func GetMap ¶

func GetMap(ctx core.Context, stack string, keys ...string) (map[string]string, error)

func GetMapOrEmpty ¶

func GetMapOrEmpty(ctx core.Context, stack string, keys ...string) (map[string]string, error)

func GetOTELEnvVars ¶

func GetOTELEnvVars(ctx core.Context, stack, serviceName string, sliceStringSeparator string) ([]v1.EnvVar, error)

func GetResourceList ¶

func GetResourceList(ctx core.Context, stack string, keys ...string) (v1.ResourceList, error)

func GetResourceRequirements ¶

func GetResourceRequirements(ctx core.Context, stack string, keys ...string) (*v1.ResourceRequirements, error)

func GetString ¶

func GetString(ctx core.Context, stack string, keys ...string) (*string, error)

func GetStringOrDefault ¶

func GetStringOrDefault(ctx core.Context, stack, defaultValue string, keys ...string) (string, error)

func GetStringOrEmpty ¶

func GetStringOrEmpty(ctx core.Context, stack string, keys ...string) (string, error)

func GetStringSlice ¶

func GetStringSlice(ctx core.Context, stack string, keys ...string) ([]string, error)

func GetTrimmedStringSlice ¶

func GetTrimmedStringSlice(ctx core.Context, stack string, keys ...string) ([]string, error)

func GetUInt ¶

func GetUInt(ctx core.Context, stack string, keys ...string) (*uint, error)

func GetUInt16 ¶

func GetUInt16(ctx core.Context, stack string, keys ...string) (*uint16, error)

func GetUInt16OrDefault ¶

func GetUInt16OrDefault(ctx core.Context, stack string, defaultValue uint16, keys ...string) (uint16, error)

func GetUInt64 ¶

func GetUInt64(ctx core.Context, stack string, keys ...string) (*uint64, error)

func GetURL ¶

func GetURL(ctx core.Context, stack string, keys ...string) (*v1beta1.URI, error)

func HasOpenTelemetryTracesEnabled ¶

func HasOpenTelemetryTracesEnabled(ctx core.Context, stack string) (bool, error)

func IsTrue ¶

func IsTrue(v string) bool

func New ¶

func New(name, key, value string, stacks ...string) *v1beta1.Settings

func RequireString ¶

func RequireString(ctx core.Context, stack string, keys ...string) (string, error)

func RequireURL ¶

func RequireURL(ctx core.Context, stack string, keys ...string) (*v1beta1.URI, error)

func SplitKeywordWithDot ¶

func SplitKeywordWithDot(key string) []string

Types ¶

type MonitoringType ¶

type MonitoringType string

const (
	MonitoringTypeTraces  MonitoringType = "TRACES"
	MonitoringTypeMetrics MonitoringType = "METRICS"
)

Source Files ¶

View all Source files

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