client

Jan 17, 2025

Changes in this version

type CreateBuilderOptions

+ AppendImageNameSuffix bool

type PackageBuildpackOptions

+ AppendImageNameSuffix bool

Aug 5, 2024

Changes in this version

type BuildOptions

+ TrustExtraBuildpacks bool

Jul 17, 2024

Changes in this version

+ var RunningInContainer = func() bool

type DockerClient

+ NetworkCreate func(ctx context.Context, name string, options types.NetworkCreate) (types.NetworkCreateResponse, error)

+ NetworkRemove func(ctx context.Context, network string) error

May 24, 2024

Changes in this version

+ func ProcessDockerContext(logger logging.Logger) error

type BuildOptions

+ Platform string

type Client

+ func (c *Client) AddManifest(ctx context.Context, opts ManifestAddOptions) (err error)

+ func (c *Client) AnnotateManifest(ctx context.Context, opts ManifestAnnotateOptions) error

+ func (c *Client) CreateManifest(ctx context.Context, opts CreateManifestOptions) (err error)

+ func (c *Client) DeleteManifest(names []string) error

+ func (c *Client) InspectManifest(indexRepoName string) error

+ func (c *Client) PushManifest(opts PushManifestOptions) (err error)

+ func (c *Client) RemoveManifest(name string, images []string) error

type CreateBuilderOptions

+ Targets []dist.Target

+ type CreateManifestOptions struct

+ Format types.MediaType

+ IndexRepoName string

+ Insecure bool

+ Publish bool

+ RepoNames []string

type ImageFetcher

+ CheckReadAccess func(repo string, options image.FetchOptions) bool

+ type IndexFactory interface

+ CreateIndex func(repoName string, opts ...imgutil.IndexOption) (imgutil.ImageIndex, error)

+ Exists func(repoName string) bool

+ FetchIndex func(name string, opts ...imgutil.IndexOption) (imgutil.ImageIndex, error)

+ FindIndex func(name string, opts ...imgutil.IndexOption) (imgutil.ImageIndex, error)

+ LoadIndex func(reponame string, opts ...imgutil.IndexOption) (imgutil.ImageIndex, error)

+ type ManifestAddOptions struct

+ IndexRepoName string

+ RepoName string

+ type ManifestAnnotateOptions struct

+ Annotations map[string]string

+ IndexRepoName string

+ OS string

+ OSArch string

+ OSVariant string

+ RepoName string

type Option

+ func WithIndexFactory(f IndexFactory) Option

type PackageBuildpackOptions

+ Targets []dist.Target

+ type PushManifestOptions struct

+ Format types.MediaType

+ IndexRepoName string

+ Insecure bool

+ Purge bool

type RebaseOptions

+ PreviousImage string

Feb 14, 2024

Changes in this version

+ var IsTrustedBuilderFunc = func(b string) bool

type BuildOptions

+ MacAddress string

Jan 29, 2024

Changes in this version

+ type AccessChecker interface

+ Check func(repo string) bool

type BuildOptions

+ UserID int

type CreateBuilderOptions

+ Labels map[string]string

type Option

+ func WithAccessChecker(f AccessChecker) Option

Nov 2, 2023

Changes in this version

type CreateBuilderOptions

+ BuildConfigEnv map[string]string

type DockerClient

+ ServerVersion func(ctx context.Context) (types.Version, error)

type NewBuildpackOptions

+ Targets []dist.Target

Sep 19, 2023

Changes in this version

type PackageBuildpackOptions

+ Labels map[string]string

Aug 11, 2023

Changes in this version

type BuildOptions

+ Extensions []string

type BuilderInfo

+ RunImages []pubbldr.RunImageConfig

type Client

+ func (c *Client) PackageExtension(ctx context.Context, opts PackageBuildpackOptions) error

type CreateBuilderOptions

+ Depth int

+ Flatten bool

+ FlattenExclude []string

type DockerClient

+ ImageHistory func(ctx context.Context, image string) ([]image.HistoryResponseItem, error)

type ImageInfo

+ Rebasable bool

type PackageBuildpackOptions

+ Depth int

+ Flatten bool

+ FlattenExclude []string

type RebaseOptions

+ Force bool

Mar 10, 2023

Changes in this version

type BuildOptions

+ LayoutConfig *LayoutConfig

+ PostBuildpacks []string

+ PreBuildpacks []string

+ ReportDestinationDir string

+ func (b *BuildOptions) Layout() bool

type BuilderInfo

+ Extensions []dist.ModuleInfo

+ OrderExtensions pubbldr.DetectionOrder

type Client

+ func (c *Client) InspectExtension(opts InspectExtensionOptions) (*ExtensionInfo, error)

+ type DockerClient interface

+ ContainerAttach func(ctx context.Context, container string, options types.ContainerAttachOptions) (types.HijackedResponse, error)

+ ContainerCreate func(ctx context.Context, config *containertypes.Config, ...) (containertypes.ContainerCreateCreatedBody, error)

+ ContainerInspect func(ctx context.Context, container string) (types.ContainerJSON, error)

+ ContainerRemove func(ctx context.Context, container string, options types.ContainerRemoveOptions) error

+ ContainerStart func(ctx context.Context, container string, options types.ContainerStartOptions) error

+ ContainerWait func(ctx context.Context, container string, condition containertypes.WaitCondition) (<-chan containertypes.ContainerWaitOKBody, <-chan error)

+ CopyFromContainer func(ctx context.Context, container, srcPath string) (io.ReadCloser, types.ContainerPathStat, error)

+ CopyToContainer func(ctx context.Context, container, path string, content io.Reader, ...) error

+ ImageInspectWithRaw func(ctx context.Context, image string) (types.ImageInspect, []byte, error)

+ ImageLoad func(ctx context.Context, input io.Reader, quiet bool) (types.ImageLoadResponse, error)

+ ImagePull func(ctx context.Context, ref string, options types.ImagePullOptions) (io.ReadCloser, error)

+ ImageRemove func(ctx context.Context, image string, options types.ImageRemoveOptions) ([]types.ImageDeleteResponseItem, error)

+ ImageSave func(ctx context.Context, images []string) (io.ReadCloser, error)

+ ImageTag func(ctx context.Context, image, ref string) error

+ Info func(ctx context.Context) (types.Info, error)

+ VolumeRemove func(ctx context.Context, volumeID string, force bool) error

+ type ExtensionInfo struct

+ Extension dist.ModuleInfo

+ Location buildpack.LocatorType

type ImageInfo

+ Extensions []buildpack.GroupElement

+ type InputImageReference interface

+ FullName func() (string, error)

+ Layout func() bool

+ Name func() string

+ func ParseInputImageReference(input string) InputImageReference

+ type InspectExtensionOptions struct

+ Daemon bool

+ ExtensionName string

+ type LayoutConfig struct

+ InputImage InputImageReference

+ LayoutRepoDir string

+ PreviousInputImage InputImageReference

+ Sparse bool

+ func (l *LayoutConfig) Enable() bool

type RebaseOptions

+ ReportDestinationDir string

Dec 4, 2022

Changes in this version

type BuildOptions

+ Cache cache.CacheOpts

May 5, 2022

Changes in this version

type BuildOptions

+ CreationTime *time.Time

Feb 3, 2022

Changes in this version

+ const Local

+ const Remote

type BuildOptions

+ SBOMDestinationDir string

type Client

+ func (c *Client) DownloadSBOM(name string, options DownloadSBOMOptions) error

+ type DownloadSBOMOptions struct

+ Daemon bool

+ DestinationDir string

Nov 8, 2021

Changes in this version

+ const CNBExtension

+ const DockerAPIVersion

+ const FormatFile

+ const FormatImage

+ var IsSuggestedBuilderFunc = func(b string) bool

+ type BlobDownloader interface

+ Download func(ctx context.Context, pathOrURI string) (blob.Blob, error)

+ type BuildOptions struct

+ AdditionalMirrors map[string][]string

+ AdditionalTags []string

+ AppPath string

+ Builder string

+ Buildpacks []string

+ CacheImage string

+ ClearCache bool

+ ContainerConfig ContainerConfig

+ DefaultProcessType string

+ DockerHost string

+ Env map[string]string

+ GroupID int

+ Image string

+ Interactive bool

+ LifecycleImage string

+ PreviousImage string

+ ProjectDescriptor projectTypes.Descriptor

+ ProjectDescriptorBaseDir string

+ ProxyConfig *ProxyConfig

+ Publish bool

+ PullPolicy image.PullPolicy

+ Registry string

+ RelativeBaseDir string

+ RunImage string

+ TrustBuilder IsTrustedBuilder

+ Workspace string

+ type BuilderInfo struct

+ BuildpackLayers dist.BuildpackLayers

+ Buildpacks []dist.BuildpackInfo

+ CreatedBy builder.CreatorMetadata

+ Description string

+ Lifecycle builder.LifecycleDescriptor

+ Mixins []string

+ Order pubbldr.DetectionOrder

+ RunImage string

+ RunImageMirrors []string

+ Stack string

+ type BuilderInspectionConfig struct

+ OrderDetectionDepth int

+ type BuilderInspectionModifier func(config *BuilderInspectionConfig)

+ func WithDetectionOrderDepth(depth int) BuilderInspectionModifier

+ type BuildpackDownloader interface

+ Download func(ctx context.Context, buildpackURI string, opts buildpack.DownloadOptions) (buildpack.Buildpack, []buildpack.Buildpack, error)

+ type BuildpackInfo struct

+ BuildpackLayers dist.BuildpackLayers

+ BuildpackMetadata buildpack.Metadata

+ Buildpacks []dist.BuildpackInfo

+ Location buildpack.LocatorType

+ Order dist.Order

+ type BuildpackInfoKey struct

+ ID string

+ Version string

+ type Client struct

+ func NewClient(opts ...Option) (*Client, error)

+ func (c *Client) Build(ctx context.Context, opts BuildOptions) error

+ func (c *Client) CreateBuilder(ctx context.Context, opts CreateBuilderOptions) error

+ func (c *Client) InspectBuilder(name string, daemon bool, modifiers ...BuilderInspectionModifier) (*BuilderInfo, error)

+ func (c *Client) InspectBuildpack(opts InspectBuildpackOptions) (*BuildpackInfo, error)

+ func (c *Client) InspectImage(name string, daemon bool) (*ImageInfo, error)

+ func (c *Client) NewBuildpack(ctx context.Context, opts NewBuildpackOptions) error

+ func (c *Client) PackageBuildpack(ctx context.Context, opts PackageBuildpackOptions) error

+ func (c *Client) PullBuildpack(ctx context.Context, opts PullBuildpackOptions) error

+ func (c *Client) Rebase(ctx context.Context, opts RebaseOptions) error

+ func (c *Client) RegisterBuildpack(ctx context.Context, opts RegisterBuildpackOptions) error

+ func (c *Client) Version() string

+ func (c *Client) YankBuildpack(opts YankBuildpackOptions) error

+ type ContainerConfig struct

+ Network string

+ Volumes []string

+ type CreateBuilderOptions struct

+ BuilderName string

+ Config pubbldr.Config

+ Publish bool

+ PullPolicy image.PullPolicy

+ Registry string

+ RelativeBaseDir string

+ type ExperimentError struct

+ func NewExperimentError(msg string) ExperimentError

+ func (ee ExperimentError) Error() string

+ type ImageFactory interface

+ NewImage func(repoName string, local bool, imageOS string) (imgutil.Image, error)

+ type ImageFetcher interface

+ Fetch func(ctx context.Context, name string, options image.FetchOptions) (imgutil.Image, error)

+ type ImageInfo struct

+ BOM []buildpack.BOMEntry

+ Base platform.RunImageMetadata

+ Buildpacks []buildpack.GroupBuildpack

+ Processes ProcessDetails

+ Stack platform.StackMetadata

+ StackID string

+ type ImgWrapper struct

+ func (iw ImgWrapper) Label(name string) (string, error)

+ type InspectBuildpackOptions struct

+ BuildpackName string

+ Daemon bool

+ Registry string

+ type IsTrustedBuilder func(string) bool

+ type LifecycleExecutor interface

+ Execute func(ctx context.Context, opts build.LifecycleOptions) error

+ type NewBuildpackOptions struct

+ API string

+ ID string

+ Path string

+ Stacks []dist.Stack

+ Version string

+ type Option func(c *Client)

+ func WithBuildpackDownloader(d BuildpackDownloader) Option

+ func WithCacheDir(path string) Option

+ func WithDockerClient(docker dockerClient.CommonAPIClient) Option

+ func WithDownloader(d BlobDownloader) Option

+ func WithExperimental(experimental bool) Option

+ func WithFetcher(f ImageFetcher) Option

+ func WithImageFactory(f ImageFactory) Option

+ func WithKeychain(keychain authn.Keychain) Option

+ func WithLogger(l logging.Logger) Option

+ func WithRegistryMirrors(registryMirrors map[string]string) Option

+ type PackageBuildpackOptions struct

+ Config pubbldpkg.Config

+ Format string

+ Name string

+ Publish bool

+ PullPolicy image.PullPolicy

+ Registry string

+ RelativeBaseDir string

+ type ProcessDetails struct

+ DefaultProcess *launch.Process

+ OtherProcesses []launch.Process

+ type ProxyConfig struct

+ HTTPProxy string

+ HTTPSProxy string

+ NoProxy string

+ type PullBuildpackOptions struct

+ RegistryName string

+ RelativeBaseDir string

+ URI string

+ type RebaseOptions struct

+ AdditionalMirrors map[string][]string

+ Publish bool

+ PullPolicy image.PullPolicy

+ RepoName string

+ RunImage string

+ type RegisterBuildpackOptions struct

+ ImageName string

+ Name string

+ Type string

+ URL string

+ type SoftError struct

+ func NewSoftError() SoftError

+ func (se SoftError) Error() string

+ type YankBuildpackOptions struct

+ ID string

+ Type string

+ URL string

+ Version string

+ Yank bool