.. raw:: html

    <script type="module" src="../_static/js/object_tab_linker.js"> </script>
    <script type="module" src="../_static/js/query_example_selector.js"> </script>

Operator Bundle
===============

.. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted

    An Operator Bundle is a container image that stores the Kubernetes manifests and metadata associated with an operator. A bundle is meant to represent a specific version of an operator.



.. tab-set::
    .. tab-item:: Fields
        
        .. div::
            :name: ``alm_examples``
        

        ``alm_examples`` | List[:doc:`/objects/ALMExample`] 




        
        .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted

            Specific information from the CSV requested by customer.

        

        
        .. div::
            :name: ``annotations``
        ``annotations`` | :doc:`OperatorBundleAnnotation` 

        
        .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted

            A subset of the "metadata.annotations" object from the CSV. Any annotations that are in the "operators.openshift.io" namespace that are strings of JSON will be expanded if it is valid JSON. Namespaces are not preserved due to their usage of special characters and all dashes are converted to underscores for consistency with other fields.

        

        
        .. div::
            :name: ``architectures``
        

        ``architectures`` | List[:doc:`/scalars/String`] 




        
        .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted

            List of all supported architectures. An empty list means that architectures are unknown as CSV doesn't include architecture labels.

        

        
        .. div::
            :name: ``bundle``
        
        ``bundle`` | String 



        
        .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted

            The 'bundle' is the operator representation of a version of operator metadata. There is one bundle per operator/package channel for a particular OpenShift version.

        

        
        .. div::
            :name: ``bundle_path``
        
        ``bundle_path`` | String 



        
        .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted

            Pullspec of the operator bundle e.g. quay.io/foo/bar@sha256:digest.

        

        
        .. div::
            :name: ``bundle_path_digest``
        
        ``bundle_path_digest`` | String  :bdg-warning-line:`nullable`



        
        .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted

            Digest from the bundle_path.

        

        
        .. div::
            :name: ``capabilities``
        

        ``capabilities`` | List[:doc:`/scalars/String`] 




        
        .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted

            Specific information from the CSV requested by customer.

        

        
        .. div::
            :name: ``channel_name``
        
        ``channel_name`` | String 



        
        .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted

            The channel for which this bundle is being released, e.g. "amq-streams-1.5.x.

        

        
        .. div::
            :name: ``csv_name``
        
        ``csv_name`` | String 



        
        .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted

            Full name of the package. Usually consists of package_name.version.

        

        
        .. div::
            :name: ``csv_display_name``
        
        ``csv_display_name`` | String 



        
        .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted

            A public name to identify the Operator.

        

        
        .. div::
            :name: ``csv_description``
        
        ``csv_description`` | String 



        
        .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted

            A thorough description of the Operator’s functionality in form of a markdown blob.

        

        
        .. div::
            :name: ``csv_metadata_description``
        
        ``csv_metadata_description`` | String 



        
        .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted

            Short description of the CRD and operator functionality.

        

        
        .. div::
            :name: ``in_index_img``
        
        ``in_index_img`` | :doc:`/scalars/Boolean` 



        
        .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted

            Indicate if the bundle is in an index image.

        

        
        .. div::
            :name: ``install_modes``
        

        ``install_modes`` | List[:doc:`/objects/OperatorBundleInstallMode`] 




        
        .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted

            Specific information from the CSV requested by customer.

        

        
        .. div::
            :name: ``is_default_channel``
        
        ``is_default_channel`` | :doc:`/scalars/Boolean` 



        
        .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted

            If true then the channel is the default for this package, false otherwise.

        

        
        .. div::
            :name: ``latest_in_channel``
        
        ``latest_in_channel`` | :doc:`/scalars/Boolean` 



        
        .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted

            Indicate that the bundle is the latest version of a package in a channel for its associated OCP version (index image).

        

        
        .. div::
            :name: ``ocp_version``
        ``ocp_version`` | :doc:`/scalars/SemVer` 

        
        .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted

            Specific OCP version for this bundle, e.g. "4.5".

        

        
        .. div::
            :name: ``organization``
        
        ``organization`` | String 



        
        .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted

            Organization as understood by iib, e.g. "redhat-marketplace".

        

        
        .. div::
            :name: ``package``
        
        ``package`` | String 



        
        .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted

            The name of the operator, e.g. "amq-streams".

        

        
        .. div::
            :name: ``provided_apis``
        

        ``provided_apis`` | List[:doc:`/objects/ProvidedAPIsItems`] 




        
        .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted

            Specific information from the CSV requested by customer. Should correspond with values from alm_examples.

        

        
        .. div::
            :name: ``related_images``
        

        ``related_images`` | List[:doc:`/objects/RelatedImagesItems`] 




        
        .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted

            Specific information from the CSV requested by customer.

        

        
        .. div::
            :name: ``source_index_container_path``
        
        ``source_index_container_path`` | String 



        
        .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted

            Where this bundle was collected from, e.g. "quay.io/foo/bar:v4.5".

        

        
        .. div::
            :name: ``version``
        ``version`` | :doc:`/scalars/SemVer` 

        
        .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted

            The operator version for this bundle

        

        
        .. div::
            :name: ``version_original``
        
        ``version_original`` | String 



        
        .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted

            Original version of the bundle, used to recognize semver validity.

        

        
        .. div::
            :name: ``replaces``
        
        ``replaces`` | String  :bdg-warning-line:`nullable`



        
        .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted

            Name of operator which the bundle replaces.

        

        
        .. div::
            :name: ``skips``
        

        ``skips`` | List[:doc:`/scalars/String`] 




        
        .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted

            List of skipped updates. See OLM upgrades documentation for more details.

        

        
        .. div::
            :name: ``skip_range``
        
        ``skip_range`` | String  :bdg-warning-line:`nullable`



        
        .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted

            String describing skipped versions.

        

        
        .. div::
            :name: ``provider``
        
        ``provider`` | String  :bdg-warning-line:`nullable`



        
        .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted

            String describing bundle provider

        

        
        .. div::
            :name: ``_id``
        ``_id`` | :doc:`/scalars/ObjectID` :bdg-primary-line:`read-only`

        
        .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted

            MongoDB unique _id

        

        
        .. div::
            :name: ``creation_date``
        
        ``creation_date`` | :doc:`/scalars/DateTime` :bdg-primary-line:`read-only`



        
        .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted

            The date when the entry was created. Value is created automatically on creation.

        

        
        .. div::
            :name: ``last_update_date``
        
        ``last_update_date`` | :doc:`/scalars/DateTime` :bdg-primary-line:`read-only`



        
        .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted

            The date when the entry was last updated.

        

        

    


    .. tab-item:: Indexes

        

            

            
            .. div::
                :name: ``bundle_path_digest``

            ``bundle_path_digest``

            .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
            Fields
                - ``bundle_path_digest: ASC``

            

            .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
            Description
                | This index is used to find Operator bundle by bundle_path_digest.
                |
            .. div::
                :name: ``related_images.digest``

            ``related_images.digest``

            .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
            Fields
                - ``related_images.digest: ASC``

            

            .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
            Description
                | This index is used to find Operator bundle by related_images.digest.
                |
            .. div::
                :name: ``package_1_csv_name_1_channel_name_1_ocp_version_1``

            ``package_1_csv_name_1_channel_name_1_ocp_version_1``

            .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
            Fields
                - ``package: ASC``
                - ``csv_name: ASC``
                - ``channel_name: ASC``
                - ``ocp_version: ASC``

            

            .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
            Description
                | This index is used to find Operator bundle by package, csv_name, channel_name and ocp_version.
                |
            .. div::
                :name: ``operatorBundle_package_organization``

            ``operatorBundle_package_organization``

            .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
            Fields
                - ``package: ASC``
                - ``organization: ASC``

            

            .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
            Description
                | This index is used to find Operator bundle by package and organization.
                |
            .. div::
                :name: ``operatorBundle_creation_date``

            ``operatorBundle_creation_date``

            .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
            Fields
                - ``creation_date: DESC``

            

            .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
            Description
                | This index is used to find Operator bundle by creation_date.
                |
            .. div::
                :name: ``operatorBundle_csv_display_name_organization``

            ``operatorBundle_csv_display_name_organization``

            .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
            Fields
                - ``csv_display_name: ASC``
                - ``organization: ASC``

            

            .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
            Description
                | This index is used to find Operator bundle by csv_display_name and organization.
                |
            .. div::
                :name: ``operatorBundle_csv_name``

            ``operatorBundle_csv_name``

            .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
            Fields
                - ``csv_name: ASC``

            

            .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
            Description
                | This index is used to find Operator bundle by csv_name.
                |
            .. div::
                :name: ``operatorBundle_channel_name``

            ``operatorBundle_channel_name``

            .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
            Fields
                - ``channel_name: ASC``

            

            .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
            Description
                | This index is used to find Operator bundle by channel_name.
                |
            .. div::
                :name: ``operatorBundle_source_index_container_path_related_images.digest``

            ``operatorBundle_source_index_container_path_related_images.digest``

            .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
            Fields
                - ``source_index_container_path: ASC``
                - ``related_images.digest: ASC``

            

            .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
            Description
                | This index is used to find Operator bundle by related_images.digest and source_index_container_path.
                |
            .. div::
                :name: ``operatorBundle_organization_internal_only_in_index_img``

            ``operatorBundle_organization_internal_only_in_index_img``

            .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
            Fields
                - ``organization: ASC``
                - ``internal_only: ASC``
                - ``in_index_img: ASC``

            

            .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted
            Description
                | Added because running queries without support of this index made the database unresponsive.
                |

        

    

    

    .. tab-item:: Usage

        .. dropdown:: Endpoints
            :animate: fade-in

            

            - :doc:`GET - /operators/bundles </endpoints/RESTGetOperatorBundles>`

            - :doc:`GET - /repositories/registry/{registry}/repository/{repository}/operators/bundles </endpoints/RESTGetOperatorBundlesByRepository>`

        .. dropdown:: Queries and Mutations
            :animate: fade-in

            

            - :doc:`find_repository_operator_bundles_by_registry_path </queries/find_repository_operator_bundles_by_registry_path>`

            - :doc:`find_operator_bundles </queries/find_operator_bundles>`