Skip to content
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

Fix yaml comment in pod template examples #5024

Merged
merged 2 commits into from
Mar 8, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions docs/deployment/configuration/general.rst
Original file line number Diff line number Diff line change
Expand Up @@ -241,19 +241,19 @@ The resultant Pod using the above default PodTemplate and K8s Plugin configurati
name: example-pod
namespace: flytesnacks-development
labels:
- foo // maintained initial value
- bar // value appended by k8s plugin configuration
- foo # maintained initial value
- bar # value appended by k8s plugin configuration
annotations:
- foo: overridden-value // value overridden by k8s plugin configuration
- bar: initial-value // maintained initial value
- baz: non-overridden-value // value added by k8s plugin configuration
- foo: overridden-value # value overridden by k8s plugin configuration
- bar: initial-value # maintained initial value
- baz: non-overridden-value # value added by k8s plugin configuration
spec:
containers:
- name: ax9kd5xb4p8r45bpdv7v-n0-0
image: ghcr.io/flyteorg/flytecookbook:core-bfee7e549ad749bfb55922e130f4330a0ebc25b0
terminationMessagePath: "/dev/foo"
// remaining container configuration omitted
hostNetwork: true // overridden by the k8s plugin configuration
# remaining container configuration omitted
hostNetwork: true # overridden by the k8s plugin configuration

The last step in constructing a Pod is to apply any task-specific configuration.
These options follow the same rules as merging the default PodTemplate and K8s
Expand Down Expand Up @@ -343,7 +343,7 @@ The resultant Pod is as follows:
image: a.b.c/image:v1
command: cmd
args: []
// remaining container configuration omitted
# remaining container configuration omitted

Notice how options follow the same merging rules, i.e. lists append and maps override.

Expand Down Expand Up @@ -450,4 +450,4 @@ The resultant pod for that task is as follows:
image: a.b.c/image:v1
command: cmd
args: []
// remaining container configuration omitted
# remaining container configuration omitted
Loading