Skip to content

docs: document the minimal IAM policy for the executor#48

Open
nh13 wants to merge 1 commit into
snakemake:mainfrom
nh13:nh_iam-docs
Open

docs: document the minimal IAM policy for the executor#48
nh13 wants to merge 1 commit into
snakemake:mainfrom
nh13:nh_iam-docs

Conversation

@nh13

@nh13 nh13 commented Jul 15, 2026

Copy link
Copy Markdown
Collaborator

Adds a "Required IAM permissions" section to docs/further.md giving the minimal policy the executor role needs:

  • Core policy (always required): batch:SubmitJob, batch:DescribeJobs, batch:RegisterJobDefinition, batch:DeregisterJobDefinition, batch:TerminateJob, batch:DescribeJobQueues, batch:DescribeComputeEnvironments, and iam:PassRole.
  • Tags add-on (--aws-batch-tags / SNAKEMAKE_AWS_BATCH_JOB_TAGS): batch:TagResource, with a note that ecs:TagResource may also be required depending on the account's tag-authorization settings (for tag propagation to ECS).

Each permission is tied to the feature that needs it, and the register/deregister and PassRole statements are called out as conditional (register/deregister can be dropped with a pre-existing job definition; PassRole is only needed when --aws-batch-job-role is set, and should be scoped to that role ARN). Cross-linked from the README.

Docs-only — no code changes.

@coderabbitai

coderabbitai Bot commented Jul 15, 2026

Copy link
Copy Markdown
Contributor

Warning

Review limit reached

@nh13, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 3 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: c3e766b9-3b21-42db-a801-24a8b06ff25f

📥 Commits

Reviewing files that changed from the base of the PR and between 47e8027 and 6718396.

📒 Files selected for processing (2)
  • README.md
  • docs/further.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

Add a "Required IAM permissions" section to docs/further.md giving the minimal
core policy the executor role needs (batch:SubmitJob/DescribeJobs/
RegisterJobDefinition/DeregisterJobDefinition/TerminateJob/DescribeJobQueues/
DescribeComputeEnvironments and iam:PassRole), plus a single tags add-on
(batch:TagResource, with an ecs:TagResource note for tag propagation). Each
permission is tied to the feature that needs it, and the register/deregister
and PassRole statements are called out as conditional (pre-existing job
definitions, and only when --aws-batch-job-role is set). Cross-linked from the
README.
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