Skip to content

Commit

Permalink
editing pass
Browse files Browse the repository at this point in the history
  • Loading branch information
dgrove-oss committed Jan 15, 2025
1 parent 07cb5ee commit b38034d
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions samples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,20 @@ different Pod-creating Kubernetes resources in an AppWrapper.
AppWrappers can be used to wrap any Kubernetes Kind that uses `PodSpecTemplate`
to express its Pods.

An AppWrapper contains a `component` array of `AppWrapperComponents`.
An AppWrapper contains a`components` array containing the wrapped resources.
Each component has two main pieces: a `template` that defines the wrapped resource
and a `podSets` array that gives the `replicas` and `path` within the template
for each `PodSpecTemplate`. For correct operation of the AppWrapper, it is
required that the provided `path` and `replicas` information correctly represent
the Pod creating behavior of the wrapped resource.
the Pod creating behavior of the wrapped resource. For resources that do not
created Pods (eg `Services` or `Secrets`) `podSets` should be empty and thus omitted.

To simplify the user experience, for a selection of commonly-used Kubernetes
resource Kinds, the AppWrapper controller can automatically infer the `podSets`
array if it is not provided. For these same kinds, the AppWrapper controller
will validate that any explicitly provided `podSet` entries match the definitions in
`template`. The current set of automatically inferred Kinds is:
array if it is not provided. For these same Kinds, the AppWrapper controller
will validate that any explicitly provided `podSet` entries do in fact match the
definitions in `template`.
The current set of automatically inferred Kinds is:
+ v1 Pod
+ apps/v1 Deployment
+ apps/v1 StatefulSet
Expand All @@ -25,5 +27,5 @@ will validate that any explicitly provided `podSet` entries match the definition
+ ray.io/v1 RayCluster
+ ray.io/v1 RayJob

In all the examples, if the Kind supports automatic inference the `podSets`
are elided.
In all of the examples, if automatic inference is supported for the wrapped Kind,
the `podSets` are omitted from the AppWrapper.

0 comments on commit b38034d

Please sign in to comment.