Skip to content

Commit e6c45ec

Browse files
authored
Document how to update your own OSDK images (#5643)
1 parent c5b5f62 commit e6c45ec

File tree

1 file changed

+42
-0
lines changed

1 file changed

+42
-0
lines changed

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

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -265,6 +265,48 @@ If your bundle is too large, there are a few things you can try:
265265
* Reducing the number of [CRD versions][k8s-crd-versions] supported in your Operator by deprecating and then removing older API versions. It is a good idea to have a clear plan for deprecation and removal of old CRDs versions when new ones get added, see [Kubernetes API change practices][k8s-api-change]. Also, refer to the [Kubernetes API conventions][k8s-api-convention].
266266
* Reduce the verbosity of your API documentation. (We do not recommend eliminating documenting the APIs)
267267
268+
## How can I update dependencies for an unsupported release image?
269+
270+
The Operator-SDK community releases updated images for supported
271+
releases. If you are using an older version of Operator-SDK, sometimes
272+
the dependencies will need to be updated in the images. For users in
273+
this situation we recommend updating to the latest version. If this is
274+
not possible, users can build and push their own versions of any of the
275+
images provided by the Operator-SDK.
276+
277+
**Operator-SDK**
278+
docker buildx build -t quay.io/operator-framework/operator-sdk:dev -f ./images/operator-sdk/Dockerfile --load .
279+
280+
**Helm-Operator**
281+
docker buildx build -t quay.io/operator-framework/helm-operator:dev -f ./images/helm-operator/Dockerfile --load .
282+
283+
**Scorecard-test**
284+
docker buildx build -t quay.io/operator-framework/scorecard-test:dev -f ./images/scorecard-test/Dockerfile --load .
285+
286+
**Scorecard-test-kuttl**
287+
docker buildx build -t quay.io/operator-framework/scorecard-test-kuttl:dev -f ./images/scorecard-test-kuttl/Dockerfile --load .
288+
289+
290+
### Ansible
291+
292+
Ansible images are built in 2 layers, and both will need to be rebuilt.
293+
Build and push the dependency image
294+
`images/ansible-operator/base.Dockerfile`, and then update `FROM` in
295+
`images/ansible-operator/Dockerfile` to point to your image, and build
296+
and push this image, which can be added to your operator's `FROM`.
297+
298+
**Ansible Operator (2.9) base**
299+
`docker buildx build -t quay.io/operator-framework/ansible-operator-base:dev -f ./images/ansible-operator/base.Dockerfile --load images/ansible-operator`
300+
301+
**Ansible Operator (2.9)**
302+
`docker buildx build -t quay.io/operator-framework/ansible-operator:dev -f ./images/ansible-operator/Dockerfile --load .`
303+
304+
**Ansible Operator (2.11) Dependencies**
305+
`docker buildx build -t quay.io/operator-framework/ansible-operator-2.11-preview-base:dev -f ./images/ansible-operator-2.11-preview/base.Dockerfile --load images/ansible-operator-2.11-preview`
306+
307+
**Ansible Operator (2.11)**
308+
`docker buildx build -t quay.io/operator-framework/ansible-operator-2.11-preview:dev -f ./images/ansible-operator-2.11-preview/Dockerfile --load .`
309+
268310
269311
[k8s-crd-versions]: https://kubernetes.io/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definition-versioning/#specify-multiple-versions
270312
[k8s-api-change]: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api_changes.md

0 commit comments

Comments
 (0)