Owner: Architect:

Story (Required)

As an OpenShift user, I would like documentation so I can better understand how to use ClusterWorkloadResourceMapping resources.

Background (Required)

Workload resource mappings are a feature not yet documented for usage with SBO.

Out of scope

Modifying/adding features to SBO itself.  Anything that would require changing SBO outside of its documentation should be captured in a separate story.

In Scope

Writing documentation for SBO.

Approach(Required)

Provide a description of what the fields of a ClusterWorkloadResourceMapping resource mean.  An example of usage with both a PodSpec and a non-PodSpec resource (as defined by the spec) would be useful.

Dependencies

https://issues.redhat.com/browse/APPSVC-970

Acceptance Criteria

Consult with the docs team to understand what they need for documentation.

Documentation should describe how to use workload resource mapping.  It should provide an example of usage with a podspec-compliant resource (such as a CronJob).