API Reference

Packages

Package v1alpha1 contains API Schema definitions for the v1alpha1 API group

Image is the Schema for the images API.

Appears in: - ImageList

Field	Description	Default	Validation
`apiVersion` string	`image-builder.anza-labs.dev/v1alpha1`
`kind` string	`Image`
`kind` string	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
`apiVersion` string	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`metadata` ObjectMeta	Refer to Kubernetes API documentation for fields of `metadata`.
`spec` ImageSpec
`status` ImageStatus

ImageList contains a list of Image.

Field	Description	Default	Validation
`apiVersion` string	`image-builder.anza-labs.dev/v1alpha1`
`kind` string	`ImageList`
`kind` string	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
`apiVersion` string	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`metadata` ListMeta	Refer to Kubernetes API documentation for fields of `metadata`.
`items` Image array

ImageSpec defines the desired state of Image.

Appears in: - Image

Field	Description	Default	Validation
`builderImage` string	BuilderImage indicates the container image to use for the Builder job.
`builderVerbosity` integer	BuilderVerbosity specifies log verbosity of the builder.	4	Maximum: 10 Minimum: 0
`resources` ResourceRequirements	Resources describe the compute resource requirements.
`affinity` Affinity	Affinity specifies the scheduling constraints for Pods.
`format` string	Format specifies the image format.		Enum: [aws docker dynamic-vhd gcp iso-bios iso-efi iso-efi-initrd kernel+initrd kernel+iso kernel+squashfs qcow2-bios qcow2-efi raw-bios raw-efi rpi3 tar tar-kernel-initrd vhd vmdk]
`configuration` string	Configuration is a YAML formatted Linuxkit config.
`result` LocalObjectReference	Result is a local reference that lists downloadable objects, that are results of the image building. Defaults to the Image.Metadata.Name.
`bucketCredentials` LocalObjectReference	BucketCredentials is a reference to the credentials for S3, where the image will be stored.

ImageStatus defines the observed state of Image.

Appears in: - Image

Field	Description	Default	Validation
`ready` boolean	Ready indicates whether the image is ready.