Skip to content

Add NnfContainerData documentation - #307

Merged
matthew-richerson merged 2 commits into
mainfrom
contaienr-crd
Mar 13, 2026
Merged

Add NnfContainerData documentation#307
matthew-richerson merged 2 commits into
mainfrom
contaienr-crd

Conversation

@matthew-richerson

Copy link
Copy Markdown
Contributor

Document the NnfContainerData resource that is created during PreRun for external container orchestrators to use.

Document the NnfContainerData resource that is created during PreRun for
external container orchestrators to use.

Signed-off-by: Matt Richerson <matthew.richerson@hpe.com>
Comment thread docs/guides/user-containers/readme.md Outdated
the workflow. In turn, user containers are created and launched by Kubernetes. Containers are
expected to start in this state. If `createContainer: false`, no pods are launched; instead an
[`NnfContainerData`](#nnfcontainerdata) resource is created that records the storage mount paths.
- PostRun: If `createContainer: true`, user containers are expected to complete (non-zero exit)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(non-zero exit) would indicate the container failed, wouldn't it?

Comment thread docs/guides/user-containers/readme.md Outdated
| `data.volumes[].mountPath` | string | Absolute path on the Rabbit node where the storage is mounted |

The external orchestrator can query the resource by workflow name and namespace to discover where
each storage volume is mounted:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
each storage volume is mounted:
each storage volume is mounted.

Signed-off-by: Matt Richerson <matthew.richerson@hpe.com>
@github-project-automation github-project-automation Bot moved this from 📋 Open to 👀 In review in Issues Dashboard Mar 12, 2026
@matthew-richerson
matthew-richerson merged commit ba28770 into main Mar 13, 2026
1 check passed
@github-project-automation github-project-automation Bot moved this from 👀 In review to ✅ Closed in Issues Dashboard Mar 13, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: ✅ Closed

Development

Successfully merging this pull request may close these issues.

2 participants