k3s/vendor/github.com/lxc/lxd/shared/api/image.go
2019-11-10 04:05:59 +00:00

133 lines
4.4 KiB
Go

package api
import (
"time"
)
// ImagesPost represents the fields available for a new LXD image
type ImagesPost struct {
ImagePut `yaml:",inline"`
Filename string `json:"filename" yaml:"filename"`
Source *ImagesPostSource `json:"source" yaml:"source"`
// API extension: image_compression_algorithm
CompressionAlgorithm string `json:"compression_algorithm" yaml:"compression_algorithm"`
// API extension: image_create_aliases
Aliases []ImageAlias `json:"aliases" yaml:"aliases"`
}
// ImagesPostSource represents the source of a new LXD image
type ImagesPostSource struct {
ImageSource `yaml:",inline"`
Mode string `json:"mode" yaml:"mode"`
Type string `json:"type" yaml:"type"`
// For protocol "direct"
URL string `json:"url" yaml:"url"`
// For type "container"
Name string `json:"name" yaml:"name"`
// For type "image"
Fingerprint string `json:"fingerprint" yaml:"fingerprint"`
Secret string `json:"secret" yaml:"secret"`
}
// ImagePut represents the modifiable fields of a LXD image
type ImagePut struct {
AutoUpdate bool `json:"auto_update" yaml:"auto_update"`
Properties map[string]string `json:"properties" yaml:"properties"`
Public bool `json:"public" yaml:"public"`
// API extension: images_expiry
ExpiresAt time.Time `json:"expires_at" yaml:"expires_at"`
}
// Image represents a LXD image
type Image struct {
ImagePut `yaml:",inline"`
Aliases []ImageAlias `json:"aliases" yaml:"aliases"`
Architecture string `json:"architecture" yaml:"architecture"`
Cached bool `json:"cached" yaml:"cached"`
Filename string `json:"filename" yaml:"filename"`
Fingerprint string `json:"fingerprint" yaml:"fingerprint"`
Size int64 `json:"size" yaml:"size"`
UpdateSource *ImageSource `json:"update_source,omitempty" yaml:"update_source,omitempty"`
// API extension: image_types
Type string `json:"type" yaml:"type"`
CreatedAt time.Time `json:"created_at" yaml:"created_at"`
LastUsedAt time.Time `json:"last_used_at" yaml:"last_used_at"`
UploadedAt time.Time `json:"uploaded_at" yaml:"uploaded_at"`
}
// Writable converts a full Image struct into a ImagePut struct (filters read-only fields)
func (img *Image) Writable() ImagePut {
return img.ImagePut
}
// ImageAlias represents an alias from the alias list of a LXD image
type ImageAlias struct {
Name string `json:"name" yaml:"name"`
Description string `json:"description" yaml:"description"`
}
// ImageSource represents the source of a LXD image
type ImageSource struct {
Alias string `json:"alias" yaml:"alias"`
Certificate string `json:"certificate" yaml:"certificate"`
Protocol string `json:"protocol" yaml:"protocol"`
Server string `json:"server" yaml:"server"`
// API extension: image_types
ImageType string `json:"image_type" yaml:"image_type"`
}
// ImageAliasesPost represents a new LXD image alias
type ImageAliasesPost struct {
ImageAliasesEntry `yaml:",inline"`
}
// ImageAliasesEntryPost represents the required fields to rename a LXD image alias
type ImageAliasesEntryPost struct {
Name string `json:"name" yaml:"name"`
}
// ImageAliasesEntryPut represents the modifiable fields of a LXD image alias
type ImageAliasesEntryPut struct {
Description string `json:"description" yaml:"description"`
Target string `json:"target" yaml:"target"`
}
// ImageAliasesEntry represents a LXD image alias
type ImageAliasesEntry struct {
ImageAliasesEntryPut `yaml:",inline"`
Name string `json:"name" yaml:"name"`
// API extension: image_types
Type string `json:"type" yaml:"type"`
}
// ImageMetadata represents LXD image metadata
type ImageMetadata struct {
Architecture string `json:"architecture" yaml:"architecture"`
CreationDate int64 `json:"creation_date" yaml:"creation_date"`
ExpiryDate int64 `json:"expiry_date" yaml:"expiry_date"`
Properties map[string]string `json:"properties" yaml:"properties"`
Templates map[string]*ImageMetadataTemplate `json:"templates" yaml:"templates"`
}
// ImageMetadataTemplate represents a template entry in image metadata
type ImageMetadataTemplate struct {
When []string `json:"when" yaml:"when"`
CreateOnly bool `json:"create_only" yaml:"create_only"`
Template string `json:"template" yaml:"template"`
Properties map[string]string `json:"properties" yaml:"properties"`
}