Maintaining Connector-Application configuration

Introduction

Sometimes, you may need to update your Connector-Application configuration. Some possible reasons are:

  • You want to consume an additional stream

  • The Connect-Plugin in use has been updated

  • You need to fix a mistake in the configuration

  • You want to enable additional logging

Update an Application Deployment Configuration

You can update a Connector-Application configuration using the self-service UI. You first need to stop your Connector-Application deployment.

  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

    Axual "Self-Service" UI, section of the "Application" page, showing the connector-configuration status box of a configured connector, in "running" state

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

    Axual "Self-Service" UI, section of the "Application" page, showing the connector-configuration status box of a configured connector, in "stopped" state and with the "grear" configuration button being highlighted

  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.

Mandatory, Optional, Custom and Unsupported configuration

The application deployment configuration keys come in 4 flavors:

  1. Mandatory — These keys are identified with an Asterisk on the left side, and they are mandatory. You cannot save the configuration without providing these values.

  2. Optional — These keys might come with default values (provided by the Connect-Plugin itself)
    You can click the Cross ( X ) icon next to the value to remove the provided default.

  3. Custom — These keys have been created by the user while defining the application deployment configuration; they can be deleted by pressing the Bin icon on the right side of the value.

  4. Unsupported — These are obsolete keys which were used in previous versions of the connector plugin and are not used by the current version of the connector plugin anymore. These keys should be deleted.

Check if Application Deployment Tasks are failing

In case the new Connect-Plugin version introduced mandatory fields, your application deployment may be failing. This can happen if the Connect-Plugin was updated while your Connector-Application 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.