convergence.go 24 KB

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