volumespec

package
v29.0.2+incompatible Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 17, 2025 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type BindOpts

type BindOpts struct {
	Propagation string `yaml:",omitempty" json:"propagation,omitempty"`
}

BindOpts are options for a service volume of type bind

type ClusterOpts

type ClusterOpts struct{}

ClusterOpts are options for a service volume of type cluster. Deliberately left blank for future options, but unused now.

type ImageOpts

type ImageOpts struct {
	Subpath string `mapstructure:"subpath" yaml:"subpath,omitempty" json:"subpath,omitempty"`
}

ImageOpts are options for a service volume of type image

type TmpFsOpts

type TmpFsOpts struct {
	Size int64 `yaml:",omitempty" json:"size,omitempty"`
}

TmpFsOpts are options for a service volume of type tmpfs

type VolumeConfig

type VolumeConfig struct {
	Type        string       `yaml:",omitempty" json:"type,omitempty"`
	Source      string       `yaml:",omitempty" json:"source,omitempty"`
	Target      string       `yaml:",omitempty" json:"target,omitempty"`
	ReadOnly    bool         `mapstructure:"read_only" yaml:"read_only,omitempty" json:"read_only,omitempty"`
	Consistency string       `yaml:",omitempty" json:"consistency,omitempty"`
	Bind        *BindOpts    `yaml:",omitempty" json:"bind,omitempty"`
	Volume      *VolumeOpts  `yaml:",omitempty" json:"volume,omitempty"`
	Image       *ImageOpts   `yaml:",omitempty" json:"image,omitempty"`
	Tmpfs       *TmpFsOpts   `yaml:",omitempty" json:"tmpfs,omitempty"`
	Cluster     *ClusterOpts `yaml:",omitempty" json:"cluster,omitempty"`
}

VolumeConfig are references to a volume used by a service

func Parse

func Parse(spec string) (VolumeConfig, error)

Parse parses a volume spec without any knowledge of the target platform

type VolumeOpts

type VolumeOpts struct {
	NoCopy  bool   `mapstructure:"nocopy" yaml:"nocopy,omitempty" json:"nocopy,omitempty"`
	Subpath string `mapstructure:"subpath" yaml:"subpath,omitempty" json:"subpath,omitempty"`
}

VolumeOpts are options for a service volume of type volume

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL