api

Documentation

Index

• Constants
• type ConfigSpec
• type CredSpec
• type MatchConstraintsSpec
• type ResourceRule

Constants

const (
	// FieldManager is the name of the manager performing Kubernetes patch operations.
	FieldManager = "krm-kcl"

	// KCLRunKind represents the kind of resource for the KCLRun resource.
	KCLRunKind = "KCLRun"

	// SourceKey is the key for the source field in the KCLRun resource, which denotes the source of the KCL script
	// and it can be from the inline code, git, oci source, etc.
	SourceKey = "source"

	// ParamsKey is the key for the params field in the KCLRun resource, which denotes the top level dynamic arguments.
	ParamsKey = "params"

	// ConfigKey is the key for the config field in the KCLRun resource, which denotes the KCL CLI running config.
	ConfigKey = "config"

	// MatchConstraintsKey is the key for the match constraints field in the KCLRun resource.
	MatchConstraintsKey = "matchConstraints"
)

Types

type ConfigSpec

type ConfigSpec struct {
	// Arguments is the list of top level dynamic arguments for the kcl option function, e.g., env="prod"
	Arguments []string `json:"arguments,omitempty" yaml:"arguments,omitempty"`
	// Settings is the list of kcl setting files including all of the CLI config.
	Settings []string `json:"settings,omitempty" yaml:"settings,omitempty"`
	// Overrides is the list of override paths and values, e.g., app.image="v2"
	Overrides []string `json:"overrides,omitempty" yaml:"overrides,omitempty"`
	// PathSelectors is the list of path selectors to select output result, e.g., a.b.c
	PathSelectors []string `json:"pathSelectors,omitempty" yaml:"pathSelectors,omitempty"`
	// Vendor denotes running kcl in the vendor mode.
	Vendor bool `json:"vendor,omitempty" yaml:"vendor,omitempty"`
	// SortKeys denotes sorting the output result keys, e.g., `{b = 1, a = 2} => {a = 2, b = 1}`.
	SortKeys bool `json:"sortKeys,omitempty" yaml:"sortKeys,omitempty"`
	// ShowHidden denotes output the hidden attribute in the result.
	ShowHidden bool `json:"showHidden,omitempty" yaml:"showHidden,omitempty"`
	// DisableNone denotes running kcl and disable dumping None values.
	DisableNone bool `json:"disableNone,omitempty" yaml:"disableNone,omitempty"`
	// Debug denotes running kcl in debug mode.
	Debug bool `json:"debug,omitempty" yaml:"debug,omitempty"`
	// StrictRangeCheck performs the 32-bit strict numeric range checks on numbers.
	StrictRangeCheck bool `json:"strictRangeCheck,omitempty" yaml:"strictRangeCheck,omitempty"`
}

ConfigSpec defines the compile config.

type CredSpec

type CredSpec struct {
	Url      string `json:"url,omitempty" yaml:"url,omitempty"`
	Username string `json:"username" yaml:"username"`
	Password string `json:"password" yaml:"password"`
}

CredSpec defines authentication credentials for remote locations

type MatchConstraintsSpec

type MatchConstraintsSpec struct {
	ResourceRules []ResourceRule `json:"resourceRules,omitempty" yaml:"resourceRules,omitempty"`
}

MatchConstraintsSpec defines the resource matching rules.

type ResourceRule

type ResourceRule struct {
	APIVersions []string `json:"apiVersions,omitempty" yaml:"apiVersions,omitempty"`
	Kinds       []string `json:"kinds,omitempty" yaml:"kinds,omitempty"`
}

ResourceRule defines a rule for matching resources.