Updating Connector Configuration

This guide covers updating the plugin configuration of a running connector application, and checking whether an application deployment fails after the change.

Type

How-to guide

Goal

Change the plugin configuration of an existing connector application and restart it with the new values.

Audience

An application owner who runs a Managed Connector application in Self-Service.

When to use

When you need to consume an additional topic, adopt an updated plugin, fix a configuration mistake, or enable extra logging.

Update an Application Deployment Configuration

You can update a Connector plugin configuration using the Self-Service UI. You first need to stop your Connector plugin deployment. For what each configuration key flavour means, see Connector application states.

Update the configuration as follows:

  1. Visit the detail page of the application.

  2. Select the environment for which you want to update the configuration.

  3. Press the Stop button.

  4. After the Connector deployment has been stopped, click on the Gear button in the application box (hovering on the button will show the text 'Configuration').

  5. From the Configuration modal you can now change the configuration values. Once you’re done press Save to persist the changes.

  6. After saving the Connector application deployment configuration, press the Start button to run the Connector using the new configuration.

Check if Application Deployment Tasks are failing

In case the new plugin version introduced mandatory fields, your application deployment may be failing. This can happen if the plugin was updated while your Connector was running.

The Axual Platform operator-team should notify you when a plugin is scheduled for upgrades, in which case you should consult the plugin documentation and check for breaking changes. You might be able to introduce some mandatory configuration values before the update.