API Reference
Packages
- image-builder.anza-labs.dev/v1alpha1
- image-builder.anza-labs.dev/v1alpha2
- image-builder.anza-labs.dev/v1beta1
image-builder.anza-labs.dev/v1alpha1
Package v1alpha1 contains API Schema definitions for the v1alpha1 API group
Deprecated: Due to breaking changes, v1alpha2 is a new default, and this version will be removed in upcoming releases.
Resource Types
Image
Image is the Schema for the images API.
Deprecated: Due to breaking changes, v1alpha2 is a new default, and this version will be removed in upcoming releases.
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
ImageList contains a list of Image.
Deprecated: Due to breaking changes, v1alpha2 is a new default, and this version will be removed in upcoming releases.
| 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
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
ImageStatus defines the observed state of Image.
Appears in: - Image
| Field | Description | Default | Validation |
|---|---|---|---|
ready boolean |
Ready indicates whether the image is ready. |
image-builder.anza-labs.dev/v1alpha2
Package v1alpha2 contains API Schema definitions for the image-builder v1alpha2 API group
Deprecated: Due to breaking changes, v1beta1 is a new default, and this version will be removed in upcoming releases.
Resource Types
AdditionalData
AdditionalData represents additional data sources for image building.
Appears in: - ImageSpec
| Field | Description | Default | Validation |
|---|---|---|---|
name string |
Name specifies unique name for the additional data. | ||
volumeMountPoint string |
VolumeMountPoint specifies the path where this data should be mounted. | ||
configMap ConfigMapVolumeSource |
ConfigMap specifies a ConfigMap as a data source. | ||
secret SecretVolumeSource |
Secret specifies a Secret as a data source. | ||
image ImageVolumeSource |
Image specifies a container image as a data source. | ||
volume PersistentVolumeClaimVolumeSource |
Volume specifies a PersistentVolumeClaim as a data source. | ||
bucket BucketDataSource |
Bucket specifies an S3 bucket as a data source. | ||
gitRepository GitRepository |
GitRepository specifies a Git repository as a data source. |
BucketDataSource
BucketDataSource represents an S3 bucket data source.
Appears in: - AdditionalData - DataSource
| Field | Description | Default | Validation |
|---|---|---|---|
credentials LocalObjectReference |
Credentials is a reference to the credentials for accessing the bucket. | ||
items KeyToPath array |
Items specifies specific items within the bucket to include. | ||
itemsConfigMap LocalObjectReference |
ItemsSecret specifies a Scret mapping item names to object storage keys. Each value should either be a key of the object or follow the format "key = e.g.: item-1: "path/to/item-1 = item-2: "path/to/item-2" |
Container
Appears in: - ImageSpec
| Field | Description | Default | Validation |
|---|---|---|---|
image string |
Image indicates the container image to use for the init container. | ||
verbosity integer |
Verbosity specifies the log verbosity level for the container. | 4 | Maximum: 10 Minimum: 0 |
resources ResourceRequirements |
Resources describe the compute resource requirements for the builder job. |
DataSource
DataSource defines the available sources for additional data. Each data source is either used directly as a Volume for the image, or will be fetched into empty dir shared between init container and the builder.
Appears in: - AdditionalData
| Field | Description | Default | Validation |
|---|---|---|---|
configMap ConfigMapVolumeSource |
ConfigMap specifies a ConfigMap as a data source. | ||
secret SecretVolumeSource |
Secret specifies a Secret as a data source. | ||
image ImageVolumeSource |
Image specifies a container image as a data source. | ||
volume PersistentVolumeClaimVolumeSource |
Volume specifies a PersistentVolumeClaim as a data source. | ||
bucket BucketDataSource |
Bucket specifies an S3 bucket as a data source. | ||
gitRepository GitRepository |
GitRepository specifies a Git repository as a data source. |
GitRepository
GitRepository represents a Git repository data source.
Appears in: - AdditionalData - DataSource
| Field | Description | Default | Validation |
|---|---|---|---|
repository string |
Repository specifies the URL of the Git repository. | ||
ref string |
Ref specifies the branch, tag, or commit hash to be used from the Git repository. | ||
credentials LocalObjectReference |
Credentials specifies the credentials for accessing the repository. Secret must be one of the following types: - "kubernetes.io/basic-auth" with "username" and "password" fields; - "kubernetes.io/ssh-auth" with "ssh-privatekey" field; - "Opaque" with "gitconfig" field. |
Image
Image represents the schema for the images API.
Appears in: - ImageList
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string |
image-builder.anza-labs.dev/v1alpha2 |
||
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
ImageList contains a list of Image resources.
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string |
image-builder.anza-labs.dev/v1alpha2 |
||
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
ImageSpec defines the desired state of an Image resource.
Appears in: - Image
| Field | Description | Default | Validation |
|---|---|---|---|
builder Container |
Builder specifies the parameters for the main container configuration. | ||
objFetcher Container |
ObjFetcher specifies the parameters for the Object Fetcher init container configuration. | ||
gitFetcher Container |
GitFetcher specifies the parameters for the Git Fetcher init container configuration. | ||
affinity Affinity |
Affinity specifies the scheduling constraints for Pods running the builder job. | ||
format string |
Format specifies the output 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 configuration. | ||
result LocalObjectReference |
Result is a reference to the local object containing downloadable build results. Defaults to the Image.Metadata.Name if not specified. |
||
bucketCredentials LocalObjectReference |
BucketCredentials is a reference to the credentials used for storing the image in S3. | ||
additionalData AdditionalData array |
AdditionalData specifies additional data sources required for building the image. |
ImageStatus
ImageStatus defines the observed state of an Image resource.
Appears in: - Image
| Field | Description | Default | Validation |
|---|---|---|---|
ready boolean |
Ready indicates whether the image has been successfully built. |
image-builder.anza-labs.dev/v1beta1
Package v1beta1 contains API Schema definitions for the image-builder v1beta1 API group.
Resource Types
AdditionalData
AdditionalData represents additional data sources for image building.
Appears in: - LinuxKitSpec
| Field | Description | Default | Validation |
|---|---|---|---|
name string |
Name specifies unique name for the additional data. | ||
volumeMountPoint string |
VolumeMountPoint specifies the path where this data should be mounted. | ||
configMap ConfigMapVolumeSource |
ConfigMap specifies a ConfigMap as a data source. | ||
secret SecretVolumeSource |
Secret specifies a Secret as a data source. | ||
image ImageVolumeSource |
Image specifies a container image as a data source. | ||
volume PersistentVolumeClaimVolumeSource |
Volume specifies a PersistentVolumeClaim as a data source. | ||
bucket BucketDataSource |
Bucket specifies an S3 bucket as a data source. | ||
gitRepository GitRepository |
GitRepository specifies a Git repository as a data source. |
BucketDataSource
BucketDataSource represents an S3 bucket data source.
Appears in: - AdditionalData - DataSource
| Field | Description | Default | Validation |
|---|---|---|---|
credentials LocalObjectReference |
Credentials is a reference to the credentials for accessing the bucket. | ||
items KeyToPath array |
Items specifies specific items within the bucket to include. | ||
itemsConfigMap LocalObjectReference |
ItemsSecret specifies a Scret mapping item names to object storage keys. Each value should either be a key of the object or follow the format "key = e.g.: item-1: "path/to/item-1 = item-2: "path/to/item-2" |
Container
Appears in: - LinuxKitSpec
| Field | Description | Default | Validation |
|---|---|---|---|
image string |
Image indicates the container image to use for the init container. | ||
verbosity integer |
Verbosity specifies the log verbosity level for the container. | 4 | Maximum: 10 Minimum: 0 |
resources ResourceRequirements |
Resources describe the compute resource requirements for the builder job. |
DataSource
DataSource defines the available sources for additional data. Each data source is either used directly as a Volume for the image, or will be fetched into empty dir shared between init container and the builder.
Appears in: - AdditionalData
| Field | Description | Default | Validation |
|---|---|---|---|
configMap ConfigMapVolumeSource |
ConfigMap specifies a ConfigMap as a data source. | ||
secret SecretVolumeSource |
Secret specifies a Secret as a data source. | ||
image ImageVolumeSource |
Image specifies a container image as a data source. | ||
volume PersistentVolumeClaimVolumeSource |
Volume specifies a PersistentVolumeClaim as a data source. | ||
bucket BucketDataSource |
Bucket specifies an S3 bucket as a data source. | ||
gitRepository GitRepository |
GitRepository specifies a Git repository as a data source. |
GitRepository
GitRepository represents a Git repository data source.
Appears in: - AdditionalData - DataSource
| Field | Description | Default | Validation |
|---|---|---|---|
repository string |
Repository specifies the URL of the Git repository. | ||
ref string |
Ref specifies the branch, tag, or commit hash to be used from the Git repository. | ||
credentials LocalObjectReference |
Credentials specifies the credentials for accessing the repository. Secret must be one of the following types: - "kubernetes.io/basic-auth" with "username" and "password" fields; - "kubernetes.io/ssh-auth" with "ssh-privatekey" field; - "Opaque" with "gitconfig" field. |
LinuxKit
LinuxKit is the Schema for the linuxkits API.
Appears in: - LinuxKitList
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string |
image-builder.anza-labs.dev/v1beta1 |
||
kind string |
LinuxKit |
||
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 LinuxKitSpec |
|||
status LinuxKitStatus |
LinuxKitList
LinuxKitList contains a list of LinuxKit.
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string |
image-builder.anza-labs.dev/v1beta1 |
||
kind string |
LinuxKitList |
||
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 LinuxKit array |
LinuxKitSpec
LinuxKitSpec defines the desired state of an LinuxKit resource.
Appears in: - LinuxKit
| Field | Description | Default | Validation |
|---|---|---|---|
builder Container |
Builder specifies the parameters for the main container configuration. | ||
objFetcher Container |
ObjFetcher specifies the parameters for the Object Fetcher init container configuration. | ||
gitFetcher Container |
GitFetcher specifies the parameters for the Git Fetcher init container configuration. | ||
affinity Affinity |
Affinity specifies the scheduling constraints for Pods running the builder job. | ||
format string |
Format specifies the output 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 configuration. | ||
result LocalObjectReference |
Result is a reference to the local object containing downloadable build results. Defaults to the Image.Metadata.Name if not specified. |
||
bucketCredentials LocalObjectReference |
BucketCredentials is a reference to the credentials used for storing the image in S3. | ||
additionalData AdditionalData array |
AdditionalData specifies additional data sources required for building the image. |
LinuxKitStatus
LinuxKitStatus defines the observed state of an Image resource.
Appears in: - LinuxKit
| Field | Description | Default | Validation |
|---|---|---|---|
ready boolean |
Ready indicates whether the image has been successfully built. |
Mkosi
Mkosi is the Schema for the mkosis API.
Appears in: - MkosiList
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string |
image-builder.anza-labs.dev/v1beta1 |
||
kind string |
Mkosi |
||
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 MkosiSpec |
|||
status MkosiStatus |
MkosiList
MkosiList contains a list of Mkosi.
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string |
image-builder.anza-labs.dev/v1beta1 |
||
kind string |
MkosiList |
||
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 Mkosi array |
MkosiSpec
MkosiSpec defines the desired state of Mkosi.
Appears in: - Mkosi
MkosiStatus
MkosiStatus defines the observed state of Mkosi.
Appears in: - Mkosi
| Field | Description | Default | Validation |
|---|---|---|---|
ready boolean |
Ready indicates whether the image has been successfully built. |