Skip to content

Flag unoserver image as alpha, add CPU pinning guidance#116

Merged
Frooodle merged 2 commits into
mainfrom
unoserver-alpha-and-pinning
May 15, 2026
Merged

Flag unoserver image as alpha, add CPU pinning guidance#116
Frooodle merged 2 commits into
mainfrom
unoserver-alpha-and-pinning

Conversation

@Frooodle
Copy link
Copy Markdown
Member

Summary

Follow-up to #115. Two changes to docs/Configuration/LibreOffice-Parallel-Processing.md:

  • Alpha callout. The stirling-unoserver image is only published as :alpha today — the previous tags table implied :latest and :1.0.0 were already available. Adds a :::caution Alpha release admonition, restructures the tags table to flag status (Available now / Coming soon), and notes that the compose examples on the page still use :latest for forward-compatibility so readers should substitute :alpha for now.
  • CPU pinning subsection. The existing wording "one core pinned per active conversion" under Host resource requirements was being read as a literal pinning instruction. Reworded that line to "each active conversion saturates roughly one CPU core" and added a new ### CPU allocation and pinning subsection under "The stirling-unoserver Image" that:
    • States explicitly that pinning is not required and explains why the "one worker per two cores" rule already covers the scheduling headroom LibreOffice needs.
    • Documents the soft cap option (cpus: / --cpus) as the recommended approach when you want a CPU budget without giving up scheduling elasticity.
    • Documents hard pinning (cpuset: / --cpuset-cpus / systemd CPUAffinity) with the cases where it's actually warranted (NUMA, noisy neighbours, benchmarked problem) and the tradeoff (lost elasticity, idle pinned cores).
    • Closes with a tip steering readers to soft caps first and cpuset: only after benchmarking shows the scheduler is the bottleneck.

Test plan

  • Local Docusaurus build renders both admonitions (caution, tip) and the anchor link from Host resource requirements → CPU allocation and pinning.
  • Tags table renders with three columns (Tag / Status / Use).
  • No broken internal anchors.

The stirling-unoserver image is currently only published as :alpha; flag
that explicitly so users don't try to pull :latest. Also add a CPU
allocation and pinning subsection because the existing "one core pinned
per active conversion" wording was being misread as a pinning
instruction. Document both the soft cap (cpus:) and hard pinning
(cpuset:) options, with a steer toward the soft cap.
@vercel
Copy link
Copy Markdown

vercel Bot commented May 15, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
stirling-tools-github-io Ready Ready Preview, Comment May 15, 2026 0:11am

- Compatibility note: latest stirling-unoserver image is always
  compatible with the latest Stirling PDF, so tracking :latest (or
  :alpha today) on both needs no coordination.
- Shorten the CPU allocation section to lead with "Core allocation
  between instances should be handled automatically", and drop the
  preamble, NUMA/HT detail, and closing tip block.
- Rename the section from "CPU allocation and pinning" to
  "CPU allocation" and update the link from Host resource requirements.
- Strip em dashes throughout.
@Frooodle Frooodle merged commit 44f996d into main May 15, 2026
3 checks passed
@Frooodle Frooodle deleted the unoserver-alpha-and-pinning branch May 15, 2026 12:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant