Riak CS Configuration Reference

  {riak_cs, [
      {cs_ip, "127.0.0.1"},
      {cs_port, 8080 },
      . . .
  ]},

  {riak_cs, [
      {listener, {"127.0.0.1", 8080}},
      . . .
  ]},

This document is intended as a reference listing of all configurable parameters for Riak CS. For a more narrative-style walkthrough of configuring Riak CS, we recommend consulting the configuring Riak CS tutorial.

The configuration for Riak CS is handled through either the riak-cs.conf and advanced.config file pair, which were introduced in Riak CS 2.0.0, or the two old-style app.config and vm.args files. All configuration files will be located in each Riak CS node’s /etc directory. Please note that you may only use one of these pairs at a time, as the app.config/vm.args pair will take priority over the new-style configuration files.

If you are using it, the vm.args file will house settings related to the Erlang VM on which both Riak and Riak CS run. These settings have been folded into the riak-cs.conf and riak.conf configuration files in newer systems.

The app.config and advanced.config files share an identical format, and can control all of Riak CS’s behaviors. The files are divided into the following sections:

• riak_cs — Most settings are housed in this section of the file
• webmachine — Settings related to Webmachine, the HTTP server framework that Riak CS uses for HTTP connections
• lager — Settings for lager, the Erlang logging framework used by Riak CS
• sasl — There is only one setting in this section, sasl_error_lager, which determines whether and how Riak CS uses Erlang’s SASL error logger

Most of the settings you will need to manipulate have been ported into the newer riak-cs.conf configuration format, but there may be some advanced settings – such as setting up customized lager streams – that will need to be configured in advanced.config.

The tables below will show settings for both riak-cs.conf and advanced.config/app.config where applicable, organized by functionality.

Connection Information

riak-cs.conf

advanced.config/app.config

Connection Pools

Riak CS enables you to establish connection pools for normal requests (such as GET and PUT) as well as for bucket listing requests.

riak-cs.conf

advanced.config/app.config

In these files, each pool is specified as a nested tuple of the following form:

{riak_cs, [
           {Name, {FixedSize, OverflowSize}}
          ]}

Stanchion

riak-cs.conf

advanced.config/app.config

Admin and Authentication Settings

riak-cs.conf

advanced.config/app.config

Usage Recording

These settings relate to Riak CS’s access logs.

riak-cs.conf

advanced.config/app.config

Garbage Collection

Settings related to Riak CS’s garbage collection (GC) process.

riak-cs.conf

advanced.config/app.config

Concurrency and Buffering

advanced.config/app.config Only

There are two parameters related to concurrency and buffering that you should consider adding to your Riak CS settings if you are having issues with PUT requests. Raising the value of both of these settings may provide higher single- client throughput.

Miscellaneous Settings

riak-cs.conf

advanced.config/app.config

Timeouts on each Riak call

As Riak CS stores all data in underlying Riak, Riak CS processes communicate to Riak over an API using protocol buffers. This is a typical remote call - depending on system requirements, the timeout could be configured to avoid unnecessary timeouts.

In Riak 1.5.3 or later, configurations under riakc section are unavailable. Timeouts are configurable depending on each access case. This enables fine grained tuning or ad-hoc reaction in production environment issues. These items are only configurable in riak_cs section of advanced.config. All units in the chart below are milliseconds.

Webmachine

advanced.config/app.config Only

Settings specific to Webmachine, the web server that handles all HTTP and HTTPS connections to Riak CS. The riak_cs_access_log_handler and webmachine_log_handler settings are part of a log_handlers sub-grouping:

{webmachine, [
              %% Other configs
              {log_handlers, [
                              {webmachine_access_log_handler, ...},
                              {riak_cs_access_log_handler, ...},
                              ]},
              %% Other configs
             ]}

Logging

advanced.config/app.config Only

These settings relate to lager, the Erlang logging framework used by Riak CS. They are included in the lager settings in app.config.

The lager_console_backend and lager_file_backend settings are part of a handlers sub-group:

{lager, [
         %% Other configs
         {handlers, [
                     {lager_console_backend, ...},
                     {lager_file_backend, ...}
                    ]},
         %% Other configs
        ]}

SASL

advanced.config/app.config Only