Skip to content

Commit 46af8c1

Browse files
committedJul 25, 2023
Address review feedback operator-framework#3
Signed-off-by: Rashmi Gottipati <[email protected]>
1 parent 2e0ac7a commit 46af8c1

File tree

1 file changed

+19
-6
lines changed

1 file changed

+19
-6
lines changed
 

‎docs/design/bundle-sources.md

+19-6
Original file line numberDiff line numberDiff line change
@@ -110,10 +110,10 @@ Procedure
110110
mkdir <catalog_dir>
111111
```
112112

113-
1. Create a Dockerfile that can build a catalog image by running the `opm generate dockerfile` command:
113+
1. In the same directory level, create a Dockerfile that can build a catalog image:
114114

115-
```sh
116-
opm generate dockerfile <catalog_dir>
115+
```sh
116+
touch Dockerfile
117117
```
118118

119119
* The Dockerfile must be in the same parent directory as the catalog directory that you created in the previous step:
@@ -125,6 +125,17 @@ Procedure
125125
└── <catalog_dir>.Dockerfile
126126
```
127127

128+
1. Make the below changes to your Dockerfile:
129+
130+
*Example Dockerfile*
131+
132+
```sh
133+
FROM scratch
134+
ADD <catalog_dir> /configs
135+
```
136+
137+
> **Note:** Use the `FROM scratch` directive to make the size of the image smaller.
138+
128139
1. Populate the catalog with the package definition for your Operator by running the `opm init` command:
129140

130141
```sh
@@ -173,7 +184,7 @@ Procedure
173184
```json
174185
{
175186
"schema": "olm.bundle",
176-
"name": "<operator_name>.<version>",
187+
"name": "<operator_name>.v<version>",
177188
"package": "<operator_name>",
178189
"image": "quay.io/<organization_name>/<repository_name>:<image_tag>",
179190
"properties": [
@@ -199,16 +210,18 @@ Procedure
199210
```json
200211
{
201212
"schema": "olm.channel",
202-
"name": "<default_channel_name>",
213+
"name": "<desired_channel_name>",
203214
"package": "<operator_name>",
204215
"entries": [
205216
{
206-
"name": "<operator_name>/<bundle_version>"
217+
"name": "<operator_name>.v<version>"
207218
}
208219
]
209220
}
210221
```
211222
223+
> **Note:** Some examples for the <desired_channel_name> include `stable`, `fast`, and `preview`.
224+
212225
<h3 id="verify-adding-a-plain-bundle-to-fbc">
213226
Verification
214227
</h3>

0 commit comments

Comments
 (0)