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

📖 Update docs for Installing and deleting extensions #700

Conversation

michaelryanpeter
Copy link
Contributor

@michaelryanpeter michaelryanpeter commented Mar 14, 2024

Description

Preview links

Reviewer Checklist

  • API Go Documentation
  • Tests: Unit Tests (and E2E Tests, if appropriate)
  • Comprehensive Commit Messages
  • Links to related GitHub Issue(s)

@michaelryanpeter michaelryanpeter requested a review from a team as a code owner March 14, 2024 20:59
@openshift-ci openshift-ci bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Mar 14, 2024
Copy link

netlify bot commented Mar 14, 2024

Deploy Preview for olmv1 ready!

Name Link
🔨 Latest commit 1feb79a
🔍 Latest deploy log https://app.netlify.com/sites/olmv1/deploys/65f9adf378d9ce0009fd1c16
😎 Deploy Preview https://deploy-preview-700--olmv1.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@michaelryanpeter michaelryanpeter force-pushed the docs-kubecon-installing-extensions branch from 815d5e3 to 39994fe Compare March 14, 2024 21:02
Copy link

codecov bot commented Mar 14, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 64.01%. Comparing base (1ef2792) to head (1feb79a).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #700   +/-   ##
=======================================
  Coverage   64.01%   64.01%           
=======================================
  Files          22       22           
  Lines        1370     1370           
=======================================
  Hits          877      877           
  Misses        442      442           
  Partials       51       51           
Flag Coverage Δ
e2e 47.37% <ø> (ø)
unit 58.41% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

* If mulitple catalogs are added to a cluster, you cannot specify a catalog when you install an extension.
* OLM 1.0 requires that all of the extensions have unique bundle and package names for dependency resolution.

As a result, if two catalogs have an extension with the same name, the installation might fail or lead to an unintended outcome.
Copy link
Contributor

Choose a reason for hiding this comment

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

I think it's okay to leave this as is, but IIRC (please correct me if I'm wrong!) the first one found is the one used. It might be worth adding some text about that

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I added a sentence but still kept it sort of hand wavy.

@michaelryanpeter michaelryanpeter force-pushed the docs-kubecon-installing-extensions branch from a0dd4f7 to bee0437 Compare March 15, 2024 15:41
@michaelryanpeter michaelryanpeter changed the title [WIP] 📖 Update docs for Installing and deleting extensions 📖 Update docs for Installing and deleting extensions Mar 15, 2024
@openshift-ci openshift-ci bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Mar 15, 2024
@michaelryanpeter michaelryanpeter force-pushed the docs-kubecon-installing-extensions branch from bee0437 to 92e68aa Compare March 15, 2024 15:49
@michaelryanpeter
Copy link
Contributor Author

Thank you for the feedback, @everettraven! Suggestions applied. PTAL.

As a result, if two catalogs have an extension with the same name, the installation might fail or lead to an unintended outcome.
For example, the first extension that matches might install successfully and finish without searching for a match in the second catalog.

2. Apply the CR the cluster:

Choose a reason for hiding this comment

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

Should be Apply the CR to the cluster?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thank you! Fixed in 1feb79a

$ kubectl apply -f <cr_name>.yaml
```

??? success

Choose a reason for hiding this comment

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

Why is there ??? ?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This adds a toggle to hide the output results once the MD is rendered. You can see it here in the rendered preview, step 2: https://deploy-preview-700--olmv1.netlify.app/tasks/installing-an-extension/

@everettraven everettraven added this pull request to the merge queue Mar 19, 2024
Merged via the queue into operator-framework:main with commit 9f6e7df Mar 19, 2024
17 checks passed
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.

None yet

3 participants