docs: Update compatibility.md by Dimrok · Pull Request #385 · docker-archive-public/docker.app

Dimrok · 2018-09-17T16:04:07Z

- What I did

I merged the two matrices to get a clearer view.
I added docker-compose
I added version 2.x

- Description for the changelog

Update documentation regarding composefile version compatibility.

- A picture of a cute animal (not mandatory but encouraged)

(credits: u/kaitlynsara06 from reddit)

vdemeester · 2018-09-17T16:12:22Z

+|     - order                  |  SK |  SK |  SK |  SK |     |     |     |     |     |     |     |     |     |
+|     - parallelism            |  SK |  SK |  SK |  SK |  SK |  SK |  SK |  SK |     |     |     |     |     |
+| - devices                    |  C  |  C  |  C  |  C  |  C  |  C  |  C  |  C  |  C  |  C  |  C  |  C  |  C  |
+| - depends_on                 |  CS |  CS |  CS |  CS |  CS |  CS |  CS |  CS |  CS |  CS |  CS |  CS |  CS |


Doesn't work on swarm, there is no notion of depends_on in swarm, the key is ignored (should be in UnsupportedProperties, not sur why it's not…)

The depends_on option is ignored when deploying a stack in swarm mode with a version 3 Compose file.

Good catch.

vdemeester · 2018-09-17T16:14:02Z

+|   - timeout                  |  *  |  *  |  *  |  *  |  *  |  *  |  *  |  *  |  *  |  *  |  *  |  *  |  *  |
+| - hostname                   |  *  |  *  |  *  |  *  |  *  |  *  |  *  |  *  |  *  |  *  |  *  |  *  |  *  |
+| - image                      |  *  |  *  |  *  |  *  |  *  |  *  |  *  |  *  |  *  |  *  |  *  |  *  |  *  |
+| - init                       |  *  |     |     |     |     |     |     |     |     |     |     |     |     |


Probably not support in Kubernetes if it's in 3.7, might be wrong though

vdemeester · 2018-09-17T16:14:21Z

+| - ipc                        |  CK |  CK |  CK |  CK |  CK |  CK |  CK |  CK |  CK |  CK |  CK |  CK |  CK |
+| - isolation                  |  CS |  CS |  CS |     |     |     |     |     |     |     |     |     |     |
+| - labels                     |  *  |  *  |  *  |  *  |  *  |  *  |  *  |  *  |  *  |  *  |  *  |  *  |  *  |
+| - links                      |     |     |     |     |     |     |     |     |     |     |     |     |     |


Should be supported in C (compose) I think

vdemeester · 2018-09-17T16:15:19Z

-| - working_dir                |  Y  |  Y  |  Y  |  Y  |  Y  |  Y  |  Y  |
+| Features                     | 3.7 | 3.6 | 3.5 | 3.4 | 3.3 | 3.2 | 3.1 | 3.0 | 2.4 | 2.3 | 2.2 | 2.1 | 2.0 |
+|------------------------------|-----|-----|-----|-----|-----|-----|-----|-----|-----|-----|-----|-----|-----|
+| configs                      |  *  |  *  |  *  |  *  |  *  |     |     |     |     |     |     |     |     |


Config should work the same way secret are…

vdemeester · 2018-09-17T16:15:34Z

+| - ports                      |  *  |  *  |  *  |  *  |  *  |  *  |  *  |  *  |  *  |  *  |  *  |  *  |  *  |
+|   - mode:                    |  *  |  *  |  *  |  *  |  *  |  *  |  *  |  *  |  *  |  *  |  *  |  *  |  *  |
+|     - host                   | CS? | CS? | CS? | CS? | CS? | CS? | CS? | CS? | CS? | CS? | CS? | CS? | CS? |
+|     - ingress                | CS? | CS? | CS? | CS? | CS? | CS? | CS? | CS? | CS? | CS? | CS? | CS? | CS? |


ingress is swarm only

vdemeester · 2018-09-17T16:16:42Z

+|     - volume                 |  *  |  *  |  *  |  *  |  *  |  *  |     |     |     |     |     |     |     |
+|     - bind                   |  *  |  *  |  *  |  *  |  *  |  *  |     |     |     |     |     |     |     |
+|     - tmpfs                  |  *  |  *  |  *  |  *  |  *  |  *  |     |     |     |     |     |     |     |
+|   - bind                     |  CS |  CS |  CS |  CS |  CS |  CS |     |     |     |     |     |     |     |


Didn't we had support for bind mount in k8s ? 🤔

cc @simonferquel

shin-

A few notes on Compose support. Also, indentation doesn't work inside table cells.

shin- · 2018-09-18T22:27:02Z

-| - working_dir                |  Y  |  Y  |  Y  |  Y  |  Y  |  Y  |  Y  |
+| Features                     | 3.7 | 3.6 | 3.5 | 3.4 | 3.3 | 3.2 | 3.1 | 3.0 | 2.4 | 2.3 | 2.2 | 2.1 | 2.0 |
+|------------------------------|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:|
+| configs.<name> (long syntax) |  *  |  *  |  *  |  *  |  *  |     |     |     |     |     |     |     |     |


configs is SK - Compose doesn't have support: docker/compose#5739

My bad, I saw

def get_configs(self): return {} if self.version < const.COMPOSEFILE_V3_3 else self.config.get('configs', {})

and the doc says

Defining and using configs in compose files Both the `docker compose` and `docker stack` commands support defining configs in a compose file. See the Compose file reference for details.

I assumed it was supported.

shin- · 2018-09-19T00:27:00Z

+| - configs                    |  *  |  *  |  *  |  *  |  *  |     |     |     |     |     |     |     |     |
+| - cgroup_parent              |  C  |  C  |  C  |  C  |  C  |  C  |  C  |  C  |  C  |  C  |  C  |  C  |  C  |
+| - container_name             |  C  |  C  |  C  |  C  |  C  |  C  |  C  |  C  |  C  |  C  |  C  |  C  |  C  |
+| - credential_spec            |  *  |  *  |  *  |  *  |  *  |     |     |     |     |     |     |     |     |


Note that support for credential_spec in Compose is pending: docker/compose#5488

shin- · 2018-09-19T00:29:27Z

+|   - labels                   |  SK |  SK |  SK |  SK |  SK |  SK |  SK |  SK |     |     |     |     |     |
+|   - mode                     |  SK |  SK |  SK |  SK |  SK |  SK |  SK |  SK |     |     |     |     |     |
+|   - placement                |  SK |  SK |  SK |  SK |  SK |  SK |  SK |  SK |     |     |     |     |     |
+|   - replicas                 |  SK |  SK |  SK |  SK |  SK |  SK |  SK |  SK |     |     |     |     |     |


Supported in Compose if compatibility mode is enabled: https://docs.docker.com/compose/compose-file/compose-versioning/#compatibility-mode

shin- · 2018-09-19T00:29:34Z

+|   - resources                |  SK |  SK |  SK |  SK |  SK |  SK |  SK |  SK |     |     |     |     |     |
+|     - limits                 |  SK |  SK |  SK |  SK |  SK |  SK |  SK |  SK |     |     |     |     |     |
+|     - reservations           |  SK |  SK |  SK |  SK |  SK |  SK |  SK |  SK |     |     |     |     |     |
+|   - restart_policy           |  SK |  SK |  SK |  SK |  SK |  SK |  SK |  SK |     |     |     |     |     |


Partially supported in Compose if compatibility mode is enabled: https://docs.docker.com/compose/compose-file/compose-versioning/#compatibility-mode

shin- · 2018-09-19T00:30:35Z

+|   - mode                     |  SK |  SK |  SK |  SK |  SK |  SK |  SK |  SK |     |     |     |     |     |
+|   - placement                |  SK |  SK |  SK |  SK |  SK |  SK |  SK |  SK |     |     |     |     |     |
+|   - replicas                 |  SK |  SK |  SK |  SK |  SK |  SK |  SK |  SK |     |     |     |     |     |
+|   - resources                |  SK |  SK |  SK |  SK |  SK |  SK |  SK |  SK |     |     |     |     |     |


Supported in Compose if compatibility mode is enabled: https://docs.docker.com/compose/compose-file/compose-versioning/#compatibility-mode

codecov · 2018-09-21T08:32:57Z

Codecov Report

Merging #385 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #385   +/-   ##
=======================================
  Coverage   58.34%   58.34%           
=======================================
  Files          59       59           
  Lines        3260     3260           
=======================================
  Hits         1902     1902           
  Misses       1093     1093           
  Partials      265      265

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 35db18a...088131f. Read the comment docs.

simonferquel · 2018-09-24T08:38:35Z

+|   - network                  |  C  |  C  |  C  |  C  |  C  |  C  |  C  |  C  |  C  |  C  |  C  |  C  |  C  |
+|   - shm_size                 |  C  |  C  |  C  |  C  |  C  |  C  |  C  |  C  |  C  |  C  |  C  |  C  |  C  |
+|   - target                   |  C  |  C  |  C  |  C  |  C  |  C  |  C  |  C  |  C  |  C  |  C  |  C  |  C  |
+| - cap_add                    |  CK |  CK |  CK |  CK |  CK |  CK |  CK |  C  |  C  |  C  |  C  |  C  |  C  |


Just checked, cap_add/cap_drop are ignored in kube-compose

Just re-checked they are not, just wasn't looking at the right place

simonferquel · 2018-09-24T08:39:36Z

+|   - timeout                  |  *  |  *  |  *  |  *  |  *  |  *  |  *  |  *  |  *  |  *  |  *  |  *  |  *  |
+| - hostname                   |  *  |  *  |  *  |  *  |  *  |  *  |  *  |  *  |  *  |  *  |  *  |  *  |  *  |
+| - image                      |  *  |  *  |  *  |  *  |  *  |  *  |  *  |  *  |  *  |  *  |  *  |  *  |  *  |
+| - init                       |  CK |     |     |     |     |     |     |     |     |     |     |     |     |


seemed to be ignored in kube-compose

chris-crone · 2018-09-25T14:07:40Z

Ping @vdemeester and @simonferquel to update their reviews

shin-

1 last thing

shin- · 2018-09-25T15:28:09Z

-| - working_dir                |  Y  |  Y  |  Y  |  Y  |  Y  |  Y  |  Y  |
+| Features                     | 3.7 | 3.6 | 3.5 | 3.4 | 3.3 | 3.2 | 3.1 | 3.0 | 2.4 | 2.3 | 2.2 | 2.1 | 2.0 |
+|------------------------------|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:|
+| configs.<name> (long syntax) |  CK |  CK |  CK |  CK |  CK |     |     |     |     |     |     |     |     |


The whole configs section should be SK, not CK

Signed-off-by: Antony MECHIN <antony.mechin@docker.com>

chris-crone · 2018-10-01T08:12:32Z

Ping @shin- for a review update

shin-

1 instance of configs was missed

shin- · 2018-10-02T07:59:56Z

+| - cpu_quota                  |     |     |     |     |     |     |     |     |  C  |  C  |  C  |  C  |  C  |
+| - cpuset                     |     |     |     |     |     |     |     |     |  C  |  C  |  C  |  C  |  C  |
+| - command                    |  *  |  *  |  *  |  *  |  *  |  *  |  *  |  *  |  *  |  *  |  *  |  *  |  *  |
+| - configs                    |  CK |  CK |  CK |  CK |  CK |     |     |     |     |     |     |     |     |


SK also to match https://github.com/docker/app/pull/385/files#diff-90ba508fd9c179b95ae20ac325190e9fR17

Since @Dimrok is on PTO, can we merge and follow up?

Yep, intentionally left as a comment as to not block this any further. Merge away!

ijc · 2018-10-02T10:53:18Z

This seems like a pretty massive/intractable PR review-wise, given that it clearly contains an improvement over the status quo perhaps we should merge it and correct that last few remaining inaccuracies in a followup (or followups)?

Dimrok requested a review from chris-crone as a code owner September 17, 2018 16:04

GordonTheTurtle added the status/0-triage label Sep 17, 2018

vdemeester suggested changes Sep 17, 2018

View reviewed changes

shin- reviewed Sep 19, 2018

View reviewed changes

simonferquel suggested changes Sep 24, 2018

View reviewed changes

vdemeester approved these changes Sep 25, 2018

View reviewed changes

simonferquel approved these changes Sep 25, 2018

View reviewed changes

shin- suggested changes Sep 25, 2018

View reviewed changes

Dimrok force-pushed the feature/docs branch from 2236763 to 21ffaec Compare September 26, 2018 08:29

docs: Merge matrices and include docker-compose up.

088131f

Signed-off-by: Antony MECHIN <antony.mechin@docker.com>

Dimrok force-pushed the feature/docs branch from 21ffaec to 088131f Compare September 28, 2018 08:30

shin- approved these changes Oct 2, 2018

View reviewed changes

shin- reviewed Oct 2, 2018

View reviewed changes

chris-crone merged commit 00b2e92 into docker-archive-public:master Oct 2, 2018

Conversation

Dimrok commented Sep 17, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

shin- left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

codecov Bot commented Sep 21, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

chris-crone commented Sep 25, 2018

Uh oh!

shin- left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

chris-crone commented Oct 1, 2018

Uh oh!

shin- left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ijc commented Oct 2, 2018

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

codecov Bot commented Sep 21, 2018 •

edited

Loading