Documentation
¶
Overview ¶
Code generated by gengo:runtimedoc DO NOT EDIT.
Index ¶
- Variables
- func MergeMap[K comparable, V any](a map[K]V, b map[K]V) map[K]V
- func NewNamespace(ctx context.Context, registryAuthStore RegistryAuthStore, o NamespaceOptions) (content.Namespace, error)
- func Secret(ctx context.Context, c *dagger.Client, s *client.Secret) (*dagger.Secret, bool)
- type Auth
- type Build
- type CacheDir
- type Config
- type Container
- func (container *Container) Container(ctx context.Context, c *dagger.Client) (*dagger.Container, error)
- func (v *Container) RuntimeDoc(names ...string) ([]string, bool)
- func (container *Container) Scope() piperdagger.Scope
- func (container *Container) Select(ctx context.Context) piperdagger.Engine
- func (container *Container) Sync(ctx context.Context, c *dagger.Container, platform string) error
- type Copy
- type Diff
- type Dir
- type Dump
- type DumpOption
- type Exec
- type Export
- type Fs
- func (fs *Fs) Directory(ctx context.Context, c *dagger.Client) (*dagger.Directory, error)
- func (fs *Fs) DirectoryID() dagger.DirectoryID
- func (v *Fs) RuntimeDoc(names ...string) ([]string, bool)
- func (fs *Fs) Scope() piperdagger.Scope
- func (fs *Fs) Select(ctx context.Context) piperdagger.Engine
- func (fs *Fs) Sync(ctx context.Context, c *dagger.Directory) error
- func (fs *Fs) SyncLazyDirectory(ctx context.Context, inputs any, do LazyDoFn) error
- type HTTPFetch
- type ImageConfig
- type LazyDoFn
- type Merge
- type Mkdir
- type Mount
- type MountCacheDir
- type MountFile
- type MountFs
- type MountSecret
- type MountTemp
- type Mounter
- type NamespaceOptions
- type Pull
- type Push
- type ReadFile
- type RegistryAuth
- type RegistryAuthStore
- type Rm
- type RootfsDo
- type RootfsDoStepInterface
- type Run
- type Set
- type Source
- type SourceFile
- type StepInterface
- type Stretch
- type Sub
- type TempDir
- type WriteFile
Constants ¶
This section is empty.
Variables ¶
View Source
var RegistryAuthStoreContext = contextx.New[RegistryAuthStore]( contextx.WithDefaultsFunc(func() RegistryAuthStore { return defaultRegistryStore }), )
Functions ¶
func MergeMap ¶
func MergeMap[K comparable, V any](a map[K]V, b map[K]V) map[K]V
func NewNamespace ¶
func NewNamespace(ctx context.Context, registryAuthStore RegistryAuthStore, o NamespaceOptions) (content.Namespace, error)
Types ¶
type Auth ¶
type Auth struct {
Server string `json:"server,omitzero"`
Username string `json:"username"`
Secret client.Secret `json:"secret"`
}
type Build ¶
type Build struct {
task.Group
Steps []StepInterface `json:"steps"`
Output Container `json:"-" output:"output"`
}
Build docker build step
type Container ¶
type Container struct {
Ref struct {
ID string `json:"id"`
} `json:"$$container"`
Rootfs Fs `json:"rootfs"`
Platform string `json:"platform"`
}
func (*Container) Scope ¶
func (container *Container) Scope() piperdagger.Scope
type Copy ¶
type Copy struct {
task.Task
Input Container `json:"input"`
Contents Fs `json:"contents"`
Source string `json:"source" default:"/"`
Include []string `json:"include,omitzero"`
Exclude []string `json:"exclude,omitzero"`
Dest string `json:"dest" default:"/"`
Output Container `json:"-" output:"output"`
}
type Diff ¶
type Dir ¶
type Dump ¶
type DumpOption ¶
type DumpOption struct {
Empty bool `json:"empty,omitzero"`
}
func (*DumpOption) RuntimeDoc ¶
func (v *DumpOption) RuntimeDoc(names ...string) ([]string, bool)
type Exec ¶
type Exec struct {
task.Task
Input Container `json:"input"`
Args []string `json:"args"`
Mounts map[string]Mount `json:"mounts,omitzero"`
Env map[string]client.SecretOrString `json:"env,omitzero"`
Workdir string `json:"workdir,omitzero" default:"/"`
Entrypoint []string `json:"entrypoint,omitzero"`
User string `json:"user,omitzero" default:"root:root"`
Always bool `json:"always,omitzero"`
Output Container `json:"-" output:"output"`
}
type Export ¶
type Fs ¶
type Fs struct {
Ref struct {
ID string `json:"id"`
} `json:"$$fs"`
}
func (*Fs) DirectoryID ¶
func (fs *Fs) DirectoryID() dagger.DirectoryID
func (*Fs) Scope ¶
func (fs *Fs) Scope() piperdagger.Scope
type HTTPFetch ¶
type ImageConfig ¶
type ImageConfig piperdagger.ImageConfig
func (ImageConfig) Merge ¶
func (p ImageConfig) Merge(config ImageConfig) ImageConfig
func (*ImageConfig) RuntimeDoc ¶
func (v *ImageConfig) RuntimeDoc(names ...string) ([]string, bool)
type Mkdir ¶
type Mount ¶
type Mount struct {
Mounter `json:"-"`
}
func (Mount) MarshalJSON ¶
func (*Mount) UnmarshalJSON ¶
type MountCacheDir ¶
type MountCacheDir struct {
Type string `json:"type" enum:"cache"`
Dest string `json:"dest"`
Contents CacheDir `json:"contents"`
}
func (MountCacheDir) MountType ¶
func (MountCacheDir) MountType() string
func (*MountCacheDir) RuntimeDoc ¶
func (v *MountCacheDir) RuntimeDoc(names ...string) ([]string, bool)
type MountFile ¶
type MountFile struct {
Type string `json:"type" enum:"file"`
Dest string `json:"dest"`
Contents string `json:"contents"`
Permissions int `json:"mask" default:"0o644"`
}
type MountFs ¶
type MountFs struct {
Type string `json:"type" enum:"fs"`
Contents Fs `json:"contents"`
Dest string `json:"dest"`
Source *string `json:"source,omitzero"`
}
type MountSecret ¶
type MountSecret struct {
Type string `json:"type" enum:"secret"`
Dest string `json:"dest"`
Contents client.Secret `json:"contents"`
}
func (MountSecret) MountType ¶
func (MountSecret) MountType() string
func (*MountSecret) RuntimeDoc ¶
func (v *MountSecret) RuntimeDoc(names ...string) ([]string, bool)
type MountTemp ¶
type MountTemp struct {
Type string `json:"type" enum:"tmp"`
Dest string `json:"dest"`
Contents TempDir `json:"contents"`
}
type NamespaceOptions ¶
func (*NamespaceOptions) RuntimeDoc ¶
func (v *NamespaceOptions) RuntimeDoc(names ...string) ([]string, bool)
type Pull ¶
type Pull struct {
task.Task
// image from
Source string `json:"source"`
// image platform
Platform string `json:"platform,omitzero" output:"platform"`
// registry auth
Auth *Auth `json:"auth,omitzero"`
// image
Output Container `json:"-" output:"output"`
}
Pull image from
type Push ¶
type Push struct {
task.Task
// image tag
Dest string `json:"dest"`
// images for push
// [Platform]: _
Images map[string]Container `json:"images"`
// annotations
Annotations map[string]string `json:"annotations,omitzero"`
// registry auth
Auth *Auth `json:"auth,omitzero"`
// image pushed result
Result string `json:"-" output:"result"`
}
Push image to registry
type ReadFile ¶
type RegistryAuth ¶
type RegistryAuth struct {
Host string
remote.RegistryHost
}
func (*RegistryAuth) RuntimeDoc ¶
func (v *RegistryAuth) RuntimeDoc(names ...string) ([]string, bool)
type RegistryAuthStore ¶
type RegistryAuthStore interface {
Store(address string, auth *Auth)
RegistryAuths(ctx context.Context) iter.Seq[RegistryAuth]
ApplyTo(ctx context.Context, c *dagger.Client, container *dagger.Container, address string, localAuths ...*Auth) *dagger.Container
}
func NewRegistryAuthStore ¶
func NewRegistryAuthStore() RegistryAuthStore
type Rm ¶
type RootfsDo ¶
type RootfsDo struct {
task.Group
Input Container `json:"input"`
Steps []RootfsDoStepInterface `json:"steps"`
Output Container `json:"-" output:"output"`
}
FsDo docker build but with rootfs
type RootfsDoStepInterface ¶
func (*RootfsDoStepInterface) RuntimeDoc ¶
func (v *RootfsDoStepInterface) RuntimeDoc(names ...string) ([]string, bool)
type Run ¶
type Run struct {
task.Task
Input Container `json:"input"`
Mounts map[string]Mount `json:"mounts,omitzero"`
Env map[string]client.SecretOrString `json:"env,omitzero"`
Workdir string `json:"workdir,omitzero" default:"/"`
User string `json:"user,omitzero" default:"root:root"`
Always bool `json:"always,omitzero"`
Shell string `json:"shell,omitzero" default:"sh"`
Run client.StringOrSlice `json:"run"`
Output Container `json:"-" output:"output"`
}
type Set ¶
type Set struct {
task.Task
Input Container `json:"input"`
Config ImageConfig `json:"config"`
Output Container `json:"-" output:"output"`
}
type Source ¶
type SourceFile ¶
type SourceFile struct {
task.Task
File file.File `json:"file"`
Dest string `json:"dest,omitzero"`
Output Fs `json:"-" output:"output"`
}
func (*SourceFile) RuntimeDoc ¶
func (v *SourceFile) RuntimeDoc(names ...string) ([]string, bool)
type StepInterface ¶
type StepInterface struct {
Input Container `json:"input,omitzero"`
Output Container `json:"output"`
}
func (*StepInterface) RuntimeDoc ¶
func (v *StepInterface) RuntimeDoc(names ...string) ([]string, bool)
type Stretch ¶
type Stretch struct {
task.Task
// image platform
Platform string `json:"platform,omitzero" output:"platform"`
// image
Output Container `json:"-" output:"output"`
}
Stretch image from stretch
type Sub ¶
Source Files
¶
- auth.go
- container.go
- container__build.go
- container__copy.go
- container__dir.go
- container__exec.go
- container__export.go
- container__pull.go
- container__push.go
- container__rootfs_do.go
- container__run.go
- container__set.go
- container__stretch.go
- fs.go
- fs__diff.go
- fs__dump.go
- fs__http_fetch.go
- fs__merge.go
- fs__mkdir.go
- fs__read_file.go
- fs__rm.go
- fs__source.go
- fs__source_file.go
- fs__sub.go
- fs__write_file.go
- image.go
- mount.go
- registry.go
- registry_config.go
- zz_generated.runtimedoc.go
Click to show internal directories.
Click to hide internal directories.