convergence.go 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768
  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. "fmt"
  17. "sort"
  18. "strconv"
  19. "strings"
  20. "sync"
  21. "time"
  22. "go.opentelemetry.io/otel/attribute"
  23. "go.opentelemetry.io/otel/trace"
  24. "github.com/compose-spec/compose-go/types"
  25. "github.com/containerd/containerd/platforms"
  26. "github.com/docker/compose/v2/internal/tracing"
  27. moby "github.com/docker/docker/api/types"
  28. containerType "github.com/docker/docker/api/types/container"
  29. specs "github.com/opencontainers/image-spec/specs-go/v1"
  30. "github.com/pkg/errors"
  31. "github.com/sirupsen/logrus"
  32. "golang.org/x/sync/errgroup"
  33. "github.com/docker/compose/v2/pkg/api"
  34. "github.com/docker/compose/v2/pkg/progress"
  35. "github.com/docker/compose/v2/pkg/utils"
  36. )
  37. const (
  38. extLifecycle = "x-lifecycle"
  39. forceRecreate = "force_recreate"
  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. observedState map[string]Containers
  52. stateMutex sync.Mutex
  53. }
  54. func (c *convergence) getObservedState(serviceName string) Containers {
  55. c.stateMutex.Lock()
  56. defer c.stateMutex.Unlock()
  57. return c.observedState[serviceName]
  58. }
  59. func (c *convergence) setObservedState(serviceName string, containers Containers) {
  60. c.stateMutex.Lock()
  61. defer c.stateMutex.Unlock()
  62. c.observedState[serviceName] = containers
  63. }
  64. func newConvergence(services []string, state Containers, s *composeService) *convergence {
  65. observedState := map[string]Containers{}
  66. for _, s := range services {
  67. observedState[s] = Containers{}
  68. }
  69. for _, c := range state.filter(isNotOneOff) {
  70. service := c.Labels[api.ServiceLabel]
  71. observedState[service] = append(observedState[service], c)
  72. }
  73. return &convergence{
  74. service: s,
  75. observedState: observedState,
  76. }
  77. }
  78. func (c *convergence) apply(ctx context.Context, project *types.Project, options api.CreateOptions) error {
  79. return InDependencyOrder(ctx, project, func(ctx context.Context, name string) error {
  80. service, err := project.GetService(name)
  81. if err != nil {
  82. return err
  83. }
  84. return tracing.SpanWrapFunc("service/apply", tracing.ServiceOptions(service), func(ctx context.Context) error {
  85. strategy := options.RecreateDependencies
  86. if utils.StringContains(options.Services, name) {
  87. strategy = options.Recreate
  88. }
  89. return c.ensureService(ctx, project, service, strategy, options.Inherit, options.Timeout)
  90. })(ctx)
  91. })
  92. }
  93. var mu sync.Mutex
  94. func (c *convergence) ensureService(ctx context.Context, project *types.Project, service types.ServiceConfig, recreate string, inherit bool, timeout *time.Duration) error {
  95. expected, err := getScale(service)
  96. if err != nil {
  97. return err
  98. }
  99. containers := c.getObservedState(service.Name)
  100. actual := len(containers)
  101. updated := make(Containers, expected)
  102. eg, _ := errgroup.WithContext(ctx)
  103. err = c.resolveServiceReferences(&service)
  104. if err != nil {
  105. return err
  106. }
  107. sort.Slice(containers, func(i, j int) bool {
  108. return containers[i].Created < containers[j].Created
  109. })
  110. for i, container := range containers {
  111. if i >= expected {
  112. // Scale Down
  113. container := container
  114. traceOpts := append(tracing.ServiceOptions(service), tracing.ContainerOptions(container)...)
  115. eg.Go(tracing.SpanWrapFuncForErrGroup(ctx, "service/scale/down", traceOpts, func(ctx context.Context) error {
  116. timeoutInSecond := utils.DurationSecondToInt(timeout)
  117. err := c.service.apiClient().ContainerStop(ctx, container.ID, containerType.StopOptions{
  118. Timeout: timeoutInSecond,
  119. })
  120. if err != nil {
  121. return err
  122. }
  123. return c.service.apiClient().ContainerRemove(ctx, container.ID, moby.ContainerRemoveOptions{})
  124. }))
  125. continue
  126. }
  127. mustRecreate, err := mustRecreate(service, container, recreate)
  128. if err != nil {
  129. return err
  130. }
  131. if mustRecreate {
  132. i, container := i, container
  133. eg.Go(tracing.SpanWrapFuncForErrGroup(ctx, "container/recreate", tracing.ContainerOptions(container), func(ctx context.Context) error {
  134. recreated, err := c.service.recreateContainer(ctx, project, service, container, inherit, timeout)
  135. updated[i] = recreated
  136. return err
  137. }))
  138. continue
  139. }
  140. // Enforce non-diverged containers are running
  141. w := progress.ContextWriter(ctx)
  142. name := getContainerProgressName(container)
  143. switch container.State {
  144. case ContainerRunning:
  145. w.Event(progress.RunningEvent(name))
  146. case ContainerCreated:
  147. case ContainerRestarting:
  148. case ContainerExited:
  149. w.Event(progress.CreatedEvent(name))
  150. default:
  151. container := container
  152. eg.Go(tracing.EventWrapFuncForErrGroup(ctx, "service/start", tracing.ContainerOptions(container), func(ctx context.Context) error {
  153. return c.service.startContainer(ctx, container)
  154. }))
  155. }
  156. updated[i] = container
  157. }
  158. next := nextContainerNumber(containers)
  159. for i := 0; i < expected-actual; i++ {
  160. // Scale UP
  161. number := next + i
  162. name := getContainerName(project.Name, service, number)
  163. i := i
  164. eventOpts := tracing.SpanOptions{trace.WithAttributes(attribute.String("container.name", name))}
  165. eg.Go(tracing.EventWrapFuncForErrGroup(ctx, "service/scale/up", eventOpts, func(ctx context.Context) error {
  166. opts := createOptions{
  167. AutoRemove: false,
  168. AttachStdin: false,
  169. UseNetworkAliases: true,
  170. Labels: mergeLabels(service.Labels, service.CustomLabels),
  171. }
  172. container, err := c.service.createContainer(ctx, project, service, name, number, opts)
  173. updated[actual+i] = container
  174. return err
  175. }))
  176. continue
  177. }
  178. err = eg.Wait()
  179. c.setObservedState(service.Name, updated)
  180. return err
  181. }
  182. // resolveServiceReferences replaces reference to another service with reference to an actual container
  183. func (c *convergence) resolveServiceReferences(service *types.ServiceConfig) error {
  184. err := c.resolveVolumeFrom(service)
  185. if err != nil {
  186. return err
  187. }
  188. err = c.resolveSharedNamespaces(service)
  189. if err != nil {
  190. return err
  191. }
  192. return nil
  193. }
  194. func (c *convergence) resolveVolumeFrom(service *types.ServiceConfig) error {
  195. for i, vol := range service.VolumesFrom {
  196. spec := strings.Split(vol, ":")
  197. if len(spec) == 0 {
  198. continue
  199. }
  200. if spec[0] == "container" {
  201. service.VolumesFrom[i] = spec[1]
  202. continue
  203. }
  204. name := spec[0]
  205. dependencies := c.getObservedState(name)
  206. if len(dependencies) == 0 {
  207. return fmt.Errorf("cannot share volume with service %s: container missing", name)
  208. }
  209. service.VolumesFrom[i] = dependencies.sorted()[0].ID
  210. }
  211. return nil
  212. }
  213. func (c *convergence) resolveSharedNamespaces(service *types.ServiceConfig) error {
  214. str := service.NetworkMode
  215. if name := getDependentServiceFromMode(str); name != "" {
  216. dependencies := c.getObservedState(name)
  217. if len(dependencies) == 0 {
  218. return fmt.Errorf("cannot share network namespace with service %s: container missing", name)
  219. }
  220. service.NetworkMode = types.ContainerPrefix + dependencies.sorted()[0].ID
  221. }
  222. str = service.Ipc
  223. if name := getDependentServiceFromMode(str); name != "" {
  224. dependencies := c.getObservedState(name)
  225. if len(dependencies) == 0 {
  226. return fmt.Errorf("cannot share IPC namespace with service %s: container missing", name)
  227. }
  228. service.Ipc = types.ContainerPrefix + dependencies.sorted()[0].ID
  229. }
  230. str = service.Pid
  231. if name := getDependentServiceFromMode(str); name != "" {
  232. dependencies := c.getObservedState(name)
  233. if len(dependencies) == 0 {
  234. return fmt.Errorf("cannot share PID namespace with service %s: container missing", name)
  235. }
  236. service.Pid = types.ContainerPrefix + dependencies.sorted()[0].ID
  237. }
  238. return nil
  239. }
  240. func mustRecreate(expected types.ServiceConfig, actual moby.Container, policy string) (bool, error) {
  241. if policy == api.RecreateNever {
  242. return false, nil
  243. }
  244. if policy == api.RecreateForce || expected.Extensions[extLifecycle] == forceRecreate {
  245. return true, nil
  246. }
  247. configHash, err := ServiceHash(expected)
  248. if err != nil {
  249. return false, err
  250. }
  251. configChanged := actual.Labels[api.ConfigHashLabel] != configHash
  252. imageUpdated := actual.Labels[api.ImageDigestLabel] != expected.CustomLabels[api.ImageDigestLabel]
  253. return configChanged || imageUpdated, nil
  254. }
  255. func getContainerName(projectName string, service types.ServiceConfig, number int) string {
  256. name := strings.Join([]string{projectName, service.Name, strconv.Itoa(number)}, api.Separator)
  257. if service.ContainerName != "" {
  258. name = service.ContainerName
  259. }
  260. return name
  261. }
  262. func getContainerProgressName(container moby.Container) string {
  263. return "Container " + getCanonicalContainerName(container)
  264. }
  265. func containerEvents(containers Containers, eventFunc func(string) progress.Event) []progress.Event {
  266. events := []progress.Event{}
  267. for _, container := range containers {
  268. events = append(events, eventFunc(getContainerProgressName(container)))
  269. }
  270. return events
  271. }
  272. func containerReasonEvents(containers Containers, eventFunc func(string, string) progress.Event, reason string) []progress.Event {
  273. events := []progress.Event{}
  274. for _, container := range containers {
  275. events = append(events, eventFunc(getContainerProgressName(container), reason))
  276. }
  277. return events
  278. }
  279. // ServiceConditionRunningOrHealthy is a service condition on status running or healthy
  280. const ServiceConditionRunningOrHealthy = "running_or_healthy"
  281. //nolint:gocyclo
  282. func (s *composeService) waitDependencies(ctx context.Context, project *types.Project, dependencies types.DependsOnConfig, containers Containers) error {
  283. eg, _ := errgroup.WithContext(ctx)
  284. w := progress.ContextWriter(ctx)
  285. for dep, config := range dependencies {
  286. if shouldWait, err := shouldWaitForDependency(dep, config, project); err != nil {
  287. return err
  288. } else if !shouldWait {
  289. continue
  290. }
  291. waitingFor := containers.filter(isService(dep))
  292. w.Events(containerEvents(waitingFor, progress.Waiting))
  293. dep, config := dep, config
  294. eg.Go(func() error {
  295. ticker := time.NewTicker(500 * time.Millisecond)
  296. defer ticker.Stop()
  297. for {
  298. select {
  299. case <-ticker.C:
  300. case <-ctx.Done():
  301. return nil
  302. }
  303. switch config.Condition {
  304. case ServiceConditionRunningOrHealthy:
  305. healthy, err := s.isServiceHealthy(ctx, waitingFor, true)
  306. if err != nil {
  307. if !config.Required {
  308. w.Events(containerReasonEvents(waitingFor, progress.SkippedEvent, fmt.Sprintf("optional dependency %q is not running or is unhealthy", dep)))
  309. logrus.Warnf("optional dependency %q is not running or is unhealthy: %s", dep, err.Error())
  310. return nil
  311. }
  312. return err
  313. }
  314. if healthy {
  315. w.Events(containerEvents(waitingFor, progress.Healthy))
  316. return nil
  317. }
  318. case types.ServiceConditionHealthy:
  319. healthy, err := s.isServiceHealthy(ctx, waitingFor, false)
  320. if err != nil {
  321. if !config.Required {
  322. w.Events(containerReasonEvents(waitingFor, progress.SkippedEvent, fmt.Sprintf("optional dependency %q failed to start", dep)))
  323. logrus.Warnf("optional dependency %q failed to start: %s", dep, err.Error())
  324. return nil
  325. }
  326. w.Events(containerEvents(waitingFor, progress.ErrorEvent))
  327. return errors.Wrap(err, "dependency failed to start")
  328. }
  329. if healthy {
  330. w.Events(containerEvents(waitingFor, progress.Healthy))
  331. return nil
  332. }
  333. case types.ServiceConditionCompletedSuccessfully:
  334. exited, code, err := s.isServiceCompleted(ctx, waitingFor)
  335. if err != nil {
  336. return err
  337. }
  338. if exited {
  339. if code == 0 {
  340. w.Events(containerEvents(waitingFor, progress.Exited))
  341. return nil
  342. }
  343. messageSuffix := fmt.Sprintf("%q didn't complete successfully: exit %d", dep, code)
  344. if !config.Required {
  345. // optional -> mark as skipped & don't propagate error
  346. w.Events(containerReasonEvents(waitingFor, progress.SkippedEvent, fmt.Sprintf("optional dependency %s", messageSuffix)))
  347. logrus.Warnf("optional dependency %s", messageSuffix)
  348. return nil
  349. }
  350. msg := fmt.Sprintf("service %s", messageSuffix)
  351. w.Events(containerReasonEvents(waitingFor, progress.ErrorMessageEvent, msg))
  352. return errors.New(msg)
  353. }
  354. default:
  355. logrus.Warnf("unsupported depends_on condition: %s", config.Condition)
  356. return nil
  357. }
  358. }
  359. })
  360. }
  361. return eg.Wait()
  362. }
  363. func shouldWaitForDependency(serviceName string, dependencyConfig types.ServiceDependency, project *types.Project) (bool, error) {
  364. if dependencyConfig.Condition == types.ServiceConditionStarted {
  365. // already managed by InDependencyOrder
  366. return false, nil
  367. }
  368. if service, err := project.GetService(serviceName); err != nil {
  369. for _, ds := range project.DisabledServices {
  370. if ds.Name == serviceName {
  371. // don't wait for disabled service (--no-deps)
  372. return false, nil
  373. }
  374. }
  375. return false, err
  376. } else if service.Scale == 0 {
  377. // don't wait for the dependency which configured to have 0 containers running
  378. return false, nil
  379. }
  380. return true, nil
  381. }
  382. func nextContainerNumber(containers []moby.Container) int {
  383. max := 0
  384. for _, c := range containers {
  385. s, ok := c.Labels[api.ContainerNumberLabel]
  386. if !ok {
  387. logrus.Warnf("container %s is missing %s label", c.ID, api.ContainerNumberLabel)
  388. }
  389. n, err := strconv.Atoi(s)
  390. if err != nil {
  391. logrus.Warnf("container %s has invalid %s label: %s", c.ID, api.ContainerNumberLabel, s)
  392. continue
  393. }
  394. if n > max {
  395. max = n
  396. }
  397. }
  398. return max + 1
  399. }
  400. func getScale(config types.ServiceConfig) (int, error) {
  401. scale := 1
  402. if config.Deploy != nil && config.Deploy.Replicas != nil {
  403. scale = int(*config.Deploy.Replicas)
  404. }
  405. if scale > 1 && config.ContainerName != "" {
  406. return 0, fmt.Errorf(doubledContainerNameWarning,
  407. config.Name,
  408. config.ContainerName)
  409. }
  410. return scale, nil
  411. }
  412. func (s *composeService) createContainer(ctx context.Context, project *types.Project, service types.ServiceConfig,
  413. name string, number int, opts createOptions) (container moby.Container, err error) {
  414. w := progress.ContextWriter(ctx)
  415. eventName := "Container " + name
  416. w.Event(progress.CreatingEvent(eventName))
  417. container, err = s.createMobyContainer(ctx, project, service, name, number, nil, opts, w)
  418. if err != nil {
  419. return
  420. }
  421. w.Event(progress.CreatedEvent(eventName))
  422. return
  423. }
  424. func (s *composeService) recreateContainer(ctx context.Context, project *types.Project, service types.ServiceConfig,
  425. replaced moby.Container, inherit bool, timeout *time.Duration) (moby.Container, error) {
  426. var created moby.Container
  427. w := progress.ContextWriter(ctx)
  428. w.Event(progress.NewEvent(getContainerProgressName(replaced), progress.Working, "Recreate"))
  429. number, err := strconv.Atoi(replaced.Labels[api.ContainerNumberLabel])
  430. if err != nil {
  431. return created, err
  432. }
  433. var inherited *moby.Container
  434. if inherit {
  435. inherited = &replaced
  436. }
  437. name := getContainerName(project.Name, service, number)
  438. tmpName := fmt.Sprintf("%s_%s", replaced.ID[:12], name)
  439. opts := createOptions{
  440. AutoRemove: false,
  441. AttachStdin: false,
  442. UseNetworkAliases: true,
  443. Labels: mergeLabels(service.Labels, service.CustomLabels).Add(api.ContainerReplaceLabel, replaced.ID),
  444. }
  445. created, err = s.createMobyContainer(ctx, project, service, tmpName, number, inherited, opts, w)
  446. if err != nil {
  447. return created, err
  448. }
  449. timeoutInSecond := utils.DurationSecondToInt(timeout)
  450. err = s.apiClient().ContainerStop(ctx, replaced.ID, containerType.StopOptions{Timeout: timeoutInSecond})
  451. if err != nil {
  452. return created, err
  453. }
  454. err = s.apiClient().ContainerRemove(ctx, replaced.ID, moby.ContainerRemoveOptions{})
  455. if err != nil {
  456. return created, err
  457. }
  458. err = s.apiClient().ContainerRename(ctx, created.ID, name)
  459. if err != nil {
  460. return created, err
  461. }
  462. w.Event(progress.NewEvent(getContainerProgressName(replaced), progress.Done, "Recreated"))
  463. setDependentLifecycle(project, service.Name, forceRecreate)
  464. return created, err
  465. }
  466. // setDependentLifecycle define the Lifecycle strategy for all services to depend on specified service
  467. func setDependentLifecycle(project *types.Project, service string, strategy string) {
  468. mu.Lock()
  469. defer mu.Unlock()
  470. for i, s := range project.Services {
  471. if utils.StringContains(s.GetDependencies(), service) {
  472. if s.Extensions == nil {
  473. s.Extensions = map[string]interface{}{}
  474. }
  475. s.Extensions[extLifecycle] = strategy
  476. project.Services[i] = s
  477. }
  478. }
  479. }
  480. func (s *composeService) startContainer(ctx context.Context, container moby.Container) error {
  481. w := progress.ContextWriter(ctx)
  482. w.Event(progress.NewEvent(getContainerProgressName(container), progress.Working, "Restart"))
  483. err := s.apiClient().ContainerStart(ctx, container.ID, moby.ContainerStartOptions{})
  484. if err != nil {
  485. return err
  486. }
  487. w.Event(progress.NewEvent(getContainerProgressName(container), progress.Done, "Restarted"))
  488. return nil
  489. }
  490. func (s *composeService) createMobyContainer(ctx context.Context,
  491. project *types.Project,
  492. service types.ServiceConfig,
  493. name string,
  494. number int,
  495. inherit *moby.Container,
  496. opts createOptions,
  497. w progress.Writer,
  498. ) (moby.Container, error) {
  499. var created moby.Container
  500. cfgs, err := s.getCreateConfigs(ctx, project, service, number, inherit, opts)
  501. if err != nil {
  502. return created, err
  503. }
  504. platform := service.Platform
  505. if platform == "" {
  506. platform = project.Environment["DOCKER_DEFAULT_PLATFORM"]
  507. }
  508. var plat *specs.Platform
  509. if platform != "" {
  510. var p specs.Platform
  511. p, err = platforms.Parse(platform)
  512. if err != nil {
  513. return created, err
  514. }
  515. plat = &p
  516. }
  517. response, err := s.apiClient().ContainerCreate(ctx, cfgs.Container, cfgs.Host, cfgs.Network, plat, name)
  518. if err != nil {
  519. return created, err
  520. }
  521. for _, warning := range response.Warnings {
  522. w.Event(progress.Event{
  523. ID: service.Name,
  524. Status: progress.Warning,
  525. Text: warning,
  526. })
  527. }
  528. inspectedContainer, err := s.apiClient().ContainerInspect(ctx, response.ID)
  529. if err != nil {
  530. return created, err
  531. }
  532. created = moby.Container{
  533. ID: inspectedContainer.ID,
  534. Labels: inspectedContainer.Config.Labels,
  535. Names: []string{inspectedContainer.Name},
  536. NetworkSettings: &moby.SummaryNetworkSettings{
  537. Networks: inspectedContainer.NetworkSettings.Networks,
  538. },
  539. }
  540. // the highest-priority network is the primary and is included in the ContainerCreate API
  541. // call via container.NetworkMode & network.NetworkingConfig
  542. // any remaining networks are connected one-by-one here after creation (but before start)
  543. serviceNetworks := service.NetworksByPriority()
  544. for _, networkKey := range serviceNetworks {
  545. mobyNetworkName := project.Networks[networkKey].Name
  546. if string(cfgs.Host.NetworkMode) == mobyNetworkName {
  547. // primary network already configured as part of ContainerCreate
  548. continue
  549. }
  550. epSettings := createEndpointSettings(project, service, number, networkKey, cfgs.Links, opts.UseNetworkAliases)
  551. if err := s.apiClient().NetworkConnect(ctx, mobyNetworkName, created.ID, epSettings); err != nil {
  552. return created, err
  553. }
  554. }
  555. err = s.injectSecrets(ctx, project, service, created.ID)
  556. return created, err
  557. }
  558. // getLinks mimics V1 compose/service.py::Service::_get_links()
  559. func (s *composeService) getLinks(ctx context.Context, projectName string, service types.ServiceConfig, number int) ([]string, error) {
  560. var links []string
  561. format := func(k, v string) string {
  562. return fmt.Sprintf("%s:%s", k, v)
  563. }
  564. getServiceContainers := func(serviceName string) (Containers, error) {
  565. return s.getContainers(ctx, projectName, oneOffExclude, true, serviceName)
  566. }
  567. for _, rawLink := range service.Links {
  568. linkSplit := strings.Split(rawLink, ":")
  569. linkServiceName := linkSplit[0]
  570. linkName := linkServiceName
  571. if len(linkSplit) == 2 {
  572. linkName = linkSplit[1] // linkName if informed like in: "serviceName:linkName"
  573. }
  574. cnts, err := getServiceContainers(linkServiceName)
  575. if err != nil {
  576. return nil, err
  577. }
  578. for _, c := range cnts {
  579. containerName := getCanonicalContainerName(c)
  580. links = append(links,
  581. format(containerName, linkName),
  582. format(containerName, linkServiceName+api.Separator+strconv.Itoa(number)),
  583. format(containerName, strings.Join([]string{projectName, linkServiceName, strconv.Itoa(number)}, api.Separator)),
  584. )
  585. }
  586. }
  587. if service.Labels[api.OneoffLabel] == "True" {
  588. cnts, err := getServiceContainers(service.Name)
  589. if err != nil {
  590. return nil, err
  591. }
  592. for _, c := range cnts {
  593. containerName := getCanonicalContainerName(c)
  594. links = append(links,
  595. format(containerName, service.Name),
  596. format(containerName, strings.TrimPrefix(containerName, projectName+api.Separator)),
  597. format(containerName, containerName),
  598. )
  599. }
  600. }
  601. for _, rawExtLink := range service.ExternalLinks {
  602. extLinkSplit := strings.Split(rawExtLink, ":")
  603. externalLink := extLinkSplit[0]
  604. linkName := externalLink
  605. if len(extLinkSplit) == 2 {
  606. linkName = extLinkSplit[1]
  607. }
  608. links = append(links, format(externalLink, linkName))
  609. }
  610. return links, nil
  611. }
  612. func (s *composeService) isServiceHealthy(ctx context.Context, containers Containers, fallbackRunning bool) (bool, error) {
  613. for _, c := range containers {
  614. container, err := s.apiClient().ContainerInspect(ctx, c.ID)
  615. if err != nil {
  616. return false, err
  617. }
  618. name := container.Name[1:]
  619. if container.State.Status == "exited" {
  620. return false, fmt.Errorf("container %s exited (%d)", name, container.State.ExitCode)
  621. }
  622. if container.Config.Healthcheck == nil && fallbackRunning {
  623. // Container does not define a health check, but we can fall back to "running" state
  624. return container.State != nil && container.State.Status == "running", nil
  625. }
  626. if container.State == nil || container.State.Health == nil {
  627. return false, fmt.Errorf("container %s has no healthcheck configured", name)
  628. }
  629. switch container.State.Health.Status {
  630. case moby.Healthy:
  631. // Continue by checking the next container.
  632. case moby.Unhealthy:
  633. return false, fmt.Errorf("container %s is unhealthy", name)
  634. case moby.Starting:
  635. return false, nil
  636. default:
  637. return false, fmt.Errorf("container %s had unexpected health status %q", name, container.State.Health.Status)
  638. }
  639. }
  640. return true, nil
  641. }
  642. func (s *composeService) isServiceCompleted(ctx context.Context, containers Containers) (bool, int, error) {
  643. for _, c := range containers {
  644. container, err := s.apiClient().ContainerInspect(ctx, c.ID)
  645. if err != nil {
  646. return false, 0, err
  647. }
  648. if container.State != nil && container.State.Status == "exited" {
  649. return true, container.State.ExitCode, nil
  650. }
  651. }
  652. return false, 0, nil
  653. }
  654. func (s *composeService) startService(ctx context.Context, project *types.Project, service types.ServiceConfig, containers Containers) error {
  655. if service.Deploy != nil && service.Deploy.Replicas != nil && *service.Deploy.Replicas == 0 {
  656. return nil
  657. }
  658. err := s.waitDependencies(ctx, project, service.DependsOn, containers)
  659. if err != nil {
  660. return err
  661. }
  662. if len(containers) == 0 {
  663. if scale, err := getScale(service); err != nil && scale == 0 {
  664. return nil
  665. }
  666. return fmt.Errorf("service %q has no container to start", service.Name)
  667. }
  668. w := progress.ContextWriter(ctx)
  669. for _, container := range containers.filter(isService(service.Name)) {
  670. if container.State == ContainerRunning {
  671. continue
  672. }
  673. eventName := getContainerProgressName(container)
  674. w.Event(progress.StartingEvent(eventName))
  675. err := s.apiClient().ContainerStart(ctx, container.ID, moby.ContainerStartOptions{})
  676. if err != nil {
  677. return err
  678. }
  679. w.Event(progress.StartedEvent(eventName))
  680. }
  681. return nil
  682. }
  683. func mergeLabels(ls ...types.Labels) types.Labels {
  684. merged := types.Labels{}
  685. for _, l := range ls {
  686. for k, v := range l {
  687. merged[k] = v
  688. }
  689. }
  690. return merged
  691. }