Change task schema doc to reflect the new implementation #384
Conversation
This file contains hidden or 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
pengz1
reviewed
Mar 28, 2017
docs/rackhd/tasks.rst
Outdated
| - A Task Definition conforms to only one Task Schema, but different Task Definition can conform to the same Task Schema; For example, all obm-control tasks share the same obm-control schema. | ||
| - A Task Schema only describes one Job, but a Job may be described by multiple Task Schemas. For example, all of install-centos, install-ubuntu, install-esxi schemas are to describe the same install-os job. | ||
| - A Task Schema can include other schemas for the sake of schema reuse and minimizing duplication. For example, all task schemas include a common options schema. | ||
| There are totally 3 kinds of options schema: Common options schema, BaseTask options schema and Task options schema. |
Member
There was a problem hiding this comment.
Capitalizing for Common, BaseTask, Task is not consistent in the document, as Line 166 is using lowercase.
docs/rackhd/tasks.rst
Outdated
| There are totally 3 kinds of options schema: Common options schema, BaseTask options schema and Task options schema. | ||
|
|
||
| Below is a diagram shows the relation: | ||
| - The common options schema is to describe all those common options that shared by all tasks, such as `_taskTimeout`, the common options schema is defined in the file 'https://github.com/RackHD/on-tasks/blob/master/lib/task-data/schemas/common-task-options.json'. User doesn't have to explicitly define the common schema in Task or BaseTask definition, it is defaultly enabled for every task. |
Member
There was a problem hiding this comment.
that are shared by
defaultly => default
|
|
||
| You can follow below 3 steps to define a Task Schema: | ||
| - The schema in Task definition is to describe the options of corresponding task. Since a task defintion will always link to a BaseTask, so the task's schema will automatically inherit the BaseTask's schema during validation. So in practice, usually the task schema only need to describe those options that not included in BaseTask. | ||
|
|
Member
There was a problem hiding this comment.
need => needs or to remove to
that not included => that are not included or remove that.
docs/rackhd/tasks.rst
Outdated
| - The schema in Task definition is to describe the options of corresponding task. Since a task defintion will always link to a BaseTask, so the task's schema will automatically inherit the BaseTask's schema during validation. So in practice, usually the task schema only need to describe those options that not included in BaseTask. | ||
|
|
||
| - Step 1: Create a JSON File | ||
| NOTE: The options schema is always optional for Task/BaseTask definition. If missing options schema, that means user gives up the upfront options validation before running a TaskGraph. |
Member
There was a problem hiding this comment.
If missing options schema => If options schema is missing
docs/rackhd/tasks.rst
Outdated
| - Schema File Reference <String>: Specify the file name of a JSON file, the JSON file is a valid JSON schema and it must be placed in the folder 'https://github.com/RackHD/on-tasks/tree/master/lib/task-data/schemas'. | ||
|
|
||
| - Step 3: Define Options | ||
| The Built-in Schema is usually used when there is few options or for those situation that is not suitable to use file reference, such as within skupack. |
Member
There was a problem hiding this comment.
those => the, or just remove those
docs/rackhd/tasks.rst
Outdated
| **Upfront Schema Validation** | ||
|
|
||
| The Task Schema validation will be firstly executed when user triggers a workflow. Only if all options (Combine user input and the default value) conform to schema for every task, the workflow then can be successfully triggered. | ||
| The options schema validation will be firstly executed when user triggers a workflow. Only if all options (Combine user input and the default value) conform to all kinds of above schemas for the task, the workflow then can be successfully triggered. |
Member
There was a problem hiding this comment.
all kinds of => all of, then can => can then
yyscamper
force-pushed
the
task-schema-doc
branch
from
8acacca to
0c15092
Compare
Contributor
Author
|
Thanks @pengz1 , all your comment has been addressed. |
pengz1
approved these changes
Mar 29, 2017
anhou
approved these changes
Apr 1, 2017
BillyAbildgaard
pushed a commit
to BillyAbildgaard/docs
that referenced
this pull request
Apr 7, 2017
…schema Add redfish-obm-service schema and fix node view
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
I had refactored the task schema design (see RackHD/on-tasks#360), but I forgot to update the doc
@anhou @manfrednde @brianparry @iceiilin @pengz1 @lanchongyizu