Configuration

Every deployment has configuration that controls the behavior of the Iggy server and any active connectors. Configuration is versioned — you can create multiple versions, activate a specific version, and roll back to a previous one.

Configuration Kinds

How It Works

1. Each deployment starts with a default configuration based on best-practice defaults
2. You can create a new named configuration with custom values
3. Each named config maintains a version history — every save creates a new version
4. Activate a specific version to apply it to the deployment
5. The Warden agent pulls the new config and applies it automatically
6. If something goes wrong, activate a previous version to roll back

Configuration Schemas

Every configuration kind has a schema that defines the available settings, their types, defaults, and validation rules. You can retrieve the schema to see what's configurable before creating a config.

From the Console

1. Navigate to your deployment and open the Configuration tab
2. Select the configuration kind (Iggy, Connectors, or a specific connector instance)
3. The schema is displayed as a form with current values, defaults, and descriptions
4. Modify values and click Save to create a new version
5. Click Activate to apply the version to the deployment

Managing Configurations

From the Configuration tab you can:

• View all named configs for each kind with their version history
• See the primary (active) configuration
• Compare versions side-by-side
• Activate any version to make it live
• Delete configurations you no longer need

Required permission: deployment:config:manage (create, activate, delete) or deployment:config:read (view)

API Reference

Get Configuration Schema

Returns the available settings, types, and defaults for a configuration kind.

curl {supervisor_url}/deployments/{deployment_id}/configs/iggy/schema \
  -H "ld-api-key: YOUR_API_KEY"

Create a Configuration

curl -X POST {supervisor_url}/deployments/{deployment_id}/configs/iggy \
  -H "ld-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "high-throughput",
    "values": {
      "IGGY_SYSTEM_TOPIC_MAX_SIZE": "2 GB"
    },
    "activate": false
  }'

Set "activate": true to immediately apply the config after creation.

Get Active Configuration

curl {supervisor_url}/deployments/{deployment_id}/configs/iggy/primary \
  -H "ld-api-key: YOUR_API_KEY"

List All Configurations

curl {supervisor_url}/deployments/{deployment_id}/configs/iggy \
  -H "ld-api-key: YOUR_API_KEY"

Get Version History

curl {supervisor_url}/deployments/{deployment_id}/configs/iggy/{config_name}/versions \
  -H "ld-api-key: YOUR_API_KEY"

Activate a Version

curl -X PUT {supervisor_url}/deployments/{deployment_id}/configs/iggy/{config_name}/activate/{version} \
  -H "ld-api-key: YOUR_API_KEY"

Delete a Configuration

curl -X DELETE {supervisor_url}/deployments/{deployment_id}/configs/iggy/{config_id} \
  -H "ld-api-key: YOUR_API_KEY"

Apply Configuration Changes

After activating a new configuration version, trigger a reconfigure task to apply it to the deployment:

curl -X POST {supervisor_url}/deployments/{deployment_id}/tasks \
  -H "ld-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "iggy:reconfigure"
  }'

The Warden agent on each node pulls the task and applies the active configuration automatically. Use connectors:reconfigure to apply connector configuration changes instead.

Required permission: deployment:task:manage