convergence.go 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858
  1. /*
  2. Copyright 2020 Docker Compose CLI authors
  3. Licensed under the Apache License, Version 2.0 (the "License");
  4. you may not use this file except in compliance with the License.
  5. You may obtain a copy of the License at
  6. http://www.apache.org/licenses/LICENSE-2.0
  7. Unless required by applicable law or agreed to in writing, software
  8. distributed under the License is distributed on an "AS IS" BASIS,
  9. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  10. See the License for the specific language governing permissions and
  11. limitations under the License.
  12. */
  13. package compose
  14. import (
  15. "context"
  16. "errors"
  17. "fmt"
  18. "slices"
  19. "sort"
  20. "strconv"
  21. "strings"
  22. "sync"
  23. "time"
  24. "go.opentelemetry.io/otel/attribute"
  25. "go.opentelemetry.io/otel/trace"
  26. "github.com/compose-spec/compose-go/v2/types"
  27. "github.com/containerd/platforms"
  28. "github.com/docker/compose/v2/internal/tracing"
  29. moby "github.com/docker/docker/api/types"
  30. containerType "github.com/docker/docker/api/types/container"
  31. "github.com/docker/docker/api/types/versions"
  32. specs "github.com/opencontainers/image-spec/specs-go/v1"
  33. "github.com/sirupsen/logrus"
  34. "golang.org/x/sync/errgroup"
  35. "github.com/docker/compose/v2/pkg/api"
  36. "github.com/docker/compose/v2/pkg/progress"
  37. "github.com/docker/compose/v2/pkg/utils"
  38. )
  39. const (
  40. doubledContainerNameWarning = "WARNING: The %q service is using the custom container name %q. " +
  41. "Docker requires each container to have a unique name. " +
  42. "Remove the custom name to scale the service.\n"
  43. )
  44. // convergence manages service's container lifecycle.
  45. // Based on initially observed state, it reconciles the existing container with desired state, which might include
  46. // re-creating container, adding or removing replicas, or starting stopped containers.
  47. // Cross services dependencies are managed by creating services in expected order and updating `service:xx` reference
  48. // when a service has converged, so dependent ones can be managed with resolved containers references.
  49. type convergence struct {
  50. service *composeService
  51. services map[string]Containers
  52. networks map[string]string
  53. stateMutex sync.Mutex
  54. }
  55. func (c *convergence) getObservedState(serviceName string) Containers {
  56. c.stateMutex.Lock()
  57. defer c.stateMutex.Unlock()
  58. return c.services[serviceName]
  59. }
  60. func (c *convergence) setObservedState(serviceName string, containers Containers) {
  61. c.stateMutex.Lock()
  62. defer c.stateMutex.Unlock()
  63. c.services[serviceName] = containers
  64. }
  65. func newConvergence(services []string, state Containers, networks map[string]string, s *composeService) *convergence {
  66. observedState := map[string]Containers{}
  67. for _, s := range services {
  68. observedState[s] = Containers{}
  69. }
  70. for _, c := range state.filter(isNotOneOff) {
  71. service := c.Labels[api.ServiceLabel]
  72. observedState[service] = append(observedState[service], c)
  73. }
  74. return &convergence{
  75. service: s,
  76. services: observedState,
  77. networks: networks,
  78. }
  79. }
  80. func (c *convergence) apply(ctx context.Context, project *types.Project, options api.CreateOptions) error {
  81. return InDependencyOrder(ctx, project, func(ctx context.Context, name string) error {
  82. service, err := project.GetService(name)
  83. if err != nil {
  84. return err
  85. }
  86. return tracing.SpanWrapFunc("service/apply", tracing.ServiceOptions(service), func(ctx context.Context) error {
  87. strategy := options.RecreateDependencies
  88. if utils.StringContains(options.Services, name) {
  89. strategy = options.Recreate
  90. }
  91. return c.ensureService(ctx, project, service, strategy, options.Inherit, options.Timeout)
  92. })(ctx)
  93. })
  94. }
  95. func (c *convergence) ensureService(ctx context.Context, project *types.Project, service types.ServiceConfig, recreate string, inherit bool, timeout *time.Duration) error { //nolint:gocyclo
  96. expected, err := getScale(service)
  97. if err != nil {
  98. return err
  99. }
  100. containers := c.getObservedState(service.Name)
  101. actual := len(containers)
  102. updated := make(Containers, expected)
  103. eg, _ := errgroup.WithContext(ctx)
  104. err = c.resolveServiceReferences(&service)
  105. if err != nil {
  106. return err
  107. }
  108. sort.Slice(containers, func(i, j int) bool {
  109. // select obsolete containers first, so they get removed as we scale down
  110. if obsolete, _ := c.mustRecreate(service, containers[i], recreate); obsolete {
  111. // i is obsolete, so must be first in the list
  112. return true
  113. }
  114. if obsolete, _ := c.mustRecreate(service, containers[j], recreate); obsolete {
  115. // j is obsolete, so must be first in the list
  116. return false
  117. }
  118. // For up-to-date containers, sort by container number to preserve low-values in container numbers
  119. ni, erri := strconv.Atoi(containers[i].Labels[api.ContainerNumberLabel])
  120. nj, errj := strconv.Atoi(containers[j].Labels[api.ContainerNumberLabel])
  121. if erri == nil && errj == nil {
  122. return ni > nj
  123. }
  124. // If we don't get a container number (?) just sort by creation date
  125. return containers[i].Created < containers[j].Created
  126. })
  127. slices.Reverse(containers)
  128. for i, container := range containers {
  129. if i >= expected {
  130. // Scale Down
  131. // As we sorted containers, obsolete ones and/or highest number will be removed
  132. container := container
  133. traceOpts := append(tracing.ServiceOptions(service), tracing.ContainerOptions(container)...)
  134. eg.Go(tracing.SpanWrapFuncForErrGroup(ctx, "service/scale/down", traceOpts, func(ctx context.Context) error {
  135. return c.service.stopAndRemoveContainer(ctx, container, &service, timeout, false)
  136. }))
  137. continue
  138. }
  139. mustRecreate, err := c.mustRecreate(service, container, recreate)
  140. if err != nil {
  141. return err
  142. }
  143. if mustRecreate {
  144. err := c.stopDependentContainers(ctx, project, service)
  145. if err != nil {
  146. return err
  147. }
  148. i, container := i, container
  149. eg.Go(tracing.SpanWrapFuncForErrGroup(ctx, "container/recreate", tracing.ContainerOptions(container), func(ctx context.Context) error {
  150. recreated, err := c.service.recreateContainer(ctx, project, service, container, inherit, timeout)
  151. updated[i] = recreated
  152. return err
  153. }))
  154. continue
  155. }
  156. // Enforce non-diverged containers are running
  157. w := progress.ContextWriter(ctx)
  158. name := getContainerProgressName(container)
  159. switch container.State {
  160. case ContainerRunning:
  161. w.Event(progress.RunningEvent(name))
  162. case ContainerCreated:
  163. case ContainerRestarting:
  164. case ContainerExited:
  165. w.Event(progress.CreatedEvent(name))
  166. default:
  167. container := container
  168. eg.Go(tracing.EventWrapFuncForErrGroup(ctx, "service/start", tracing.ContainerOptions(container), func(ctx context.Context) error {
  169. return c.service.startContainer(ctx, container)
  170. }))
  171. }
  172. updated[i] = container
  173. }
  174. next := nextContainerNumber(containers)
  175. for i := 0; i < expected-actual; i++ {
  176. // Scale UP
  177. number := next + i
  178. name := getContainerName(project.Name, service, number)
  179. i := i
  180. eventOpts := tracing.SpanOptions{trace.WithAttributes(attribute.String("container.name", name))}
  181. eg.Go(tracing.EventWrapFuncForErrGroup(ctx, "service/scale/up", eventOpts, func(ctx context.Context) error {
  182. opts := createOptions{
  183. AutoRemove: false,
  184. AttachStdin: false,
  185. UseNetworkAliases: true,
  186. Labels: mergeLabels(service.Labels, service.CustomLabels),
  187. }
  188. container, err := c.service.createContainer(ctx, project, service, name, number, opts)
  189. updated[actual+i] = container
  190. return err
  191. }))
  192. continue
  193. }
  194. err = eg.Wait()
  195. c.setObservedState(service.Name, updated)
  196. return err
  197. }
  198. func (c *convergence) stopDependentContainers(ctx context.Context, project *types.Project, service types.ServiceConfig) error {
  199. // Stop dependent containers, so they will be restarted after service is re-created
  200. dependents := project.GetDependentsForService(service)
  201. err := c.service.stop(ctx, project.Name, api.StopOptions{
  202. Services: dependents,
  203. Project: project,
  204. })
  205. if err != nil {
  206. return err
  207. }
  208. for _, name := range dependents {
  209. dependents := c.getObservedState(name)
  210. for i, dependent := range dependents {
  211. dependent.State = ContainerExited
  212. dependents[i] = dependent
  213. }
  214. c.setObservedState(name, dependents)
  215. }
  216. return nil
  217. }
  218. func getScale(config types.ServiceConfig) (int, error) {
  219. scale := config.GetScale()
  220. if scale > 1 && config.ContainerName != "" {
  221. return 0, fmt.Errorf(doubledContainerNameWarning,
  222. config.Name,
  223. config.ContainerName)
  224. }
  225. return scale, nil
  226. }
  227. // resolveServiceReferences replaces reference to another service with reference to an actual container
  228. func (c *convergence) resolveServiceReferences(service *types.ServiceConfig) error {
  229. err := c.resolveVolumeFrom(service)
  230. if err != nil {
  231. return err
  232. }
  233. err = c.resolveSharedNamespaces(service)
  234. if err != nil {
  235. return err
  236. }
  237. return nil
  238. }
  239. func (c *convergence) resolveVolumeFrom(service *types.ServiceConfig) error {
  240. for i, vol := range service.VolumesFrom {
  241. spec := strings.Split(vol, ":")
  242. if len(spec) == 0 {
  243. continue
  244. }
  245. if spec[0] == "container" {
  246. service.VolumesFrom[i] = spec[1]
  247. continue
  248. }
  249. name := spec[0]
  250. dependencies := c.getObservedState(name)
  251. if len(dependencies) == 0 {
  252. return fmt.Errorf("cannot share volume with service %s: container missing", name)
  253. }
  254. service.VolumesFrom[i] = dependencies.sorted()[0].ID
  255. }
  256. return nil
  257. }
  258. func (c *convergence) resolveSharedNamespaces(service *types.ServiceConfig) error {
  259. str := service.NetworkMode
  260. if name := getDependentServiceFromMode(str); name != "" {
  261. dependencies := c.getObservedState(name)
  262. if len(dependencies) == 0 {
  263. return fmt.Errorf("cannot share network namespace with service %s: container missing", name)
  264. }
  265. service.NetworkMode = types.ContainerPrefix + dependencies.sorted()[0].ID
  266. }
  267. str = service.Ipc
  268. if name := getDependentServiceFromMode(str); name != "" {
  269. dependencies := c.getObservedState(name)
  270. if len(dependencies) == 0 {
  271. return fmt.Errorf("cannot share IPC namespace with service %s: container missing", name)
  272. }
  273. service.Ipc = types.ContainerPrefix + dependencies.sorted()[0].ID
  274. }
  275. str = service.Pid
  276. if name := getDependentServiceFromMode(str); name != "" {
  277. dependencies := c.getObservedState(name)
  278. if len(dependencies) == 0 {
  279. return fmt.Errorf("cannot share PID namespace with service %s: container missing", name)
  280. }
  281. service.Pid = types.ContainerPrefix + dependencies.sorted()[0].ID
  282. }
  283. return nil
  284. }
  285. func (c *convergence) mustRecreate(expected types.ServiceConfig, actual moby.Container, policy string) (bool, error) {
  286. if policy == api.RecreateNever {
  287. return false, nil
  288. }
  289. if policy == api.RecreateForce {
  290. return true, nil
  291. }
  292. configHash, err := ServiceHash(expected)
  293. if err != nil {
  294. return false, err
  295. }
  296. configChanged := actual.Labels[api.ConfigHashLabel] != configHash
  297. imageUpdated := actual.Labels[api.ImageDigestLabel] != expected.CustomLabels[api.ImageDigestLabel]
  298. if configChanged || imageUpdated {
  299. return true, nil
  300. }
  301. if c.networks != nil {
  302. // check the networks container is connected to are the expected ones
  303. for net := range expected.Networks {
  304. id := c.networks[net]
  305. if id == "swarm" {
  306. // corner-case : swarm overlay network isn't visible until a container is attached
  307. continue
  308. }
  309. found := false
  310. for _, settings := range actual.NetworkSettings.Networks {
  311. if settings.NetworkID == id {
  312. found = true
  313. break
  314. }
  315. }
  316. if !found {
  317. // config is up-to-date but container is not connected to network - maybe recreated ?
  318. return true, nil
  319. }
  320. }
  321. }
  322. return false, nil
  323. }
  324. func getContainerName(projectName string, service types.ServiceConfig, number int) string {
  325. name := getDefaultContainerName(projectName, service.Name, strconv.Itoa(number))
  326. if service.ContainerName != "" {
  327. name = service.ContainerName
  328. }
  329. return name
  330. }
  331. func getDefaultContainerName(projectName, serviceName, index string) string {
  332. return strings.Join([]string{projectName, serviceName, index}, api.Separator)
  333. }
  334. func getContainerProgressName(container moby.Container) string {
  335. return "Container " + getCanonicalContainerName(container)
  336. }
  337. func containerEvents(containers Containers, eventFunc func(string) progress.Event) []progress.Event {
  338. events := []progress.Event{}
  339. for _, container := range containers {
  340. events = append(events, eventFunc(getContainerProgressName(container)))
  341. }
  342. return events
  343. }
  344. func containerReasonEvents(containers Containers, eventFunc func(string, string) progress.Event, reason string) []progress.Event {
  345. events := []progress.Event{}
  346. for _, container := range containers {
  347. events = append(events, eventFunc(getContainerProgressName(container), reason))
  348. }
  349. return events
  350. }
  351. // ServiceConditionRunningOrHealthy is a service condition on status running or healthy
  352. const ServiceConditionRunningOrHealthy = "running_or_healthy"
  353. //nolint:gocyclo
  354. func (s *composeService) waitDependencies(ctx context.Context, project *types.Project, dependant string, dependencies types.DependsOnConfig, containers Containers, timeout time.Duration) error {
  355. if timeout > 0 {
  356. withTimeout, cancelFunc := context.WithTimeout(ctx, timeout)
  357. defer cancelFunc()
  358. ctx = withTimeout
  359. }
  360. eg, _ := errgroup.WithContext(ctx)
  361. w := progress.ContextWriter(ctx)
  362. for dep, config := range dependencies {
  363. if shouldWait, err := shouldWaitForDependency(dep, config, project); err != nil {
  364. return err
  365. } else if !shouldWait {
  366. continue
  367. }
  368. waitingFor := containers.filter(isService(dep))
  369. w.Events(containerEvents(waitingFor, progress.Waiting))
  370. if len(waitingFor) == 0 {
  371. if config.Required {
  372. return fmt.Errorf("%s is missing dependency %s", dependant, dep)
  373. }
  374. logrus.Warnf("%s is missing dependency %s", dependant, dep)
  375. continue
  376. }
  377. dep, config := dep, config
  378. eg.Go(func() error {
  379. ticker := time.NewTicker(500 * time.Millisecond)
  380. defer ticker.Stop()
  381. for {
  382. select {
  383. case <-ticker.C:
  384. case <-ctx.Done():
  385. return nil
  386. }
  387. switch config.Condition {
  388. case ServiceConditionRunningOrHealthy:
  389. healthy, err := s.isServiceHealthy(ctx, waitingFor, true)
  390. if err != nil {
  391. if !config.Required {
  392. w.Events(containerReasonEvents(waitingFor, progress.SkippedEvent, fmt.Sprintf("optional dependency %q is not running or is unhealthy", dep)))
  393. logrus.Warnf("optional dependency %q is not running or is unhealthy: %s", dep, err.Error())
  394. return nil
  395. }
  396. return err
  397. }
  398. if healthy {
  399. w.Events(containerEvents(waitingFor, progress.Healthy))
  400. return nil
  401. }
  402. case types.ServiceConditionHealthy:
  403. healthy, err := s.isServiceHealthy(ctx, waitingFor, false)
  404. if err != nil {
  405. if !config.Required {
  406. w.Events(containerReasonEvents(waitingFor, progress.SkippedEvent, fmt.Sprintf("optional dependency %q failed to start", dep)))
  407. logrus.Warnf("optional dependency %q failed to start: %s", dep, err.Error())
  408. return nil
  409. }
  410. w.Events(containerEvents(waitingFor, progress.ErrorEvent))
  411. return fmt.Errorf("dependency failed to start: %w", err)
  412. }
  413. if healthy {
  414. w.Events(containerEvents(waitingFor, progress.Healthy))
  415. return nil
  416. }
  417. case types.ServiceConditionCompletedSuccessfully:
  418. exited, code, err := s.isServiceCompleted(ctx, waitingFor)
  419. if err != nil {
  420. return err
  421. }
  422. if exited {
  423. if code == 0 {
  424. w.Events(containerEvents(waitingFor, progress.Exited))
  425. return nil
  426. }
  427. messageSuffix := fmt.Sprintf("%q didn't complete successfully: exit %d", dep, code)
  428. if !config.Required {
  429. // optional -> mark as skipped & don't propagate error
  430. w.Events(containerReasonEvents(waitingFor, progress.SkippedEvent, fmt.Sprintf("optional dependency %s", messageSuffix)))
  431. logrus.Warnf("optional dependency %s", messageSuffix)
  432. return nil
  433. }
  434. msg := fmt.Sprintf("service %s", messageSuffix)
  435. w.Events(containerReasonEvents(waitingFor, progress.ErrorMessageEvent, msg))
  436. return errors.New(msg)
  437. }
  438. default:
  439. logrus.Warnf("unsupported depends_on condition: %s", config.Condition)
  440. return nil
  441. }
  442. }
  443. })
  444. }
  445. err := eg.Wait()
  446. if errors.Is(err, context.DeadlineExceeded) {
  447. return fmt.Errorf("timeout waiting for dependencies")
  448. }
  449. return err
  450. }
  451. func shouldWaitForDependency(serviceName string, dependencyConfig types.ServiceDependency, project *types.Project) (bool, error) {
  452. if dependencyConfig.Condition == types.ServiceConditionStarted {
  453. // already managed by InDependencyOrder
  454. return false, nil
  455. }
  456. if service, err := project.GetService(serviceName); err != nil {
  457. for _, ds := range project.DisabledServices {
  458. if ds.Name == serviceName {
  459. // don't wait for disabled service (--no-deps)
  460. return false, nil
  461. }
  462. }
  463. return false, err
  464. } else if service.GetScale() == 0 {
  465. // don't wait for the dependency which configured to have 0 containers running
  466. return false, nil
  467. }
  468. return true, nil
  469. }
  470. func nextContainerNumber(containers []moby.Container) int {
  471. maxNumber := 0
  472. for _, c := range containers {
  473. s, ok := c.Labels[api.ContainerNumberLabel]
  474. if !ok {
  475. logrus.Warnf("container %s is missing %s label", c.ID, api.ContainerNumberLabel)
  476. }
  477. n, err := strconv.Atoi(s)
  478. if err != nil {
  479. logrus.Warnf("container %s has invalid %s label: %s", c.ID, api.ContainerNumberLabel, s)
  480. continue
  481. }
  482. if n > maxNumber {
  483. maxNumber = n
  484. }
  485. }
  486. return maxNumber + 1
  487. }
  488. func (s *composeService) createContainer(ctx context.Context, project *types.Project, service types.ServiceConfig,
  489. name string, number int, opts createOptions) (container moby.Container, err error) {
  490. w := progress.ContextWriter(ctx)
  491. eventName := "Container " + name
  492. w.Event(progress.CreatingEvent(eventName))
  493. container, err = s.createMobyContainer(ctx, project, service, name, number, nil, opts, w)
  494. if err != nil {
  495. return
  496. }
  497. w.Event(progress.CreatedEvent(eventName))
  498. return
  499. }
  500. func (s *composeService) recreateContainer(ctx context.Context, project *types.Project, service types.ServiceConfig,
  501. replaced moby.Container, inherit bool, timeout *time.Duration) (moby.Container, error) {
  502. var created moby.Container
  503. w := progress.ContextWriter(ctx)
  504. w.Event(progress.NewEvent(getContainerProgressName(replaced), progress.Working, "Recreate"))
  505. number, err := strconv.Atoi(replaced.Labels[api.ContainerNumberLabel])
  506. if err != nil {
  507. return created, err
  508. }
  509. var inherited *moby.Container
  510. if inherit {
  511. inherited = &replaced
  512. }
  513. name := getContainerName(project.Name, service, number)
  514. tmpName := fmt.Sprintf("%s_%s", replaced.ID[:12], name)
  515. opts := createOptions{
  516. AutoRemove: false,
  517. AttachStdin: false,
  518. UseNetworkAliases: true,
  519. Labels: mergeLabels(service.Labels, service.CustomLabels).Add(api.ContainerReplaceLabel, replaced.ID),
  520. }
  521. created, err = s.createMobyContainer(ctx, project, service, tmpName, number, inherited, opts, w)
  522. if err != nil {
  523. return created, err
  524. }
  525. timeoutInSecond := utils.DurationSecondToInt(timeout)
  526. err = s.apiClient().ContainerStop(ctx, replaced.ID, containerType.StopOptions{Timeout: timeoutInSecond})
  527. if err != nil {
  528. return created, err
  529. }
  530. err = s.apiClient().ContainerRemove(ctx, replaced.ID, containerType.RemoveOptions{})
  531. if err != nil {
  532. return created, err
  533. }
  534. err = s.apiClient().ContainerRename(ctx, created.ID, name)
  535. if err != nil {
  536. return created, err
  537. }
  538. w.Event(progress.NewEvent(getContainerProgressName(replaced), progress.Done, "Recreated"))
  539. return created, err
  540. }
  541. func (s *composeService) startContainer(ctx context.Context, container moby.Container) error {
  542. w := progress.ContextWriter(ctx)
  543. w.Event(progress.NewEvent(getContainerProgressName(container), progress.Working, "Restart"))
  544. err := s.apiClient().ContainerStart(ctx, container.ID, containerType.StartOptions{})
  545. if err != nil {
  546. return err
  547. }
  548. w.Event(progress.NewEvent(getContainerProgressName(container), progress.Done, "Restarted"))
  549. return nil
  550. }
  551. func (s *composeService) createMobyContainer(ctx context.Context,
  552. project *types.Project,
  553. service types.ServiceConfig,
  554. name string,
  555. number int,
  556. inherit *moby.Container,
  557. opts createOptions,
  558. w progress.Writer,
  559. ) (moby.Container, error) {
  560. var created moby.Container
  561. cfgs, err := s.getCreateConfigs(ctx, project, service, number, inherit, opts)
  562. if err != nil {
  563. return created, err
  564. }
  565. platform := service.Platform
  566. if platform == "" {
  567. platform = project.Environment["DOCKER_DEFAULT_PLATFORM"]
  568. }
  569. var plat *specs.Platform
  570. if platform != "" {
  571. var p specs.Platform
  572. p, err = platforms.Parse(platform)
  573. if err != nil {
  574. return created, err
  575. }
  576. plat = &p
  577. }
  578. response, err := s.apiClient().ContainerCreate(ctx, cfgs.Container, cfgs.Host, cfgs.Network, plat, name)
  579. if err != nil {
  580. return created, err
  581. }
  582. for _, warning := range response.Warnings {
  583. w.Event(progress.Event{
  584. ID: service.Name,
  585. Status: progress.Warning,
  586. Text: warning,
  587. })
  588. }
  589. inspectedContainer, err := s.apiClient().ContainerInspect(ctx, response.ID)
  590. if err != nil {
  591. return created, err
  592. }
  593. created = moby.Container{
  594. ID: inspectedContainer.ID,
  595. Labels: inspectedContainer.Config.Labels,
  596. Names: []string{inspectedContainer.Name},
  597. NetworkSettings: &moby.SummaryNetworkSettings{
  598. Networks: inspectedContainer.NetworkSettings.Networks,
  599. },
  600. }
  601. apiVersion, err := s.RuntimeVersion(ctx)
  602. if err != nil {
  603. return created, err
  604. }
  605. // Starting API version 1.44, the ContainerCreate API call takes multiple networks
  606. // so we include all the configurations there and can skip the one-by-one calls here
  607. if versions.LessThan(apiVersion, "1.44") {
  608. // the highest-priority network is the primary and is included in the ContainerCreate API
  609. // call via container.NetworkMode & network.NetworkingConfig
  610. // any remaining networks are connected one-by-one here after creation (but before start)
  611. serviceNetworks := service.NetworksByPriority()
  612. for _, networkKey := range serviceNetworks {
  613. mobyNetworkName := project.Networks[networkKey].Name
  614. if string(cfgs.Host.NetworkMode) == mobyNetworkName {
  615. // primary network already configured as part of ContainerCreate
  616. continue
  617. }
  618. epSettings := createEndpointSettings(project, service, number, networkKey, cfgs.Links, opts.UseNetworkAliases)
  619. if err := s.apiClient().NetworkConnect(ctx, mobyNetworkName, created.ID, epSettings); err != nil {
  620. return created, err
  621. }
  622. }
  623. }
  624. err = s.injectSecrets(ctx, project, service, created.ID)
  625. if err != nil {
  626. return created, err
  627. }
  628. err = s.injectConfigs(ctx, project, service, created.ID)
  629. return created, err
  630. }
  631. // getLinks mimics V1 compose/service.py::Service::_get_links()
  632. func (s *composeService) getLinks(ctx context.Context, projectName string, service types.ServiceConfig, number int) ([]string, error) {
  633. var links []string
  634. format := func(k, v string) string {
  635. return fmt.Sprintf("%s:%s", k, v)
  636. }
  637. getServiceContainers := func(serviceName string) (Containers, error) {
  638. return s.getContainers(ctx, projectName, oneOffExclude, true, serviceName)
  639. }
  640. for _, rawLink := range service.Links {
  641. linkSplit := strings.Split(rawLink, ":")
  642. linkServiceName := linkSplit[0]
  643. linkName := linkServiceName
  644. if len(linkSplit) == 2 {
  645. linkName = linkSplit[1] // linkName if informed like in: "serviceName:linkName"
  646. }
  647. cnts, err := getServiceContainers(linkServiceName)
  648. if err != nil {
  649. return nil, err
  650. }
  651. for _, c := range cnts {
  652. containerName := getCanonicalContainerName(c)
  653. links = append(links,
  654. format(containerName, linkName),
  655. format(containerName, linkServiceName+api.Separator+strconv.Itoa(number)),
  656. format(containerName, strings.Join([]string{projectName, linkServiceName, strconv.Itoa(number)}, api.Separator)),
  657. )
  658. }
  659. }
  660. if service.Labels[api.OneoffLabel] == "True" {
  661. cnts, err := getServiceContainers(service.Name)
  662. if err != nil {
  663. return nil, err
  664. }
  665. for _, c := range cnts {
  666. containerName := getCanonicalContainerName(c)
  667. links = append(links,
  668. format(containerName, service.Name),
  669. format(containerName, strings.TrimPrefix(containerName, projectName+api.Separator)),
  670. format(containerName, containerName),
  671. )
  672. }
  673. }
  674. for _, rawExtLink := range service.ExternalLinks {
  675. extLinkSplit := strings.Split(rawExtLink, ":")
  676. externalLink := extLinkSplit[0]
  677. linkName := externalLink
  678. if len(extLinkSplit) == 2 {
  679. linkName = extLinkSplit[1]
  680. }
  681. links = append(links, format(externalLink, linkName))
  682. }
  683. return links, nil
  684. }
  685. func (s *composeService) isServiceHealthy(ctx context.Context, containers Containers, fallbackRunning bool) (bool, error) {
  686. for _, c := range containers {
  687. container, err := s.apiClient().ContainerInspect(ctx, c.ID)
  688. if err != nil {
  689. return false, err
  690. }
  691. name := container.Name[1:]
  692. if container.State.Status == "exited" {
  693. return false, fmt.Errorf("container %s exited (%d)", name, container.State.ExitCode)
  694. }
  695. if container.Config.Healthcheck == nil && fallbackRunning {
  696. // Container does not define a health check, but we can fall back to "running" state
  697. return container.State != nil && container.State.Status == "running", nil
  698. }
  699. if container.State == nil || container.State.Health == nil {
  700. return false, fmt.Errorf("container %s has no healthcheck configured", name)
  701. }
  702. switch container.State.Health.Status {
  703. case moby.Healthy:
  704. // Continue by checking the next container.
  705. case moby.Unhealthy:
  706. return false, fmt.Errorf("container %s is unhealthy", name)
  707. case moby.Starting:
  708. return false, nil
  709. default:
  710. return false, fmt.Errorf("container %s had unexpected health status %q", name, container.State.Health.Status)
  711. }
  712. }
  713. return true, nil
  714. }
  715. func (s *composeService) isServiceCompleted(ctx context.Context, containers Containers) (bool, int, error) {
  716. for _, c := range containers {
  717. container, err := s.apiClient().ContainerInspect(ctx, c.ID)
  718. if err != nil {
  719. return false, 0, err
  720. }
  721. if container.State != nil && container.State.Status == "exited" {
  722. return true, container.State.ExitCode, nil
  723. }
  724. }
  725. return false, 0, nil
  726. }
  727. func (s *composeService) startService(ctx context.Context,
  728. project *types.Project, service types.ServiceConfig,
  729. containers Containers, listener api.ContainerEventListener,
  730. timeout time.Duration) error {
  731. if service.Deploy != nil && service.Deploy.Replicas != nil && *service.Deploy.Replicas == 0 {
  732. return nil
  733. }
  734. err := s.waitDependencies(ctx, project, service.Name, service.DependsOn, containers, timeout)
  735. if err != nil {
  736. return err
  737. }
  738. if len(containers) == 0 {
  739. if service.GetScale() == 0 {
  740. return nil
  741. }
  742. return fmt.Errorf("service %q has no container to start", service.Name)
  743. }
  744. w := progress.ContextWriter(ctx)
  745. for _, container := range containers.filter(isService(service.Name)) {
  746. if container.State == ContainerRunning {
  747. continue
  748. }
  749. eventName := getContainerProgressName(container)
  750. w.Event(progress.StartingEvent(eventName))
  751. err = s.apiClient().ContainerStart(ctx, container.ID, containerType.StartOptions{})
  752. if err != nil {
  753. return err
  754. }
  755. for _, hook := range service.PostStart {
  756. err = s.runHook(ctx, container, service, hook, listener)
  757. if err != nil {
  758. return err
  759. }
  760. }
  761. w.Event(progress.StartedEvent(eventName))
  762. }
  763. return nil
  764. }
  765. func mergeLabels(ls ...types.Labels) types.Labels {
  766. merged := types.Labels{}
  767. for _, l := range ls {
  768. for k, v := range l {
  769. merged[k] = v
  770. }
  771. }
  772. return merged
  773. }