fix(docs): Configuration packages CAN include MRAPs - #1127
fix(docs): Configuration packages CAN include MRAPs#1127boxcee-interview wants to merge 1 commit into
Conversation
✅ Deploy Preview for crossplane ready!
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** - |
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 ?
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
looks better - can we do the changes in all the active docs ? and please don't link the linter - lets link the cli docs for crossplane xpkg build which is enough in my point of view
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>
de2e818 to
337eea7
Compare
boxcee-interview
changed the title
2 participants
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.