imagebuilder

Documentation

Index

• Variables
• type BuildImageRequest
• type EnsemblerImage
• type ImageBuilder
  • func NewEnsemblerJobImageBuilder(clusterController cluster.Controller, ...) (ImageBuilder, error)
  • func NewEnsemblerServiceImageBuilder(clusterController cluster.Controller, ...) (ImageBuilder, error)
• type JobState
• type JobStatus
  • func (js JobStatus) IsActive() bool

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
}

BuildImageRequest contains the information needed to build the OCI image

type EnsemblerImage

type EnsemblerImage struct {
	ProjectID           models.ID                  `json:"project_id"`
	EnsemblerID         models.ID                  `json:"ensembler_id"`
	EnsemblerRunnerType models.EnsemblerRunnerType `json:"runner_type"`
	ImageRef            string                     `json:"image_ref"`
	Exists              bool                       `json:"exists"`
	JobStatus           JobStatus                  `json:"image_building_job_status"`
}

type ImageBuilder

type ImageBuilder interface {
	// Build OCI image based on a Dockerfile
	BuildImage(request BuildImageRequest) (string, error)
	GetEnsemblerImage(project *mlp.Project, ensembler *models.PyFuncEnsembler) (EnsemblerImage, error)
	GetImageBuildingJobStatus(
		projectName string,
		ensemblerName string,
		ensemblerID models.ID,
		versionID string,
	) JobStatus
	DeleteImageBuildingJob(
		projectName string,
		ensemblerName string,
		ensemblerID 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,
	artifactService artifact.Service,
) (ImageBuilder, error)

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

func NewEnsemblerServiceImageBuilder

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

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

type JobState

type JobState string

const (
	// JobStateActive is the status of the image building job is active
	JobStateActive JobState = "active"
	// JobStateSucceeded is when the image building job has succeeded
	JobStateSucceeded JobState = "succeeded"
	// JobStateFailed is when the image building job has failed
	JobStateFailed JobState = "failed"
	// JobStateUnknown is when the image building job status is unknown
	JobStateUnknown JobState = "unknown"
)

type JobStatus

type JobStatus struct {
	State   JobState `json:"state"`
	Message string   `json:"message,omitempty"`
}

JobStatus is the current status of the image building job.

func (JobStatus) IsActive

func (js JobStatus) IsActive() bool