Skip to content

Document the ImageConfig path rewriting feature in Crossplane 1.20 #936

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 22, 2025

Conversation

adamwg
Copy link
Contributor

@adamwg adamwg commented May 21, 2025

While we're here, move the common content on matching and debugging to their own top-level headings, since they apply to all the different ImageConfig features.

Copy link

netlify bot commented May 21, 2025

Deploy Preview for crossplane ready!

Name Link
🔨 Latest commit ee31c7b
🔍 Latest deploy log https://app.netlify.com/projects/crossplane/deploys/682f4492da65ce00086f43c5
😎 Deploy Preview https://deploy-preview-936--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: 70 (🔴 down 8 from production)
Accessibility: 90 (🔴 down 2 from production)
Best Practices: 83 (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.

@adamwg adamwg force-pushed the awg/imageconfig-rewrite branch 2 times, most recently from c1ece7a to c499786 Compare May 21, 2025 23:02
While we're here, move the common content on matching and debugging to their own
top-level headings, since they apply to all the different ImageConfig features.

Signed-off-by: Adam Wolfe Gordon <[email protected]>
@adamwg adamwg force-pushed the awg/imageconfig-rewrite branch from c499786 to 67143ce Compare May 21, 2025 23:05
Copy link
Member

@jbw976 jbw976 left a comment

Choose a reason for hiding this comment

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

This is great @adamwg, thanks for writing up such helpful information about the image rewriting feature you built! 🙌

This also should be copied to /content/master so it's applicable there too, and then just one small suggestion for you to consider beyond that. Thank you!

### Interaction with other operations

Image rewriting is always done before other `ImageConfig` operations. If you
Copy link
Member

Choose a reason for hiding this comment

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

this seems pretty important for folks to know, consider putting it into a "hint - tip" box to help it stand out a bit more. details on how to use them are in https://docs.crossplane.io/contribute/features/#hints-and-alert-boxes.

@@ -10,6 +10,35 @@ description: "Image Configs is an API for centralized control of the configurati
Crossplane package images. It allows you to configure package manager behavior
for images globally, without needing to be referenced by other objects.

## Matching image references
Copy link
Member

Choose a reason for hiding this comment

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

This feature is also in master builds, so the same changes should be copied to /content/master as well. This docs repo does not use git branches for the different versions.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done!

Copy link
Member

@jbw976 jbw976 left a comment

Choose a reason for hiding this comment

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

Great work @adamwg, thanks for this contribution! 🎉

@jbw976 jbw976 merged commit 255b651 into crossplane:master May 22, 2025
6 of 7 checks passed
@adamwg adamwg deleted the awg/imageconfig-rewrite branch May 22, 2025 16:57
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.

2 participants