Refactor the spec documentation with better structure: #406
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
Member
resouer
commented
Sep 15, 2020
resouer
commented
- Clarify the intention that workload type is the NAME of workload definition.
- Clarify ContainerizedWorkload as schema of Server workload type.
- Create placeholder for Task workload type.
- Fix several bugs
- Remove SPEC_WORKING_DRAFT.md.
- Rename SPEC_LATEST_STABLE.md to SPEC.md
- Move specification components as part of SPEC.md, not readme.
resouer
requested review from
hongchaodeng,
technosophos and
vturecek
as code owners
resouer
requested review from
wonderflow
and removed request for
technosophos and
vturecek
resouer
force-pushed
the
spec-refactor
branch
2 times, most recently
from
656be86
to
d8eef93
Compare
1. Clarify the intention that workload type is the NAME of workload definition. 2. Clarify ContainerizedWorkload as schema of Server workload type. 3. Create placeholder for Task workload type. 4. Fix several bugs 5. Remove SPEC_WORKING_DRAFT.md. 6. Rename SPEC_LATEST_STABLE.md to SPEC.md 7. Move specification components as part of SPEC.md, not readme.
resouer
force-pushed
the
spec-refactor
branch
from
d8eef93
to
5542477
Compare
wonderflow
approved these changes
Sep 16, 2020
Comment on lines
+42
to
+46
| |-|-|-| | ||
| |`workload.oam.dev/replicable`|boolean|Whether they are replicable. If not, no replication or scaling traits may be assigned.| | ||
| |`workload.oam.dev/daemonized`|boolean|Whether they are daemonized. For daemon types, if the workload exits, this is considered a fault, and the system must fix it. For non-daemonized types, exit is considered a success if no error is reported.| | ||
| |`workload.oam.dev/exposed`|boolean|Whether they are exposed, i.e. have a service endpoint with a stable name for network traffic. Workload types that have a service endpoint need a virtual IP address (VIP) with a DNS name to represent the component as a whole, addressable within their network scope and can be assigned traffic routing traits.| | ||
| |`workload.oam.dev/podspecable`|boolean|Whether this workload can be addressed by Kubernetes `PodSpec`. If yes, the implementation could manipulate the workload by leveraging `PodSpec` structure, instead of being agnostic of the workload's schematic. | |
There was a problem hiding this comment.
just for clarify, we haven't implemented this label mechanism yet.
Co-authored-by: Hongchao Deng <[email protected]>
Co-authored-by: Hongchao Deng <[email protected]>
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.