Itential Automation GatewayDeploy and manageConfigure

Initial configuration

Initial configuration of your gateway cluster involves setting up the gateway server to handle client requests, manage resources, and communicate with Gateway Manager and runner nodes. Different sections of the configuration file apply to specific nodes and communication scenarios.

Configuration file structure

The configuration file is located at /etc/gateway/gateway.conf for RPM/DEB installations or managed through environment variables for containerized deployments. Each configuration section serves specific node types and communication requirements:

  • [application]: Global settings applied to all node types
  • [server]: Settings specific to gateway server nodes
  • [client]: Settings specific to gateway client nodes
  • [connect]: Settings for Gateway Manager connectivity (applies to server nodes)
  • [runner]: Settings specific to gateway runner nodes
  • [store]: Database backend configuration (applies to server and runner nodes in distributed execution deployment models)
  • [log], [features], [secrets]: Shared settings across node types

Essential configuration settings

After installing Gateway Manager and IAG, configure each node by updating the appropriate configuration variables. The following tabs provide examples of the most common settings you need to configure before starting your gateway cluster. To view an example configuration file, see Configuration variables.

Applies to: All nodes

Set the application mode to server to manage gateway resources:

$[application]
$mode = server
$cluster_id = 'cluster_1'
$working_dir = /var/lib/gateway
$# CA certificate for mutual TLS verification
$ca_certificate_file = /etc/gateway/certificates/ca.pem

For more information, see Application modes.

Server startup and management

Once your configuration is complete, start your gateway server to begin accepting client connections. The startup process differs between RPM/DEB installations and container deployments.

RPM/DEB installations

$# Start the server
$sudo systemctl start iagctl
$
$# Enable auto-start
$sudo systemctl enable iagctl
$
$# Check status
$sudo systemctl status iagctl
$
$# View logs
$sudo journalctl -u iagctl -f

Container deployments

$# Start server container
$docker compose up -d
$
$# View logs
$docker compose logs -f gateway5-server
$
$# Stop server
$docker compose down

Initial admin setup

On first startup, IAG creates a temporary admin account for initial configuration. Gateway clients use this account to connect to the server and configure services and resources. Find the credentials in the logs:

=== CREATED TEMPORARY ADMIN
username: admin
password: admin
===

Learn more