runner

iagctl runner

Start runner the server

Synopsis

This command will start up a gateway runner instance that will listen for service execution requests from a core gateway server that is within the same cluster, execute any given request, and then return any given request back to the core gateway server. Gateway runners can be a powerful tool when distributed gateway deployments are desired.

Understanding Gateway Clusters

Several gateway servers can be linked together if they all share the following properties:

• A shared etcd database. This can be configured by setting the configuration variable GATEWAY_STORE_BACKEND to etcd as well as setting the values for the GATEWAY_STORE_ETCD_* configuration variables to the appropriate values for your etcd deployment.
  
  
• The same value for the configuration variable GATEWAY_APPLICATION_CLUSTER_ID. All resources saved to a gateway database are linked to the GATEWAY_APPLICATION_CLUSTER_ID that was set at the time of creation. If multiple gateway instances are reading from the same etcd database with the same GATEWAY_APPLICATION_CLUSTER_ID, they will all have access to the same resources.

Gateway Core Servers vs Gateway Runners

By default, when a gateway server is started, it will have the ability to handle many different requests such as Create, Delete, and View resources as well as execute automations.

If the configuration variable GATEWAY_SERVER_DISTRIBUTED_EXECUTION
is set to true, the gateway server will still be able to accept all of the same requests, but the actual execution of automations will now be sent to a runner node that exists within the same cluster as the core server. It is important to understand the relationship where a core gateway server will accept all requests and pass the actual execution of requests to a runner node.

You can scale out to have as many runner nodes as desired. When a core server receives a service execution request, it will round robin between all of the runner nodes that are connected to the same etcd server and have the same GATEWAY_APPLICATION_CLUSTER_ID. The result of the service execution will be returned back to the gateway server
and ultimately back to the client that made the request.

To ensure that your gateway runner is correctly configured to receive requests from a gateway core server, see all of the GATEWAY_RUNNER_* configuration variables in the gateway reference documentation.

iagctl runner [flags]

Examples

Start a Gateway Runner

Start up a gateway runner instance that will connect up to a configured gateway core node.

>_ iagctl runner

Options

  -h, --help   help for runner

Options Inherited from Parent Commands

--config string   Path to the configuration file
--raw             Displays the result of the command in its raw format
--verbose         Enable verbose output

CLI References

For all CLI commands see → Command References Index