facts

Documentation

Overview

Package facts provides shared fact key constants and validation for @fact. references.

Index

• Constants
• func BuiltInKeys() []string
• func IsCustomKey(key string) bool
• func IsKnownKey(key string) bool

Constants

const (
	KeyInterfacePrimary = "interface.primary"
	KeyHostname         = "hostname"
	KeyArch             = "arch"
	KeyKernel           = "kernel"
	KeyFQDN             = "fqdn"
	KeyContainerized    = "containerized"
)

Built-in fact key constants. These are the canonical @fact. reference keys that agents resolve at execution time. All validation, resolution, and API responses should reference these constants.

const CustomPrefix = "custom."

CustomPrefix is the prefix for user-defined fact keys.

const Prefix = "@fact."

Prefix is the reference prefix used in API request fields.

Functions

func BuiltInKeys

func BuiltInKeys() []string

BuiltInKeys returns the list of all built-in fact keys.

func IsCustomKey

func IsCustomKey(key string) bool

IsCustomKey reports whether key is a valid custom fact key (starts with "custom." and has at least one character after the prefix).

func IsKnownKey

func IsKnownKey(key string) bool

IsKnownKey reports whether key is a recognized fact key. Known keys are the built-in keys plus any key with the "custom." prefix followed by at least one character.