Skip to content

update docs for operator-sdk run bundle with SQLite #6054

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.

Sign up for GitHub

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 2 commits into from
Nov 23, 2022
Merged

update docs for operator-sdk run bundle with SQLite #6054

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9d3ffad
update docs for operator-sdk run bundle with SQLite
everettraven Oct 4, 2022
6fbc6c6
update docs based on review
everettraven Oct 17, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion website/content/en/docs/faqs/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -346,4 +346,14 @@ where the command `operator-sdk generate kustomize manifests` is not respecting
made on this manifest.

[cgo-docs]: https://pkg.go.dev/cmd/cgo
[open-issue]: https://github.com/operator-framework/operator-sdk/issues/new/choose
[open-issue]: https://github.com/operator-framework/operator-sdk/issues/new/choose

## 'operator-sdk run bundle' command fails and the registry pod has an error of 'mkdir: can't create directory '/database': Permission denied'

In Operator SDK version `v1.22.0`, the `operator-sdk run bundle` command started using the new file-based catalog (FBC) bundle format by default. Earlier releases used the deprecated SQLite format. The command uses `quay.io/operator-framework/opm:latest` as the index image for creating a registry pod. Due to recent pod security updates, using the latest version of `opm` does not work as expected with the SQLite bundle format.

There are two workarounds available to resolve this issue:
1. You can update the Operator SDK to version `v1.22.0` or later. Updating to a more recent version makes `operator-sdk run bundle` utilize the new FBC bundle format.
2. If you are not ready to update your version of the Operator SDK, you can manually specify the index image by using the `--index-image=quay.io/operator-framework/opm:v1.23.0` flag.

**Note:** The SQLite bundle format is deprecated and will be removed in a future release. If you can, it is recommended that you upgrade a newer version of the Operator SDK to resolve the issue.
4 changes: 3 additions & 1 deletion website/content/en/docs/olm-integration/tutorial-bundle.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,8 +152,9 @@ INFO[0040] Found ClusterServiceVersion "default/memcached-operator.v0.0.1" pha
INFO[0040] OLM has successfully installed "memcached-operator.v0.0.1"
```

**Note:** If the bundle that is being installed has dependencies, the `--index-image` flag allows adding a bundle to a catalog that contains that bundle's dependencies.
**Note:** If the bundle that is being installed has dependencies, the `--index-image` flag allows adding a bundle to a catalog that contains that bundle's dependencies.

**Note:** Version `v1.22.0` and later of the `operator-sdk` use the new file-based catalog (FBC) bundle format by default. Earlier releases use the deprecated SQLite bundle format. If you use an earlier version of the Operator SDK, you must update to a newer version or specify the index image by adding the `--index-image=quay.io/operator-framework/opm:v1.23.0` flag. For more information about this known issue, see the [FAQ][run-bundle-fbc-sqlite-faq].
<!-- TODO(jmccormick2001): add `scorecard` usage here -->

### Upgrading a bundle to a newer version
Expand Down Expand Up @@ -308,3 +309,4 @@ In-depth discussions of OLM concepts mentioned here:
[olm-install]:https://olm.operatorframework.io/docs/tasks/install-operator-with-olm/
[olm-manifests]:https://github.com/operator-framework/operator-lifecycle-manager/blob/master/deploy/upstream/quickstart/olm.yaml
[run-bundle]: https://sdk.operatorframework.io/docs/cli/operator-sdk_run_bundle/
[run-bundle-fbc-sqlite-faq]: https://sdk.operatorframework.io/docs/faqs/#operator-sdk-run-bundle-command-fails-and-the-registry-pod-has-an-error-of-mkdir-cant-create-directory-database-permission-denied