mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 12:46:18 +01:00
93 lines
3.7 KiB
Plaintext
93 lines
3.7 KiB
Plaintext
// Module included in the following assemblies:
|
||
//
|
||
// * operators/operator_sdk/golang/osdk-golang-tutorial.adoc
|
||
// * operators/operator_sdk/ansible/osdk-ansible-tutorial.adoc
|
||
// * operators/operator_sdk/helm/osdk-helm-tutorial.adoc
|
||
// * operators/operator_sdk/osdk-working-bundle-images.adoc
|
||
|
||
ifeval::["{context}" == "osdk-golang-tutorial"]
|
||
:golang:
|
||
endif::[]
|
||
ifeval::["{context}" == "osdk-working-bundle-images"]
|
||
:golang:
|
||
endif::[]
|
||
|
||
:_mod-docs-content-type: PROCEDURE
|
||
[id="osdk-bundle-operator_{context}"]
|
||
= Bundling an Operator
|
||
|
||
The Operator bundle format is the default packaging method for Operator SDK and Operator Lifecycle Manager (OLM). You can get your Operator ready for use on OLM by using the Operator SDK to build and push your Operator project as a bundle image.
|
||
|
||
.Prerequisites
|
||
|
||
- Operator SDK CLI installed on a development workstation
|
||
- OpenShift CLI (`oc`) v{product-version}+ installed
|
||
- Operator project initialized by using the Operator SDK
|
||
ifdef::golang[]
|
||
- If your Operator is Go-based, your project must be updated to use supported images for running on {product-title}
|
||
endif::[]
|
||
|
||
.Procedure
|
||
|
||
. Run the following `make` commands in your Operator project directory to build and push your Operator image. Modify the `IMG` argument in the following steps to reference a repository that you have access to. You can obtain an account for storing containers at repository sites such as Quay.io.
|
||
|
||
.. Build the image:
|
||
+
|
||
[source,terminal]
|
||
----
|
||
$ make docker-build IMG=<registry>/<user>/<operator_image_name>:<tag>
|
||
----
|
||
+
|
||
[NOTE]
|
||
====
|
||
The Dockerfile generated by the SDK for the Operator explicitly references `GOARCH=amd64` for `go build`. This can be amended to `GOARCH=$TARGETARCH` for non-AMD64 architectures. Docker will automatically set the environment variable to the value specified by `–platform`. With Buildah, the `–build-arg` will need to be used for the purpose. For more information, see link:https://sdk.operatorframework.io/docs/advanced-topics/multi-arch/#supporting-multiple-architectures[Multiple Architectures].
|
||
====
|
||
|
||
.. Push the image to a repository:
|
||
+
|
||
[source,terminal]
|
||
----
|
||
$ make docker-push IMG=<registry>/<user>/<operator_image_name>:<tag>
|
||
----
|
||
|
||
. Create your Operator bundle manifest by running the `make bundle` command, which invokes several commands, including the Operator SDK `generate bundle` and `bundle validate` subcommands:
|
||
+
|
||
[source,terminal]
|
||
----
|
||
$ make bundle IMG=<registry>/<user>/<operator_image_name>:<tag>
|
||
----
|
||
+
|
||
Bundle manifests for an Operator describe how to display, create, and manage an application. The `make bundle` command creates the following files and directories in your Operator project:
|
||
+
|
||
--
|
||
* A bundle manifests directory named `bundle/manifests` that contains a `ClusterServiceVersion` object
|
||
* A bundle metadata directory named `bundle/metadata`
|
||
* All custom resource definitions (CRDs) in a `config/crd` directory
|
||
* A Dockerfile `bundle.Dockerfile`
|
||
--
|
||
+
|
||
These files are then automatically validated by using `operator-sdk bundle validate` to ensure the on-disk bundle representation is correct.
|
||
|
||
. Build and push your bundle image by running the following commands. OLM consumes Operator bundles using an index image, which reference one or more bundle images.
|
||
|
||
.. Build the bundle image. Set `BUNDLE_IMG` with the details for the registry, user namespace, and image tag where you intend to push the image:
|
||
+
|
||
[source,terminal]
|
||
----
|
||
$ make bundle-build BUNDLE_IMG=<registry>/<user>/<bundle_image_name>:<tag>
|
||
----
|
||
|
||
.. Push the bundle image:
|
||
+
|
||
[source,terminal]
|
||
----
|
||
$ docker push <registry>/<user>/<bundle_image_name>:<tag>
|
||
----
|
||
|
||
ifeval::["{context}" == "osdk-golang-tutorial"]
|
||
:!golang:
|
||
endif::[]
|
||
ifeval::["{context}" == "osdk-working-bundle-images"]
|
||
:!golang:
|
||
endif::[]
|