functions

package

Go to main page

Versions in this module

v0

v0.46.1

Aug 21, 2025

v0.46.0

Jul 24, 2025

Changes in this version

+ const DefaultInvokeRequestType

type BuildSpec

+ BaseImage string

type Instance

+ Labels map[string]string

type InvokeMessage

+ RequestType string

type RunOption

+ func RunWithAddress(address string) RunOption

type RunOptions

+ Address string

v0.45.1

Apr 30, 2025

v0.45.0

Apr 24, 2025

Changes in this version

type BuildSpec

+ Mounts []MountSpec

+ RemoteStorageClass string

+ type MountSpec struct

+ Destination string

+ Source string

v0.44.0

Jan 23, 2025

v0.43.2

Mar 3, 2025

v0.43.1

Nov 5, 2024

v0.43.0

Oct 23, 2024

v0.42.2

Nov 5, 2024

v0.42.1

Sep 5, 2024

v0.42.0

Jul 24, 2024

Changes in this version

+ type DeployOptions struct

v0.41.0

May 2, 2024

Changes in this version

+ const BuiltHash

+ const BuiltImage

+ var ErrFunctionNotFound = errors.New("function not found")

+ var ErrNamespaceRequired = errors.New("namespace required")

type BuildSpec

+ Image string

type DeploySpec

+ Image string

type Function

+ Namespace string

+ func (f Function) ImageNameWithDigest(newDigest string) string

+ func (f Function) WriteRuntimeBuiltImage(verbose bool) error

+ type PushPasswordKey struct

+ type PushTokenKey struct

+ type PushUsernameKey struct

v0.40.1

Mar 13, 2024

v0.40.0

Jan 24, 2024

Changes in this version

+ const RunDataLocalFile

type DeploySpec

+ Subscriptions []KnativeSubscription

type Function

+ Local Local

+ type KnativeSubscription struct

+ Filters map[string]string

+ Source string

+ type Local struct

+ Remote bool

type Volume

+ PersistentVolumeClaim *PersistentVolumeClaim

v0.39.2

Mar 13, 2024

v0.39.1

Jan 24, 2024

v0.39.0

Oct 25, 2023

v0.38.3

Oct 23, 2023

v0.38.2

Oct 12, 2023

v0.38.1

Oct 2, 2023

v0.38.0

Jul 20, 2023

Changes in this version

+ const DefaultStartTimeout

+ const StorageMediumDefault

+ const StorageMediumMemory

+ var DefaultPlatforms = []Platform

+ var ErrContextCanceled = errors.New("the operation was canceled")

+ func Fingerprint(root string) (hash, log string, err error)

+ func NewErrNotInitialized(path string) error

+ func WithStampJournal() stampOption

+ type BuildOption func(c *BuildOptions)

+ func BuildWithPlatforms(pp []Platform) BuildOption

+ type BuildOptions struct

+ Platforms []Platform

type Client

+ func (c *Client) Scaffold(ctx context.Context, f Function, dest string) (err error)

+ type EmptyDir struct

+ Medium string

+ SizeLimit *string

+ type Envs []Env

+ func (ee Envs) Slice() []string

+ func (ee Envs) String() string

type ErrNotInitialized

+ Path string

+ func (e ErrNotInitialized) Error() string

+ type ErrRunTimeout struct

+ Timeout time.Duration

+ func (e ErrRunTimeout) Error() string

+ type ErrRunnerNotImplemented struct

+ Runtime string

+ func (e ErrRunnerNotImplemented) Error() string

+ type ErrRuntimeNotRecognized struct

+ Runtime string

+ func (e ErrRuntimeNotRecognized) Error() string

type Function

+ Domain string

+ func (f Function) Stamp(oo ...stampOption) (err error)

type Job

+ Host string

+ func (j *Job) Dir() string

type Option

+ func WithStartTimeout(t time.Duration) Option

+ type PersistentVolumeClaim struct

+ ClaimName *string

+ ReadOnly bool

+ type Platform struct

+ Architecture string

+ OS string

+ Variant string

type Repository

+ func (r Repository) FS() filesystem.Filesystem

+ type RunOption func(c *RunOptions)

+ func RunWithStartTimeout(t time.Duration) RunOption

+ type RunOptions struct

+ StartTimeout time.Duration

type RunSpec

+ StartTimeout time.Duration

type Volume

+ EmptyDir *EmptyDir

+ PresistentVolumeClaim *PersistentVolumeClaim

v0.37.2

Oct 12, 2023

v0.37.1

Jul 7, 2023

Changes in this version

type DeploySpec

+ ServiceAccountName string

v0.37.0

Apr 26, 2023

Changes in this version

+ const DefaultInvocationFormat

+ const DefaultInvokeContentType

+ const DefaultInvokeData

+ const DefaultInvokeFormat

+ const DefaultInvokeSource

+ const DefaultInvokeType

+ const DefaultLivenessEndpoint

+ const DefaultPersistentVolumeClaimSize

+ const DefaultReadinessEndpoint

+ const DefaultRegistry

+ const DefaultRepositoryName

+ const DefaultTemplate

+ const DefaultTemplatesPath

+ const EnvironmentLocal

+ const EnvironmentRemote

+ const FunctionFile

+ const RunDataDir

+ var EmbeddedTemplatesFS filesystem.Filesystem = newEmbeddedTemplatesFS()

+ var ErrEnvironmentNotFound = errors.New("environment not found")

+ var ErrMismatchedName = errors.New("name passed does not match name of the function at root")

+ var ErrNameRequired = errors.New("name required")

+ var ErrNotBuilt = errors.New("not built")

+ var ErrNotInitialized = errors.New("function is not initialized")

+ var ErrNotRunning = errors.New("function not running")

+ var ErrRegistryRequired = errors.New(...)

+ var ErrRepositoriesNotDefined = errors.New("custom template repositories location not specified")

+ var ErrRepositoryNotFound = errors.New("repository not found")

+ var ErrRootRequired = errors.New("function root path is required")

+ var ErrRuntimeNotFound = errors.New("language runtime not found")

+ var ErrRuntimeRequired = errors.New("language runtime required")

+ var ErrTemplateMissingRepository = errors.New("template name missing repository prefix")

+ var ErrTemplateNotFound = errors.New("template not found")

+ var ErrTemplatesNotFound = errors.New("templates path (runtimes) not found")

+ func FilesystemFromRepo(uri string) (filesystem.Filesystem, error)

+ func Interpolate(ee []Env) (map[string]string, error)

+ func LastSpecVersion() string

+ func RepositoriesPath() string

+ func ValidateBuildEnvs(envs []Env) (errors []string)

+ func ValidateEnvs(envs []Env) (errors []string)

+ func ValidateLabels(labels []Label) (errors []string)

+ type BuildConfig struct

+ BuilderImages map[string]string

+ Buildpacks []string

+ type BuildSpec struct

+ BuildEnvs []Env

+ Builder string

+ BuilderImages map[string]string

+ Buildpacks []string

+ Git Git

+ PVCSize string

+ type Builder interface

+ Build func(context.Context, Function) error

+ type Client struct

+ func New(options ...Option) *Client

+ func (c *Client) Apply(ctx context.Context, f Function) (string, Function, error)

+ func (c *Client) Build(ctx context.Context, f Function) (Function, error)

+ func (c *Client) ConfigurePAC(ctx context.Context, f Function, metadata any) error

+ func (c *Client) Deploy(ctx context.Context, f Function, opts ...DeployOption) (Function, error)

+ func (c *Client) Describe(ctx context.Context, name string, f Function) (d Instance, err error)

+ func (c *Client) Init(cfg Function) (Function, error)

+ func (c *Client) Instances() *InstanceRefs

+ func (c *Client) Invoke(ctx context.Context, root string, target string, m InvokeMessage) (metadata map[string][]string, body string, err error)

+ func (c *Client) List(ctx context.Context) ([]ListItem, error)

+ func (c *Client) New(ctx context.Context, cfg Function) (string, Function, error)

+ func (c *Client) Push(ctx context.Context, f Function) (Function, error)

+ func (c *Client) Registry() string

+ func (c *Client) Remove(ctx context.Context, cfg Function, deleteAll bool) error

+ func (c *Client) RemovePAC(ctx context.Context, f Function, metadata any) error

+ func (c *Client) Repositories() *Repositories

+ func (c *Client) RepositoriesPath() (path string)

+ func (c *Client) Route(ctx context.Context, f Function) (string, Function, error)

+ func (c *Client) Run(ctx context.Context, f Function) (job *Job, err error)

+ func (c *Client) RunPipeline(ctx context.Context, f Function) (Function, error)

+ func (c *Client) Runtimes() ([]string, error)

+ func (c *Client) Templates() *Templates

+ func (c *Client) Update(ctx context.Context, f Function) (string, Function, error)

+ type DNSProvider interface

+ Provide func(Function) error

+ type DeployOption func(f *DeployParams)

+ func WithDeploySkipBuildCheck(skipBuiltCheck bool) DeployOption

+ type DeployParams struct

+ type DeploySpec struct

+ Annotations map[string]string

+ HealthEndpoints HealthEndpoints

+ Labels []Label

+ Namespace string

+ Options Options

+ Remote bool

+ type Deployer interface

+ Deploy func(context.Context, Function) (DeploymentResult, error)

+ type DeploymentResult struct

+ Namespace string

+ Status Status

+ URL string

+ type Describer interface

+ Describe func(ctx context.Context, name string) (Instance, error)

+ type Env struct

+ Name *string

+ Value *string

+ func (e Env) KeyValuePair() string

+ func (e Env) String() string

+ type Function struct

+ Build BuildSpec

+ BuildStamp string

+ Created time.Time

+ Deploy DeploySpec

+ Image string

+ ImageDigest string

+ Invoke string

+ Name string

+ NeedsWriteBuildStamp bool

+ Registry string

+ Root string

+ Run RunSpec

+ Runtime string

+ SpecVersion string

+ Template string

+ func NewFunction(path string) (f Function, err error)

+ func NewFunctionWith(defaults Function) Function

+ func (f Function) Built() bool

+ func (f Function) ImageName() (image string, err error)

+ func (f Function) ImageWithDigest() string

+ func (f Function) Initialized() bool

+ func (f Function) LabelsMap() (map[string]string, error)

+ func (f Function) Migrate() (migrated Function, err error)

+ func (f Function) Migrated() bool

+ func (f Function) Validate() error

+ func (f Function) Write() (err error)

+ type Git struct

+ ContextDir string

+ Revision string

+ URL string

+ type HealthEndpoints struct

+ Liveness string

+ Readiness string

+ type Instance struct

+ Image string

+ Name string

+ Namespace string

+ Route string

+ Routes []string

+ Subscriptions []Subscription

+ type InstanceRefs struct

+ func (s *InstanceRefs) Get(ctx context.Context, f Function, environment string) (Instance, error)

+ func (s *InstanceRefs) Local(ctx context.Context, f Function) (Instance, error)

+ func (s *InstanceRefs) Remote(ctx context.Context, name, root string) (Instance, error)

+ type InvokeMessage struct

+ ContentType string

+ Data string

+ Format string

+ ID string

+ Source string

+ Type string

+ func NewInvokeMessage() InvokeMessage

+ type Job struct

+ Errors chan error

+ Function Function

+ Port string

+ func NewJob(f Function, port string, errs chan error, onStop func()) (*Job, error)

+ func (j *Job) Stop()

+ type Label struct

+ Key *string

+ Value *string

+ func (l Label) String() string

+ type ListItem struct

+ Name string

+ Namespace string

+ Ready string

+ Runtime string

+ URL string

+ type Lister interface

+ List func(ctx context.Context) ([]ListItem, error)

+ type NoopProgressListener struct

+ func (p *NoopProgressListener) Complete(m string)

+ func (p *NoopProgressListener) Done()

+ func (p *NoopProgressListener) Increment(m string)

+ func (p *NoopProgressListener) SetTotal(i int)

+ func (p *NoopProgressListener) Stopping()

+ type Option func(*Client)

+ func WithBuilder(d Builder) Option

+ func WithDNSProvider(provider DNSProvider) Option

+ func WithDeployer(d Deployer) Option

+ func WithDescriber(describer Describer) Option

+ func WithLister(l Lister) Option

+ func WithPipelinesProvider(pp PipelinesProvider) Option

+ func WithProgressListener(p ProgressListener) Option

+ func WithPusher(d Pusher) Option

+ func WithRegistry(registry string) Option

+ func WithRemover(r Remover) Option

+ func WithRepositoriesPath(path string) Option

+ func WithRepository(uri string) Option

+ func WithRunner(r Runner) Option

+ func WithTransport(t http.RoundTripper) Option

+ func WithVerbose(v bool) Option

+ type Options struct

+ Resources *ResourcesOptions

+ Scale *ScaleOptions

+ type PipelinesProvider interface

+ ConfigurePAC func(context.Context, Function, any) error

+ Remove func(context.Context, Function) error

+ RemovePAC func(context.Context, Function, any) error

+ Run func(context.Context, Function) error

+ type ProgressListener interface

+ Complete func(message string)

+ Done func()

+ Increment func(message string)

+ SetTotal func(int)

+ Stopping func()

+ type Pusher interface

+ Push func(ctx context.Context, f Function) (string, error)

+ type Remover interface

+ Remove func(ctx context.Context, name string) error

+ type Repositories struct

+ func (r *Repositories) Add(name, uri string) (string, error)

+ func (r *Repositories) All() (repos []Repository, err error)

+ func (r *Repositories) Get(name string) (repo Repository, err error)

+ func (r *Repositories) List() ([]string, error)

+ func (r *Repositories) Path() string

+ func (r *Repositories) Remove(name string) error

+ func (r *Repositories) Rename(from, to string) error

+ type Repository struct

+ Name string

+ Runtimes []Runtime

+ func NewRepository(name, uri string) (r Repository, err error)

+ func (r *Repository) Runtime(name string) (runtime Runtime, err error)

+ func (r *Repository) Template(runtimeName, name string) (t Template, err error)

+ func (r *Repository) Templates(runtimeName string) ([]Template, error)

+ func (r *Repository) URL() string

+ func (r *Repository) Write(dest string) (err error)

+ type ResourcesLimitsOptions struct

+ CPU *string

+ Concurrency *int64

+ Memory *string

+ type ResourcesOptions struct

+ Limits *ResourcesLimitsOptions

+ Requests *ResourcesRequestsOptions

+ type ResourcesRequestsOptions struct

+ CPU *string

+ Memory *string

+ type RunSpec struct

+ Envs []Env

+ Volumes []Volume

+ type Runner interface

+ Run func(context.Context, Function) (*Job, error)

+ type Runtime struct

+ Name string

+ Templates []Template

+ type ScaleOptions struct

+ Max *int64

+ Metric *string

+ Min *int64

+ Target *float64

+ Utilization *float64

+ type Status int

+ const Deployed

+ const Failed

+ const Updated

+ type Subscription struct

+ Broker string

+ Source string

+ Type string

+ type Template interface

+ Fullname func() string

+ Name func() string

+ Repository func() string

+ Runtime func() string

+ Write func(ctx context.Context, f *Function) error

+ type Templates struct

+ func (t *Templates) Get(runtime, fullname string) (Template, error)

+ func (t *Templates) List(runtime string) ([]string, error)

+ func (t *Templates) Write(f *Function) error

+ type Volume struct

+ ConfigMap *string

+ Path *string

+ Secret *string

+ func (v Volume) String() string

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