-
Notifications
You must be signed in to change notification settings - Fork 1
chore(docs): adapt deployment description #303
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
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -8,18 +8,22 @@ baseDomain: "example.com" | |||||||||||
| # Images | ||||||||||||
| # ============================================================ | ||||||||||||
| # An image address is `repository:tag`. Two repositories exist: | ||||||||||||
| # release/ one image per `v*` tag — what you deploy | ||||||||||||
| # temporary/ one image per push to main — for testing, moves constantly | ||||||||||||
| # release/ one image per `v*` tag — what prod runs | ||||||||||||
| # temporary/ one image per push to main — what dev runs, moves constantly | ||||||||||||
|
Comment on lines
+11
to
+12
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. comment: this works, but it is non-standard, and we could drop the |
||||||||||||
| # | ||||||||||||
| # If there is no `tag` specified: then the chart then uses its the | ||||||||||||
| # `appVersion` from Chart.yaml, | ||||||||||||
| # 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. | ||||||||||||
|
Comment on lines
+14
to
+16
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. comment: I am not sure I understand this sentence. And I don't think we need 3 lines to explain the tag. |
||||||||||||
| # | ||||||||||||
| # But for test deploys you might want to override this, with a | ||||||||||||
| # tagged image from the `temporary/` repository. | ||||||||||||
| # | ||||||||||||
| # To test against the head of `main`, override both keys, e.g.: | ||||||||||||
| # A cluster that should follow `main` instead overrides three keys per | ||||||||||||
| # component: | ||||||||||||
| # --set frontend.image.repository=<registry>/temporary/frontend-service | ||||||||||||
| # --set frontend.image.tag=latest | ||||||||||||
| # --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 on lines
+22
to
+26
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
comment: I just learnt that kubernetes sets |
||||||||||||
| # | ||||||||||||
| # ============================================================ | ||||||||||||
| # Frontend | ||||||||||||
|
|
||||||||||||
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.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@cmdoret What is the deployment's repo in this case?
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.
ordes cloud-infra