--template is required to use krane run
#668
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
cjoudrey
commented
Jan 17, 2020
| @@ -503,7 +503,7 @@ Based on this specification `krane run` will create a new pod with the entrypoin | |||
|
|
|||
| *Options:* | |||
|
|
|||
| * `--template=TEMPLATE`: Specifies the name of the PodTemplate to use (default is `task-runner-template` if this option is not set). | |||
| * `--template=TEMPLATE`: Specifies the name of the PodTemplate to use. | |||
There was a problem hiding this comment.
Wasn't sure what the convention was to mention the option is required.
I was going to put:
Suggested change
| * `--template=TEMPLATE`: Specifies the name of the PodTemplate to use. | |
| * `--template=TEMPLATE` (required): Specifies the name of the PodTemplate to use. |
There was a problem hiding this comment.
Not a convention we're currently using.
dturn
approved these changes
Jan 18, 2020
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.
When reading the usage of
krane runin theREADME.md, I noticed the--templateoption was documented as being optional.This doesn't match the current behaviour of
krane run:After chatting with @dturn, it sounds like this was a typo in the
README.md, hence this PR. 😄