@@ -5,18 +5,20 @@ different Pod-creating Kubernetes resources in an AppWrapper.
5
5
AppWrappers can be used to wrap any Kubernetes Kind that uses ` PodSpecTemplate `
6
6
to express its Pods.
7
7
8
- An AppWrapper contains a ` component ` array of ` AppWrapperComponents ` .
8
+ An AppWrapper contains a` components ` array containing the wrapped resources .
9
9
Each component has two main pieces: a ` template ` that defines the wrapped resource
10
10
and a ` podSets ` array that gives the ` replicas ` and ` path ` within the template
11
11
for each ` PodSpecTemplate ` . For correct operation of the AppWrapper, it is
12
12
required 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.
14
15
15
16
To simplify the user experience, for a selection of commonly-used Kubernetes
16
17
resource 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:
20
22
+ v1 Pod
21
23
+ apps/v1 Deployment
22
24
+ apps/v1 StatefulSet
@@ -25,5 +27,5 @@ will validate that any explicitly provided `podSet` entries match the definition
25
27
+ ray.io/v1 RayCluster
26
28
+ ray.io/v1 RayJob
27
29
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