Publishing Config

Publishing a configuration pushes the current set of connectors and bindings to the desired state of a deployment's device shadow. The edge gateway then picks up the changes on its next poll cycle.

When to publish

You need to publish a configuration whenever you want changes to take effect on the edge gateway. Changes that require publishing include:

• Creating, updating, or deleting variable bindings
• Attaching or detaching connectors from assets
• Modifying connector configuration (endpoint, security settings)

The platform tracks every unpublished change and classifies it by impact:

With auto-publish enabled, routine changes are published automatically; deferred and structural changes always wait for you.

Publishing for a deployment

To publish pending changes:

1. Open the deployment and go to its Configuration page
2. Review the Pending Changes card — it lists every unpublished change grouped by tier
3. Optionally click Preview Changes to see exactly what will be sent to the gateway
4. Click Publish Now (or Publish Config on the Config Sync card)

If the pending set includes structural changes, a review dialog asks you to confirm you have reviewed them before publishing.

The platform assembles the configuration from the current bindings and connectors, updates the desired state in the shadow, and increments the config version.

What happens during publish

When you publish a configuration, the platform:

1. Collects the configuration — gathers the connectors in the gateway's scope and all their variable bindings
2. Computes a hash — for change detection
3. Compares with current — if the hash matches the existing desired config hash, the publish is skipped
4. Updates the shadow — stores the new configuration in the desired state and increments the config version
5. Sets sync status — changes the sync status to Pending

After publishing

Once published, the configuration is available for the edge gateway to pick up:

1. The Edge Runtime polls the shadow every 30 seconds
2. When it detects a newer desired version, it applies the connector and binding changes to its in-process protocol drivers
3. The runtime reports the applied version back to the cloud
4. The sync status updates to In Sync

You can monitor the progress in the Config Sync card on the deployment's Configuration page.