Connect

Configure an Allow or Deny List

This feature requires an enterprise license. You can either upgrade to an Enterprise Edition license, or generate a trial license key that’s valid for 30 days.

You can configure an allow or deny list to limit the Redpanda Connect components that users can run within data pipelines on a Redpanda Connect instance.

Introduced in version 4.39.0.

Limitations

  • You can configure only one allow list, or one deny list per Redpanda Connect instance.

  • When you add the name of a component to your allow or deny list, you grant or block access to all related components. For example, if you include aws_s3 in your list, you grant or block access to the entire aws_s3 family of components, including the cache, input, and output.

Configure an allow list

To configure an allow list:

  1. Create a connector_list.yaml file in the following location: /etc/redpanda/connector_list.yaml.

  2. In the Connector Catalog, find the exact name of the component family you want to grant access to. For example: aws_s3 and azure_cosmosdb.

  3. Add the names of the component families to the connector_list.yaml file, using the following format:

    allow:
      - aws_s3
      - azure_cosmosdb
  4. Save your configuration.

Configure a deny list

To configure a deny list:

  1. Create a connector_list.yaml file in the following location: /etc/redpanda/connector_list.yaml.

  2. In the Connector Catalog, find the exact name of the component family you want to block access to. For example: aws_s3 and azure_cosmosdb.

  3. Add the names of the component families to the connector_list.yaml file, using the following format:

    deny:
      - aws_s3
      - azure_cosmosdb
  4. Save your configuration.

Errors for excluded components

Redpanda Connect does not report that a list blocked a component. A config that uses a component the list excludes fails with the same error as a misspelled component name. For example, an aws_s3 output fails with this error when aws_s3 is excluded:

unable to infer output type from candidates: [aws_s3]

If the config sets the component with the type field, the error is output type 'aws_s3' was not recognised.

If a component name is spelled correctly but Redpanda Connect does not recognize it, check /etc/redpanda/connector_list.yaml.