[Docs] Clarify PodTemplate restrictions and behavior

[davidmirror-ops]

Description

After reading this page and trying the code examples, there are some open questions:

1. What's the difference between the primary and default containers? Is the default container really a Flyte concept?
2. If a user needs to override the Task container name using a Runtime PodTemplate, how it can be achieved if the use of primary as the base container spec seems to be prescripted?
3. It should be clear that while there's a hierarchy for applying PodTemplates, the watch does not need a deafult-pod-template-name to be set. Even with a namespace-specific PodTemplate, the controller should start the watch
4. Probably code examples have to be revisited to make sure that the restrictions to merge lists (like the containers section) are considered. Using the code example here leads to the controller ignoring all the spec config and using the default.

Are you sure this issue hasn't been raised already?

• Yes

Have you read the Code of Conduct?

• Yes

[runllm]

1. Difference between primary and default containers: The primary container is the main container that must complete for the task to be considered complete. The default container serves as a base configuration for all containers in the Pod. The default container is a Kubernetes concept, not specific to Flyte (source).

2. Overriding Task container name: To override the Task container name using a Runtime PodTemplate, you can specify the primary_container_name in the PodTemplate. This allows you to define a custom name for the primary container (source).

3. Hierarchy for applying PodTemplates: The hierarchy for applying PodTemplates is well-defined, and the watch does not require a default-pod-template-name to be set. Namespace-specific PodTemplates are sufficient for the controller to start the watch (source).

4. Code examples and list merging restrictions: Code examples should be revisited to ensure that list merging restrictions, such as the containers section, are considered. Incorrect configurations can lead to the controller ignoring the spec and using the default configuration (source).

Would you like more detail on any specific point?

Sources:

• Flyte Community Discussion
• Flyte Community Discussion
• FlyteSnacks Pod Example

---

This is an AI-generated response and your feedback is appreciated! Please leave a 👍 if this is helpful and 👎 if it is not.

Mention @RunLLM to ask follow-up questions. See runllm.com for more!

[davidmirror-ops]

Fixing #4864 would help with this issue.