Uploaded image for project: 'Docs for Red Hat Developers'
  1. Docs for Red Hat Developers
  2. RHDEVDOCS-7061

Document Running Builds with Runtime Class Set

XMLWordPrintable

      Overview

      This task creates comprehensive user documentation explaining how to use the RuntimeClass feature, including use cases, examples, and troubleshooting guidance.

      Description

      The user documentation should include:

      • User guide section explaining RuntimeClass feature
      • Document use cases (e.g., Kata containers)
      • Provide example YAML configurations:
        • Build with runtimeClassName
        • BuildRun with runtimeClassName
        • BuildRun overriding Build runtimeClassName
      • Document CLI usage with --runtime-class flag
      • Add troubleshooting section for pod scheduling issues

      Acceptance Criteria

      • User guide section created explaining the feature
      • Kata containers use case documented
      • Example YAML configurations provided
      • CLI usage documented
      • Troubleshooting guidance included

      Dependencies

      Technical Notes

      • Should explain what RuntimeClass is and why users might want to use it
      • Kata containers is the primary use case mentioned in the SHIP
      • Should document the precedence behavior clearly
      • Troubleshooting section should address pod scheduling collision risks mentioned in the SHIP
      • Should include links to Kubernetes RuntimeClass documentation

      Related GitHub Issue

      This issue corresponds to: shipwright-io/website#184

      Part of SHIP-0040: Build Runtime Class implementation. See SHIP-0040 for the full enhancement proposal.

              rhn-support-ssathe Shivani Sathe
              adkaplan@redhat.com Adam Kaplan
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated: