Navigation

Automation Agent Configuration

This page describes possible settings for Automation Agent. These values are set after first launching Cloud Manager and not through manual editing of these files.

Warning

If you edit these settings through the Settings or Deployments, in the case of authentication or SSL, in Cloud Manager, those changes overwrite any changes made manually in this configuration file.

Configuration File Location per Operating System

The location of the Automation Agent configuration file depends on your operating system:

Operating System Installation Method Config File Path
RHEL, CentOS, Amazon Linux and Ubuntu package manager /etc/mongodb-mms/automation-agent.config
OS X or other Linux distributions tar /path/to/install/local.config
Windows msi C:\MMSData\Automation\automation-agent.config

Settings

Cloud Manager provides default values for many of the Automation Agent Configuration settings.

Connection Settings

mmsGroupId

Type: string

Specifies the ID of your Cloud Manager project. In Cloud Manager, click Settings, then Agents and then click on the appropriate operating system under Agent Downloads.

When the Automation Agent Installation Instructions box appears, these values can be copied directly from this box using the Copy buttons.

Required.

mmsGroupId=8zvbo2s2asigxvmpnkq5yexf
mmsApiKey

Type: string

Specifies the Cloud Manager agent API key of your Cloud Manager project.

You can use an Agent API key that you have already generated for the project. Otherwise, you can generate a new Agent API key. A project can have more than one Agent API key, and any of the project’s agents can use any of the keys. For more information, see Manage Agent API Keys.

To generate an Agent API key, go to the Agent API Keys tab. To navigate to the tab, from the Deployment view, click the Agents tab and then the Agent API Keys tab.

Important

When you generate an Agent API key, Cloud Manager displays it one time only. You must copy it and store it in a secure place. Cloud Manager will never display the full key again.

Required.

mmsApiKey=rgdte4w7wwbnds9nceuodx9mcte2zqem
mmsBaseUrl

Type: string

Specifies the URL of the Cloud Manager.

logFile

Type: string

Specifies the path to which Cloud Manager should write the Automation Agent’s log.

By default, this path is /var/log/mongodb-mms-automation/automation-agent.log.

logFile=/path/to/mongodb-mms-automation/automation-agent.log
mmsConfigBackup

Type:

Specifies the path to the Cloud Manager automation configuration backup file. This file describes the desired state of the deployment.

mmsConfigBackup=/path/to/mms-cluster-config-backup.json

Note

When Ops Manager is installed, it stores this configuration backup file in /var/lib/mongodb-mms-automation/.

dialTimeoutSeconds

Type: int

Specifies the number of seconds to wait before a connection times out. By default, connections time out after 40 seconds. However, The Automation Agent may frequently time out of connections for one or more of the following reasons:

  • High network latency
  • High server load
  • Large SSL keys
  • Lack of SSL accelerator
  • Insufficient CPU speed

MongoDB recommends gradually increasing the value of the dialTimeoutSeconds Automation Agent configuration setting to prevent frequent premature connection timeouts.

dialTimeoutSeconds=40

Note

Increasing this value also increases the time required to deploy configuration changes to the Automation Agent. Experiment with small, incremental increases until you determine the optimum value for your deployment.

Logging Settings

logLevel

Type: string

Specifies the level of logging granularity.

Choose from the following severity levels, from most to least verbose:

  • DEBUG
  • INFO
  • WARN
  • ERROR
  • FATAL

By default, logLevel is INFO.

logLevel=ROUTINE

Each level includes the log items included in the succeeding levels.

Example

  • If you choose DEBUG, the Automation Agent logs all messages, including INFO, WARN, ERROR and FATAL.
  • If you choose FATAL, the Automation Agent only logs FATAL messages.
maxLogFiles

Type: integer

Specifies the maximum number of rotated log files to retain.

By default, maxLogFiles is 10. You can change the value to retain a different quantity of rotated log files.

maxLogFiles=15
maxLogFileSize

Type: integer

Specifies the maximum size, in bytes, of a log file before the logs are rotated. If unspecified, the Automation Agent does not rotate logs based on file size. This is optional.

maxLogFileSize=536870912
maxLogFileDurationHrs

Type: float

Specifies the number of hours after which the logs (regular and verbose) are rotated. This is optional.

Note

On UNIX- and Linux-based systems you can manually rotate the Automation Agent logs. Issue a user signal 1 kill command for the Automation Agent process:

kill -SIGUSR1 <automationAgentID>

This rotates the Automation Agent regular and verbose logs.

HTTP Proxy Settings

httpProxy

Type: string

Specifies the URL of an HTTP proxy server the Automation Agent can use.

httpProxy=http://proxy.example.com:8080

MongoDB Kerberos Settings

Specify these settings if the Automation Agent authenticates to hosts using Kerberos.

krb5ConfigLocation

Type: string

Specifies an absolute path to an non-system-standard location for the Kerberos configuration file.

krb5ConfigLocation=/path/to/krb_custom.conf

Note

Cloud Manager creates a Kerberos Credential (Ticket) Cache for each agent automatically when Kerberos is enabled. If you want to override the location of the Kerberos Credential Cache, you must set the KRB5CCNAME environment variable to the desired file name and path before running the agent.

Cloud Manager SSL Settings

Specify the settings the Automation Agent uses when communicating with Cloud Manager using SSL.

sslTrustedMMSServerCertificate

Type: string

Specifies the absolute path that contains the trusted CA certificates in PEM format. The absolute path must be used because the Automation Agent may pass this certificate to the other agents, which may have different paths relative to the Automation Agent. This certificate verifies that the agent is talking to the designated Cloud Manager instance.

sslTrustedMMSServerCertificate=/path/to/ca.pem
sslRequireValidMMSServerCertificates

Type: boolean

Specifies if the Automation Agent should validate SSL certificates presented by Cloud Manager.

Warning

Setting this option to false disables certificate verification and makes connections between the Automation Agent and Cloud Manager susceptible to man-in-the-middle attacks. Setting this option to false is only recommended for testing purposes.

sslRequireValidMMSServerCertificates=true