imagebuilder

Documentation

Index

• Constants
• Variables
• type BuildImageRequest
• type ImageBuilder
  • func NewEnsemblerJobImageBuilder(clusterController cluster.Controller, ...) (ImageBuilder, error)
  • func NewEnsemblerServiceImageBuilder(clusterController cluster.Controller, ...) (ImageBuilder, error)
• type JobStatus

Constants

const (

	// JobStatusActive is the status of the image building job is active
	JobStatusActive = JobStatus(iota)
	// JobStatusFailed is when the image building job has failed
	JobStatusFailed
	// JobStatusSucceeded is when the image building job has succeeded
	JobStatusSucceeded
	// JobStatusUnknown is when the image building job status is unknown
	JobStatusUnknown
)

Variables

var (
	// ErrUnableToGetImageRef is an error that failed to check if a previous image exists.
	ErrUnableToGetImageRef = errors.New("error checking previous image")

	// ErrUnableToGetJobStatus is an error that failed to get job status.
	ErrUnableToGetJobStatus = errors.New("unknown kaniko builder status")

	// ErrUnableToBuildImage is an error that failed to build an OCI image.
	ErrUnableToBuildImage = errors.New("error building OCI image")

	// ErrDeleteFailedJob is an error that the OCI image building process has failed.
	ErrDeleteFailedJob = errors.New("error deleting kaniko builder")

	// ErrUnableToParseKanikoResource is an error that failed to parse kubernetes resources for kaniko builder.
	ErrUnableToParseKanikoResource = errors.New("error parsing kaniko resources")

	// ErrTimeoutBuildingImage is an error that the image build timed out.
	ErrTimeoutBuildingImage = errors.New("timeout building pyfunc image")
)

Types

type BuildImageRequest

type BuildImageRequest struct {
	ProjectName     string
	ResourceName    string
	ResourceID      models.ID
	VersionID       string
	ArtifactURI     string
	BuildLabels     map[string]string
	EnsemblerFolder string
	BaseImageRefTag string
}

BuildImageRequest contains the information needed to build the OCI image

type ImageBuilder

type ImageBuilder interface {
	// Build OCI image based on a Dockerfile
	BuildImage(request BuildImageRequest) (string, error)
	GetImageBuildingJobStatus(
		projectName string,
		modelName string,
		modelID models.ID,
		versionID string,
	) (JobStatus, error)
	DeleteImageBuildingJob(
		projectName string,
		modelName string,
		modelID models.ID,
		versionID string,
	) error
}

ImageBuilder defines the operations on building and publishing OCI images.

func NewEnsemblerJobImageBuilder

func NewEnsemblerJobImageBuilder(
	clusterController cluster.Controller,
	imageBuildingConfig config.ImageBuildingConfig,
) (ImageBuilder, error)

NewEnsemblerJobImageBuilder create ImageBuilder for building docker image of ensembling job (batch)

func NewEnsemblerServiceImageBuilder

func NewEnsemblerServiceImageBuilder(
	clusterController cluster.Controller,
	imageBuildingConfig config.ImageBuildingConfig,
) (ImageBuilder, error)

NewEnsemblerServiceImageBuilder create ImageBuilder for building docker image of the ensembling service (real-time)

type JobStatus

type JobStatus int

JobStatus is the current state of the image building job.