imagebuilder

package
v1.2.0-main Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 29, 2026 License: Apache-2.0 Imports: 13 Imported by: 0

Documentation

Overview

Package imagebuilder provides the types and client for the Flight Control Image Builder API.

Package imagebuilder provides primitives to interact with the openapi HTTP API.

Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.5.1 DO NOT EDIT.

Package imagebuilder provides primitives to interact with the openapi HTTP API.

Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.5.1 DO NOT EDIT.

Index

Constants

View Source 
const (
	APIGroup = "flightctl.io"

	ImageBuildAPIVersion = "v1beta1"
	ImageBuildListKind   = "ImageBuildList"

	ImageExportAPIVersion = "v1beta1"
	ImageExportListKind   = "ImageExportList"

	// LogStreamCompleteMarker is sent by the server when a log stream is complete.
	// The CLI uses this to distinguish between orderly completion and abrupt disconnection.
	LogStreamCompleteMarker = "<<STREAM_COMPLETE>>"
)

Variables

This section is empty.

Functions

func GetSwagger 

func GetSwagger() (swagger *openapi3.T, err error)

GetSwagger returns the Swagger specification corresponding to the generated code in this file. The external references of Swagger specification are resolved. The logic of resolving external references is tightly connected to "import-mapping" feature. Externally referenced files must be embedded in the corresponding golang packages. Urls can be supported but this task was out of the scope.

func PathToRawSpec 

func PathToRawSpec(pathToFile string) map[string]func() ([]byte, error)

Constructs a synthetic filesystem for resolving external references when loading openapi specifications.

func SetImageBuildStatusCondition 

func SetImageBuildStatusCondition(conditions *[]ImageBuildCondition, newCondition ImageBuildCondition) (changed bool)

SetImageBuildStatusCondition sets the corresponding condition in conditions to newCondition and returns true if the conditions are changed by this call. conditions must be non-nil.

  1. if the condition of the specified type already exists (all fields of the existing condition are updated to newCondition, LastTransitionTime is set to now if the new status differs from the old status)
  2. if a condition of the specified type does not exist (LastTransitionTime is set to now() if unset, and newCondition is appended)

func SetImageExportStatusCondition 

func SetImageExportStatusCondition(conditions *[]ImageExportCondition, newCondition ImageExportCondition) (changed bool)

SetImageExportStatusCondition sets the corresponding condition in conditions to newCondition and returns true if the conditions are changed by this call. conditions must be non-nil.

  1. if the condition of the specified type already exists (all fields of the existing condition are updated to newCondition, LastTransitionTime is set to now if the new status differs from the old status)
  2. if a condition of the specified type does not exist (LastTransitionTime is set to now() if unset, and newCondition is appended)

Types

type BindingType 

type BindingType string

BindingType The type of binding for the image build. 

const (
	BindingTypeEarly BindingType = "early"
	BindingTypeLate  BindingType = "late"
)

Defines values for BindingType.

type CreateImageBuildJSONRequestBody 

type CreateImageBuildJSONRequestBody = ImageBuild

CreateImageBuildJSONRequestBody defines body for CreateImageBuild for application/json ContentType.

type CreateImageExportJSONRequestBody 

type CreateImageExportJSONRequestBody = ImageExport

CreateImageExportJSONRequestBody defines body for CreateImageExport for application/json ContentType.

type EarlyBinding 

type EarlyBinding struct {
	// Type The type of binding.
	Type EarlyBindingType `json:"type"`
}

EarlyBinding Early binding configuration - embeds certificate in the image.

type EarlyBindingType 

type EarlyBindingType string

EarlyBindingType The type of binding. 

const (
	Early EarlyBindingType = "early"
)

Defines values for EarlyBindingType.

type ExportFormatType 

type ExportFormatType string

ExportFormatType The type of format to export the image to. 

const (
	ExportFormatTypeISO                ExportFormatType = "iso"
	ExportFormatTypeQCOW2              ExportFormatType = "qcow2"
	ExportFormatTypeQCOW2DiskContainer ExportFormatType = "qcow2-disk-container"
	ExportFormatTypeVMDK               ExportFormatType = "vmdk"
)

Defines values for ExportFormatType.

type GetImageBuildLogParams 

type GetImageBuildLogParams struct {
	// Follow If true, stream logs continuously (like kubectl logs -f). For active builds, keeps connection open. For completed builds, returns all logs and closes.
	Follow *bool `form:"follow,omitempty" json:"follow,omitempty"`
}

GetImageBuildLogParams defines parameters for GetImageBuildLog.

type GetImageBuildParams 

type GetImageBuildParams struct {
	// WithExports If true, includes related ImageExport resources in the response.
	WithExports *bool `form:"withExports,omitempty" json:"withExports,omitempty"`
}

GetImageBuildParams defines parameters for GetImageBuild.

type GetImageExportLogParams 

type GetImageExportLogParams struct {
	// Follow If true, stream logs continuously (like kubectl logs -f). For active exports, keeps connection open. For completed exports, returns all logs and closes.
	Follow *bool `form:"follow,omitempty" json:"follow,omitempty"`
}

GetImageExportLogParams defines parameters for GetImageExportLog.

type ImageBuild 

type ImageBuild struct {
	// ApiVersion 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.
	ApiVersion string `json:"apiVersion"`

	// Imageexports Array of ImageExport resources that reference this ImageBuild. Only populated when withExports query parameter is true.
	Imageexports *[]ImageExport `json:"imageexports,omitempty"`

	// Kind 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.
	Kind string `json:"kind"`

	// Metadata ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
	Metadata externalRef0.ObjectMeta `json:"metadata"`

	// Spec ImageBuildSpec describes the specification for an image build.
	Spec ImageBuildSpec `json:"spec"`

	// Status ImageBuildStatus represents the current status of an ImageBuild.
	Status *ImageBuildStatus `json:"status,omitempty"`
}

ImageBuild ImageBuild represents a build request for a container image.

type ImageBuildBinding 

type ImageBuildBinding struct {
	// contains filtered or unexported fields
}

ImageBuildBinding ImageBuildBinding specifies binding configuration for the build.

func (ImageBuildBinding) AsEarlyBinding 

func (t ImageBuildBinding) AsEarlyBinding() (EarlyBinding, error)

AsEarlyBinding returns the union data inside the ImageBuildBinding as a EarlyBinding

func (ImageBuildBinding) AsLateBinding 

func (t ImageBuildBinding) AsLateBinding() (LateBinding, error)

AsLateBinding returns the union data inside the ImageBuildBinding as a LateBinding

func (ImageBuildBinding) Discriminator 

func (t ImageBuildBinding) Discriminator() (string, error)

func (*ImageBuildBinding) FromEarlyBinding 

func (t *ImageBuildBinding) FromEarlyBinding(v EarlyBinding) error

FromEarlyBinding overwrites any union data inside the ImageBuildBinding as the provided EarlyBinding

func (*ImageBuildBinding) FromLateBinding 

func (t *ImageBuildBinding) FromLateBinding(v LateBinding) error

FromLateBinding overwrites any union data inside the ImageBuildBinding as the provided LateBinding

func (ImageBuildBinding) MarshalJSON 

func (t ImageBuildBinding) MarshalJSON() ([]byte, error)

func (*ImageBuildBinding) MergeEarlyBinding 

func (t *ImageBuildBinding) MergeEarlyBinding(v EarlyBinding) error

MergeEarlyBinding performs a merge with any union data inside the ImageBuildBinding, using the provided EarlyBinding

func (*ImageBuildBinding) MergeLateBinding 

func (t *ImageBuildBinding) MergeLateBinding(v LateBinding) error

MergeLateBinding performs a merge with any union data inside the ImageBuildBinding, using the provided LateBinding

func (*ImageBuildBinding) UnmarshalJSON 

func (t *ImageBuildBinding) UnmarshalJSON(b []byte) error

func (ImageBuildBinding) ValueByDiscriminator 

func (t ImageBuildBinding) ValueByDiscriminator() (interface{}, error)

type ImageBuildCondition 

type ImageBuildCondition struct {
	// LastTransitionTime The last time the condition transitioned from one status to another.
	LastTransitionTime time.Time `json:"lastTransitionTime"`

	// Message Human readable message indicating details about last transition.
	Message string `json:"message"`

	// ObservedGeneration The .metadata.generation that the condition was set based upon.
	ObservedGeneration *int64 `json:"observedGeneration,omitempty"`

	// Reason A (brief) reason for the condition's last transition.
	Reason string `json:"reason"`

	// Status Status of the condition, one of True, False, Unknown.
	Status externalRef0.ConditionStatus `json:"status"`

	// Type Type of ImageBuild condition.
	Type ImageBuildConditionType `json:"type"`
}

ImageBuildCondition defines model for ImageBuildCondition.

func FindImageBuildStatusCondition 

func FindImageBuildStatusCondition(conditions []ImageBuildCondition, conditionType ImageBuildConditionType) *ImageBuildCondition

FindImageBuildStatusCondition finds the conditionType in conditions.

type ImageBuildConditionReason 

type ImageBuildConditionReason string

ImageBuildConditionReason Reason for the ImageBuild Ready condition. 

const (
	ImageBuildConditionReasonBuilding  ImageBuildConditionReason = "Building"
	ImageBuildConditionReasonCanceled  ImageBuildConditionReason = "Canceled"
	ImageBuildConditionReasonCanceling ImageBuildConditionReason = "Canceling"
	ImageBuildConditionReasonCompleted ImageBuildConditionReason = "Completed"
	ImageBuildConditionReasonFailed    ImageBuildConditionReason = "Failed"
	ImageBuildConditionReasonPending   ImageBuildConditionReason = "Pending"
	ImageBuildConditionReasonPushing   ImageBuildConditionReason = "Pushing"
)

Defines values for ImageBuildConditionReason.

type ImageBuildConditionType 

type ImageBuildConditionType string

ImageBuildConditionType Type of ImageBuild condition. 

const (
	ImageBuildConditionTypeReady ImageBuildConditionType = "Ready"
)

Defines values for ImageBuildConditionType.

type ImageBuildDestination 

type ImageBuildDestination struct {
	// ImageName The name of the output image.
	ImageName string `json:"imageName"`

	// ImageTag The tag of the output image.
	ImageTag string `json:"imageTag"`

	// Repository The name of the Repository resource of type OCI to push the built image to.
	Repository string `json:"repository"`
}

ImageBuildDestination ImageBuildDestination specifies the destination for the built image.

type ImageBuildList 

type ImageBuildList struct {
	// ApiVersion 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.
	ApiVersion string `json:"apiVersion"`

	// Items List of ImageBuild resources.
	Items []ImageBuild `json:"items"`

	// Kind 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.
	Kind string `json:"kind"`

	// Metadata ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
	Metadata externalRef0.ListMeta `json:"metadata"`
}

ImageBuildList ImageBuildList is a list of ImageBuild resources.

type ImageBuildRefSource 

type ImageBuildRefSource struct {
	// ImageBuildRef The name of the ImageBuild resource to use as source.
	ImageBuildRef string `json:"imageBuildRef"`

	// Type The type of source.
	Type ImageBuildRefSourceType `json:"type"`
}

ImageBuildRefSource ImageBuildRefSource specifies a source image from an ImageBuild resource.

type ImageBuildRefSourceType 

type ImageBuildRefSourceType string

ImageBuildRefSourceType The type of source. 

const (
	ImageBuildRefSourceTypeImageBuild ImageBuildRefSourceType = "imageBuild"
)

Defines values for ImageBuildRefSourceType.

type ImageBuildSource 

type ImageBuildSource struct {
	// ImageName The name of the source image.
	ImageName string `json:"imageName"`

	// ImageTag The tag of the source image.
	ImageTag string `json:"imageTag"`

	// Repository The name of the Repository resource of type OCI containing the source image.
	Repository string `json:"repository"`
}

ImageBuildSource ImageBuildSource specifies the source image for the build.

type ImageBuildSpec 

type ImageBuildSpec struct {
	// Binding ImageBuildBinding specifies binding configuration for the build.
	Binding ImageBuildBinding `json:"binding"`

	// Destination ImageBuildDestination specifies the destination for the built image.
	Destination ImageBuildDestination `json:"destination"`

	// Source ImageBuildSource specifies the source image for the build.
	Source ImageBuildSource `json:"source"`

	// UserConfiguration ImageBuildUserConfiguration specifies user configuration for the build.
	UserConfiguration *ImageBuildUserConfiguration `json:"userConfiguration,omitempty"`
}

ImageBuildSpec ImageBuildSpec describes the specification for an image build.

type ImageBuildStatus 

type ImageBuildStatus struct {
	// Architecture The architecture of the built image.
	Architecture *string `json:"architecture,omitempty"`

	// Conditions Current conditions of the ImageBuild.
	Conditions *[]ImageBuildCondition `json:"conditions,omitempty"`

	// ImageReference The full image reference of the built image (e.g., quay.io/org/imagename:tag).
	ImageReference *string `json:"imageReference,omitempty"`

	// LastSeen The last time the build was seen (heartbeat).
	LastSeen *time.Time `json:"lastSeen,omitempty"`

	// ManifestDigest The digest of the built image manifest.
	ManifestDigest *string `json:"manifestDigest,omitempty"`
}

ImageBuildStatus ImageBuildStatus represents the current status of an ImageBuild.

type ImageBuildUserConfiguration 

type ImageBuildUserConfiguration struct {
	// Publickey The public key for the user configuration.
	Publickey string `json:"publickey"`

	// Username The username for the user configuration.
	Username string `json:"username"`
}

ImageBuildUserConfiguration ImageBuildUserConfiguration specifies user configuration for the build.

type ImageExport 

type ImageExport struct {
	// ApiVersion 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.
	ApiVersion string `json:"apiVersion"`

	// Kind 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.
	Kind string `json:"kind"`

	// Metadata ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
	Metadata externalRef0.ObjectMeta `json:"metadata"`

	// Spec ImageExportSpec describes the specification for an image export.
	Spec ImageExportSpec `json:"spec"`

	// Status ImageExportStatus represents the current status of an ImageExport.
	Status *ImageExportStatus `json:"status,omitempty"`
}

ImageExport ImageExport represents an export request to convert and push images to different formats.

type ImageExportCondition 

type ImageExportCondition struct {
	// LastTransitionTime The last time the condition transitioned from one status to another.
	LastTransitionTime time.Time `json:"lastTransitionTime"`

	// Message Human readable message indicating details about last transition.
	Message string `json:"message"`

	// ObservedGeneration The .metadata.generation that the condition was set based upon.
	ObservedGeneration *int64 `json:"observedGeneration,omitempty"`

	// Reason A (brief) reason for the condition's last transition.
	Reason string `json:"reason"`

	// Status Status of the condition, one of True, False, Unknown.
	Status externalRef0.ConditionStatus `json:"status"`

	// Type Type of ImageExport condition.
	Type ImageExportConditionType `json:"type"`
}

ImageExportCondition defines model for ImageExportCondition.

func FindImageExportStatusCondition 

func FindImageExportStatusCondition(conditions []ImageExportCondition, conditionType ImageExportConditionType) *ImageExportCondition

FindImageExportStatusCondition finds the conditionType in conditions.

type ImageExportConditionReason 

type ImageExportConditionReason string

ImageExportConditionReason Reason for the ImageExport Ready condition. 

const (
	ImageExportConditionReasonCanceled   ImageExportConditionReason = "Canceled"
	ImageExportConditionReasonCanceling  ImageExportConditionReason = "Canceling"
	ImageExportConditionReasonCompleted  ImageExportConditionReason = "Completed"
	ImageExportConditionReasonConverting ImageExportConditionReason = "Converting"
	ImageExportConditionReasonFailed     ImageExportConditionReason = "Failed"
	ImageExportConditionReasonPending    ImageExportConditionReason = "Pending"
	ImageExportConditionReasonPushing    ImageExportConditionReason = "Pushing"
)

Defines values for ImageExportConditionReason.

type ImageExportConditionType 

type ImageExportConditionType string

ImageExportConditionType Type of ImageExport condition. 

const (
	ImageExportConditionTypeReady ImageExportConditionType = "Ready"
)

Defines values for ImageExportConditionType.

type ImageExportFormatPhase 

type ImageExportFormatPhase string

ImageExportFormatPhase The phase of a single format conversion. 

const (
	ImageExportFormatPhaseComplete   ImageExportFormatPhase = "complete"
	ImageExportFormatPhaseConverting ImageExportFormatPhase = "converting"
	ImageExportFormatPhaseFailed     ImageExportFormatPhase = "failed"
	ImageExportFormatPhasePushing    ImageExportFormatPhase = "pushing"
	ImageExportFormatPhaseQueued     ImageExportFormatPhase = "queued"
)

Defines values for ImageExportFormatPhase.

type ImageExportList 

type ImageExportList struct {
	// ApiVersion 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.
	ApiVersion string `json:"apiVersion"`

	// Items List of ImageExport resources.
	Items []ImageExport `json:"items"`

	// Kind 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.
	Kind string `json:"kind"`

	// Metadata ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
	Metadata externalRef0.ListMeta `json:"metadata"`
}

ImageExportList ImageExportList is a list of ImageExport resources.

type ImageExportSource 

type ImageExportSource struct {
	// contains filtered or unexported fields
}

ImageExportSource ImageExportSource specifies the source image for the export.

func (ImageExportSource) AsImageBuildRefSource 

func (t ImageExportSource) AsImageBuildRefSource() (ImageBuildRefSource, error)

AsImageBuildRefSource returns the union data inside the ImageExportSource as a ImageBuildRefSource

func (ImageExportSource) Discriminator 

func (t ImageExportSource) Discriminator() (string, error)

func (*ImageExportSource) FromImageBuildRefSource 

func (t *ImageExportSource) FromImageBuildRefSource(v ImageBuildRefSource) error

FromImageBuildRefSource overwrites any union data inside the ImageExportSource as the provided ImageBuildRefSource

func (ImageExportSource) MarshalJSON 

func (t ImageExportSource) MarshalJSON() ([]byte, error)

func (*ImageExportSource) MergeImageBuildRefSource 

func (t *ImageExportSource) MergeImageBuildRefSource(v ImageBuildRefSource) error

MergeImageBuildRefSource performs a merge with any union data inside the ImageExportSource, using the provided ImageBuildRefSource

func (*ImageExportSource) UnmarshalJSON 

func (t *ImageExportSource) UnmarshalJSON(b []byte) error

func (ImageExportSource) ValueByDiscriminator 

func (t ImageExportSource) ValueByDiscriminator() (interface{}, error)

type ImageExportSourceType 

type ImageExportSourceType string

ImageExportSourceType The type of source for the image export. 

const (
	ImageExportSourceTypeImageBuild ImageExportSourceType = "imageBuild"
)

Defines values for ImageExportSourceType.

type ImageExportSpec 

type ImageExportSpec struct {
	// Format The type of format to export the image to.
	Format ExportFormatType `json:"format"`

	// Source ImageExportSource specifies the source image for the export.
	Source ImageExportSource `json:"source"`
}

ImageExportSpec ImageExportSpec describes the specification for an image export.

type ImageExportStatus 

type ImageExportStatus struct {
	// Conditions Current conditions of the ImageExport.
	Conditions *[]ImageExportCondition `json:"conditions,omitempty"`

	// LastSeen The last time the export was seen (heartbeat).
	LastSeen *time.Time `json:"lastSeen,omitempty"`

	// ManifestDigest The digest of the exported image manifest for this format.
	ManifestDigest *string `json:"manifestDigest,omitempty"`
}

ImageExportStatus ImageExportStatus represents the current status of an ImageExport.

type LateBinding 

type LateBinding struct {
	// Type The type of binding.
	Type LateBindingType `json:"type"`
}

LateBinding Late binding configuration - device binds at first boot.

type LateBindingType 

type LateBindingType string

LateBindingType The type of binding. 

const (
	Late LateBindingType = "late"
)

Defines values for LateBindingType.

type ListImageBuildsParams 

type ListImageBuildsParams struct {
	// LabelSelector A selector to restrict the list of returned objects by their labels.
	LabelSelector *string `form:"labelSelector,omitempty" json:"labelSelector,omitempty"`

	// FieldSelector A selector to restrict the list of returned objects by their fields.
	FieldSelector *string `form:"fieldSelector,omitempty" json:"fieldSelector,omitempty"`

	// Limit The maximum number of results returned in the list response.
	Limit *int32 `form:"limit,omitempty" json:"limit,omitempty"`

	// Continue An optional parameter to query more results from the server.
	Continue *string `form:"continue,omitempty" json:"continue,omitempty"`

	// WithExports If true, includes related ImageExport resources in each ImageBuild in the response.
	WithExports *bool `form:"withExports,omitempty" json:"withExports,omitempty"`
}

ListImageBuildsParams defines parameters for ListImageBuilds.

type ListImageExportsParams 

type ListImageExportsParams struct {
	// LabelSelector A selector to restrict the list of returned objects by their labels.
	LabelSelector *string `form:"labelSelector,omitempty" json:"labelSelector,omitempty"`

	// FieldSelector A selector to restrict the list of returned objects by their fields.
	FieldSelector *string `form:"fieldSelector,omitempty" json:"fieldSelector,omitempty"`

	// Limit The maximum number of results returned in the list response.
	Limit *int32 `form:"limit,omitempty" json:"limit,omitempty"`

	// Continue An optional parameter to query more results from the server.
	Continue *string `form:"continue,omitempty" json:"continue,omitempty"`
}

ListImageExportsParams defines parameters for ListImageExports.

type ResourceKind 

type ResourceKind string

ResourceKind Resource types exposed via the ImageBuilder API. 

const (
	ResourceKindImageBuild  ResourceKind = "ImageBuild"
	ResourceKindImageExport ResourceKind = "ImageExport"
)

Defines values for ResourceKind.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.