manager_linux.go 7.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284
  1. // +build linux
  2. package plugin
  3. import (
  4. "encoding/json"
  5. "fmt"
  6. "os"
  7. "path/filepath"
  8. "syscall"
  9. "time"
  10. "github.com/Sirupsen/logrus"
  11. "github.com/docker/docker/api/types"
  12. "github.com/docker/docker/daemon/initlayer"
  13. "github.com/docker/docker/libcontainerd"
  14. "github.com/docker/docker/pkg/mount"
  15. "github.com/docker/docker/pkg/plugins"
  16. "github.com/docker/docker/pkg/stringid"
  17. "github.com/docker/docker/plugin/v2"
  18. "github.com/opencontainers/go-digest"
  19. specs "github.com/opencontainers/runtime-spec/specs-go"
  20. "github.com/pkg/errors"
  21. )
  22. func (pm *Manager) enable(p *v2.Plugin, c *controller, force bool) error {
  23. p.Rootfs = filepath.Join(pm.config.Root, p.PluginObj.ID, "rootfs")
  24. if p.IsEnabled() && !force {
  25. return fmt.Errorf("plugin %s is already enabled", p.Name())
  26. }
  27. spec, err := p.InitSpec(pm.config.ExecRoot)
  28. if err != nil {
  29. return err
  30. }
  31. c.restart = true
  32. c.exitChan = make(chan bool)
  33. pm.mu.Lock()
  34. pm.cMap[p] = c
  35. pm.mu.Unlock()
  36. var propRoot string
  37. if p.PropagatedMount != "" {
  38. propRoot = filepath.Join(filepath.Dir(p.Rootfs), "propagated-mount")
  39. if err := os.MkdirAll(propRoot, 0755); err != nil {
  40. logrus.Errorf("failed to create PropagatedMount directory at %s: %v", propRoot, err)
  41. }
  42. if err := mount.MakeRShared(propRoot); err != nil {
  43. return errors.Wrap(err, "error setting up propagated mount dir")
  44. }
  45. if err := mount.Mount(propRoot, p.PropagatedMount, "none", "rbind"); err != nil {
  46. return errors.Wrap(err, "error creating mount for propagated mount")
  47. }
  48. }
  49. if err := initlayer.Setup(filepath.Join(pm.config.Root, p.PluginObj.ID, rootFSFileName), 0, 0); err != nil {
  50. return errors.WithStack(err)
  51. }
  52. if err := pm.containerdClient.Create(p.GetID(), "", "", specs.Spec(*spec), attachToLog(p.GetID())); err != nil {
  53. if p.PropagatedMount != "" {
  54. if err := mount.Unmount(p.PropagatedMount); err != nil {
  55. logrus.Warnf("Could not unmount %s: %v", p.PropagatedMount, err)
  56. }
  57. if err := mount.Unmount(propRoot); err != nil {
  58. logrus.Warnf("Could not unmount %s: %v", propRoot, err)
  59. }
  60. }
  61. return errors.WithStack(err)
  62. }
  63. return pm.pluginPostStart(p, c)
  64. }
  65. func (pm *Manager) pluginPostStart(p *v2.Plugin, c *controller) error {
  66. client, err := plugins.NewClientWithTimeout("unix://"+filepath.Join(pm.config.ExecRoot, p.GetID(), p.GetSocket()), nil, c.timeoutInSecs)
  67. if err != nil {
  68. c.restart = false
  69. shutdownPlugin(p, c, pm.containerdClient)
  70. return errors.WithStack(err)
  71. }
  72. p.SetPClient(client)
  73. pm.config.Store.SetState(p, true)
  74. pm.config.Store.CallHandler(p)
  75. return pm.save(p)
  76. }
  77. func (pm *Manager) restore(p *v2.Plugin) error {
  78. if err := pm.containerdClient.Restore(p.GetID(), attachToLog(p.GetID())); err != nil {
  79. return err
  80. }
  81. if pm.config.LiveRestoreEnabled {
  82. c := &controller{}
  83. if pids, _ := pm.containerdClient.GetPidsForContainer(p.GetID()); len(pids) == 0 {
  84. // plugin is not running, so follow normal startup procedure
  85. return pm.enable(p, c, true)
  86. }
  87. c.exitChan = make(chan bool)
  88. c.restart = true
  89. pm.mu.Lock()
  90. pm.cMap[p] = c
  91. pm.mu.Unlock()
  92. return pm.pluginPostStart(p, c)
  93. }
  94. return nil
  95. }
  96. func shutdownPlugin(p *v2.Plugin, c *controller, containerdClient libcontainerd.Client) {
  97. pluginID := p.GetID()
  98. err := containerdClient.Signal(pluginID, int(syscall.SIGTERM))
  99. if err != nil {
  100. logrus.Errorf("Sending SIGTERM to plugin failed with error: %v", err)
  101. } else {
  102. select {
  103. case <-c.exitChan:
  104. logrus.Debug("Clean shutdown of plugin")
  105. case <-time.After(time.Second * 10):
  106. logrus.Debug("Force shutdown plugin")
  107. if err := containerdClient.Signal(pluginID, int(syscall.SIGKILL)); err != nil {
  108. logrus.Errorf("Sending SIGKILL to plugin failed with error: %v", err)
  109. }
  110. }
  111. }
  112. }
  113. func (pm *Manager) disable(p *v2.Plugin, c *controller) error {
  114. if !p.IsEnabled() {
  115. return fmt.Errorf("plugin %s is already disabled", p.Name())
  116. }
  117. c.restart = false
  118. shutdownPlugin(p, c, pm.containerdClient)
  119. pm.config.Store.SetState(p, false)
  120. return pm.save(p)
  121. }
  122. // Shutdown stops all plugins and called during daemon shutdown.
  123. func (pm *Manager) Shutdown() {
  124. plugins := pm.config.Store.GetAll()
  125. for _, p := range plugins {
  126. pm.mu.RLock()
  127. c := pm.cMap[p]
  128. pm.mu.RUnlock()
  129. if pm.config.LiveRestoreEnabled && p.IsEnabled() {
  130. logrus.Debug("Plugin active when liveRestore is set, skipping shutdown")
  131. continue
  132. }
  133. if pm.containerdClient != nil && p.IsEnabled() {
  134. c.restart = false
  135. shutdownPlugin(p, c, pm.containerdClient)
  136. }
  137. }
  138. }
  139. func (pm *Manager) upgradePlugin(p *v2.Plugin, configDigest digest.Digest, blobsums []digest.Digest, tmpRootFSDir string, privileges *types.PluginPrivileges) (err error) {
  140. config, err := pm.setupNewPlugin(configDigest, blobsums, privileges)
  141. if err != nil {
  142. return err
  143. }
  144. pdir := filepath.Join(pm.config.Root, p.PluginObj.ID)
  145. orig := filepath.Join(pdir, "rootfs")
  146. backup := orig + "-old"
  147. if err := os.Rename(orig, backup); err != nil {
  148. return err
  149. }
  150. defer func() {
  151. if err != nil {
  152. if rmErr := os.RemoveAll(orig); rmErr != nil && !os.IsNotExist(rmErr) {
  153. logrus.WithError(rmErr).WithField("dir", backup).Error("error cleaning up after failed upgrade")
  154. return
  155. }
  156. if err := os.Rename(backup, orig); err != nil {
  157. err = errors.Wrap(err, "error restoring old plugin root on upgrade failure")
  158. }
  159. if rmErr := os.RemoveAll(tmpRootFSDir); rmErr != nil && !os.IsNotExist(rmErr) {
  160. logrus.WithError(rmErr).WithField("plugin", p.Name()).Errorf("error cleaning up plugin upgrade dir: %s", tmpRootFSDir)
  161. }
  162. } else {
  163. if rmErr := os.RemoveAll(backup); rmErr != nil && !os.IsNotExist(rmErr) {
  164. logrus.WithError(rmErr).WithField("dir", backup).Error("error cleaning up old plugin root after successful upgrade")
  165. }
  166. p.Config = configDigest
  167. p.Blobsums = blobsums
  168. }
  169. }()
  170. if err := os.Rename(tmpRootFSDir, orig); err != nil {
  171. return errors.Wrap(err, "error upgrading")
  172. }
  173. p.PluginObj.Config = config
  174. err = pm.save(p)
  175. return errors.Wrap(err, "error saving upgraded plugin config")
  176. }
  177. func (pm *Manager) setupNewPlugin(configDigest digest.Digest, blobsums []digest.Digest, privileges *types.PluginPrivileges) (types.PluginConfig, error) {
  178. configRC, err := pm.blobStore.Get(configDigest)
  179. if err != nil {
  180. return types.PluginConfig{}, err
  181. }
  182. defer configRC.Close()
  183. var config types.PluginConfig
  184. dec := json.NewDecoder(configRC)
  185. if err := dec.Decode(&config); err != nil {
  186. return types.PluginConfig{}, errors.Wrapf(err, "failed to parse config")
  187. }
  188. if dec.More() {
  189. return types.PluginConfig{}, errors.New("invalid config json")
  190. }
  191. requiredPrivileges, err := computePrivileges(config)
  192. if err != nil {
  193. return types.PluginConfig{}, err
  194. }
  195. if privileges != nil {
  196. if err := validatePrivileges(requiredPrivileges, *privileges); err != nil {
  197. return types.PluginConfig{}, err
  198. }
  199. }
  200. return config, nil
  201. }
  202. // createPlugin creates a new plugin. take lock before calling.
  203. func (pm *Manager) createPlugin(name string, configDigest digest.Digest, blobsums []digest.Digest, rootFSDir string, privileges *types.PluginPrivileges) (p *v2.Plugin, err error) {
  204. if err := pm.config.Store.validateName(name); err != nil { // todo: this check is wrong. remove store
  205. return nil, err
  206. }
  207. config, err := pm.setupNewPlugin(configDigest, blobsums, privileges)
  208. if err != nil {
  209. return nil, err
  210. }
  211. p = &v2.Plugin{
  212. PluginObj: types.Plugin{
  213. Name: name,
  214. ID: stringid.GenerateRandomID(),
  215. Config: config,
  216. },
  217. Config: configDigest,
  218. Blobsums: blobsums,
  219. }
  220. p.InitEmptySettings()
  221. pdir := filepath.Join(pm.config.Root, p.PluginObj.ID)
  222. if err := os.MkdirAll(pdir, 0700); err != nil {
  223. return nil, errors.Wrapf(err, "failed to mkdir %v", pdir)
  224. }
  225. defer func() {
  226. if err != nil {
  227. os.RemoveAll(pdir)
  228. }
  229. }()
  230. if err := os.Rename(rootFSDir, filepath.Join(pdir, rootFSFileName)); err != nil {
  231. return nil, errors.Wrap(err, "failed to rename rootfs")
  232. }
  233. if err := pm.save(p); err != nil {
  234. return nil, err
  235. }
  236. pm.config.Store.Add(p) // todo: remove
  237. return p, nil
  238. }