-
Notifications
You must be signed in to change notification settings - Fork 459
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
doc: miniojob doc #2173
doc: miniojob doc #2173
Conversation
miniojob doc
Apply suggestions from code review Co-authored-by: Shubhendu <[email protected]>
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
suggestion
@ravindk89 @feorlen would you mind checking on this please? |
Sure thing! |
remove doc
PTAL @ravindk89 @djwfyi @feorlen |
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.
Mostly clarifying questions on how parts of this would/should work.
docs/minio-job.md
Outdated
### command | ||
The `command` field specifies the command that will be executed by the `mc` command. | ||
`args` must be empty. And `op` can be set to the main command name. | ||
``` |
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.
Is this for arbitrary commands? Just an array list of strings to pass into a constructor, so I could do
- op: config
- command:
- "mc"
- "admin"
- "config"
- "set"
- "config_setting"
- "config_param=foo"
- "config_param=bar"
Is this ballpark?
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.
Yesh
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.
I would still like to remove op
in case command
is used (it has no use in that case). Or use op: command
and use the args
as the command arguments. I think the current syntax is confusing.
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.
Agree with ramon - it's sufficient to support name
since that is what you would use dependsOn
with. op
is fully redundant.
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.
As a note - how is this meaningfully different from the pre-baked paths?
I could also do
- op: mb
- command:
- "mc"
- "mb"
- "--with-locks"
- "myminio"
- "foobar"
Right?
Also - assuming myminio
is a preconfigured alias for the Tenant. Otherwise we have to specify what alias to use here.
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.
Yes. myminio
is a preconfigured alias for the Tenant. Have a documentation at this markdown top line now.
Nothing different. @ravindk89
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.
op
is optional now for this.
3fce527
add flags example
docs/minio-job.md
Outdated
USER: ZGFuaWVs | ||
PASSWORD: ZGFuaWVsMTIz |
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.
We may want to add a comment in YAML that this specifies user daniel
with password: daniel123
.
docs/minio-job.md
Outdated
### command | ||
The `command` field specifies the command that will be executed by the `mc` command. | ||
`args` must be empty. And `op` can be set to the main command name. | ||
``` |
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.
I would still like to remove op
in case command
is used (it has no use in that case). Or use op: command
and use the args
as the command arguments. I think the current syntax is confusing.
apply suggestion
apply suggestion
apply suggestion
apply suggestion
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.
OK from docs perspective this is a good baseline, and as Pedro noted the goal here is baseline, not complete.
As we iterate we can update this doc, which will eventually flow into the webdoc content.
[miniojob doc](doc: miniojob doc)