Configuration

You can configure the Connector runtime environment in the following ways:

• The Zeebe instance to connect to.
• The Connector functions to run.
• The secrets that should be available to the Connectors.

Connecting to Zeebe

In general, the Connector Runtime will respect all properties known to Spring Zeebe.

SaaS

To use Camunda 8 SaaS specify the connection properties:

ZEEBE_CLIENT_CLOUD_CLUSTER-ID=xxx
ZEEBE_CLIENT_CLOUD_CLIENT-ID=xxx
ZEEBE_CLIENT_CLOUD_CLIENT-SECRET=xxx
ZEEBE_CLIENT_CLOUD_REGION=bru-2

You can further configure separate connection properties for Camunda Operate (otherwise it will use the properties configured for Zeebe above):

CAMUNDA_OPERATE_CLIENT_CLIENT-ID=xxx
CAMUNDA_OPERATE_CLIENT_CLIENT-SECRET=xxx

If you are connecting a local Connector runtime to a SaaS cluster, you may want to review our guide to using Connectors in hybrid mode.

Local installation

Zeebe:

ZEEBE_CLIENT_BROKER_GATEWAY-ADDRESS=127.0.0.1:26500
ZEEBE_CLIENT_SECURITY_PLAINTEXT=true

If the Zeebe Gateway is set up with Camunda Identity-based authorization, Zeebe client OAuth environment variables must be provided.

Connect to Operate locally using username and password:

CAMUNDA_OPERATE_CLIENT_URL=http://localhost:8081
CAMUNDA_OPERATE_CLIENT_USERNAME=demo
CAMUNDA_OPERATE_CLIENT_PASSWORD=demo

When running against a self-managed environment you might also need to configure Identity properties instead of username and password:

CAMUNDA_OPERATE_CLIENT_URL=http://localhost:8081
CAMUNDA_IDENTITY_TYPE=KEYCLOAK
CAMUNDA_IDENTITY_AUDIENCE=operate-api
CAMUNDA_IDENTITY_ISSUER_BACKEND_URL=http://localhost:18080/auth/realms/camunda-platform
CAMUNDA_IDENTITY_CLIENT_ID=connectors
CAMUNDA_IDENTITY_CLIENT_SECRET=<YOUR_OPERATE_CLIENT_SECRET>

Disable Operate connectivity

Disabling Operate polling will lead to inability to use inbound (e.g., webhook) capabilities. However, if you still wish to do so, you need to start your Connector runtime with the following environment variables:

CAMUNDA_CONNECTOR_POLLING_ENABLED=false
CAMUNDA_CONNECTOR_WEBHOOK_ENABLED=false
SPRING_MAIN_WEB-APPLICATION-TYPE=none
OPERATE_CLIENT_ENABLED=false

Manual discovery of Connectors

By default, the Connector runtime picks up outbound Connectors available on the classpath automatically. To disable this behavior, use the following environment variables to configure Connectors and their configuration explicitly:

Environment variable	Purpose
CONNECTOR_{NAME}_FUNCTION (required)	Function to be registered as job worker with the given NAME
CONNECTOR_{NAME}_TYPE (optional)	Job type to register for worker with NAME
CONNECTOR_{NAME}_INPUT_VARIABLES (optional)	Variables to fetch for worker with NAME
CONNECTOR_{NAME}_TIMEOUT (optional)	Timeout in milliseconds for worker with NAME

Through that configuration, you define all job workers to run.

Specifying optional values allow you to override @OutboundConnector-provided Connector configuration.

CONNECTOR_HTTPJSON_FUNCTION=io.camunda.connector.http.HttpJsonFunction
CONNECTOR_HTTPJSON_TYPE=non-default-httpjson-task-type

Secrets

Providing secrets to the runtime environment can be achieved in different ways, depending on your setup.

Default secret provider

caution

By default, all environment variables can be used as Connector secrets.

To limit the environment that can be accessed by the default secret provider, configure a prefix. For example:

export CAMUNDA_CONNECTOR_SECRETPROVIDER_ENVIRONMENT_PREFIX='SUPER_SECRETS_'
export SUPER_SECRETS_MY_SECRET='foo' # This will be resolved by using {{ secrets.MY_SECRET }}

The following environment variables can be used to configure the default secret provider:

Name	Description	Default value
CAMUNDA_CONNECTOR_SECRETPROVIDER_ENVIRONMENT_ENABLED	Whether the default secret provider is enabled.	true
CAMUNDA_CONNECTOR_SECRETPROVIDER_ENVIRONMENT_PREFIX	The prefix applied to the secret name before looking up the environment.	""

Secrets in Docker images

To inject secrets into the Docker images of the runtime, they must be available in the environment of the Docker container.

For example, you can inject secrets when running a container:

docker run --rm --name=connectors -d \
  -v $PWD/connector.jar:/opt/app/ \  # Add a connector jar to the classpath
  -e MY_SECRET=secret \              # Set a secret with value
  -e SECRET_FROM_SHELL \             # Set a secret from the environment
  --env-file secrets.txt \           # Set secrets from a file
  camunda/connectors-bundle:latest

The secret MY_SECRET value is specified directly in the docker run call, whereas the SECRET_FROM_SHELL is injected based on the value in the current shell environment when docker run is executed. The --env-file option allows using a single file with the format NAME=VALUE per line to inject multiple secrets at once.

Secrets in manual installations

In the manual setup, inject secrets during Connector execution by providing them as environment variables before starting the runtime environment. You can, for example, export them beforehand as follows:

export MY_SECRET='foo'

Reference the secret in the Connector's input in the prefixed style {{secrets.MY_SECRET}}.

Custom secret provider

Create your own implementation of the io.camunda.connector.api.secret.SecretProvider interface that comes with the SDK.

Package this class and all its dependencies as a JAR, e.g. my-secret-provider-with-dependencies.jar. This needs to include a file META-INF/services/io.camunda.connector.api.secret.SecretProvider that contains the fully qualified class name of your secret provider implementation. Add this JAR to the runtime environment, depending on your deployment setup. Your secret provider will serve secrets as implemented.

For Docker images, you can add the JAR by using volumes, for example:

docker run --rm --name=connectors -d \
  -v $PWD/my-secret-provider-with-dependencies.jar:/opt/app/my-secret-provider-with-dependencies.jar \  # Specify secret provider
  -e ZEEBE_CLIENT_BROKER_GATEWAY-ADDRESS=ip.address.of.zeebe:26500 \                                    # Specify Zeebe address
  -e ZEEBE_CLIENT_SECURITY_PLAINTEXT=true \                                                             # Optional: provide security configs to connect to Zeebe
  camunda/connectors:latest

In manual installations, add the JAR to the -cp argument of the Java call:

java -cp 'connector-runtime-application-VERSION-with-dependencies.jar:...:my-secret-provider-with-dependencies.jar' \
    io.camunda.connector.runtime.ConnectorRuntimeApplication

Multi-tenancy

The Connector Runtime supports multiple tenants for inbound and outbound Connectors. A single Connector Runtime can serve a single tenant or can be configured to serve multiple tenants. By default, the runtime uses the <default> tenant id for all Zeebe related operations like handling Jobs and publishing Messages.

info

Support for outbound Connectors with multiple tenants requires a dedicated tenant job worker config (described below). Inbound Connectors will automatically work for all tenants the configured Connector Runtime client has access to. This can be configured in Identity via the application assignment.

Environment variables

The following environment variables are used by the Connector Runtime for the configuration of multi-tenancy.

Name	Description	Default value
ZEEBE_CLIENT_DEFAULT-TENANT-ID	The default tenant id used to communicate with Zeebe	<default>
ZEEBE_CLIENT_DEFAULT-JOB-WORKER-TENANT-IDS	The default tenants ids (comma separated) used to activate jobs	<default>

If you are using an embedded version of the Connector Runtime you can specify the tenant information in your Spring configuration like in this example application.properties file:

zeebe.client.default-tenant-id=<default>
zeebe.client.default-job-worker-tenant-ids=t1,<default>

Outbound Connector config

The Connector Runtime uses the <default> tenant for outbound Connector related features. If support for a different tenant or multiple tenants should be enabled, the tenants need to be configured individually using the following environment variables.

If you want to use outbound Connectors for a single tenant that is different from the <default> tenant you can specify a different default tenant id using:

ZEEBE_CLIENT_DEFAULT-TENANT-ID=tenant1

This will change the default tenant id used for fetching jobs and publishing messages to the tenant id tenant1.

note

Please keep in mind that inbound Connectors will still be enabled for all tenants that the Connector Runtime client has access to.

If you want to run the Connector Runtime in a setup where a single runtime serves multiple tenants you have to add each tenant id to the list of the default job workers:

ZEEBE_CLIENT_DEFAULT-JOB-WORKER-TENANT-IDS=tenant1, tenant2

In this case the ZEEBE_CLIENT_DEFAULT-TENANT-ID will not be used for the configuration of job workers.

Inbound Connector config

The Connector Runtime will fetch and execute all inbound Connectors it receives from Operate independently of the outbound Connector configuration without any additional configuration required from the user.

If you want to restrict the Connector Runtime inbound Connector feature to a single tenant or multiple tenants you have to use Identity and assign the tenants the Connector application should have access to.

Troubleshooting

To ensure seamless integration and functionality, the multi-tenancy feature must also be enabled across all associated components if not configured in Helm so users can view any data from tenants for which they have authorizations configured in Identity.

Find more information (including links to individual component configuration) on the multi-tenancy concepts page.

Logging

Google Stackdriver (JSON) logging

To enable Google Stackdriver compatible JSON logging, set the environment variable CONNECTORS_LOG_APPENDER=stackdriver on the Connector Runtime.