The CloudSoda Agent is designed (by default) to connect with the CloudSoda Controller, along with other agents, and form a mesh. However, at times, it may be necessary to manually overwrite the CloudSoda Agent's default behavior. This is done by editing the soda.conf file on the server where the agent is installed. Please note, all changes to the soda.conf file require a restart of the agent in order to take effect. This can be done with sudo soda restart or soda.exe restart on Windows.
soda.conf
To overwrite the CloudSoda Agent's default behavior, add the following options to the soda.conf file. This file is not created when the CloudSoda Agent is installed but rather needs to be created by the user when they want to override the agent's default behavior.
Location
The file should be created in the "soda" directory. On macOS or Linux the "soda" directory is /etc/soda/ so the path of the file should be /etc/soda/soda.conf. For Windows, the location of the "soda" directory is based on whether the agent was installed as an Administrator or as a regular user. Open cmd.exe (Start - Run - cmd.exe [enter]).
If CloudSoda was installed as the Administrator, type:
cd %ProgramData%\soda
If CloudSoda was installed as a regular user, type (make sure you're logged in as the user that installed it):
cd %LocalAppData%\soda
If you see the error The system cannot find the path specified., go back to make sure you installed CloudSoda first.
Contents
The contents of the soda.conf should be in a YAML format. Therefore, the options must be entered in key: value notation, for example, debug: true. To add multiple entries to the file, put each entry on a new line. Whenever the contents of the file change the agent must be restarted, which can be done by running soda restart via the CLI.
Key
Value
Description
debug
Boolean - example: true
Sets debug to true to enable a higher level of logging. This should only be done when requested by CloudSoda support.
bind-ip
(deprecated)
IPv4 or IPv6 address - example: 192.1.2.3
Binds the CloudSoda Agent to a specific IP address rather than working over every IP address.
listen-address
IPv4 or IPv6 address with port - example: 1.1.1.1:39844 or :45818 or 1.1.1.1:0
Binds the CloudSoda Agent to a specific IP address and port. No two agents in the same network should share a port number. If you don't want to hardcode a port you should use 0.
disable-auto-update
Boolean - example: true
Prohibits the CloudSoda Agent from auto-updating. This should only be done when requested by CloudSoda support.
profile-path
/home/user/agent_profile.json
Defines the path to the CloudSoda Agent's profile JSON file.
cpu-concurrency
Positive integer - example: 60
Use a percentage of the agent's estimated CPU power. By default this is 100. Specifying a value of 50 means the agent should only use 50% of the estimated CPU power for transfers. A value greater than 100 can also be used if you think the agent's estimate is too conservative. This value can range from 1 to 200
s3-concurrency
Positive integer - example: 5
Set the number of concurrent uploaders for large transfers to AWS or S3 compatible storage. This should only be changed when suggested by CloudSoda support.
fs-walk-concurrency
Positive integer - example: 5
Set the number of concurrent storage walkers for local file system. By default this is 2.
smb-walk-concurrency
Positive integer - example: 5
Set the number of concurrent storage walkers for SMB shares. By default this is 2.
s3-walk-concurrency
Positive integer - example: 150
Set the number of concurrent S3 and S3 like storage walkers. By default this is 100.
gcs-walk-concurrency
Positive integer - example: 150
Set the number of concurrent gcs storage walkers. By default this is 100.
azure-walk-concurrency
Positive integer - example: 150
Set the number of concurrent azure blob storage walkers. By default this is 100.
powerscale-walk-concurrency
Positive integer - example: 200
Set the number of concurrent walkers for PowerScale storage. By default this is 128.
Comments
0 comments
Please sign in to leave a comment.