v1

package
v1.1.0 Latest Latest
Warning

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

Go to latest
Published: Sep 24, 2026 License: Apache-2.0 Imports: 2 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ConditionApplyConfiguration

type ConditionApplyConfiguration struct {
	Type    *string                    `json:"type,omitempty"`
	Status  *kptfilev1.ConditionStatus `json:"status,omitempty"`
	Reason  *string                    `json:"reason,omitempty"`
	Message *string                    `json:"message,omitempty"`
}

ConditionApplyConfiguration represents a declarative configuration of the Condition type for use with apply.

func Condition

func Condition() *ConditionApplyConfiguration

ConditionApplyConfiguration constructs a declarative configuration of the Condition type for use with apply.

func (*ConditionApplyConfiguration) WithMessage

WithMessage sets the Message field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Message field is set to the value of the last call.

func (*ConditionApplyConfiguration) WithReason

WithReason sets the Reason field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Reason field is set to the value of the last call.

func (*ConditionApplyConfiguration) WithStatus

WithStatus sets the Status field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Status field is set to the value of the last call.

func (*ConditionApplyConfiguration) WithType

WithType sets the Type field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Type field is set to the value of the last call.

type FunctionApplyConfiguration

type FunctionApplyConfiguration struct {
	// `Image` specifies the function container image.
	// It can either be fully qualified, e.g.:
	//
	// image: ghcr.io/kptdev/krm-functions-catalog/set-labels
	//
	// Optionally, kpt can be configured to use a image
	// registry host-path that will be used to resolve the image path in case
	// the image path is missing (Defaults to ghcr.io/kptdev/krm-functions-catalog).
	// e.g. The following resolves to ghcr.io/kptdev/krm-functions-catalog/set-labels
	//
	// image: set-labels
	Image *string `json:"image,omitempty"`
	// Exec specifies the function binary executable.
	// The executable can be fully qualified or it must exists in the $PATH e.g:
	//
	// exec: set-namespace
	// exec: /usr/local/bin/my-custom-fn
	Exec *string `json:"exec,omitempty"`
	// `ConfigPath` specifies a slash-delimited relative path to a file in the current directory
	// containing a KRM resource used as the function config. The function will
	// not see this resource in its input items — it is passed as configuration
	// only. Other functions in the pipeline can still see and modify the file.
	ConfigPath *string `json:"configPath,omitempty"`
	// `ConfigMap` is a convenient way to specify a function config of kind ConfigMap.
	ConfigMap map[string]string `json:"configMap,omitempty"`
	// `ConfigRef` references an existing resource in the package as the function config.
	// The resource is identified by apiVersion, kind, and name. This is mutually exclusive
	// with `configPath` and `configMap`.
	ConfigRef *ResourceReferenceApplyConfiguration `json:"configRef,omitempty"`
	// `Name` is used to uniquely identify the function declaration
	// this is primarily used for merging function declaration with upstream counterparts
	Name *string `json:"name,omitempty"`
	// `Tag` is an optional field for specifying/overriding the tag of the function image.
	// Can be a semver constraint satisfying this spec: https://github.com/Masterminds/semver?tab=readme-ov-file#checking-version-constraints
	Tag *string `json:"tag,omitempty"`
	// `Selectors` are used to specify resources on which the function should be executed
	// if not specified, all resources are selected
	Selectors []SelectorApplyConfiguration `json:"selectors,omitempty"`
	// `Exclude` are used to specify resources on which the function should NOT be executed.
	// If not specified, all resources selected by `Selectors` are selected.
	Exclusions []SelectorApplyConfiguration `json:"exclude,omitempty"`
	// CelCondition is an optional CEL expression (exposed as 'when' in YAML) that determines whether this
	// function should be executed. The expression is evaluated against the list
	// of KRM resources passed to this function step (after `Selectors` and
	// `Exclude` have been applied) and should return a boolean value.
	// If omitted or evaluates to true, the function executes normally.
	// If evaluates to false, the function is skipped.
	//
	// Example: Check if a specific ConfigMap exists among the selected resources:
	// when: "resources.exists(r, r.kind == 'ConfigMap' && r.metadata.name == 'my-config')"
	//
	// Example: Check resource count among the selected resources:
	// when: "resources.filter(r, r.kind == 'Deployment').size() > 0"
	CelCondition *string `json:"when,omitempty"`
}

FunctionApplyConfiguration represents a declarative configuration of the Function type for use with apply.

Function specifies a KRM function.

func Function

func Function() *FunctionApplyConfiguration

FunctionApplyConfiguration constructs a declarative configuration of the Function type for use with apply.

func (*FunctionApplyConfiguration) WithCelCondition

func (b *FunctionApplyConfiguration) WithCelCondition(value string) *FunctionApplyConfiguration

WithCelCondition sets the CelCondition field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the CelCondition field is set to the value of the last call.

func (*FunctionApplyConfiguration) WithConfigMap

func (b *FunctionApplyConfiguration) WithConfigMap(entries map[string]string) *FunctionApplyConfiguration

WithConfigMap puts the entries into the ConfigMap field in the declarative configuration and returns the receiver, so that objects can be build by chaining "With" function invocations. If called multiple times, the entries provided by each call will be put on the ConfigMap field, overwriting an existing map entries in ConfigMap field with the same key.

func (*FunctionApplyConfiguration) WithConfigPath

WithConfigPath sets the ConfigPath field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the ConfigPath field is set to the value of the last call.

func (*FunctionApplyConfiguration) WithConfigRef

WithConfigRef sets the ConfigRef field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the ConfigRef field is set to the value of the last call.

func (*FunctionApplyConfiguration) WithExclusions

WithExclusions adds the given value to the Exclusions field in the declarative configuration and returns the receiver, so that objects can be build by chaining "With" function invocations. If called multiple times, values provided by each call will be appended to the Exclusions field.

func (*FunctionApplyConfiguration) WithExec

WithExec sets the Exec field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Exec field is set to the value of the last call.

func (*FunctionApplyConfiguration) WithImage

WithImage sets the Image field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Image field is set to the value of the last call.

func (*FunctionApplyConfiguration) WithName

WithName sets the Name field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Name field is set to the value of the last call.

func (*FunctionApplyConfiguration) WithSelectors

WithSelectors adds the given value to the Selectors field in the declarative configuration and returns the receiver, so that objects can be build by chaining "With" function invocations. If called multiple times, values provided by each call will be appended to the Selectors field.

func (*FunctionApplyConfiguration) WithTag

WithTag sets the Tag field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Tag field is set to the value of the last call.

type GenericLockApplyConfiguration

type GenericLockApplyConfiguration struct {
	// StoreID is a descriptor of the underlying storage type.
	// e.g. 'DB' for database
	StoreID *string `json:"storeID,omitempty"`
	// ResourceID is a unique identifier of the resource.
	// The format depends on the underlying storage.
	ResourceID *string `json:"resourceID,omitempty"`
	// ResourceVersion indicates the last fetched version of the resource.
	// The format depends on the underlying storage.
	ResourceVersion *string `json:"resourceVersion,omitempty"`
}

GenericLockApplyConfiguration represents a declarative configuration of the GenericLock type for use with apply.

GenericLock is a minimal locator for a package stored in a generic storage backend.

func GenericLock

func GenericLock() *GenericLockApplyConfiguration

GenericLockApplyConfiguration constructs a declarative configuration of the GenericLock type for use with apply.

func (*GenericLockApplyConfiguration) WithResourceID

WithResourceID sets the ResourceID field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the ResourceID field is set to the value of the last call.

func (*GenericLockApplyConfiguration) WithResourceVersion

WithResourceVersion sets the ResourceVersion field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the ResourceVersion field is set to the value of the last call.

func (*GenericLockApplyConfiguration) WithStoreID

WithStoreID sets the StoreID field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the StoreID field is set to the value of the last call.

type GitApplyConfiguration

type GitApplyConfiguration struct {
	// Repo is the git repository the package.
	// e.g. 'https://github.com/kubernetes/examples.git'
	Repo *string `json:"repo,omitempty"`
	// Directory is the sub directory of the git repository.
	// e.g. 'staging/cockroachdb'
	Directory *string `json:"directory,omitempty"`
	// Ref can be a Git branch, tag, or a commit SHA-1.
	Ref *string `json:"ref,omitempty"`
}

GitApplyConfiguration represents a declarative configuration of the Git type for use with apply.

Git is the user-specified locator for a package on Git.

func Git

func Git() *GitApplyConfiguration

GitApplyConfiguration constructs a declarative configuration of the Git type for use with apply.

func (*GitApplyConfiguration) WithDirectory

func (b *GitApplyConfiguration) WithDirectory(value string) *GitApplyConfiguration

WithDirectory sets the Directory field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Directory field is set to the value of the last call.

func (*GitApplyConfiguration) WithRef

WithRef sets the Ref field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Ref field is set to the value of the last call.

func (*GitApplyConfiguration) WithRepo

WithRepo sets the Repo field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Repo field is set to the value of the last call.

type GitLockApplyConfiguration

type GitLockApplyConfiguration struct {
	// Repo is the git repository that was fetched.
	// e.g. 'https://github.com/kubernetes/examples.git'
	Repo *string `json:"repo,omitempty"`
	// Directory is the sub directory of the git repository that was fetched.
	// e.g. 'staging/cockroachdb'
	Directory *string `json:"directory,omitempty"`
	// Ref can be a Git branch, tag, or a commit SHA-1 that was fetched.
	// e.g. 'master'
	Ref *string `json:"ref,omitempty"`
	// Commit is the SHA-1 for the last fetch of the package.
	// This is set by kpt for bookkeeping purposes.
	Commit *string `json:"commit,omitempty"`
}

GitLockApplyConfiguration represents a declarative configuration of the GitLock type for use with apply.

GitLock is the resolved locator for a package on Git.

func GitLock

func GitLock() *GitLockApplyConfiguration

GitLockApplyConfiguration constructs a declarative configuration of the GitLock type for use with apply.

func (*GitLockApplyConfiguration) WithCommit

WithCommit sets the Commit field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Commit field is set to the value of the last call.

func (*GitLockApplyConfiguration) WithDirectory

WithDirectory sets the Directory field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Directory field is set to the value of the last call.

func (*GitLockApplyConfiguration) WithRef

WithRef sets the Ref field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Ref field is set to the value of the last call.

func (*GitLockApplyConfiguration) WithRepo

WithRepo sets the Repo field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Repo field is set to the value of the last call.

type InventoryApplyConfiguration

type InventoryApplyConfiguration struct {
	// Namespace for the inventory resource.
	Namespace *string `json:"namespace,omitempty"`
	// Name of the inventory resource.
	Name *string `json:"name,omitempty"`
	// Unique label to identify inventory resource in cluster.
	InventoryID *string           `json:"inventoryID,omitempty"`
	Labels      map[string]string `json:"labels,omitempty"`
	Annotations map[string]string `json:"annotations,omitempty"`
}

InventoryApplyConfiguration represents a declarative configuration of the Inventory type for use with apply.

Inventory encapsulates the parameters for the inventory resource applied to a cluster. All of the the parameters are required if any are set.

func Inventory

func Inventory() *InventoryApplyConfiguration

InventoryApplyConfiguration constructs a declarative configuration of the Inventory type for use with apply.

func (*InventoryApplyConfiguration) WithAnnotations

func (b *InventoryApplyConfiguration) WithAnnotations(entries map[string]string) *InventoryApplyConfiguration

WithAnnotations puts the entries into the Annotations field in the declarative configuration and returns the receiver, so that objects can be build by chaining "With" function invocations. If called multiple times, the entries provided by each call will be put on the Annotations field, overwriting an existing map entries in Annotations field with the same key.

func (*InventoryApplyConfiguration) WithInventoryID

WithInventoryID sets the InventoryID field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the InventoryID field is set to the value of the last call.

func (*InventoryApplyConfiguration) WithLabels

WithLabels puts the entries into the Labels field in the declarative configuration and returns the receiver, so that objects can be build by chaining "With" function invocations. If called multiple times, the entries provided by each call will be put on the Labels field, overwriting an existing map entries in Labels field with the same key.

func (*InventoryApplyConfiguration) WithName

WithName sets the Name field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Name field is set to the value of the last call.

func (*InventoryApplyConfiguration) WithNamespace

WithNamespace sets the Namespace field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Namespace field is set to the value of the last call.

type LocatorApplyConfiguration

type LocatorApplyConfiguration struct {
	// Type is the type of origin.
	Type *kptfilev1.OriginType `json:"type,omitempty"`
	// Git is the resolved locator for a package on Git.
	Git *GitLockApplyConfiguration `json:"git,omitempty"`
	// Generic is a minimal locator for a package stored in some generic storage type (e.g.: a database)
	Generic *GenericLockApplyConfiguration `json:"generic,omitempty"`
}

LocatorApplyConfiguration represents a declarative configuration of the Locator type for use with apply.

Locator is a resolved locator for the last fetch of the package.

func Locator

func Locator() *LocatorApplyConfiguration

LocatorApplyConfiguration constructs a declarative configuration of the Locator type for use with apply.

func (*LocatorApplyConfiguration) WithGeneric

WithGeneric sets the Generic field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Generic field is set to the value of the last call.

func (*LocatorApplyConfiguration) WithGit

WithGit sets the Git field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Git field is set to the value of the last call.

func (*LocatorApplyConfiguration) WithType

WithType sets the Type field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Type field is set to the value of the last call.

type PackageInfoApplyConfiguration

type PackageInfoApplyConfiguration struct {
	// Site is the URL for package web page.
	Site *string `json:"site,omitempty"`
	// Email is the list of emails for the package authors.
	Emails []string `json:"emails,omitempty"`
	// SPDX license identifier (e.g. "Apache-2.0"). See: https://spdx.org/licenses/
	License *string `json:"license,omitempty"`
	// Relative slash-delimited path to the license file (e.g. LICENSE.txt)
	LicenseFile *string `json:"licenseFile,omitempty"`
	// Description contains a short description of the package.
	Description *string `json:"description,omitempty"`
	// Keywords is a list of keywords for this package.
	Keywords []string `json:"keywords,omitempty"`
	// Man is the path to documentation about the package
	Man            *string                           `json:"man,omitempty"`
	ReadinessGates []ReadinessGateApplyConfiguration `json:"readinessGates,omitempty"`
}

PackageInfoApplyConfiguration represents a declarative configuration of the PackageInfo type for use with apply.

PackageInfo contains optional information about the package such as license, documentation, etc. These fields are not consumed by any functionality in kpt and are simply passed through. Note that like any other KRM resource, humans and automation can also use `metadata.labels` and `metadata.annotations` as the extension mechanism.

func PackageInfo

func PackageInfo() *PackageInfoApplyConfiguration

PackageInfoApplyConfiguration constructs a declarative configuration of the PackageInfo type for use with apply.

func (*PackageInfoApplyConfiguration) WithDescription

WithDescription sets the Description field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Description field is set to the value of the last call.

func (*PackageInfoApplyConfiguration) WithEmails

WithEmails adds the given value to the Emails field in the declarative configuration and returns the receiver, so that objects can be build by chaining "With" function invocations. If called multiple times, values provided by each call will be appended to the Emails field.

func (*PackageInfoApplyConfiguration) WithKeywords

WithKeywords adds the given value to the Keywords field in the declarative configuration and returns the receiver, so that objects can be build by chaining "With" function invocations. If called multiple times, values provided by each call will be appended to the Keywords field.

func (*PackageInfoApplyConfiguration) WithLicense

WithLicense sets the License field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the License field is set to the value of the last call.

func (*PackageInfoApplyConfiguration) WithLicenseFile

WithLicenseFile sets the LicenseFile field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the LicenseFile field is set to the value of the last call.

func (*PackageInfoApplyConfiguration) WithMan

WithMan sets the Man field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Man field is set to the value of the last call.

func (*PackageInfoApplyConfiguration) WithReadinessGates

WithReadinessGates adds the given value to the ReadinessGates field in the declarative configuration and returns the receiver, so that objects can be build by chaining "With" function invocations. If called multiple times, values provided by each call will be appended to the ReadinessGates field.

func (*PackageInfoApplyConfiguration) WithSite

WithSite sets the Site field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Site field is set to the value of the last call.

type PipelineApplyConfiguration

type PipelineApplyConfiguration struct {
	// Mutators defines a list of of KRM functions that mutate resources.
	Mutators []FunctionApplyConfiguration `json:"mutators,omitempty"`
	// Validators defines a list of KRM functions that validate resources.
	// Validators are not permitted to mutate resources.
	Validators []FunctionApplyConfiguration `json:"validators,omitempty"`
}

PipelineApplyConfiguration represents a declarative configuration of the Pipeline type for use with apply.

Pipeline declares a pipeline of functions used to mutate or validate resources.

func Pipeline

func Pipeline() *PipelineApplyConfiguration

PipelineApplyConfiguration constructs a declarative configuration of the Pipeline type for use with apply.

func (*PipelineApplyConfiguration) WithMutators

WithMutators adds the given value to the Mutators field in the declarative configuration and returns the receiver, so that objects can be build by chaining "With" function invocations. If called multiple times, values provided by each call will be appended to the Mutators field.

func (*PipelineApplyConfiguration) WithValidators

WithValidators adds the given value to the Validators field in the declarative configuration and returns the receiver, so that objects can be build by chaining "With" function invocations. If called multiple times, values provided by each call will be appended to the Validators field.

type PipelineStepResultApplyConfiguration

type PipelineStepResultApplyConfiguration struct {
	Name           *string                 `json:"name,omitempty"`
	Image          *string                 `json:"image,omitempty"`
	ExecPath       *string                 `json:"exec,omitempty"`
	ExecutionError *string                 `json:"executionError,omitempty"`
	Stderr         *string                 `json:"stderr,omitempty"`
	ExitCode       *int                    `json:"exitCode,omitempty"`
	Results        []fnresultv1.ResultItem `json:"results,omitempty"`
	ErrorResults   []fnresultv1.ResultItem `json:"errorResults,omitempty"`
	// When is the CEL condition expression that was evaluated
	When *string `json:"when,omitempty"`
	// Skipped indicates if the function was skipped due to a condition
	Skipped *bool `json:"skipped,omitempty"`
}

PipelineStepResultApplyConfiguration represents a declarative configuration of the PipelineStepResult type for use with apply.

PipelineStepResult contains the structured result from an individual function call in the pipeline.

func PipelineStepResult

func PipelineStepResult() *PipelineStepResultApplyConfiguration

PipelineStepResultApplyConfiguration constructs a declarative configuration of the PipelineStepResult type for use with apply.

func (*PipelineStepResultApplyConfiguration) WithErrorResults

WithErrorResults adds the given value to the ErrorResults field in the declarative configuration and returns the receiver, so that objects can be build by chaining "With" function invocations. If called multiple times, values provided by each call will be appended to the ErrorResults field.

func (*PipelineStepResultApplyConfiguration) WithExecPath

WithExecPath sets the ExecPath field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the ExecPath field is set to the value of the last call.

func (*PipelineStepResultApplyConfiguration) WithExecutionError

WithExecutionError sets the ExecutionError field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the ExecutionError field is set to the value of the last call.

func (*PipelineStepResultApplyConfiguration) WithExitCode

WithExitCode sets the ExitCode field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the ExitCode field is set to the value of the last call.

func (*PipelineStepResultApplyConfiguration) WithImage

WithImage sets the Image field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Image field is set to the value of the last call.

func (*PipelineStepResultApplyConfiguration) WithName

WithName sets the Name field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Name field is set to the value of the last call.

func (*PipelineStepResultApplyConfiguration) WithResults

WithResults adds the given value to the Results field in the declarative configuration and returns the receiver, so that objects can be build by chaining "With" function invocations. If called multiple times, values provided by each call will be appended to the Results field.

func (*PipelineStepResultApplyConfiguration) WithSkipped

WithSkipped sets the Skipped field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Skipped field is set to the value of the last call.

func (*PipelineStepResultApplyConfiguration) WithStderr

WithStderr sets the Stderr field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Stderr field is set to the value of the last call.

func (*PipelineStepResultApplyConfiguration) WithWhen

WithWhen sets the When field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the When field is set to the value of the last call.

type ReadinessGateApplyConfiguration

type ReadinessGateApplyConfiguration struct {
	ConditionType *string `json:"conditionType,omitempty"`
}

ReadinessGateApplyConfiguration represents a declarative configuration of the ReadinessGate type for use with apply.

func ReadinessGate

func ReadinessGate() *ReadinessGateApplyConfiguration

ReadinessGateApplyConfiguration constructs a declarative configuration of the ReadinessGate type for use with apply.

func (*ReadinessGateApplyConfiguration) WithConditionType

WithConditionType sets the ConditionType field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the ConditionType field is set to the value of the last call.

type RenderStatusApplyConfiguration

type RenderStatusApplyConfiguration struct {
	MutationSteps   []PipelineStepResultApplyConfiguration `json:"mutationSteps,omitempty"`
	ValidationSteps []PipelineStepResultApplyConfiguration `json:"validationSteps,omitempty"`
	ErrorSummary    *string                                `json:"errorSummary,omitempty"`
}

RenderStatusApplyConfiguration represents a declarative configuration of the RenderStatus type for use with apply.

RenderStatus represents the result of performing render operation on a package's resources.

func RenderStatus

func RenderStatus() *RenderStatusApplyConfiguration

RenderStatusApplyConfiguration constructs a declarative configuration of the RenderStatus type for use with apply.

func (*RenderStatusApplyConfiguration) WithErrorSummary

WithErrorSummary sets the ErrorSummary field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the ErrorSummary field is set to the value of the last call.

func (*RenderStatusApplyConfiguration) WithMutationSteps

WithMutationSteps adds the given value to the MutationSteps field in the declarative configuration and returns the receiver, so that objects can be build by chaining "With" function invocations. If called multiple times, values provided by each call will be appended to the MutationSteps field.

func (*RenderStatusApplyConfiguration) WithValidationSteps

WithValidationSteps adds the given value to the ValidationSteps field in the declarative configuration and returns the receiver, so that objects can be build by chaining "With" function invocations. If called multiple times, values provided by each call will be appended to the ValidationSteps field.

type ResourceReferenceApplyConfiguration

type ResourceReferenceApplyConfiguration struct {
	// APIVersion of the referenced resource (e.g. "v1"). Optional; when omitted,
	// matches resources regardless of apiVersion.
	APIVersion *string `json:"apiVersion,omitempty"`
	// Kind of the referenced resource (e.g. "ConfigMap"). Required.
	Kind *string `json:"kind,omitempty"`
	// Name of the referenced resource. Required.
	Name *string `json:"name,omitempty"`
	// Namespace of the referenced resource. Optional; when omitted, matches
	// resources regardless of namespace.
	Namespace *string `json:"namespace,omitempty"`
}

ResourceReferenceApplyConfiguration represents a declarative configuration of the ResourceReference type for use with apply.

ResourceReference identifies a resource within the package by its API identity.

func ResourceReference

func ResourceReference() *ResourceReferenceApplyConfiguration

ResourceReferenceApplyConfiguration constructs a declarative configuration of the ResourceReference type for use with apply.

func (*ResourceReferenceApplyConfiguration) WithAPIVersion

WithAPIVersion sets the APIVersion field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the APIVersion field is set to the value of the last call.

func (*ResourceReferenceApplyConfiguration) WithKind

WithKind sets the Kind field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Kind field is set to the value of the last call.

func (*ResourceReferenceApplyConfiguration) WithName

WithName sets the Name field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Name field is set to the value of the last call.

func (*ResourceReferenceApplyConfiguration) WithNamespace

WithNamespace sets the Namespace field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Namespace field is set to the value of the last call.

type SelectorApplyConfiguration

type SelectorApplyConfiguration struct {
	// APIVersion of the target resources
	APIVersion *string `json:"apiVersion,omitempty"`
	// Kind of the target resources
	Kind *string `json:"kind,omitempty"`
	// Name of the target resources
	Name *string `json:"name,omitempty"`
	// Namespace of the target resources
	Namespace *string `json:"namespace,omitempty"`
	// Labels on the target resources
	Labels map[string]string `json:"labels,omitempty"`
	// Annotations on the target resources
	Annotations map[string]string `json:"annotations,omitempty"`
	// ResourceFileRegexp a regular expression matched against the path of the file
	// containing the resource, relative to the package root. Resources whose file path
	// matches the expression will be selected.
	ResourceFileRegexp *string `json:"resourceFileRegexp,omitempty"`
}

SelectorApplyConfiguration represents a declarative configuration of the Selector type for use with apply.

Selector specifies the selection criteria please update IsEmpty method if more properties are added

func Selector

func Selector() *SelectorApplyConfiguration

SelectorApplyConfiguration constructs a declarative configuration of the Selector type for use with apply.

func (*SelectorApplyConfiguration) WithAPIVersion

WithAPIVersion sets the APIVersion field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the APIVersion field is set to the value of the last call.

func (*SelectorApplyConfiguration) WithAnnotations

func (b *SelectorApplyConfiguration) WithAnnotations(entries map[string]string) *SelectorApplyConfiguration

WithAnnotations puts the entries into the Annotations field in the declarative configuration and returns the receiver, so that objects can be build by chaining "With" function invocations. If called multiple times, the entries provided by each call will be put on the Annotations field, overwriting an existing map entries in Annotations field with the same key.

func (*SelectorApplyConfiguration) WithKind

WithKind sets the Kind field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Kind field is set to the value of the last call.

func (*SelectorApplyConfiguration) WithLabels

WithLabels puts the entries into the Labels field in the declarative configuration and returns the receiver, so that objects can be build by chaining "With" function invocations. If called multiple times, the entries provided by each call will be put on the Labels field, overwriting an existing map entries in Labels field with the same key.

func (*SelectorApplyConfiguration) WithName

WithName sets the Name field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Name field is set to the value of the last call.

func (*SelectorApplyConfiguration) WithNamespace

WithNamespace sets the Namespace field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Namespace field is set to the value of the last call.

func (*SelectorApplyConfiguration) WithResourceFileRegexp

func (b *SelectorApplyConfiguration) WithResourceFileRegexp(value string) *SelectorApplyConfiguration

WithResourceFileRegexp sets the ResourceFileRegexp field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the ResourceFileRegexp field is set to the value of the last call.

type StatusApplyConfiguration

type StatusApplyConfiguration struct {
	Conditions   []ConditionApplyConfiguration   `json:"conditions,omitempty"`
	RenderStatus *RenderStatusApplyConfiguration `json:"renderStatus,omitempty"`
}

StatusApplyConfiguration represents a declarative configuration of the Status type for use with apply.

func Status

func Status() *StatusApplyConfiguration

StatusApplyConfiguration constructs a declarative configuration of the Status type for use with apply.

func (*StatusApplyConfiguration) WithConditions

WithConditions adds the given value to the Conditions field in the declarative configuration and returns the receiver, so that objects can be build by chaining "With" function invocations. If called multiple times, values provided by each call will be appended to the Conditions field.

func (*StatusApplyConfiguration) WithRenderStatus

WithRenderStatus sets the RenderStatus field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the RenderStatus field is set to the value of the last call.

type UpstreamApplyConfiguration

type UpstreamApplyConfiguration struct {
	// Type is the type of origin.
	Type *kptfilev1.OriginType `json:"type,omitempty"`
	// Git is the locator for a package stored on Git.
	Git *GitApplyConfiguration `json:"git,omitempty"`
	// UpdateStrategy declares how a package will be updated from upstream.
	UpdateStrategy *kptfilev1.UpdateStrategyType `json:"updateStrategy,omitempty"`
	// PreserveExplicitNull, when true, keeps a field explicitly nulled in the
	// local package during resource-merge instead of deleting it. Only applies
	// to the resource-merge update strategy.
	PreserveExplicitNull *bool `json:"preserveExplicitNull,omitempty"`
}

UpstreamApplyConfiguration represents a declarative configuration of the Upstream type for use with apply.

Upstream is a user-specified upstream locator for a package.

func Upstream

func Upstream() *UpstreamApplyConfiguration

UpstreamApplyConfiguration constructs a declarative configuration of the Upstream type for use with apply.

func (*UpstreamApplyConfiguration) WithGit

WithGit sets the Git field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Git field is set to the value of the last call.

func (*UpstreamApplyConfiguration) WithPreserveExplicitNull

func (b *UpstreamApplyConfiguration) WithPreserveExplicitNull(value bool) *UpstreamApplyConfiguration

WithPreserveExplicitNull sets the PreserveExplicitNull field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the PreserveExplicitNull field is set to the value of the last call.

func (*UpstreamApplyConfiguration) WithType

WithType sets the Type field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Type field is set to the value of the last call.

func (*UpstreamApplyConfiguration) WithUpdateStrategy

WithUpdateStrategy sets the UpdateStrategy field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the UpdateStrategy field is set to the value of the last call.

Jump to

Keyboard shortcuts

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