Documentation
¶
Overview ¶
A Pulumi package for building Docker images with Buildkit.
Index ¶
- func PkgVersion() (semver.Version, error)
- type BuildArg
- type BuildArgArgs
- type BuildArgArray
- type BuildArgArrayInput
- type BuildArgArrayOutput
- type BuildArgInput
- type BuildArgOutput
- type Image
- type ImageArgs
- type ImageInput
- type ImageOutput
- type ImageState
- type Provider
- type ProviderArgs
- type ProviderInput
- type ProviderOutput
- type Registry
- type RegistryArgs
- type RegistryInput
- type RegistryOutput
- func (RegistryOutput) ElementType() reflect.Type
- func (o RegistryOutput) Password() pulumi.StringPtrOutput
- func (o RegistryOutput) Server() pulumi.StringOutput
- func (o RegistryOutput) ToRegistryOutput() RegistryOutput
- func (o RegistryOutput) ToRegistryOutputWithContext(ctx context.Context) RegistryOutput
- func (o RegistryOutput) Username() pulumi.StringPtrOutput
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func PkgVersion ¶
PkgVersion uses reflection to determine the version of the current package.
Types ¶
type BuildArg ¶
type BuildArg struct { // The name of the Docker build argument. Name string `pulumi:"name"` // The value of the Docker build argument. Value string `pulumi:"value"` }
Describes a Docker build argument.
type BuildArgArgs ¶
type BuildArgArgs struct { // The name of the Docker build argument. Name pulumi.StringInput `pulumi:"name"` // The value of the Docker build argument. Value pulumi.StringInput `pulumi:"value"` }
Describes a Docker build argument.
func (BuildArgArgs) ElementType ¶
func (BuildArgArgs) ElementType() reflect.Type
func (BuildArgArgs) ToBuildArgOutput ¶
func (i BuildArgArgs) ToBuildArgOutput() BuildArgOutput
func (BuildArgArgs) ToBuildArgOutputWithContext ¶
func (i BuildArgArgs) ToBuildArgOutputWithContext(ctx context.Context) BuildArgOutput
type BuildArgArray ¶
type BuildArgArray []BuildArgInput
func (BuildArgArray) ElementType ¶
func (BuildArgArray) ElementType() reflect.Type
func (BuildArgArray) ToBuildArgArrayOutput ¶
func (i BuildArgArray) ToBuildArgArrayOutput() BuildArgArrayOutput
func (BuildArgArray) ToBuildArgArrayOutputWithContext ¶
func (i BuildArgArray) ToBuildArgArrayOutputWithContext(ctx context.Context) BuildArgArrayOutput
type BuildArgArrayInput ¶
type BuildArgArrayInput interface { pulumi.Input ToBuildArgArrayOutput() BuildArgArrayOutput ToBuildArgArrayOutputWithContext(context.Context) BuildArgArrayOutput }
BuildArgArrayInput is an input type that accepts BuildArgArray and BuildArgArrayOutput values. You can construct a concrete instance of `BuildArgArrayInput` via:
BuildArgArray{ BuildArgArgs{...} }
type BuildArgArrayOutput ¶
type BuildArgArrayOutput struct{ *pulumi.OutputState }
func (BuildArgArrayOutput) ElementType ¶
func (BuildArgArrayOutput) ElementType() reflect.Type
func (BuildArgArrayOutput) Index ¶
func (o BuildArgArrayOutput) Index(i pulumi.IntInput) BuildArgOutput
func (BuildArgArrayOutput) ToBuildArgArrayOutput ¶
func (o BuildArgArrayOutput) ToBuildArgArrayOutput() BuildArgArrayOutput
func (BuildArgArrayOutput) ToBuildArgArrayOutputWithContext ¶
func (o BuildArgArrayOutput) ToBuildArgArrayOutputWithContext(ctx context.Context) BuildArgArrayOutput
type BuildArgInput ¶
type BuildArgInput interface { pulumi.Input ToBuildArgOutput() BuildArgOutput ToBuildArgOutputWithContext(context.Context) BuildArgOutput }
BuildArgInput is an input type that accepts BuildArgArgs and BuildArgOutput values. You can construct a concrete instance of `BuildArgInput` via:
BuildArgArgs{...}
type BuildArgOutput ¶
type BuildArgOutput struct{ *pulumi.OutputState }
Describes a Docker build argument.
func (BuildArgOutput) ElementType ¶
func (BuildArgOutput) ElementType() reflect.Type
func (BuildArgOutput) Name ¶
func (o BuildArgOutput) Name() pulumi.StringOutput
The name of the Docker build argument.
func (BuildArgOutput) ToBuildArgOutput ¶
func (o BuildArgOutput) ToBuildArgOutput() BuildArgOutput
func (BuildArgOutput) ToBuildArgOutputWithContext ¶
func (o BuildArgOutput) ToBuildArgOutputWithContext(ctx context.Context) BuildArgOutput
func (BuildArgOutput) Value ¶
func (o BuildArgOutput) Value() pulumi.StringOutput
The value of the Docker build argument.
type Image ¶
type Image struct { pulumi.CustomResourceState // The path to the build context to use. Context pulumi.StringOutput `pulumi:"context"` // The digest of the build context. ContextDigest pulumi.StringOutput `pulumi:"contextDigest"` // The path to the Dockerfile to use. Dockerfile pulumi.StringOutput `pulumi:"dockerfile"` // The name of the image. Name pulumi.StringOutput `pulumi:"name"` // The platforms to build for. Platforms pulumi.StringArrayOutput `pulumi:"platforms"` // The URL of the registry server hosting the image. RegistryServer pulumi.StringOutput `pulumi:"registryServer"` // The digest of the image manifest in the registry. RepoDigest pulumi.StringOutput `pulumi:"repoDigest"` // The name of the target stage to build in the Dockerfile. Target pulumi.StringOutput `pulumi:"target"` }
Builds a Docker image using Buildkit and pushes it to a registry.
func GetImage ¶
func GetImage(ctx *pulumi.Context, name string, id pulumi.IDInput, state *ImageState, opts ...pulumi.ResourceOption) (*Image, error)
GetImage gets an existing Image resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewImage ¶
func NewImage(ctx *pulumi.Context, name string, args *ImageArgs, opts ...pulumi.ResourceOption) (*Image, error)
NewImage registers a new resource with the given unique name, arguments, and options.
func (*Image) ElementType ¶
func (*Image) ToImageOutput ¶
func (i *Image) ToImageOutput() ImageOutput
func (*Image) ToImageOutputWithContext ¶
func (i *Image) ToImageOutputWithContext(ctx context.Context) ImageOutput
type ImageArgs ¶
type ImageArgs struct { // The build arguments. Args BuildArgArrayInput // The path to the build context to use. Context pulumi.StringPtrInput // The path to the Dockerfile to use. Dockerfile pulumi.StringPtrInput // The name of the image. Name pulumi.StringInput // The platforms to build for. Platforms pulumi.StringArrayInput // The registry to push the image to. Registry RegistryInput // The name of the target stage to build in the Dockerfile. Target pulumi.StringPtrInput }
The set of arguments for constructing a Image resource.
func (ImageArgs) ElementType ¶
type ImageInput ¶
type ImageInput interface { pulumi.Input ToImageOutput() ImageOutput ToImageOutputWithContext(ctx context.Context) ImageOutput }
type ImageOutput ¶
type ImageOutput struct{ *pulumi.OutputState }
func (ImageOutput) ElementType ¶
func (ImageOutput) ElementType() reflect.Type
func (ImageOutput) ToImageOutput ¶
func (o ImageOutput) ToImageOutput() ImageOutput
func (ImageOutput) ToImageOutputWithContext ¶
func (o ImageOutput) ToImageOutputWithContext(ctx context.Context) ImageOutput
type ImageState ¶
type ImageState struct { }
func (ImageState) ElementType ¶
func (ImageState) ElementType() reflect.Type
type Provider ¶
type Provider struct {
pulumi.ProviderResourceState
}
func NewProvider ¶
func NewProvider(ctx *pulumi.Context, name string, args *ProviderArgs, opts ...pulumi.ResourceOption) (*Provider, error)
NewProvider registers a new resource with the given unique name, arguments, and options.
func (*Provider) ElementType ¶
func (*Provider) ToProviderOutput ¶
func (i *Provider) ToProviderOutput() ProviderOutput
func (*Provider) ToProviderOutputWithContext ¶
func (i *Provider) ToProviderOutputWithContext(ctx context.Context) ProviderOutput
type ProviderArgs ¶
type ProviderArgs struct { }
The set of arguments for constructing a Provider resource.
func (ProviderArgs) ElementType ¶
func (ProviderArgs) ElementType() reflect.Type
type ProviderInput ¶
type ProviderInput interface { pulumi.Input ToProviderOutput() ProviderOutput ToProviderOutputWithContext(ctx context.Context) ProviderOutput }
type ProviderOutput ¶
type ProviderOutput struct{ *pulumi.OutputState }
func (ProviderOutput) ElementType ¶
func (ProviderOutput) ElementType() reflect.Type
func (ProviderOutput) ToProviderOutput ¶
func (o ProviderOutput) ToProviderOutput() ProviderOutput
func (ProviderOutput) ToProviderOutputWithContext ¶
func (o ProviderOutput) ToProviderOutputWithContext(ctx context.Context) ProviderOutput
type Registry ¶
type Registry struct { // The password to authenticate with. Password *string `pulumi:"password"` // The URL of the Docker registry server. Server string `pulumi:"server"` // The username to authenticate with. Username *string `pulumi:"username"` }
Describes a Docker container registry.
type RegistryArgs ¶
type RegistryArgs struct { // The password to authenticate with. Password pulumi.StringPtrInput `pulumi:"password"` // The URL of the Docker registry server. Server pulumi.StringInput `pulumi:"server"` // The username to authenticate with. Username pulumi.StringPtrInput `pulumi:"username"` }
Describes a Docker container registry.
func (RegistryArgs) ElementType ¶
func (RegistryArgs) ElementType() reflect.Type
func (RegistryArgs) ToRegistryOutput ¶
func (i RegistryArgs) ToRegistryOutput() RegistryOutput
func (RegistryArgs) ToRegistryOutputWithContext ¶
func (i RegistryArgs) ToRegistryOutputWithContext(ctx context.Context) RegistryOutput
type RegistryInput ¶
type RegistryInput interface { pulumi.Input ToRegistryOutput() RegistryOutput ToRegistryOutputWithContext(context.Context) RegistryOutput }
RegistryInput is an input type that accepts RegistryArgs and RegistryOutput values. You can construct a concrete instance of `RegistryInput` via:
RegistryArgs{...}
type RegistryOutput ¶
type RegistryOutput struct{ *pulumi.OutputState }
Describes a Docker container registry.
func (RegistryOutput) ElementType ¶
func (RegistryOutput) ElementType() reflect.Type
func (RegistryOutput) Password ¶
func (o RegistryOutput) Password() pulumi.StringPtrOutput
The password to authenticate with.
func (RegistryOutput) Server ¶
func (o RegistryOutput) Server() pulumi.StringOutput
The URL of the Docker registry server.
func (RegistryOutput) ToRegistryOutput ¶
func (o RegistryOutput) ToRegistryOutput() RegistryOutput
func (RegistryOutput) ToRegistryOutputWithContext ¶
func (o RegistryOutput) ToRegistryOutputWithContext(ctx context.Context) RegistryOutput
func (RegistryOutput) Username ¶
func (o RegistryOutput) Username() pulumi.StringPtrOutput
The username to authenticate with.