Skip to content
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

Improve Offline Provider Installation Documentation #628

Closed
wants to merge 2 commits into from
Closed

Improve Offline Provider Installation Documentation #628

wants to merge 2 commits into from

Conversation

arielsepton
Copy link

@arielsepton arielsepton commented Nov 25, 2023

This PR enhances the Crossplane documentation for offline provider installations by:

•	Highlighting critical instructions with bold formatting.
•	Adding a troubleshooting tip for a more comprehensive guide.
•	Introducing an example script for configuring Crossplane with a PersistentVolumeClaim (PVC).

These changes aim to provide a detailed guide for setting up Crossplane providers offline.

Copy link

netlify bot commented Nov 25, 2023

Deploy Preview for crossplane ready!

Name Link
🔨 Latest commit a646791
🔍 Latest deploy log https://app.netlify.com/sites/crossplane/deploys/6573634ae5c8bd000832a63b
😎 Deploy Preview https://deploy-preview-628--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: 90 (🟢 up 2 from production)
Accessibility: 88 (🔴 down 3 from production)
Best Practices: 83 (no change from production)
SEO: 93 (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 site configuration.

@plumbis
Copy link
Collaborator

plumbis commented Dec 8, 2023

It looks like you may have accidentally pulled in a lot of other commits for this PR. Can you rebase or open a new PR that only includes your intended changes?

Signed-off-by: arielsepton <[email protected]>
@arielsepton
Copy link
Author

Thanks for catching that @plumbis! I've fixed the issue

Comment on lines +149 to +152
up xpkg xp-extract xpkg.upbound.io/upbound/provider-aws:v0.44.0
mv out.gz "${CACHE_PATH}/provider-aws.gz"
chmod 644 "${CACHE_PATH}/provider-aws.gz"
docker tag xpkg.upbound.io/upbound/provider-aws:v0.44.0 provider-aws
Copy link
Collaborator

Choose a reason for hiding this comment

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

up xpkg xp-extract is a hidden command (the equiv is an alpha command) is it possible to use the crossplane CLI to do this?

Does the package have to be extracted?

Copy link
Collaborator

Choose a reason for hiding this comment

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

bump

Copy link
Author

@arielsepton arielsepton Dec 29, 2023

Choose a reason for hiding this comment

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

Yes, the package does need to be extracted.
For Crossplane offline installation, with –set packageCache.pvc=<pvc name> option, The extracted packages must be placed in the directory where the PVC is mounted for Crossplane’s inner registry to recognize them.

Regarding the Crossplane CLI command you mentioned, Could you please provide me with the relevant documentation or details about the command? I’ll review it to see if we can replace the up xpkg xp-extract command with a Crossplane CLI equivalent.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Documentation for the Crossplane CLI is here.

I'm not sure if extract is an option (even as a hidden command) but can you check to see if the options match what you're doing here? I'd prefer to have the Crossplane CLI in this doc but if Crossplane doesn't provide it and we have to reference the up CLI that's okay.

@plumbis
Copy link
Collaborator

plumbis commented Mar 26, 2024

There was an offline discussion that led to #733 , that the official recommendation for offline install is to run a local container registry. This avoids issues related to implementation details for the local Crossplane package cache.

I appreciate the work you put in to submit this PR but I'm going to close this now since it doesn't line up with the current Crossplane recommendations.

@plumbis plumbis closed this Mar 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants