Documentation of pod-config and container-config schema

[ptwales]

What would you like to be added:

Complete documentation of the schemas for the pod-config.[yaml|json] and container-config.[json|yaml] used by the crictl run and crictl runp commands. Or links to external documentation if these schemas are defined externally.

Why is this needed:

Currently only minimal examples are present in the documentation. Basic fields such as mounts, environment variables, etc. are not mentioned.

I suspect this is entirely defined externally by CRI but I can't find any documentation at all on it's website nor on k8s. Does the documentation for any of these files exist outside of go code?

I've chased down this reference to these:

• ContainerConfig
• PodSandboxConfig
  I don't even know if this is correct though.

[saschagrunert]

@ptwales thank you for reaching out! The schemas are mappings to the CRI api fields: https://github.com/kubernetes/cri-api/blob/master/pkg/apis/runtime/v1/api.proto

Maybe we can enhance the docs to mention and link them. Do you want to collaborate on this change?

[ptwales]

@saschagrunert those API protocols drill down into the same structs I linked to above. Linking to those would be a least effort solution. Although keeping the version linked in sync with the docs would be an issue. I also don't know how much those types are expected to fluctuate or if they are completely finalized.

I humbly think any further documentation should be written by someone who understands the project and isn't just learning it now.

[k8s-triage-robot]

The Kubernetes project currently lacks enough contributors to adequately respond to all issues.

This bot triages un-triaged issues according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

• Mark this issue as fresh with /remove-lifecycle stale
• Close this issue with /close
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

[k8s-triage-robot]

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues.

This bot triages un-triaged issues according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

• Mark this issue as fresh with /remove-lifecycle rotten
• Close this issue with /close
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle rotten

[k8s-triage-robot]

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages issues according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

• Reopen this issue with /reopen
• Mark this issue as fresh with /remove-lifecycle rotten
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/close not-planned

[k8s-ci-robot]

@k8s-triage-robot: Closing this issue, marking it as "Not Planned".

In response to this:

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages issues according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

• Reopen this issue with /reopen
• Mark this issue as fresh with /remove-lifecycle rotten
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/close not-planned

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.