Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var ( ErrUnsupportedQuadletType = fmt.Errorf("unsupported quadlet type") ErrNonQuadletType = fmt.Errorf("non quadlet type") )
View Source
var ( SupportedQuadletExtensions = map[string]struct{}{ quadlet.ContainerExtension: {}, quadlet.VolumeExtension: {}, quadlet.NetworkExtension: {}, quadlet.ImageExtension: {}, quadlet.PodExtension: {}, } UnsupportedQuadletExtensions = map[string]struct{}{ quadlet.BuildExtension: {}, quadlet.ArtifactExtension: {}, quadlet.KubeExtension: {}, } UnsupportedQuadletSections = map[string]struct{}{ quadlet.BuildGroup: {}, quadlet.ArtifactGroup: {}, quadlet.KubeGroup: {}, } )
Functions ¶
This section is empty.
Types ¶
type ComposeService ¶
type ComposeService struct {
Image string `json:"image"`
ContainerName string `json:"container_name,omitempty"`
Volumes []string `json:"volumes,omitempty"`
}
ComposeService represents a service in a Docker Compose specification.
type ComposeSpec ¶
type ComposeSpec struct {
Services map[string]ComposeService `json:"services,omitempty"`
Volumes map[string]ComposeVolume `json:"volumes,omitempty"`
}
ComposeSpec represents a Docker Compose specification.
func ParseComposeSpec ¶
func ParseComposeSpec(data []byte) (*ComposeSpec, error)
ParseComposeSpec parses YAML data into a ComposeSpec
type ComposeVolume ¶ added in v0.8.1
type ComposeVolume struct {
External bool `json:"external,omitempty"`
}
type QuadletReferences ¶ added in v1.0.0
type QuadletReferences struct {
// Type defines The quadlet type
Type QuadletType
// Image defines the Image associated with the quadlet. This can be an OCI image or a reference to an Image quadlet
Image *string
// MountImages defines a list images associated with the quadlet through mechanisms such as mounts.
// These can be OCI images or references to Image quadlets
MountImages []string
// The Name of the quadlet if the default will be overwritten
Name *string
}
QuadletReferences represents a parsed Quadlet file's external references.
func ParseQuadletReferences ¶ added in v1.0.0
func ParseQuadletReferences(data []byte) (*QuadletReferences, error)
ParseQuadletReferences parses unit file data into a QuadletSpec
type QuadletType ¶ added in v1.0.0
type QuadletType string
QuadletType represents the type of Quadlet unit file.
const ( QuadletTypeContainer QuadletType = "container" QuadletTypeVolume QuadletType = "volume" QuadletTypeNetwork QuadletType = "network" QuadletTypeImage QuadletType = "image" QuadletTypePod QuadletType = "pod" )
Source Files
Click to show internal directories.
Click to hide internal directories.