Skip to content

Commit f2ac68f

Browse files
authored
update docs for operator-sdk run bundle with SQLite (#6054)
* update docs for operator-sdk run bundle with SQLite Signed-off-by: Bryce Palmer <[email protected]> * update docs based on review Signed-off-by: Bryce Palmer <[email protected]> Signed-off-by: Bryce Palmer <[email protected]>
1 parent df45989 commit f2ac68f

File tree

2 files changed

+14
-2
lines changed

2 files changed

+14
-2
lines changed

website/content/en/docs/faqs/_index.md

+11-1
Original file line numberDiff line numberDiff line change
@@ -346,4 +346,14 @@ where the command `operator-sdk generate kustomize manifests` is not respecting
346346
made on this manifest.
347347
348348
[cgo-docs]: https://pkg.go.dev/cmd/cgo
349-
[open-issue]: https://github.com/operator-framework/operator-sdk/issues/new/choose
349+
[open-issue]: https://github.com/operator-framework/operator-sdk/issues/new/choose
350+
351+
## 'operator-sdk run bundle' command fails and the registry pod has an error of 'mkdir: can't create directory '/database': Permission denied'
352+
353+
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.
354+
355+
There are two workarounds available to resolve this issue:
356+
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.
357+
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.
358+
359+
**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.

website/content/en/docs/olm-integration/tutorial-bundle.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -152,8 +152,9 @@ INFO[0040] Found ClusterServiceVersion "default/memcached-operator.v0.0.1" pha
152152
INFO[0040] OLM has successfully installed "memcached-operator.v0.0.1"
153153
```
154154

155-
**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.
155+
**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.
156156

157+
**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].
157158
<!-- TODO(jmccormick2001): add `scorecard` usage here -->
158159

159160
### Upgrading a bundle to a newer version
@@ -308,3 +309,4 @@ In-depth discussions of OLM concepts mentioned here:
308309
[olm-install]:https://olm.operatorframework.io/docs/tasks/install-operator-with-olm/
309310
[olm-manifests]:https://github.com/operator-framework/operator-lifecycle-manager/blob/master/deploy/upstream/quickstart/olm.yaml
310311
[run-bundle]: https://sdk.operatorframework.io/docs/cli/operator-sdk_run_bundle/
312+
[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

0 commit comments

Comments
 (0)