backend.go 3.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136
  1. package build // import "github.com/docker/docker/api/server/backend/build"
  2. import (
  3. "context"
  4. "fmt"
  5. "strings"
  6. "github.com/docker/distribution/reference"
  7. "github.com/docker/docker/api/types"
  8. "github.com/docker/docker/api/types/backend"
  9. "github.com/docker/docker/builder"
  10. buildkit "github.com/docker/docker/builder/builder-next"
  11. "github.com/docker/docker/builder/fscache"
  12. "github.com/docker/docker/image"
  13. "github.com/docker/docker/pkg/stringid"
  14. "github.com/pkg/errors"
  15. "golang.org/x/sync/errgroup"
  16. )
  17. // ImageComponent provides an interface for working with images
  18. type ImageComponent interface {
  19. SquashImage(from string, to string) (string, error)
  20. TagImageWithReference(image.ID, reference.Named) error
  21. }
  22. // Builder defines interface for running a build
  23. type Builder interface {
  24. Build(context.Context, backend.BuildConfig) (*builder.Result, error)
  25. }
  26. // Backend provides build functionality to the API router
  27. type Backend struct {
  28. builder Builder
  29. fsCache *fscache.FSCache
  30. imageComponent ImageComponent
  31. buildkit *buildkit.Builder
  32. }
  33. // NewBackend creates a new build backend from components
  34. func NewBackend(components ImageComponent, builder Builder, fsCache *fscache.FSCache, buildkit *buildkit.Builder) (*Backend, error) {
  35. return &Backend{imageComponent: components, builder: builder, fsCache: fsCache, buildkit: buildkit}, nil
  36. }
  37. // Build builds an image from a Source
  38. func (b *Backend) Build(ctx context.Context, config backend.BuildConfig) (string, error) {
  39. options := config.Options
  40. useBuildKit := false
  41. if strings.HasPrefix(options.SessionID, "buildkit:") {
  42. useBuildKit = true
  43. options.SessionID = strings.TrimPrefix(options.SessionID, "buildkit:")
  44. }
  45. tagger, err := NewTagger(b.imageComponent, config.ProgressWriter.StdoutFormatter, options.Tags)
  46. if err != nil {
  47. return "", err
  48. }
  49. var build *builder.Result
  50. if useBuildKit {
  51. build, err = b.buildkit.Build(ctx, config)
  52. if err != nil {
  53. return "", err
  54. }
  55. } else {
  56. build, err = b.builder.Build(ctx, config)
  57. if err != nil {
  58. return "", err
  59. }
  60. }
  61. var imageID = build.ImageID
  62. if options.Squash {
  63. if imageID, err = squashBuild(build, b.imageComponent); err != nil {
  64. return "", err
  65. }
  66. if config.ProgressWriter.AuxFormatter != nil {
  67. if err = config.ProgressWriter.AuxFormatter.Emit(types.BuildResult{ID: imageID}); err != nil {
  68. return "", err
  69. }
  70. }
  71. }
  72. if !useBuildKit {
  73. stdout := config.ProgressWriter.StdoutFormatter
  74. fmt.Fprintf(stdout, "Successfully built %s\n", stringid.TruncateID(imageID))
  75. }
  76. err = tagger.TagImages(image.ID(imageID))
  77. return imageID, err
  78. }
  79. // PruneCache removes all cached build sources
  80. func (b *Backend) PruneCache(ctx context.Context) (*types.BuildCachePruneReport, error) {
  81. eg, ctx := errgroup.WithContext(ctx)
  82. var fsCacheSize uint64
  83. eg.Go(func() error {
  84. var err error
  85. fsCacheSize, err = b.fsCache.Prune(ctx)
  86. if err != nil {
  87. return errors.Wrap(err, "failed to prune fscache")
  88. }
  89. return nil
  90. })
  91. var buildCacheSize int64
  92. eg.Go(func() error {
  93. var err error
  94. buildCacheSize, err = b.buildkit.Prune(ctx)
  95. if err != nil {
  96. return errors.Wrap(err, "failed to prune build cache")
  97. }
  98. return nil
  99. })
  100. if err := eg.Wait(); err != nil {
  101. return nil, err
  102. }
  103. return &types.BuildCachePruneReport{SpaceReclaimed: fsCacheSize + uint64(buildCacheSize)}, nil
  104. }
  105. func (b *Backend) Cancel(ctx context.Context, id string) error {
  106. return b.buildkit.Cancel(ctx, id)
  107. }
  108. func squashBuild(build *builder.Result, imageComponent ImageComponent) (string, error) {
  109. var fromID string
  110. if build.FromImage != nil {
  111. fromID = build.FromImage.ImageID()
  112. }
  113. imageID, err := imageComponent.SquashImage(build.ImageID, fromID)
  114. if err != nil {
  115. return "", errors.Wrap(err, "error squashing image")
  116. }
  117. return imageID, nil
  118. }