docs(gcp-batch): Add head job sizing guidance for production pipelines#1672
Open
justinegeffen wants to merge 3 commits into
Open
docs(gcp-batch): Add head job sizing guidance for production pipelines#1672justinegeffen wants to merge 3 commits into
justinegeffen wants to merge 3 commits into
Conversation
Adds head job sizing guidance to the GCP Batch compute environment documentation in the Cloud, Enterprise, and version-26.1 versioned docs. Without this guidance, customers setting up production pipelines on GCP Batch have no indication that the default head job resources are insufficient for large workflows. Adds a :::caution block on the Head job CPUs / Head job memory fields covering: production warning, OOM failure behavior, sizing table (Small/Medium/Large scales), scaling guidance, NXF_JVM_ARGS heap tuning, and an instance-template override cross-reference. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
✅ Deploy Preview for seqera-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
Author
|
Approved by Laramie on initial PR https://github.com/seqeralabs/docs-internal/pull/1. |
christopher-hakkaart
approved these changes
Jul 20, 2026
christopher-hakkaart
left a comment
christopher-hakkaart
left a comment
Member
There was a problem hiding this comment.
A lite deslop on the text. We will need to check the preview at the indentation may now be off. Otherwise looks good.
Member
|
Indentation looks correct. But please note the update to the step in cloud. I think it should be 9 not 8. |
Co-authored-by: Chris Hakkaart <chris.hakkaart@seqera.io> Signed-off-by: Justine Geffen <justinegeffen@users.noreply.github.com>
justinegeffen
added
2. Edu reviews complete
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds head job sizing guidance to the GCP Batch compute environment documentation across three surfaces: Cloud, Enterprise, and the
version-26.1versioned snapshot. Without this guidance, customers setting up production pipelines on GCP Batch have no indication that the default head job resources are insufficient for large workflows — if the head job OOMs mid-run, the pipeline fails and results may be incomplete.Changes
Files updated
platform-cloud/docs/compute-envs/google-cloud-batch.mdplatform-enterprise_docs/compute-envs/google-cloud-batch.mdplatform-enterprise_versioned_docs/version-26.1/compute-envs/google-cloud-batch.mdWhat was added
A
:::cautionadmonition on the Head job CPUs / Head job memory fields (Advanced options) covering:Production warning — Default head job resource values are insufficient for production pipelines.
OOM failure behavior — Pipeline fails immediately; already-running worker tasks complete but no new tasks are scheduled; output files are not cleaned up.
Sizing table — CPU/memory recommendations by pipeline scale:
Scaling guidance — Memory scales with concurrent tasks and duration; CPU is moderate.
JVM heap tuning —
NXF_JVM_ARGS="-Xms4g -Xmx12g"as a Head job environment variable.Instance template cross-reference — Notes that a Head job instance template overrides these fields.
Plus a
last updatedfrontmatter bump to2026-07-20on all three files.Test plan
#scripting-and-environment-variablesresolves on all three pages🤖 Generated with Claude Code