4f0d95fa |
package plugin // import "github.com/docker/docker/plugin" |
f3711704 |
import ( |
d7ba1f85 |
"context" |
f3711704 |
"encoding/json"
"io" |
3d86b0c7 |
"io/ioutil" |
f3711704 |
"os"
"path/filepath" |
3d86b0c7 |
"reflect"
"regexp" |
dafeeac4 |
"sort" |
c54b717c |
"strings" |
f3711704 |
"sync"
|
d7ba1f85 |
"github.com/containerd/containerd/content"
"github.com/containerd/containerd/content/local" |
0421f517 |
"github.com/docker/distribution/reference" |
3d86b0c7 |
"github.com/docker/docker/api/types" |
38de272b |
"github.com/docker/docker/pkg/authorization" |
3d86b0c7 |
"github.com/docker/docker/pkg/ioutils" |
72c3bcf2 |
"github.com/docker/docker/pkg/pubsub" |
42c5c1a9 |
"github.com/docker/docker/pkg/system" |
07ff4f1d |
v2 "github.com/docker/docker/plugin/v2" |
f3711704 |
"github.com/docker/docker/registry" |
07ff4f1d |
digest "github.com/opencontainers/go-digest"
specs "github.com/opencontainers/runtime-spec/specs-go" |
3d86b0c7 |
"github.com/pkg/errors" |
1009e6a4 |
"github.com/sirupsen/logrus" |
f3711704 |
)
|
3d86b0c7 |
const configFileName = "config.json"
const rootFSFileName = "rootfs"
var validFullID = regexp.MustCompile(`^([a-f0-9]{64})$`) |
f3711704 |
|
c85e8622 |
// Executor is the interface that the plugin manager uses to interact with for starting/stopping plugins
type Executor interface {
Create(id string, spec specs.Spec, stdout, stderr io.WriteCloser) error
IsRunning(id string) (bool, error) |
dbeb4329 |
Restore(id string, stdout, stderr io.WriteCloser) (alive bool, err error) |
c85e8622 |
Signal(id string, signal int) error
}
|
dbeb4329 |
func (pm *Manager) restorePlugin(p *v2.Plugin, c *controller) error { |
27a55fba |
if p.IsEnabled() { |
dbeb4329 |
return pm.restore(p, c) |
dfd91873 |
}
return nil
}
|
42abccb8 |
type eventLogger func(id, name, action string) |
f3711704 |
|
3d86b0c7 |
// ManagerConfig defines configuration needed to start new manager.
type ManagerConfig struct {
Store *Store // remove
RegistryService registry.Service
LiveRestoreEnabled bool // TODO: remove
LogPluginEvent eventLogger
Root string
ExecRoot string |
c85e8622 |
CreateExecutor ExecutorCreator |
38de272b |
AuthzMiddleware *authorization.Middleware |
3d86b0c7 |
}
|
c85e8622 |
// ExecutorCreator is used in the manager config to pass in an `Executor`
type ExecutorCreator func(*Manager) (Executor, error)
|
f3711704 |
// Manager controls the plugin subsystem.
type Manager struct { |
c85e8622 |
config ManagerConfig
mu sync.RWMutex // protects cMap
muGC sync.RWMutex // protects blobstore deletions
cMap map[*v2.Plugin]*controller |
d7ba1f85 |
blobStore content.Store |
c85e8622 |
publisher *pubsub.Publisher
executor Executor |
b35490a8 |
}
// controller represents the manager's control on a plugin.
type controller struct {
restart bool
exitChan chan bool
timeoutInSecs int |
f3711704 |
}
|
3d86b0c7 |
// pluginRegistryService ensures that all resolved repositories
// are of the plugin class.
type pluginRegistryService struct {
registry.Service |
f3711704 |
}
|
3d86b0c7 |
func (s pluginRegistryService) ResolveRepository(name reference.Named) (repoInfo *registry.RepositoryInfo, err error) {
repoInfo, err = s.Service.ResolveRepository(name)
if repoInfo != nil {
repoInfo.Class = "plugin" |
f3711704 |
} |
3d86b0c7 |
return
} |
f3711704 |
|
3d86b0c7 |
// NewManager returns a new plugin manager.
func NewManager(config ManagerConfig) (*Manager, error) {
if config.RegistryService != nil {
config.RegistryService = pluginRegistryService{config.RegistryService} |
f3711704 |
} |
3d86b0c7 |
manager := &Manager{
config: config, |
f3711704 |
} |
d75f1d84 |
for _, dirName := range []string{manager.config.Root, manager.config.ExecRoot, manager.tmpDir()} {
if err := os.MkdirAll(dirName, 0700); err != nil {
return nil, errors.Wrapf(err, "failed to mkdir %v", dirName)
} |
3d86b0c7 |
}
var err error |
c85e8622 |
manager.executor, err = config.CreateExecutor(manager) |
f3711704 |
if err != nil { |
c85e8622 |
return nil, err |
f3711704 |
} |
c85e8622 |
|
d7ba1f85 |
manager.blobStore, err = local.NewStore(filepath.Join(manager.config.Root, "storage")) |
3d86b0c7 |
if err != nil { |
d7ba1f85 |
return nil, errors.Wrap(err, "error creating plugin blob store") |
3d86b0c7 |
}
|
b35490a8 |
manager.cMap = make(map[*v2.Plugin]*controller) |
3d86b0c7 |
if err := manager.reload(); err != nil {
return nil, errors.Wrap(err, "failed to restore plugins")
} |
72c3bcf2 |
manager.publisher = pubsub.NewPublisher(0, 0) |
3d86b0c7 |
return manager, nil
}
func (pm *Manager) tmpDir() string {
return filepath.Join(pm.config.Root, "tmp") |
f3711704 |
}
|
c85e8622 |
// HandleExitEvent is called when the executor receives the exit event
// In the future we may change this, but for now all we care about is the exit event.
func (pm *Manager) HandleExitEvent(id string) error {
p, err := pm.config.Store.GetV2Plugin(id)
if err != nil {
return err
} |
b35490a8 |
|
73351673 |
if err := os.RemoveAll(filepath.Join(pm.config.ExecRoot, id)); err != nil { |
dbeb4329 |
logrus.WithError(err).WithField("id", id).Error("Could not remove plugin bundle dir")
} |
c54b717c |
|
c85e8622 |
pm.mu.RLock()
c := pm.cMap[p]
if c.exitChan != nil {
close(c.exitChan) |
dbeb4329 |
c.exitChan = nil // ignore duplicate events (containerd issue #2299) |
863ab9ab |
} |
c85e8622 |
restart := c.restart
pm.mu.RUnlock() |
863ab9ab |
|
c85e8622 |
if restart {
pm.enable(p, c, true) |
182795cf |
} else if err := recursiveUnmount(filepath.Join(pm.config.Root, id)); err != nil {
return errors.Wrap(err, "error cleaning up plugin mounts") |
c85e8622 |
} |
f3711704 |
return nil
}
|
11cf394e |
func handleLoadError(err error, id string) {
if err == nil {
return
}
logger := logrus.WithError(err).WithField("id", id) |
07d60bc2 |
if errors.Is(err, os.ErrNotExist) { |
11cf394e |
// Likely some error while removing on an older version of docker
logger.Warn("missing plugin config, skipping: this may be caused due to a failed remove and requires manual cleanup.")
return
}
logger.Error("error loading plugin, skipping")
}
|
3d86b0c7 |
func (pm *Manager) reload() error { // todo: restore
dir, err := ioutil.ReadDir(pm.config.Root) |
f3711704 |
if err != nil { |
3d86b0c7 |
return errors.Wrapf(err, "failed to read %v", pm.config.Root) |
f3711704 |
} |
27a55fba |
plugins := make(map[string]*v2.Plugin) |
3d86b0c7 |
for _, v := range dir {
if validFullID.MatchString(v.Name()) {
p, err := pm.loadPlugin(v.Name())
if err != nil { |
11cf394e |
handleLoadError(err, v.Name())
continue |
3d86b0c7 |
}
plugins[p.GetID()] = p |
11cf394e |
} else {
if validFullID.MatchString(strings.TrimSuffix(v.Name(), "-removing")) {
// There was likely some error while removing this plugin, let's try to remove again here
if err := system.EnsureRemoveAll(v.Name()); err != nil {
logrus.WithError(err).WithField("id", v.Name()).Warn("error while attempting to clean up previously removed plugin")
}
} |
3d86b0c7 |
} |
f3711704 |
}
|
3d86b0c7 |
pm.config.Store.SetAll(plugins)
var wg sync.WaitGroup
wg.Add(len(plugins)) |
27a55fba |
for _, p := range plugins { |
dbeb4329 |
c := &controller{exitChan: make(chan bool)}
pm.mu.Lock() |
b35490a8 |
pm.cMap[p] = c |
dbeb4329 |
pm.mu.Unlock()
|
27a55fba |
go func(p *v2.Plugin) { |
3d86b0c7 |
defer wg.Done() |
dbeb4329 |
if err := pm.restorePlugin(p, c); err != nil {
logrus.WithError(err).WithField("id", p.GetID()).Error("Failed to restore plugin") |
dfd91873 |
return
}
|
c54b717c |
if p.Rootfs != "" { |
3d86b0c7 |
p.Rootfs = filepath.Join(pm.config.Root, p.PluginObj.ID, "rootfs") |
c54b717c |
}
// We should only enable rootfs propagation for certain plugin types that need it.
for _, typ := range p.PluginObj.Config.Interface.Types { |
50021047 |
if (typ.Capability == "volumedriver" || typ.Capability == "graphdriver") && typ.Prefix == "docker" && strings.HasPrefix(typ.Version, "1.") { |
c54b717c |
if p.PluginObj.Config.PropagatedMount != "" { |
e8307b86 |
propRoot := filepath.Join(filepath.Dir(p.Rootfs), "propagated-mount")
// check if we need to migrate an older propagated mount from before
// these mounts were stored outside the plugin rootfs
if _, err := os.Stat(propRoot); os.IsNotExist(err) { |
a53930a0 |
rootfsProp := filepath.Join(p.Rootfs, p.PluginObj.Config.PropagatedMount)
if _, err := os.Stat(rootfsProp); err == nil {
if err := os.Rename(rootfsProp, propRoot); err != nil { |
e8307b86 |
logrus.WithError(err).WithField("dir", propRoot).Error("error migrating propagated mount storage")
}
}
}
if err := os.MkdirAll(propRoot, 0755); err != nil {
logrus.Errorf("failed to create PropagatedMount directory at %s: %v", propRoot, err)
} |
c54b717c |
}
}
}
|
3d86b0c7 |
pm.save(p)
requiresManualRestore := !pm.config.LiveRestoreEnabled && p.IsEnabled() |
dfd91873 |
if requiresManualRestore {
// if liveRestore is not enabled, the plugin will be stopped now so we should enable it |
b35490a8 |
if err := pm.enable(p, c, true); err != nil { |
dbeb4329 |
logrus.WithError(err).WithField("id", p.GetID()).Error("failed to enable plugin") |
dfd91873 |
}
}
}(p)
} |
3d86b0c7 |
wg.Wait() |
f3711704 |
return nil
}
|
72c3bcf2 |
// Get looks up the requested plugin in the store.
func (pm *Manager) Get(idOrName string) (*v2.Plugin, error) {
return pm.config.Store.GetV2Plugin(idOrName)
}
|
3d86b0c7 |
func (pm *Manager) loadPlugin(id string) (*v2.Plugin, error) {
p := filepath.Join(pm.config.Root, id, configFileName)
dt, err := ioutil.ReadFile(p)
if err != nil {
return nil, errors.Wrapf(err, "error reading %v", p)
}
var plugin v2.Plugin
if err := json.Unmarshal(dt, &plugin); err != nil {
return nil, errors.Wrapf(err, "error decoding %v", p)
}
return &plugin, nil
}
func (pm *Manager) save(p *v2.Plugin) error {
pluginJSON, err := json.Marshal(p)
if err != nil {
return errors.Wrap(err, "failed to marshal plugin json")
}
if err := ioutils.AtomicWriteFile(filepath.Join(pm.config.Root, p.GetID(), configFileName), pluginJSON, 0600); err != nil { |
26d0bac8 |
return errors.Wrap(err, "failed to write atomically plugin json") |
3d86b0c7 |
}
return nil
}
|
39bcaee4 |
// GC cleans up unreferenced blobs. This is recommended to run in a goroutine |
3d86b0c7 |
func (pm *Manager) GC() {
pm.muGC.Lock()
defer pm.muGC.Unlock()
|
3895dd58 |
used := make(map[digest.Digest]struct{}) |
3d86b0c7 |
for _, p := range pm.config.Store.GetAll() { |
3895dd58 |
used[p.Config] = struct{}{} |
3d86b0c7 |
for _, b := range p.Blobsums { |
3895dd58 |
used[b] = struct{}{} |
3d86b0c7 |
}
}
|
d7ba1f85 |
ctx := context.TODO()
pm.blobStore.Walk(ctx, func(info content.Info) error { |
3895dd58 |
_, ok := used[info.Digest] |
d7ba1f85 |
if ok {
return nil
}
return pm.blobStore.Delete(ctx, info.Digest)
}) |
3d86b0c7 |
}
|
f3711704 |
type logHook struct{ id string }
func (logHook) Levels() []logrus.Level {
return logrus.AllLevels
}
func (l logHook) Fire(entry *logrus.Entry) error {
entry.Data = logrus.Fields{"plugin": l.id}
return nil
} |
37a3be24 |
|
c85e8622 |
func makeLoggerStreams(id string) (stdout, stderr io.WriteCloser) {
logger := logrus.New()
logger.Hooks.Add(logHook{id})
return logger.WriterLevel(logrus.InfoLevel), logger.WriterLevel(logrus.ErrorLevel) |
37a3be24 |
} |
3d86b0c7 |
func validatePrivileges(requiredPrivileges, privileges types.PluginPrivileges) error { |
dafeeac4 |
if !isEqual(requiredPrivileges, privileges, isEqualPrivilege) { |
3d86b0c7 |
return errors.New("incorrect privileges")
} |
dafeeac4 |
|
3d86b0c7 |
return nil
}
|
dafeeac4 |
func isEqual(arrOne, arrOther types.PluginPrivileges, compare func(x, y types.PluginPrivilege) bool) bool {
if len(arrOne) != len(arrOther) {
return false
}
sort.Sort(arrOne)
sort.Sort(arrOther)
for i := 1; i < arrOne.Len(); i++ {
if !compare(arrOne[i], arrOther[i]) {
return false
}
}
return true
}
func isEqualPrivilege(a, b types.PluginPrivilege) bool {
if a.Name != b.Name {
return false
}
return reflect.DeepEqual(a.Value, b.Value)
} |