kptfile

Documentation

Overview

Note: This is copied from kpt schema version v1alpha2.

Index

• Constants
• Variables
• func UpdateStrategiesAsStrings() []string
• type Function
• type Git
• type GitLock
• type Inventory
• type KptFile
• type OriginType
• type PackageInfo
• type Pipeline
  • func (p *Pipeline) IsEmpty() bool
  • func (p *Pipeline) String() string
• type Subpackage
• type UpdateStrategyType
  • func ToUpdateStrategy(strategy string) (UpdateStrategyType, error)
• type Upstream
• type UpstreamLock

Constants

const (
	KptFileName       = "Kptfile"
	KptFileKind       = "Kptfile"
	KptFileGroup      = "kpt.dev"
	KptFileVersion    = "v1alpha2"
	KptFileAPIVersion = KptFileGroup + "/" + KptFileVersion
)

Variables

var TypeMeta = yaml.ResourceMeta{
	TypeMeta: yaml.TypeMeta{
		APIVersion: KptFileAPIVersion,
		Kind:       KptFileName,
	},
}

TypeMeta is the TypeMeta for KptFile instances.

var UpdateStrategies = []UpdateStrategyType{
	ResourceMerge,
	FastForward,
	ForceDeleteReplace,
}

UpdateStrategies is a slice with all the supported update strategies.

Functions

func UpdateStrategiesAsStrings

func UpdateStrategiesAsStrings() []string

UpdateStrategiesAsStrings returns a list of update strategies as strings.

Types

type Function

type Function struct {
	// `Image` specifies the function container image.
	// It can either be fully qualified, e.g.:
	//
	//	image: gcr.io/kpt-fn/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 gcr.io/kpt-fn).
	// e.g. The following resolves to gcr.io/kpt-fn/set-labels:
	//
	//	image: set-labels
	Image string `yaml:"image,omitempty"`

	// `ConfigPath` specifies a slash-delimited relative path to a file in the current directory
	// containing a KRM resource used as the function config. This resource is
	// excluded when resolving 'sources', and as a result cannot be operated on
	// by the pipeline.
	ConfigPath string `yaml:"configPath,omitempty"`

	// `ConfigMap` is a convenient way to specify a function config of kind ConfigMap.
	ConfigMap map[string]string `yaml:"configMap,omitempty"`
}

Function specifies a KRM function.

type Git

type Git struct {
	// Repo is the git repository the package.
	// e.g. 'https://github.com/kubernetes/examples.git'
	Repo string `yaml:"repo,omitempty"`

	// Directory is the sub directory of the git repository.
	// e.g. 'staging/cockroachdb'
	Directory string `yaml:"directory,omitempty"`

	// Ref can be a Git branch, tag, or a commit SHA-1.
	Ref string `yaml:"ref,omitempty"`
}

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

type GitLock

type GitLock struct {
	// Repo is the git repository that was fetched.
	// e.g. 'https://github.com/kubernetes/examples.git'
	Repo string `yaml:"repo,omitempty"`

	// Directory is the sub directory of the git repository that was fetched.
	// e.g. 'staging/cockroachdb'
	Directory string `yaml:"directory,omitempty"`

	// Ref can be a Git branch, tag, or a commit SHA-1 that was fetched.
	// e.g. 'master'
	Ref string `yaml:"ref,omitempty"`

	// Commit is the SHA-1 for the last fetch of the package.
	// This is set by kpt for bookkeeping purposes.
	Commit string `yaml:"commit,omitempty"`
}

GitLock is the resolved locator for a package on Git.

type Inventory

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

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

type KptFile

type KptFile struct {
	yaml.ResourceMeta `yaml:",inline"`

	Upstream *Upstream `yaml:"upstream,omitempty"`

	// UpstreamLock is a resolved locator for the last fetch of the package.
	UpstreamLock *UpstreamLock `yaml:"upstreamLock,omitempty"`

	// Info contains metadata such as license, documentation, etc.
	Info *PackageInfo `yaml:"info,omitempty"`

	// Pipeline declares the pipeline of functions.
	Pipeline *Pipeline `yaml:"pipeline,omitempty"`

	// Inventory contains parameters for the inventory object used in apply.
	Inventory *Inventory `yaml:"inventory,omitempty"`
}

KptFile contains information about a package managed with kpt.Frank Farzan, 4 months ago: • Define schema for Kptfile v1alpha2 (#1417)

type OriginType

type OriginType string

OriginType defines the type of origin for a package.

const (
	// GitOrigin specifies a package as having been cloned from a git repository.
	GitOrigin OriginType = "git"
)

type PackageInfo

type PackageInfo struct {
	// Site is the URL for package web page.
	Site string `yaml:"site,omitempty"`

	// Email is the list of emails for the package authors.
	Emails []string `yaml:"emails,omitempty"`

	// SPDX license identifier (e.g. "Apache-2.0"). See: https://spdx.org/licenses/
	License string `yaml:"license,omitempty"`

	// Relative slash-delimited path to the license file (e.g. LICENSE.txt)
	LicenseFile string `yaml:"licenseFile,omitempty"`

	// Doc is the path to documentation about the package.
	Doc string `yaml:"doc,omitempty"`

	// Description contains a short description of the package.
	Description string `yaml:"description,omitempty"`

	// Keywords is a list of keywords for this package.
	Keywords []string `yaml:"keywords,omitempty"`

	// Man is the path to documentation about the package
	Man string `yaml:"man,omitempty"`
}

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 extrension mechanism.

type Pipeline

type Pipeline struct {

	// Mutators defines a list of of KRM functions that mutate resources.
	Mutators []Function `yaml:"mutators,omitempty"`

	// Validators defines a list of KRM functions that validate resources.
	// Validators are not permitted to mutate resources.
	Validators []Function `yaml:"validators,omitempty"`
}

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

func (*Pipeline) IsEmpty

func (p *Pipeline) IsEmpty() bool

IsEmpty returns true if the pipeline doesn't contain any functions in any of the function chains (mutators, validators).

func (*Pipeline) String

func (p *Pipeline) String() string

String returns the string representation of Pipeline struct The string returned is the struct content in Go default format.

type Subpackage

type Subpackage struct {
	// Name of the immediate subdirectory relative to this Kptfile where the suppackage
	// either exists (local subpackages) or will be fetched to (remote subpckages).
	// This must be unique across all subpckages of a package.
	LocalDir string `yaml:"localDir,omitempty"`

	// Upstream is a reference to where the subpackage should be fetched from.
	// Whether a subpackage is local or remote is determined by whether Upstream is specified.
	Upstream *Upstream `yaml:"upstream,omitempty"`
}

Subpackages declares a local or remote subpackage.

type UpdateStrategyType

type UpdateStrategyType string

UpdateStrategyType defines the strategy for updating a package from upstream.

const (
	// ResourceMerge performs a structural schema-aware comparison and
	// merges the changes into the local package.
	ResourceMerge UpdateStrategyType = "resource-merge"
	// FastForward fails without updating if the local package was modified
	// since it was fetched.
	FastForward UpdateStrategyType = "fast-forward"
	// ForceDeleteReplace wipes all local changes to the package.
	ForceDeleteReplace UpdateStrategyType = "force-delete-replace"
)

func ToUpdateStrategy

func ToUpdateStrategy(strategy string) (UpdateStrategyType, error)

ToUpdateStrategy takes a string representing an update strategy and will return the strategy as an UpdateStrategyType. If the provided string does not match any known update strategies, an error will be returned.

type Upstream

type Upstream struct {
	// Type is the type of origin.
	Type OriginType `yaml:"type,omitempty"`

	// Git is the locator for a package stored on Git.
	Git *Git `yaml:"git,omitempty"`

	// UpdateStrategy declares how a package will be updated from upstream.
	UpdateStrategy UpdateStrategyType `yaml:"updateStrategy,omitempty"`
}

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

type UpstreamLock

type UpstreamLock struct {
	// Type is the type of origin.
	Type OriginType `yaml:"type,omitempty"`

	// Git is the resolved locator for a package on Git.
	Git *GitLock `yaml:"git,omitempty"`
}

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