Skip to content

fix(docs): Configuration packages CAN include MRAPs - #1127

Open
boxcee-interview wants to merge 1 commit into
crossplane:masterfrom
boxcee-interview:fix/issue-1126-mrap-docs
Open

fix(docs): Configuration packages CAN include MRAPs#1127
boxcee-interview wants to merge 1 commit into
crossplane:masterfrom
boxcee-interview:fix/issue-1126-mrap-docs

Conversation

@boxcee-interview

Copy link
Copy Markdown

Closes #1126

Problem

The MRAP docs claimed Configuration packages can include MRAPs, but the xpkg spec restricts Configuration packages to Configuration, CompositeResourceDefinition, and Composition objects only.

Solution

  • Clarify that MRAPs cannot be bundled in Configuration packages
  • Link to the xpkg spec as authoritative reference
  • Show the correct approach: use dependsOn in crossplane.yaml for Provider dependencies
  • Explain that MRAPs are applied separately by cluster operators
  • Recommend documenting MRD requirements in package READMEs
  • Update best practices section to align

How to Test

Review the updated MRAP documentation at the Configuration package activation section. Verify the changes align with the xpkg spec.

@netlify

netlify Bot commented Jul 19, 2026

Copy link
Copy Markdown

Deploy Preview for crossplane ready!

Name Link
🔨 Latest commit 337eea7
🔍 Latest deploy log https://app.netlify.com/projects/crossplane/deploys/6a7fa5eb98a03700086b17de
😎 Deploy Preview https://deploy-preview-1127--crossplane.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 94 (🟢 up 1 from production)
Accessibility: 90 (🔴 down 2 from production)
Best Practices: 92 (no change from production)
SEO: 100 (no change from production)
PWA: 70 (no change from production)
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify project configuration.

4. **Include activation dependencies in Configuration packages** -
Configuration packages should declare what MRDs they need rather than
assuming resources are available
4. **Document MRD requirements in Configuration packages** -

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks for enhancing the documentation, but it is possible to add an MRAP to an configuration Package: https://github.com/crossplane/crossplane-runtime/blob/main/pkg/xpkg/lint.go#L75 thats the linter the cli is using - can you update your PR ?

@boxcee-interview boxcee-interview Aug 14, 2026

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You're right, thanks for catching that — I missed the linter's IsActivationPolicy case. The previous wording was wrong; I've reverted to the original claim and added a pointer to the package linter as the authoritative check (commit 337eea7). Vale passes on the file.

The package linter (crossplane-runtime pkg/xpkg/lint.go,
NewConfigurationLinter) accepts ManagedResourceActivationPolicy objects in
Configuration packages, so the previous wording was wrong. Keep the claim
that packages can include MRAPs and point at the linter as the
authoritative check, per haarchri review.

Signed-off-by: Moritz Schmitz von Hülst <mschmitzvonhuelst@gmail.com>
@boxcee-interview
boxcee-interview force-pushed the fix/issue-1126-mrap-docs branch from de2e818 to 337eea7 Compare August 14, 2026 23:34
@boxcee-interview boxcee-interview changed the title fix(docs): clarify Configuration packages cannot include MRAPs fix(docs): Configuration packages CAN include MRAPs Aug 14, 2026
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.

[Web Bug] - Managed Resource Activation Policies

2 participants