v1alpha1

Documentation

Index

• Constants
• Variables
• func GetBlockName(a, b string) string
• type Attributes
• type BlockType
  • func GetBlockType(n string) BlockType
  • func (d BlockType) String() string
• type Info
• type KformFile
  • func BuildKformFile(meta metav1.ObjectMeta, spec KformFileSpec) *KformFile
• type KformFileSpec
• type Maintainer
• type Provider
  • func (r Provider) Validate() error

Constants

const (
	KformAnnotationKeyPrefix         = "kform.dev"
	KformAnnotationKey_BLOCK_TYPE    = KformAnnotationKeyPrefix + "/" + "block-type"
	KformAnnotationKey_RESOURCE_TYPE = KformAnnotationKeyPrefix + "/" + "resource-type"
	KformAnnotationKey_RESOURCE_ID   = KformAnnotationKeyPrefix + "/" + "resource-id"
	KformAnnotationKey_COUNT         = KformAnnotationKeyPrefix + "/" + "count"
	KformAnnotationKey_FOR_EACH      = KformAnnotationKeyPrefix + "/" + "for-each"
	KformAnnotationKey_DEPENDS_ON    = KformAnnotationKeyPrefix + "/" + "depends-on"
	KformAnnotationKey_DEFAULT       = KformAnnotationKeyPrefix + "/" + "default"
	KformAnnotationKey_SOURCE        = KformAnnotationKeyPrefix + "/" + "source"
	KformAnnotationKey_VERSION       = KformAnnotationKeyPrefix + "/" + "version"
	KformAnnotationKey_DESCRIPTION   = KformAnnotationKeyPrefix + "/" + "description"
	KformAnnotationKey_SENSITIVE     = KformAnnotationKeyPrefix + "/" + "sensitive"
	KformAnnotationKey_LIFECYCLE     = KformAnnotationKeyPrefix + "/" + "lifecycle"
	KformAnnotationKey_PRECONDITION  = KformAnnotationKeyPrefix + "/" + "pre-condition"
	KformAnnotationKey_POSTCONDITION = KformAnnotationKeyPrefix + "/" + "post-condition"
	KformAnnotationKey_PROVIDERS     = KformAnnotationKeyPrefix + "/" + "providers"
	KformAnnotationKey_PROVIDER      = KformAnnotationKeyPrefix + "/" + "provider"
	KformAnnotationKey_PROVISIONER   = KformAnnotationKeyPrefix + "/" + "provisioner"
	KformAnnotationKey_ORGANIZATION  = KformAnnotationKeyPrefix + "/" + "organization"
	KformAnnotationKey_ALIAS         = KformAnnotationKeyPrefix + "/" + "alias"
	KformAnnotationKey_HOSTNAME      = KformAnnotationKeyPrefix + "/" + "hostname"
	KformAnnotationKey_PATH          = KformAnnotationKeyPrefix + "/" + "path"
	KformAnnotationKey_INDEX         = KformAnnotationKeyPrefix + "/" + "index"
)

kform attibutes

const (
	Group         = "meta.pkg.kform.dev"
	Version       = "v1alpha1"
	APIVersion    = Group + "/" + Version
	KformFileName = "KformFile.yaml"
)

const (
	LoopAttrCount   = "count"
	LoopAttrForEach = "forEach"
	LoopKeyCount    = "count"
	LoopKeyEach     = "each"

	LoopKeyCountIndex = "count.index"
	LoopKeyForEachKey = "each.key"
	LoopKeyForEachVal = "each.value"
	LoopKeyItemsTotal = "items.total"
	LoopKeyItemsIndex = "items.index"
)

Variables

var KformAnnotations = []string{
	KformAnnotationKey_BLOCK_TYPE,
	KformAnnotationKey_RESOURCE_TYPE,
	KformAnnotationKey_RESOURCE_ID,
	KformAnnotationKey_COUNT,
	KformAnnotationKey_FOR_EACH,
	KformAnnotationKey_DEPENDS_ON,
	KformAnnotationKey_DEFAULT,
	KformAnnotationKey_SOURCE,
	KformAnnotationKey_VERSION,
	KformAnnotationKey_DESCRIPTION,
	KformAnnotationKey_SENSITIVE,
	KformAnnotationKey_LIFECYCLE,
	KformAnnotationKey_PRECONDITION,
	KformAnnotationKey_POSTCONDITION,
	KformAnnotationKey_PROVIDERS,
	KformAnnotationKey_PROVIDER,
	KformAnnotationKey_PROVISIONER,
	KformAnnotationKey_ORGANIZATION,
	KformAnnotationKey_ALIAS,
	KformAnnotationKey_HOSTNAME,
	KformAnnotationKey_PATH,
	KformAnnotationKey_INDEX,
}

var (
	KformFileKind = reflect.TypeOf(KformFile{}).Name()
)

var LocalVars = map[string]struct{}{
	LoopKeyCountIndex: {},
	LoopKeyForEachKey: {},
	LoopKeyForEachVal: {},
}

var LoopAttr = map[string]*cel.Type{
	LoopAttrCount:   cel.IntType,
	LoopAttrForEach: cel.DynType,
}

Functions

func GetBlockName

func GetBlockName(a, b string) string

GetBlockName returns the block name

Types

type Attributes

type Attributes struct {
	APIVersion      string            `json:"apiVersion,omitempty" yaml:"apiVersion,omitempty"`
	Kind            string            `json:"kind,omitempty" yaml:"kind,omitempty"`
	ResourceType    string            `json:"resourceType,omitempty" yaml:"resourceType,omitempty"` // only relevant for resources
	ResourceID      string            `json:"resourceID,omitempty" yaml:"resourceID,omitempty"`     // only relevant for resources
	Count           string            `json:"count,omitempty" yaml:"count,omitempty"`
	ForEach         string            `json:"forEach,omitempty" yaml:"forEach,omitempty"`
	DependsOn       string            `json:"dependsOn,omitempty" yaml:"dependsOn,omitempty"`
	Provider        string            `json:"provider,omitempty" yaml:"provider,omitempty"`
	Providers       map[string]string `json:"providers,omitempty" yaml:"providers,omitempty"` // only relevant for Mixin
	Description     string            `json:"description,omitempty" yaml:"description,omitempty"`
	Sensitive       bool              `json:"sensitive,omitempty" yaml:"sensitive,omitempty"`
	Validation      string            `json:"validation,omitempty" yaml:"validation,omitempty"`
	LifeCycle       string            `json:"lifecycle,omitempty" yaml:"lifecycle,omitempty"`
	PreCondition    string            `json:"preCondition,omitempty" yaml:"preCondition,omitempty"`
	PostCondition   string            `json:"postCondition,omitempty" yaml:"postCondition,omitempty"`
	Provisioner     string            `json:"provisioner,omitempty" yaml:"provisioner,omitempty"`
	Connection      string            `json:"connection,omitempty" yaml:"connection,omitempty"`
	HostName        string            `json:"hostName,omitempty" yaml:"hostName,omitempty"`
	Organization    string            `json:"organization,omitempty" yaml:"organization,omitempty"`
	Workspaces      map[string]string `json:"workspaces,omitempty" yaml:"workspaces,omitempty"`
	Source          string            `json:"source,omitempty" yaml:"source,omitempty"`
	Alias           string            `json:"alias,omitempty" yaml:"alias,omitempty"`
	InputParameters map[string]any    `json:"inputParameters,omitempty" yaml:"inputParameters,omitempty"` // only relevant for Mixin
}

type BlockType

type BlockType int

const (
	BlockType_UNKNOWN BlockType = iota
	BlockType_BACKEND
	BlockType_REQUIREDPROVIDERS
	BlockTYPE_PROVIDER
	BlockTYPE_PACKAGE
	BlockTYPE_INPUT
	BlockTYPE_OUTPUT
	BlockTYPE_LOCAL
	BlockTYPE_RESOURCE
	BlockTYPE_DATA
	BlockTYPE_LIST
	BlockTYPE_ROOT
)

func GetBlockType

func GetBlockType(n string) BlockType

func (BlockType) String

func (d BlockType) String() string

type Info

type Info struct {
	Description string       `json:"description,omitempty" yaml:"description,omitempty"`
	Maintainers []Maintainer `json:"maintainers,omitempty" yaml:"maintainers,omitempty"`
}

type KformFile

type KformFile struct {
	metav1.TypeMeta   `json:",inline" yaml:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty" yaml:"metadata,omitempty"`

	Spec KformFileSpec `json:"spec,omitempty" yaml:"spec,omitempty"`
}

func BuildKformFile

func BuildKformFile(meta metav1.ObjectMeta, spec KformFileSpec) *KformFile

BuildKformFile returns a KformFile api type

type KformFileSpec

type KformFileSpec struct {
	// +kubebuilder:validation:Enum=provider;module
	ProviderRequirements map[string]Provider `json:"providerRequirements" yaml:"providerRequirements"`
	Info                 Info                `json:"info,omitempty" yaml:"info,omitempty"`
}

type Maintainer

type Maintainer struct {
	Name  string `json:"name,omitempty" yaml:"name,omitempty"`
	Email string `json:"email,omitempty" yaml:"email,omitempty"`
}

type Provider

type Provider struct {
	Source  string `json:"source" yaml:"source"`
	Version string `json:"version" yaml:"version"`
}

func (Provider) Validate

func (r Provider) Validate() error