feat(757): Add screwdriver.cd/disk annotation; deprecate beta.screwdriver.cd #233
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
tkyi
reviewed
Sep 10, 2018
| @@ -35,6 +35,7 @@ Some Annotations are used to modify the properties of the build environment. The | |||
| | beta.screwdriver.cd/executor | Ask your cluster admin | This will determine what compute system is used to run the build. For example, set the build to run in a VM, a kubernetes pod, a docker container, or a Jenkins agent. | | |||
| | beta.screwdriver.cd/cpu | `MICRO` / `LOW` / `HIGH` | When using a `k8s` executor, this will allow the user to choose between 0.5 (`MICRO`), 2 (`LOW`) and 6 (`HIGH`) CPU resources. Default is `LOW`.<br> When using a `k8s-vm` executor, this will allow the user to choose between 1 (`MICRO`), 2 (`LOW`) and 6 (`HIGH`) CPU resources. Default is `LOW`. | | |||
| | beta.screwdriver.cd/ram | `MICRO` / `LOW` / `HIGH` | When using a `k8s` executor, this will allow the user to choose between 1 GB (`MICRO`), 2 GB (`LOW`) and 12 GB (`HIGH`) RAM. Default is `LOW`.<br> When using a `k8s-vm` executor, this will allow the user to choose between 1 GB (`MICRO`), 2 GB (`LOW`) and 12 GB (`HIGH`) RAM. Default is `LOW`. | | |||
| | beta.screwdriver.cd/disk | `LOW` / `HIGH` | When using a `k8s-vm` executor, this will allow the user to choose between 20 GB (`LOW`) and 50 GB (`HIGH`) disk space. Default is `LOW`. | | |||
There was a problem hiding this comment.
Not sure if this makes more or less sense, but should this be alphabetically positioned in relation to the other resource annotations? (beta.screwdriver.cd/cpu, beta.screwdriver.cd/disk, beta.screwdriver.cd/ram)
tkyi
approved these changes
Sep 11, 2018
minzcmu
reviewed
Sep 11, 2018
tkyi
reviewed
Sep 11, 2018
| screwdriver.cd/buildPeriodically: H H(4-7) * * * # Run the job every day sometime between 4am and 7am UTC. | ||
| ``` | ||
|
|
||
| ## Supported Annotations | ||
| Some Annotations are used to modify the properties of the build environment. The following annotations are supported by plugins maintained by Screwdriver.cd. Ask your cluster admin which annotations are supported in your Screwdriver cluster. | ||
|
|
||
| Please note that `beta.screwdriver.cd` is deprecated in favor of `screwdriver.cd`. However, annotations that are prefixed with `beta.screwdriver.cd` will continue to work. |
There was a problem hiding this comment.
for now*?
might want to use > to highlight it
Example:
Please note that
beta.screwdriver.cdis deprecated in favor ofscrewdriver.cd. However, annotations that are prefixed withbeta.screwdriver.cdwill continue to work for now.
minzcmu
approved these changes
Sep 11, 2018
tkyi
approved these changes
Sep 12, 2018
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.
Context
High disk support will soon be available for
k8s-vm. This is configurable via thescrewdriver.cd/diskannotation.Additionally we plan to deprecate
beta.screwdriver.cdin favor ofscrewdriver.cdObjective
Document the
screwdriver.cd/diskannotation.Document the deprecation of
beta.screwdriver.cd.References
screwdriver-cd/screwdriver#757
screwdriver-cd/executor-k8s-vm#39
screwdriver-cd/executor-base#48