Skip to content

Docs: add note about management commands targeting a manager - #1590

Merged
silvin-lubecki merged 1 commit into
docker:masterfrom
thaJeztah:docs_add_management_notes
Dec 12, 2019
Merged

Docs: add note about management commands targeting a manager#1590
silvin-lubecki merged 1 commit into
docker:masterfrom
thaJeztah:docs_add_management_notes

Conversation

@thaJeztah

@thaJeztahthaJeztah commented Dec 23, 2018•
edited
Loading

Copy link
Copy Markdown
Member

Alternative for #1578

closes#1578 already merged

thaJeztah
thaJeztah commented Dec 23, 2018
View reviewed changes
Comment threaddocs/reference/commandline/stack_deploy.md Outdated
has to be run targeting a manager node.
Create and update a stack from a `compose` or a `dab` file on the swarm.

> **Note**: This is a cluster management command, and must be executed on a swarm

@thaJeztahthaJeztahDec 23, 2018

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wasn't sure how to deal with k8s as an orchestrator here; this command can be run both on Swarm or Kubernetes, so we may need a different description to either make it generic enough to fit both use-cases, or extend the description to explicitly call out both use-cases

@silvin-lubeckisilvin-lubeckiDec 27, 2018

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe add a something like: **Note**:If you use swarm as an orchestrator, this is a cluster management command... ?

@thaJeztah

thaJeztah commented Dec 23, 2018

Copy link
Copy Markdown
MemberAuthor

This is a quick approach for this, but I think we can add annotations for this, so that;

  • it can be used to automatically show/hide commands if the node is not a manager
  • it can be included in the generated YAML docs, so that we can add this information automatically when generating the documentation; similar to the API-version and Orchestrator annotations;

screen shot 2018-12-23 at 12 33 00

@codecov-io

codecov-io commented Dec 23, 2018•
edited
Loading

Copy link
Copy Markdown

Codecov Report

❗ No coverage uploaded for pull request base (master@0fd5c16). Click here to learn what that means.
The diff coverage is n/a.

@@ Coverage Diff @@## master #1590 +/- ##
=========================================
Coverage ? 55.25% =========================================
Files ? 289 Lines ? 19395 Branches ? 0 =========================================
Hits ? 10716 Misses ? 7983 Partials ? 696

@thaJeztah

thaJeztah commented Dec 23, 2018

Copy link
Copy Markdown
MemberAuthor

@ahh-docker@vdemeester

vdemeester
vdemeester approved these changes Dec 24, 2018
View reviewed changes

@vdemeestervdemeester left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

SGTM 👼

@thaJeztah
thaJeztahforce-pushed the docs_add_management_notes branch from 02fdf9b to 2cac3eaCompareDecember 24, 2018 09:49
@ahh-docker

ahh-docker commented Dec 27, 2018

Copy link
Copy Markdown
Contributor

LGTM

@SvenDowideit

SvenDowideit commented Jan 21, 2019

Copy link
Copy Markdown
Contributor

mmm, LGTM - though i'm saddened that I didn't build something to let you transclude the note from one place :D

@thaJeztah

thaJeztah commented Jan 21, 2019

Copy link
Copy Markdown
MemberAuthor

though i'm saddened that I didn't build something to let you transclude the note from one place :D

Yeah, the docs switched to Jekyll at some point, so perhaps it could be handled there, but I didn't want to jinx it 😂

Let me do a small update to address the "kubernetes as stack orchestrator" situation;
#1590 (comment)

@thaJeztah
thaJeztahforce-pushed the docs_add_management_notes branch from 2cac3ea to 8e1cdb5CompareDecember 10, 2019 13:31
@thaJeztah

thaJeztah commented Dec 10, 2019

Copy link
Copy Markdown
MemberAuthor

@silvin-lubecki slightly changed the wording for docker stack commands, to explicitly mention that a manager node must be targeted when using "swarm" as orchestrator.

silvin-lubecki
silvin-lubecki approved these changes Dec 12, 2019
View reviewed changes

@silvin-lubeckisilvin-lubecki left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@thaJeztah
Docs: add note about management commands targeting a manager
f540eae
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
@thaJeztah
thaJeztahforce-pushed the docs_add_management_notes branch from 8e1cdb5 to f540eaeCompareDecember 12, 2019 13:57
@silvin-lubecki
silvin-lubecki merged commit eb33f87 into docker:masterDec 12, 2019
@thaJeztah
thaJeztah deleted the docs_add_management_notes branch December 12, 2019 14:38
@thaJeztahthaJeztah mentioned this pull request Jan 17, 2020
Merged
@thaJeztahthaJeztah added this to the 20.03.0 milestone Feb 19, 2020
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@silvin-lubeckisilvin-lubeckisilvin-lubecki approved these changes
+1 more reviewer
@vdemeestervdemeestervdemeester approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

kind/docsprocess/cherry-pickedstatus/3-docs-review

Projects

None yet

Milestone

20.10.0

Development

Successfully merging this pull request may close these issues.

7 participants

@thaJeztah@codecov-io@ahh-docker@SvenDowideit@vdemeester@silvin-lubecki@GordonTheTurtle