options

Documentation

Index

• Constants
• Variables
• type BuildOptions
• type BuildRootfsOptions
• type CommitOptions
• type ConfigOptions
• type CopyOptions
• type EngineGlobalConfigurations
• type FromOptions
• type ImagesOptions
• type InspectOptions
• type JSONMount
• type LoadOptions
• type LoginOptions
• type LogoutOptions
• type ManifestAddOpts
• type ManifestCreateOpts
• type ManifestDeleteOpts
• type ManifestInspectOpts
• type ManifestRemoveOpts
• type MountOptions
• type PullOptions
• type PushOptions
• type RemoveContainerOptions
• type RemoveImageOptions
• type SaveOptions
• type TagOptions

Constants

const (
	WithLiteMode = "lite"
	WithAllMode  = "all"
)

Variables

var SupportedBuildModes = []string{
	WithLiteMode,
	WithAllMode,
}

Types

type BuildOptions

type BuildOptions struct {
	Kubefile       string
	DockerFilePath string
	ContextDir     string
	PullPolicy     string
	ImageType      string
	//Manifest          string
	Tag               string
	BuildArgs         []string
	Platforms         []string
	Labels            []string
	Annotations       []string
	NoCache           bool
	Base              bool
	ImageList         string
	ImageListWithAuth string
	IgnoredImageList  string

	//BuildMode means whether to download container image during the build process
	// default value is download all container images.
	BuildMode string
}

BuildOptions should be out of buildah scope.

type BuildRootfsOptions

type BuildRootfsOptions struct {
	ImageNameOrID string
	DestDir       string
}

type CommitOptions

type CommitOptions struct {
	Format             string
	Manifest           string
	Timestamp          int64
	Quiet              bool
	Rm                 bool
	Squash             bool
	DisableCompression bool
	ContainerID        string
	Image              string
}

type ConfigOptions

type ConfigOptions struct {
	ContainerID string
	Annotations []string
}

type CopyOptions

type CopyOptions struct {
	AddHistory bool
	Quiet      bool
	IgnoreFile string
	ContextDir string
	Container  string
	// paths of files relative to context dir.
	SourcesRel2CxtDir      []string
	DestinationInContainer string
}

type EngineGlobalConfigurations

type EngineGlobalConfigurations struct {
	AuthFile  string
	GraphRoot string
	RunRoot   string
}

type FromOptions

type FromOptions struct {
	Image string
	Quiet bool
}

type ImagesOptions

type ImagesOptions struct {
	All       bool
	Digests   bool
	NoHeading bool
	NoTrunc   bool
	Quiet     bool
	History   bool
	JSON      bool
}

type InspectOptions

type InspectOptions struct {
	Format        string
	InspectType   string
	ImageNameOrID string
}

type JSONMount

type JSONMount struct {
	Container  string `json:"container,omitempty"`
	MountPoint string `json:"mountPoint"`
}

type LoadOptions

type LoadOptions struct {
	Input  string
	TmpDir string
	Quiet  bool
}

type LoginOptions

type LoginOptions struct {
	Domain        string
	Username      string
	Password      string
	SkipTLSVerify bool
}

type LogoutOptions

type LogoutOptions struct {
	All    bool
	Domain string
}

type ManifestAddOpts

type ManifestAddOpts struct {
	Os          string
	Arch        string
	Variant     string
	OsVersion   string
	OsFeatures  []string
	Annotations []string
	All         bool
	TargetName  string
}

type ManifestCreateOpts

type ManifestCreateOpts struct {
}

type ManifestDeleteOpts

type ManifestDeleteOpts struct {
}

type ManifestInspectOpts

type ManifestInspectOpts struct {
}

type ManifestRemoveOpts

type ManifestRemoveOpts struct {
}

type MountOptions

type MountOptions struct {
	//Json bool
	Containers []string
}

type PullOptions

type PullOptions struct {
	CertDir       string
	Quiet         bool
	SkipTLSVerify bool
	PullPolicy    string
	Image         string
	Platform      string
}

type PushOptions

type PushOptions struct {
	Authfile      string
	CertDir       string
	Format        string
	Image         string
	Destination   string
	Rm            bool
	Quiet         bool
	SkipTLSVerify bool
	All           bool
}

type RemoveContainerOptions

type RemoveContainerOptions struct {
	ContainerNamesOrIDs []string
	All                 bool
}

type RemoveImageOptions

type RemoveImageOptions struct {
	ImageNamesOrIDs []string
	Force           bool
	Prune           bool
}

type SaveOptions

type SaveOptions struct {
	Compress bool
	Format   string
	// don't support currently
	MultiImageArchive bool
	Output            string
	Quiet             bool
	ImageNameOrID     string
	TmpDir            string
}

type TagOptions

type TagOptions struct {
	ImageNameOrID string
	Tags          []string
}