-
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
Add capabilities to task drivers' pages #8476
Conversation
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.
Thanks for this contribution @kobayashi! I took a look at the preview deploys (ex. docker) and the layout looks great.
Can you provide a sentence with a link to the API docs at the top of each capabilities section? Maybe something like:
The X task driver implements the following capabilities
And then for the Implementation
side of the table, we'd rather have a plain English version of the enums. So for example, instead of FSIsolationImage
, just image
is fine. These are operator docs rather than plugin developer docs, so having that is a little more user-friendly.
website/pages/docs/drivers/java.mdx
Outdated
| Feature | Implementation | | ||
| --- | --- | | ||
| Exec | false | | ||
| FSIsolation | FSIsolationNone | |
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.
On Linux the Java capabilities are slightly different: https://github.com/hashicorp/nomad/blob/v0.12.0/drivers/java/driver.go#L98-L101
website/pages/docs/drivers/exec.mdx
Outdated
| --- | --- | | ||
| SendSignals | true | | ||
| Exec | true | | ||
| FSIsolation | FSIsolationImage | |
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.
website/pages/docs/drivers/exec.mdx
Outdated
| SendSignals | true | | ||
| Exec | true | | ||
| FSIsolation | FSIsolationImage | | ||
| NetIsolationModes | NetIsolationModeHost, NetIsolationmodeGroup | |
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 should include MustInitiateNetwork | false
everywhere it's not explicitly set to true
by default.
website/pages/docs/drivers/qemu.mdx
Outdated
| SendSignals | false | | ||
| Exec | false | | ||
| FSIsolation | FSIsolationImage | | ||
| MountConfigs | MountConfigSupportNone | |
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 should include | NetIsolationModes | none |
here
Thank you for the review @tgross ! |
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
I'm going to lock this pull request because it has been closed for 120 days ⏳. This helps our maintainers find and focus on the active contributions. |
This add table of capabilities to each task driver page. #8402