-
Notifications
You must be signed in to change notification settings - Fork 2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Docs: add note about management commands targeting a manager #1590
Docs: add note about management commands targeting a manager #1590
Conversation
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 |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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...
?
This is a quick approach for this, but I think we can add annotations for this, so that;
|
Codecov Report
@@ Coverage Diff @@
## master #1590 +/- ##
=========================================
Coverage ? 55.25%
=========================================
Files ? 289
Lines ? 19395
Branches ? 0
=========================================
Hits ? 10716
Misses ? 7983
Partials ? 696 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
SGTM 👼
02fdf9b
to
2cac3ea
Compare
LGTM |
mmm, LGTM - 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; |
2cac3ea
to
8e1cdb5
Compare
@silvin-lubecki slightly changed the wording for |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
8e1cdb5
to
f540eae
Compare
Alternative for #1578
closes #1578already merged