@@ -5,18 +5,20 @@ different Pod-creating Kubernetes resources in an AppWrapper.
55AppWrappers can be used to wrap any Kubernetes Kind that uses ` PodSpecTemplate `
66to express its Pods.
77
8- An AppWrapper contains a ` component ` array of ` AppWrapperComponents ` .
8+ An AppWrapper contains a` components ` array containing the wrapped resources .
99Each component has two main pieces: a ` template ` that defines the wrapped resource
1010and a ` podSets ` array that gives the ` replicas ` and ` path ` within the template
1111for each ` PodSpecTemplate ` . For correct operation of the AppWrapper, it is
1212required that the provided ` path ` and ` replicas ` information correctly represent
13- the Pod creating behavior of the wrapped resource.
13+ the Pod creating behavior of the wrapped resource. For resources that do not
14+ created Pods (eg ` Services ` or ` Secrets ` ) ` podSets ` should be empty and thus omitted.
1415
1516To simplify the user experience, for a selection of commonly-used Kubernetes
1617resource Kinds, the AppWrapper controller can automatically infer the ` podSets `
17- array if it is not provided. For these same kinds, the AppWrapper controller
18- will validate that any explicitly provided ` podSet ` entries match the definitions in
19- ` template ` . The current set of automatically inferred Kinds is:
18+ array if it is not provided. For these same Kinds, the AppWrapper controller
19+ will validate that any explicitly provided ` podSet ` entries do in fact match the
20+ definitions in ` template ` .
21+ The current set of automatically inferred Kinds is:
2022 + v1 Pod
2123 + apps/v1 Deployment
2224 + apps/v1 StatefulSet
@@ -25,5 +27,5 @@ will validate that any explicitly provided `podSet` entries match the definition
2527 + ray.io/v1 RayCluster
2628 + ray.io/v1 RayJob
2729
28- In all the examples, if the Kind supports automatic inference the ` podSets `
29- are elided .
30+ In all of the examples, if automatic inference is supported for the wrapped Kind,
31+ the ` podSets ` are omitted from the AppWrapper .
0 commit comments