Add Generic Resources #5416
Add Generic Resources #5416
Conversation
compose/compose-file/index.md
Outdated
|
|
||
| Generic Resources are a way to select the kind of nodes your task can land on. | ||
|
|
||
| In a swarm cluster, nodes can advertise Generic resources as Discrete values or |
There was a problem hiding this comment.
We need to decide if they are Generic Resources or Generic resources or generic resources. 👼
There was a problem hiding this comment.
Agreed, I went with Generic resources except for the title.
compose/compose-file/index.md
Outdated
| Generic Resources are a way to select the kind of nodes your task can land on. | ||
|
|
||
| In a swarm cluster, nodes can advertise Generic resources as Discrete values or | ||
| as Named values (e.g: SSD=3 or GPU=UID1, GPU=UID2, ...). |
There was a problem hiding this comment.
please use the construction "..., such as...." instead of parentheses and the Latin abbreviation .e.g.
RenaudWasTaken
force-pushed
the
master
branch
from
c83ba9f
to
3c5eb9c
Compare
|
@mistyhacks thanks for the review! Fixed :) |
|
@mistyhacks PTAL :) ! |
compose/compose-file/index.md
Outdated
|
|
||
| Generic resources are a way to select the kind of nodes your task can land on. | ||
|
|
||
| In a swarm cluster, nodes can advertise Generic resources as Discrete values or |
There was a problem hiding this comment.
Why are "Discrete Values" and "Named Values" capitalized?
compose/compose-file/index.md
Outdated
| Generic resources are a way to select the kind of nodes your task can land on. | ||
|
|
||
| In a swarm cluster, nodes can advertise Generic resources as Discrete values or | ||
| as Named values such as SSD=3 or GPU=UID1, GPU=UID2, ... |
There was a problem hiding this comment.
No ellipsis here (just end your list with or GPU=UID1), and maybe mark up the key-value pairs with back-ticks to make them show as mono text.
compose/compose-file/index.md
Outdated
| @@ -691,6 +699,23 @@ If you have further questions, please refer to the discussion on the GitHub | |||
| issue [docker/compose/4513](https://github.com/docker/compose/issues/4513){: target="_blank" class="_"}. | |||
| {: .important} | |||
|
|
|||
| ##### Generic Resources | |||
There was a problem hiding this comment.
Sentence case here (lowercase Resources)
compose/compose-file/index.md
Outdated
| Generic resources advertised by swarm nodes and have your tasks land on nodes | ||
| with enough available resources to statisfy your request. | ||
|
|
||
| If you requested Named Generic resource(s), the resources selected will be |
There was a problem hiding this comment.
s/requested/request
s/will be exposed/are exposed
(in docs, we live in the eternal present)
compose/compose-file/index.md
Outdated
| exposed in your container through the use of environment variables. | ||
| E.g: `DOCKER_RESOURCE_GPU=UID1,UID2` | ||
|
|
||
| You can only set the `generic_resources` field for reservations. |
There was a problem hiding this comment.
Is there a place to link to for what "reservations" are? Or would you like to add it to the glossary in _data/glossary.yml?
There was a problem hiding this comment.
Well there is the resource example just in the previous section.
I've updated the sentence to make it more explicit that it's a resource field.
RenaudWasTaken
force-pushed
the
master
branch
from
3c5eb9c
to
b541b8c
Compare
mdlinville
force-pushed
the
vnext-compose
branch
from
b024050
to
104e09b
Compare
Signed-off-by: Renaud Gaubert <rgaubert@nvidia.com>
|
I rebased to fix the conflicts. Waiting for Netlify to finish again. |
mdlinville
force-pushed
the
vnext-compose
branch
from
00dfffb
to
44d4cb7
Compare
Signed-off-by: Renaud Gaubert rgaubert@nvidia.com
Proposed changes
Adding documentations for Generic Resources after having integrated them in the CLI (cli + compose) in docker/cli#429
Unreleased project version
From what I understand Generic Resources will be available in 17.12
This PR is against vnext-compose
Related issues (optional)
Should we close moby/moby#33439 after this and open another issue as we decide how we want to have generic resources evolve ?