Skip to content

Commit 2885f88

Browse files
Address review feedback
Signed-off-by: rashmigottipati <[email protected]>
1 parent 6f6909c commit 2885f88

File tree

3 files changed

+11
-9
lines changed

3 files changed

+11
-9
lines changed
Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,17 @@
11
entries:
22
- description: >
3-
Add File-Based Catalog support for both `run bundle` and `run bundle-upgrade` subcommands.
4-
Infer the image type and handle FBC scenarios accordingly for both commands. For FBC images,
5-
Operator Registry APIs are called for rendering the bundle and/or the index image and serving these images
6-
through the registry pod using a gRPC port. For images that are SQLite based,
7-
`opm registry add` and `opm serve` commands will be called during the registry pod creation.
8-
Support for these old opm commands will be deprecated and completely removed in the future.
3+
Add support for File-Based Catalog to the subcommands [operator-sdk run bundle](https://sdk.operatorframework.io/docs/cli/operator-sdk_run_bundle/#m-docsclioperator-sdk_run_bundle)
4+
and [run bundle-upgrade](https://sdk.operatorframework.io/docs/cli/operator-sdk_run_bundle-upgrade/) so that
5+
new indexes created by these subcommands are using the new format.
6+
Users are able to pass in an index catalog with FBC format via the flag option `--index-image`.
97
108
# kind is one of:
119
# - addition
1210
# - change
1311
# - deprecation
1412
# - removal
1513
# - bugfix
16-
kind: addition
14+
kind: change
1715
1816
# Is this a breaking change?
1917
breaking: false

internal/cmd/operator-sdk/run/bundle/cmd.go

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,9 @@ The main purpose of this command is to streamline running the bundle without hav
3636
3737
The ` + "`--index-image`" + ` flag specifies an index image in which to inject the given bundle. It can be specified to resolve dependencies for a bundle.
3838
This is an optional flag which will default to ` + "`quay.io/operator-framework/opm:latest`." + `
39-
The index image provided should **NOT** already have the bundle.
39+
The index image provided should **NOT** already have the bundle. A limitation of the index image flag is that it does not check the upgrade graph
40+
as the annotations for channels are ignored but it is still a useful flag to have to validate the dependencies.
41+
For example: It does not fail fast when the bundle version provided is <= ChannelHead.
4042
`,
4143
Args: cobra.ExactArgs(1),
4244
PreRunE: func(*cobra.Command, []string) error { return cfg.Load() },

website/content/en/docs/cli/operator-sdk_run_bundle.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,9 @@ The main purpose of this command is to streamline running the bundle without hav
1414

1515
The `--index-image` flag specifies an index image in which to inject the given bundle. It can be specified to resolve dependencies for a bundle.
1616
This is an optional flag which will default to `quay.io/operator-framework/opm:latest`.
17-
The index image provided should **NOT** already have the bundle.
17+
The index image provided should **NOT** already have the bundle. A limitation of the index image flag is that it does not check the upgrade graph
18+
as the annotations for channels are ignored but it is still a useful flag to have to validate the dependencies.
19+
For example: It does not fail fast when the bundle version provided is &lt;= ChannelHead.
1820

1921

2022
```

0 commit comments

Comments
 (0)