mirror of https://github.com/containers/podman.git
321 lines
9.8 KiB
Go
321 lines
9.8 KiB
Go
package entities
|
|
|
|
import (
|
|
"time"
|
|
|
|
"github.com/containers/image/v5/manifest"
|
|
"github.com/containers/image/v5/types"
|
|
"github.com/containers/libpod/pkg/inspect"
|
|
"github.com/containers/libpod/pkg/trust"
|
|
docker "github.com/docker/docker/api/types"
|
|
"github.com/docker/docker/api/types/container"
|
|
"github.com/opencontainers/go-digest"
|
|
v1 "github.com/opencontainers/image-spec/specs-go/v1"
|
|
)
|
|
|
|
type Image struct {
|
|
ID string `json:"Id"`
|
|
RepoTags []string `json:",omitempty"`
|
|
RepoDigests []string `json:",omitempty"`
|
|
Parent string `json:",omitempty"`
|
|
Comment string `json:",omitempty"`
|
|
Created string `json:",omitempty"`
|
|
Container string `json:",omitempty"`
|
|
ContainerConfig *container.Config `json:",omitempty"`
|
|
DockerVersion string `json:",omitempty"`
|
|
Author string `json:",omitempty"`
|
|
Config *container.Config `json:",omitempty"`
|
|
Architecture string `json:",omitempty"`
|
|
Variant string `json:",omitempty"`
|
|
Os string `json:",omitempty"`
|
|
OsVersion string `json:",omitempty"`
|
|
Size int64 `json:",omitempty"`
|
|
VirtualSize int64 `json:",omitempty"`
|
|
GraphDriver docker.GraphDriverData `json:",omitempty"`
|
|
RootFS docker.RootFS `json:",omitempty"`
|
|
Metadata docker.ImageMetadata `json:",omitempty"`
|
|
|
|
// Podman extensions
|
|
Digest digest.Digest `json:",omitempty"`
|
|
PodmanVersion string `json:",omitempty"`
|
|
ManifestType string `json:",omitempty"`
|
|
User string `json:",omitempty"`
|
|
History []v1.History `json:",omitempty"`
|
|
NamesHistory []string `json:",omitempty"`
|
|
HealthCheck *manifest.Schema2HealthConfig `json:",omitempty"`
|
|
}
|
|
|
|
func (i *Image) Id() string { //nolint
|
|
return i.ID
|
|
}
|
|
|
|
type ImageSummary struct {
|
|
ID string `json:"Id"`
|
|
ParentId string `json:",omitempty"` // nolint
|
|
RepoTags []string `json:",omitempty"`
|
|
Created time.Time `json:",omitempty"`
|
|
Size int64 `json:",omitempty"`
|
|
SharedSize int `json:",omitempty"`
|
|
VirtualSize int64 `json:",omitempty"`
|
|
Labels map[string]string `json:",omitempty"`
|
|
Containers int `json:",omitempty"`
|
|
ReadOnly bool `json:",omitempty"`
|
|
Dangling bool `json:",omitempty"`
|
|
|
|
// Podman extensions
|
|
Names []string `json:",omitempty"`
|
|
Digest string `json:",omitempty"`
|
|
Digests []string `json:",omitempty"`
|
|
ConfigDigest string `json:",omitempty"`
|
|
History []string `json:",omitempty"`
|
|
}
|
|
|
|
func (i *ImageSummary) Id() string { //nolint
|
|
return i.ID
|
|
}
|
|
|
|
func (i *ImageSummary) IsReadOnly() bool {
|
|
return i.ReadOnly
|
|
}
|
|
|
|
func (i *ImageSummary) IsDangling() bool {
|
|
return i.Dangling
|
|
}
|
|
|
|
// ImageRemoveOptions can be used to alter image removal.
|
|
type ImageRemoveOptions struct {
|
|
// All will remove all images.
|
|
All bool
|
|
// Foce will force image removal including containers using the images.
|
|
Force bool
|
|
}
|
|
|
|
// ImageRemoveResponse is the response for removing one or more image(s) from storage
|
|
// and containers what was untagged vs actually removed.
|
|
type ImageRemoveReport struct {
|
|
// Deleted images.
|
|
Deleted []string `json:",omitempty"`
|
|
// Untagged images. Can be longer than Deleted.
|
|
Untagged []string `json:",omitempty"`
|
|
// ExitCode describes the exit codes as described in the `podman rmi`
|
|
// man page.
|
|
ExitCode int
|
|
}
|
|
|
|
type ImageHistoryOptions struct{}
|
|
|
|
type ImageHistoryLayer struct {
|
|
ID string `json:"id"`
|
|
Created time.Time `json:"created,omitempty"`
|
|
CreatedBy string `json:",omitempty"`
|
|
Tags []string `json:"tags,omitempty"`
|
|
Size int64 `json:"size"`
|
|
Comment string `json:"comment,omitempty"`
|
|
}
|
|
|
|
type ImageHistoryReport struct {
|
|
Layers []ImageHistoryLayer
|
|
}
|
|
|
|
// ImagePullOptions are the arguments for pulling images.
|
|
type ImagePullOptions struct {
|
|
// AllTags can be specified to pull all tags of the spiecifed image. Note
|
|
// that this only works if the specified image does not include a tag.
|
|
AllTags bool
|
|
// Authfile is the path to the authentication file. Ignored for remote
|
|
// calls.
|
|
Authfile string
|
|
// CertDir is the path to certificate directories. Ignored for remote
|
|
// calls.
|
|
CertDir string
|
|
// Username for authenticating against the registry.
|
|
Username string
|
|
// Password for authenticating against the registry.
|
|
Password string
|
|
// OverrideArch will overwrite the local architecture for image pulls.
|
|
OverrideArch string
|
|
// OverrideOS will overwrite the local operating system (OS) for image
|
|
// pulls.
|
|
OverrideOS string
|
|
// Quiet can be specified to suppress pull progress when pulling. Ignored
|
|
// for remote calls.
|
|
Quiet bool
|
|
// SignaturePolicy to use when pulling. Ignored for remote calls.
|
|
SignaturePolicy string
|
|
// SkipTLSVerify to skip HTTPS and certificate verification.
|
|
SkipTLSVerify types.OptionalBool
|
|
}
|
|
|
|
// ImagePullReport is the response from pulling one or more images.
|
|
type ImagePullReport struct {
|
|
Images []string
|
|
}
|
|
|
|
// ImagePushOptions are the arguments for pushing images.
|
|
type ImagePushOptions struct {
|
|
// Authfile is the path to the authentication file. Ignored for remote
|
|
// calls.
|
|
Authfile string
|
|
// CertDir is the path to certificate directories. Ignored for remote
|
|
// calls.
|
|
CertDir string
|
|
// Compress tarball image layers when pushing to a directory using the 'dir'
|
|
// transport. Default is same compression type as source. Ignored for remote
|
|
// calls.
|
|
Compress bool
|
|
// Username for authenticating against the registry.
|
|
Username string
|
|
// Password for authenticating against the registry.
|
|
Password string
|
|
// DigestFile, after copying the image, write the digest of the resulting
|
|
// image to the file. Ignored for remote calls.
|
|
DigestFile string
|
|
// Format is the Manifest type (oci, v2s1, or v2s2) to use when pushing an
|
|
// image using the 'dir' transport. Default is manifest type of source.
|
|
// Ignored for remote calls.
|
|
Format string
|
|
// Quiet can be specified to suppress pull progress when pulling. Ignored
|
|
// for remote calls.
|
|
Quiet bool
|
|
// RemoveSignatures, discard any pre-existing signatures in the image.
|
|
// Ignored for remote calls.
|
|
RemoveSignatures bool
|
|
// SignaturePolicy to use when pulling. Ignored for remote calls.
|
|
SignaturePolicy string
|
|
// SignBy adds a signature at the destination using the specified key.
|
|
// Ignored for remote calls.
|
|
SignBy string
|
|
// SkipTLSVerify to skip HTTPS and certificate verification.
|
|
SkipTLSVerify types.OptionalBool
|
|
}
|
|
|
|
// ImageSearchOptions are the arguments for searching images.
|
|
type ImageSearchOptions struct {
|
|
// Authfile is the path to the authentication file. Ignored for remote
|
|
// calls.
|
|
Authfile string
|
|
// Filters for the search results.
|
|
Filters []string
|
|
// Limit the number of results.
|
|
Limit int
|
|
// NoTrunc will not truncate the output.
|
|
NoTrunc bool
|
|
// SkipTLSVerify to skip HTTPS and certificate verification.
|
|
SkipTLSVerify types.OptionalBool
|
|
}
|
|
|
|
// ImageSearchReport is the response from searching images.
|
|
type ImageSearchReport struct {
|
|
// Index is the image index (e.g., "docker.io" or "quay.io")
|
|
Index string
|
|
// Name is the canoncical name of the image (e.g., "docker.io/library/alpine").
|
|
Name string
|
|
// Description of the image.
|
|
Description string
|
|
// Stars is the number of stars of the image.
|
|
Stars int
|
|
// Official indicates if it's an official image.
|
|
Official string
|
|
// Automated indicates if the image was created by an automated build.
|
|
Automated string
|
|
}
|
|
|
|
// Image List Options
|
|
type ImageListOptions struct {
|
|
All bool `json:"all" schema:"all"`
|
|
Filter []string `json:"Filter,omitempty"`
|
|
}
|
|
|
|
type ImagePruneOptions struct {
|
|
All bool `json:"all" schema:"all"`
|
|
Filter []string `json:"filter" schema:"filter"`
|
|
}
|
|
|
|
type ImagePruneReport struct {
|
|
Report Report
|
|
Size int64
|
|
}
|
|
|
|
type ImageTagOptions struct{}
|
|
type ImageUntagOptions struct{}
|
|
|
|
// ImageInspectReport is the data when inspecting an image.
|
|
type ImageInspectReport struct {
|
|
*inspect.ImageData
|
|
}
|
|
|
|
type ImageLoadOptions struct {
|
|
Name string
|
|
Tag string
|
|
Input string
|
|
Quiet bool
|
|
SignaturePolicy string
|
|
}
|
|
|
|
type ImageLoadReport struct {
|
|
Names []string
|
|
}
|
|
|
|
type ImageImportOptions struct {
|
|
Changes []string
|
|
Message string
|
|
Quiet bool
|
|
Reference string
|
|
Source string
|
|
SourceIsURL bool
|
|
}
|
|
|
|
type ImageImportReport struct {
|
|
Id string //nolint
|
|
}
|
|
|
|
type ImageSaveOptions struct {
|
|
Compress bool
|
|
Format string
|
|
Output string
|
|
Quiet bool
|
|
}
|
|
|
|
// ImageTreeOptions provides options for ImageEngine.Tree()
|
|
type ImageTreeOptions struct {
|
|
WhatRequires bool // Show all child images and layers of the specified image
|
|
}
|
|
|
|
// ImageTreeReport provides results from ImageEngine.Tree()
|
|
type ImageTreeReport struct {
|
|
Tree string // TODO: Refactor move presentation work out of server
|
|
}
|
|
|
|
// ShowTrustOptions are the cli options for showing trust
|
|
type ShowTrustOptions struct {
|
|
JSON bool
|
|
PolicyPath string
|
|
Raw bool
|
|
RegistryPath string
|
|
}
|
|
|
|
// ShowTrustReport describes the results of show trust
|
|
type ShowTrustReport struct {
|
|
Raw []byte
|
|
SystemRegistriesDirPath string
|
|
JSONOutput []byte
|
|
Policies []*trust.Policy
|
|
}
|
|
|
|
// SetTrustOptions describes the CLI options for setting trust
|
|
type SetTrustOptions struct {
|
|
PolicyPath string
|
|
PubKeysFile []string
|
|
Type string
|
|
}
|
|
|
|
// SignOptions describes input options for the CLI signing
|
|
type SignOptions struct {
|
|
Directory string
|
|
SignBy string
|
|
CertDir string
|
|
}
|
|
|
|
// SignReport describes the result of signing
|
|
type SignReport struct{}
|