chore(docs): adapt deployment description - #303
Conversation
Adapt the deployment description to the current process in gitops
ee069ae to
387772a
Compare
| # release/ one image per `v*` tag — what prod runs | ||
| # temporary/ one image per push to main — what dev runs, moves constantly |
There was a problem hiding this comment.
comment: this works, but it is non-standard, and we could drop the {release,temporary}/ prefix. Normally one would just tag release images v<core-version> and temporary image v<core-version>+<build>. For example v0.9.0+7bb2580. This is semver-compliant syntax.
| # With no `tag` set, the chart falls back to `appVersion` from Chart.yaml. | ||
| # Release builds tag their images with the bare version, so that resolves to an | ||
| # image that exists. This is the prod arrangement: no image overrides at all. |
There was a problem hiding this comment.
comment: I am not sure I understand this sentence. And I don't think we need 3 lines to explain the tag.
suggestion: plain human english. like:
# Image tags default to the Chart's appVersion.
| # --set frontend.image.pullPolicy=Always | ||
| # | ||
| # The pull policy is not optional there. The default `IfNotPresent` below never | ||
| # re-pulls a moving tag, so the node would keep serving whichever image it | ||
| # fetched first. |
There was a problem hiding this comment.
| # --set frontend.image.pullPolicy=Always | |
| # | |
| # The pull policy is not optional there. The default `IfNotPresent` below never | |
| # re-pulls a moving tag, so the node would keep serving whichever image it | |
| # fetched first. |
comment: I just learnt that kubernetes sets pullPolicy: Always when the tag is latest and the policy is not specified (source).
suggestion: set pullPolicy: "" in values.yaml. It will simply default to ifNotPresent on version tags, and Always on moving tags.
There was a problem hiding this comment.
comment: IMO the deployment-specific documentation belongs in that deployment's repo. The app repo should stick to deployment-agnostic documentation.
There was a problem hiding this comment.
@cmdoret What is the deployment's repo in this case?
2 participants
Adapt the deployment description to the current process in gitops