Octopus Administrator's Guide
Configuring Octopus for Multi-Server Operation

 

Previous Topic:
Subclass Configuration
Chapter Index
  

 

Agent Configuration


Each remote computer on which an Octopus Agent is installed must have its own nucleus.ini file. This file must include an [OCTOPUS AGENT] section, containing parameters that specify the port number used to connect to the Octopus program (Port) and the name and location of the Agent�s log file (LogFile). Optionally, the BindToAdaptors parameter can be included to specify the network ID name or IP address on the remote computer to which Octopus-Agent communications will be bound.

In addition, certain ODDB parameters and an OctoEng timeout setting can appear in this section:

ODDBMaxCache= 

The maximum amount of cache (in megabytes) that can be used by all ODDB instances running on this Octopus Agent.

Possible values:

  • 0 (no limit on cache)
  • n (cache limited to n megabytes, where n is a positive integer)

Default: 0
ODDBMaxServer=

The maximum number of ODDB instances that can run on this Octopus Agent.

Possible values:

  • 0 (no limit on number of instances)
  • n (the maximum number of instances, where n is a positive integer)

Default: 0
ODDBPriority= 

This parameter determines if the Octopus Agent will prioritize queued requests to start ODDB instances based on group membership, or else serve the instances on a first-come, first-serve basis.

Priority is given to the groups in the comma-separated ODDBPriority list, reading from left to right. When ODDB instance requests are queued, groups that are earlier in the ODDBPriority list are served before ones later in the list, and all groups have priority over instances that do not belong to any group.

A group name is specified using the ODDBPriorityGroup parameter in the [Octopus instance-name] section.

Possible values:

  • FIFO (no prioritizing)
  • group-name1[,group-nameN]... (the comma-separated list of groups in order of priority)

Default: FIFO
ODDBWaitForCacheFit= 

If ODDBMaxCache is enabled, the ODDBWaitForCacheFit parameter determines whether the Agent will service ODDB instance requests strictly in the queued order (waiting for cache space to become available, if necessary), or whether requests will be filled according to the available cache space. In the latter case, if the next queued ODDB instance request cannot fit into the available cache, the Agent will skip that entire Octopus request queue and look for a request in another queue, assuming there are multiple Octopus instances with requests.

Possible values:

  • True (serve the next queued ODDB instance request, waiting for cache space to free up if necessary)
  • False (serve the next queued ODDB instance request that fits into the currently available cache)

Default:

  • False (if ODDBPRIORITY is set to FIFO)
  • True (if ODDBPRIORITY is set to a list of groups)
StartOctoEngTimeOut=

The amount of time (in seconds) to wait for a local OctoEng to start up before timing out. This value must be a nonnegative integer. A value of 0 disables the OctoEng timeout (unlimited wait).

Default: 0 (disabled)

 


Sample Octopus Agent Section (UNIX)

[OCTOPUS AGENT]
Port=6500
LogFile=/var/adm/nucleus/logs/OCTOLOG_TEST
ODDBMaxCache=2000
ODDBMaxServer=10
ODDBPriority=BigCache,MidCache,SmallCache
ODDBWaitForCache=True
StartOctoEngTimeOut=10