fix(docs): clarify Configuration packages cannot include MRAPs - #1127
Open
boxcee-interview wants to merge 1 commit into
Open
fix(docs): clarify Configuration packages cannot include MRAPs#1127boxcee-interview wants to merge 1 commit into
boxcee-interview wants to merge 1 commit into
Conversation
The xpkg spec restricts Configuration packages to Configuration, CompositeResourceDefinition, and Composition objects only. MRAPs cannot be bundled in Configuration packages. Update docs to: - Explain that MRAPs are applied separately by cluster operators - Show correct approach using dependsOn in crossplane.yaml - Recommend documenting MRD requirements in package README - Align best practices section with this constraint Closes crossplane#1126 Signed-off-by: Moritz Schmitz von Hülst <mschmitzvonhuelst@gmail.com>
✅ Deploy Preview for crossplane ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
haarchri
reviewed
Aug 13, 2026
| 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** - |
Member
There was a problem hiding this comment.
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 ?
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.
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
dependsOnin crossplane.yaml for Provider dependenciesHow to Test
Review the updated MRAP documentation at the Configuration package activation section. Verify the changes align with the xpkg spec.