Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var InterfaceSpec = spi.InterfaceSpec{
Name: "Group",
Version: "0.1.0",
}
InterfaceSpec is the current name and version of the Group API.
Functions ¶
This section is empty.
Types ¶
type Description ¶
type Description struct {
Instances []instance.Description
Converged bool
}
Description is a placeholder for the reported state of a Group.
type Plugin ¶
type Plugin interface {
CommitGroup(grp Spec, pretend bool) (string, error)
FreeGroup(id ID) error
DescribeGroup(id ID) (Description, error)
DestroyGroup(id ID) error
InspectGroups() ([]Spec, error)
}
Plugin defines the functions for a Group plugin.
type Spec ¶
type Spec struct {
// ID is the unique identifier for the group.
ID ID
// Properties is the configuration for the group.
// The schema for the raw JSON can be found as the *.Spec of the plugin used.
// For instance, if the default group plugin is used, the value here will be
// a JSON representation of github.com/docker/infrakit/plugin/group/types.Spec
Properties *json.RawMessage
}
Spec is the specification for a Group. The full schema for a Group is defined by the plugin. In general, a Spec of an entity is set as the raw JSON value of another object's Properties.
Source Files
Click to show internal directories.
Click to hide internal directories.