v1

Documentation

Index

• Constants
• func GetImageSliceFromContainerImageList(containerImageList []*ContainerImage) []string
• type BuildClient
• type ContainerImage
• type ImageExtension
  • func (ie *ImageExtension) UnmarshalJSON(data []byte) error
• type ImageSpec
• type Launch

Constants

const (
	SealerImageExtension          = "sealer.image.extension"
	SealerImageContainerImageList = "sealer.image.container.images"

	// Kube image type
	KubeInstaller = "kube-installer"
	AppInstaller  = "app-installer"

	ImageSpecSchemaVersionV1Beta1 = "v1alpha1"
)

Functions

func GetImageSliceFromContainerImageList

func GetImageSliceFromContainerImageList(containerImageList []*ContainerImage) []string

Types

type BuildClient

type BuildClient struct {
	SealerVersion string `json:"sealerVersion"`

	BuildahVersion string `json:"buildahVersion"`
}

type ContainerImage

type ContainerImage struct {
	// Image the container image name
	Image string `json:"image" yaml:"image"`

	// AppName the mame of the app to which the container image belongs
	//
	// NOTE: A container image may not belong to any app. In this case, the appName value is null.
	AppName string `json:"appName,omitempty" yaml:"appName"`

	// Platform the container image platform
	Platform *apiv1.Platform `json:"platform" yaml:"platform"`
}

type ImageExtension

type ImageExtension struct {
	// BuildClient build client info
	BuildClient BuildClient `json:"buildClient"`

	// image spec schema version
	SchemaVersion string `json:"schemaVersion"`

	// sealer image type, like AppImage
	Type string `json:"type,omitempty"`

	// applications in the sealer image
	Applications []version.VersionedApplication `json:"applications,omitempty"`

	// Labels are metadata to the sealer image
	Labels map[string]string `json:"labels,omitempty" yaml:"labels,omitempty"`

	// Env is a set of key value pair.
	// set to sealer image some default parameters which is in global level.
	// user could overwrite it through v2.ClusterSpec at run stage.
	Env map[string]string `json:"env,omitempty"`

	// launch spec will declare
	Launch Launch `json:"launch,omitempty"`
}

NOTE: the UnmarshalJSON function of ImageExtension has been overrode

func (*ImageExtension) UnmarshalJSON

func (ie *ImageExtension) UnmarshalJSON(data []byte) error

type ImageSpec

type ImageSpec struct {
	// ID the image id
	ID string `json:"id"`

	// Name the image name
	Name string `json:"name"`

	// Digest the image digest
	Digest string `json:"digest"`

	// ManifestV1 OCI version v1 image manifest
	ManifestV1 ociv1.Manifest `json:"manifestv1"`

	// OCIv1 OCI version v1 image spec
	OCIv1 ociv1.Image `json:"ociv1"`

	ImageExtension ImageExtension `json:"imageExtension"`

	// ContainerImageList the container image list contained in the sealer image
	//
	// TODO: populate this value during the build phase
	ContainerImageList []*ContainerImage `json:"containerImageList,omitempty"`
}

type Launch

type Launch struct {
	Cmds []string `json:"cmds,omitempty"`

	// user specified LAUNCH instruction
	AppNames []string `json:"app_names,omitempty"`
}