-
Notifications
You must be signed in to change notification settings - Fork 1
Feat/marketplace segregation #1041
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
Open
humoflife
wants to merge
5
commits into
main
Choose a base branch
from
feat/marketplace-segregation
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
55dbf28
fix argo plugin ctp secret namespace info
humoflife b547fb6
show how to achieve marketplace segregated image pulls from productio…
humoflife 95dbead
Merge branch 'main' into feat/marketplace-segregation
humoflife c9c3c40
Fix typo in marketplace-segregation.md
tr0njavolta 637322c
Revise marketplace segregation documentation
tr0njavolta File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
120 changes: 120 additions & 0 deletions
120
docs/manuals/platform/howtos/marketplace-segregation.md
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,120 @@ | ||
| --- | ||
| title: Segregate Marketplace Repository Access | ||
| sidebar_position: 2 | ||
| description: A guide for segregating marketplace repository access. | ||
| --- | ||
|
|
||
| Upbound allows organizations to segregate repository access to consume only | ||
| authorized artifacts like configuration packages, | ||
| [providers][crossplane-providers], functions and add-ons. SBOM, CVE, and other | ||
| relevant checks must pass to use these artifacts. | ||
|
|
||
| Controlled repository access uses `ImageConfig` to limit production control | ||
| planes from consuming unauthorized repositories and unsigned images. | ||
|
|
||
| ## Example `ImageConfig` | ||
|
|
||
| The `ImageConfig` below is an example of a production control plane with | ||
| `Verification` restrictions: | ||
| ``` | ||
| kubectl describe imageconfigs.pkg.crossplane.io | ||
| ``` | ||
|
|
||
| ``` | ||
| Name: verify-upbound-images | ||
| Namespace: | ||
| Labels: <none> | ||
| Annotations: <none> | ||
| API Version: pkg.crossplane.io/v1beta1 | ||
| Kind: ImageConfig | ||
| Metadata: | ||
| Creation Timestamp: 2025-12-02T21:22:09Z | ||
| Generation: 1 | ||
| Resource Version: 1809 | ||
| UID: 11149b5c-2ccc-4d2b-b7bd-cdea75f71ad9 | ||
| Spec: | ||
| Match Images: | ||
| Prefix: xpkg.upbound.io/upbound | ||
| Type: Prefix | ||
| Verification: | ||
| Cosign: | ||
| Authorities: | ||
| Keyless: | ||
| Identities: | ||
| Issuer: https://token.actions.githubusercontent.com | ||
| Subject: https://github.com/upbound/upbound-official-build/.github/workflows/supplychain.yml@refs/heads/main | ||
| Name: Verify Images | ||
| Provider: Cosign | ||
| Events: <none> | ||
| ``` | ||
|
|
||
| If you try to install any unsigned Upbound packages, pods to not start, the | ||
| image doesn't pull, and the control plane marks the revision as unhealthy. | ||
|
|
||
| ``` | ||
| kubectl get pkgrev | ||
| ``` | ||
|
|
||
| ``` | ||
| NAME HEALTHY RUNTIME IMAGE STATE AGE | ||
| providerrevision.pkg.crossplane.io/upbound-provider-datadog-0f38c6598970 False False xpkg.upbound.io/upbound/provider-datadog:v0.3.0 Active 3m24s | ||
| ``` | ||
|
|
||
| If you describe the revision, the status condition returns with signature | ||
| verification failure as expected. | ||
|
|
||
| ``` | ||
| Status: | ||
| Applied Image Config Refs: | ||
| Name: verify-upbound-images | ||
| Reason: VerifyImage | ||
| Conditions: | ||
| Last Transition Time: 2025-12-02T21:23:40Z | ||
| Message: Waiting for signature verification to complete | ||
| Observed Generation: 1 | ||
| Reason: UnhealthyPackageRevision | ||
| Status: False | ||
| Type: RuntimeHealthy | ||
| Last Transition Time: 2025-12-02T21:23:40Z | ||
| Observed Generation: 1 | ||
| Reason: AwaitingSignatureVerification | ||
| Status: False | ||
| Type: RevisionHealthy | ||
| Last Transition Time: 2025-12-02T21:23:41Z | ||
| Message: Signature verification failed using ImageConfig named "verify-upbound-images": authority "Verify Images": signature verification failed with no signatures found | ||
| Observed Generation: 1 | ||
| Reason: SignatureVerificationFailed | ||
| Status: False | ||
| Type: Verified | ||
| Resolved Image: xpkg.upbound.io/upbound/provider-datadog:v0.3.0 | ||
| ``` | ||
|
|
||
| ## Image signing | ||
|
|
||
|
|
||
| For more information about image signing, review the [sigstore-cosign] | ||
| repository. | ||
|
|
||
| ## Benefits | ||
|
|
||
| Adding image verification provides the following benefits: | ||
|
|
||
| - Allows developers to push artifacts to multiple [marketplace] registries, | ||
| including third-party enterprise locations. Production control planes only | ||
| consume signed image versions | ||
| - Signs images that pass CI/CD pipeline tests automatically | ||
| - Use images between development and production repositories without moving | ||
| them. | ||
| - Requires less complexity in team permissions, robot account and token | ||
| management | ||
| - Allows any authorized consumer to pull signed images | ||
|
|
||
| :::warning | ||
| You **must** install the `ImageConfig` after creating a production control | ||
| plane. | ||
| ::: | ||
|
|
||
| [crossplane-providers]: https://docs.crossplane.io/latest/packages/providers/ | ||
| [image-configs]: https://docs.upbound.io/manuals/uxp/concepts/packages/image-configs/ | ||
| [marketplace]: https://marketplace.upbound.io/providers | ||
| [sigstore-cosign]: https://github.com/sigstore/cosign | ||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we use Here a get .... -o yaml ? It's hard to Copy when using s describe