Projecting binding data

    After the backing service exposes the binding data, for a workload to access and consume this data, you must project it into the workload from a backing service. Service Binding Operator automatically projects this set of data into the workload in the following methods:

    1. By default, as files.

    2. As environment variables, after you configure the parameter from the ServiceBinding resource.

    By default, Service Binding Operator mounts the binding data as files at a specific directory in your workload resource. You can configure the directory path using the SERVICE_BINDING_ROOT environment variable setup in the container where your workload runs.

    Example: Binding data mounted as files

    To consume the binding data as environment variables, use the built-in language feature of your programming language of choice that can read environment variables.

    Example: Python client usage

    The following table summarizes the configuration of how the final path for the binding data projection is computed when files are mounted at a specific directory:

    In the previous table, the <ServiceBinding_ResourceName> entry specifies the name of the ServiceBinding resource that you configure in the .metadata.name section of the custom resource (CR).

    To access and consume the binding data within the existing SERVICE_BINDING_ROOT environment variable, use the built-in language feature of your programming language of choice that can read environment variables.

    Example: Python client usage

    In the previous example, the bindings_list variable contains the binding data for the postgresql database service type.

    Depending on your workload requirements and environment, you can choose to project the binding data either as files or environment variables.

    • You understand the following concepts:

      • Environment and requirements of your workload, and how it works with the provided services.

      • Configuration of how the final path for data projection is computed for the default method.

    • The binding data is exposed from the backing service.

    Procedure

    1. To project the binding data as files, determine the destination folder by ensuring that the existing SERVICE_BINDING_ROOT environment variable is present in the container where your workload runs.

    2. To project the binding data as environment variables, set the value for the .spec.bindAsFiles parameter to false from the ServiceBinding resource in the custom resource (CR).