chore(influx): improve usage for influx pkg commands #18334
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jsteenb2
requested review from
samhld,
russorat,
sanderson,
hoorayimhelping and
mhall119
jsteenb2
force-pushed
the
18324/pkger_improve_cli_usage
branch
from
ee6db04 to
95717d1
Compare
jsteenb2
commented
Jun 2, 2020
|
|
||
| Example: | ||
| # Export by a stack | ||
| influx pkg export stack $STACK_ID |
There was a problem hiding this comment.
v2 docs haven't been added yet. Should be available come next release. Will backfill that when it is available. Perhaps we can do it in tandem @sanderson?
There was a problem hiding this comment.
@jsteenb2 This should be pretty easy to add. I'll do it this afternoon. The task-based stack management docs are a different PR and will get finalized once I wrap up my InfluxDays presentation.
There was a problem hiding this comment.
awesome, sounds great 👍
jsteenb2
force-pushed
the
18324/pkger_improve_cli_usage
branch
from
95717d1 to
63415ad
Compare
pierwill
previously requested changes
Jun 2, 2020
cmd/influx/pkg.go
Outdated
| # template associated with it. | ||
| influx pkg --stack-id $STACK_ID | ||
|
|
||
| # Apply a template associated with a stack. Stacks make tempalte application idempotent. |
cmd/influx/pkg.go
Outdated
| # Apply a template from STDIN | ||
| cat $TEMPLATE.json | influx pkg --encoding json | ||
|
|
||
| # Applying a directory of templates, takes everything from provided dir |
There was a problem hiding this comment.
Would expand dir to directory here and below.
jsteenb2
force-pushed
the
18324/pkger_improve_cli_usage
branch
from
63415ad to
b802dfa
Compare
|
@pierwill thank you! pushed up changes per your feedback 👍 |
sanderson
requested changes
Jun 2, 2020
CHANGELOG.md
Outdated
| @@ -4,6 +4,7 @@ | |||
|
|
|||
| 1. [18279](https://github.com/influxdata/influxdb/pull/18279): Make all pkg applications stateful via stacks | |||
| 1. [18322](https://github.com/influxdata/influxdb/pull/18322): Add ability to export a stack's existing (as they are in the platform) resource state as a pkg | |||
| 1. [18334](https://github.com/influxdata/influxdb/pull/18334): Update influx pkg commands with improved usage and examples within long form. | |||
There was a problem hiding this comment.
Update influx pkg commands with improved usage and examples within in long form.
cmd/influx/pkg.go
Outdated
Comment on lines
101
to
105
| The pkg command applies InfluxDB template(s). You can use the command to create | ||
| new resources via a declarative template. The pkg command can consume templates | ||
| via file(s), url(s), stdin, or any combination of the 3. Each run of the pkg | ||
| command ensures that all templates applied are applied in unison as a transaction. | ||
| If any unexpected errors are discovered then all side effects are rolled back. |
There was a problem hiding this comment.
You can Use the command ...
jsteenb2
force-pushed
the
18324/pkger_improve_cli_usage
branch
2 times, most recently
from
deb7e49 to
c01190f
Compare
sanderson
approved these changes
Jun 2, 2020
jsteenb2
force-pushed
the
18324/pkger_improve_cli_usage
branch
from
c01190f to
95bbc6a
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #18324