Memcached

This is an Memcached Docker image used to launch a Memcached service on Nanobox. To use this image, add a data component to your boxfile.yml with the nanobox/memcached image specified:

data.cache:
  image: nanobox/memcached

Memcached Configuration Options

Memcached components are configured in your boxfile.yml. All available configuration options are outlined below.

Quick Links

version
return_error_on_memory_exhausted
max_connections
chunk_size_growth_factor
minimum_allocated_space
maximum_requests_per_event
disable_cas
max_backlog
binding_protocol

Overview of Memcached Boxfile Settings

data.cache:
  image: nanobox/memcached
  config:
    version: 1.4
    return_error_on_memory_exhausted: false
    max_connections: 1024
    chunk_size_growth_factor: 1.25
    minimum_allocated_space: 48
    maximum_requests_per_event: 20
    disable_cas: false
    max_backlog: 1024
    binding_protocol: 'auto'

Version

When configuring a Memcached component in your Boxfile, you can specify which version to use. The following version(s) are available:

• 1.4
• 1.5

Note: Due to version compatibility constraints, memcached versions cannot be changed after the component is created. To use a different version, you'll have to create a new Memcached component.

version

# default setting
data.cache:
  image: nanobox/memcached
  config:
    version: 1.4

Return Error on Memory Exhausted

This allows you to have memcached return an error when memory is exhausted rather than removing items.

return_error_on_memory_exhausted

#default setting
data.cache:
  image: nanobox/memcached
  config:
    return_error_on_memory_exhausted: false

Max Connections

Sets the limit for simultaneous connections.

max_connections

#default setting
data.cache:
  image: nanobox/memcached
  config:
    max_connections: 1024

Chunk Size Growth Factor

Specifies the chunk size growth factor.

chunk_size_growth_factor

#default setting
data.cache:
  image: nanobox/memcached
  config:
    chunk_size_growth_factor: 1.25

Minimum Allocated Space

Sets the minimum space allocated for key+value+flags.

minimum_allocated_space

#default setting
data.cache:
  image: nanobox/memcached
  config:
    minimum_allocated_space: 48

Maximum Requests Per Event

Sets the maximum number of requests per event and limits the number of requests processed for a given connection to prevent starvation.

maximum_requests_per_event

#default setting
data.cache:
  image: nanobox/memcached
  config:
    maximum_requests_per_event: 20

Disable CAS

Allows you to disable the use of CAS.

disable_cas

#default setting
data.cache:
  image: nanobox/memcached
  config:
    disable_cas: false

Max Backlog

Sets the backlog queue limit.

max_backlog

#default setting
data.cache:
  image: nanobox/memcached
  config:
    max_backlog: 1024

Binding Protocol

Allows you to set the binding protocol. The following are available:

• auto
• ascii
• binary

binding_protocol

#default setting
data.cache:
  image: nanobox/memcached
  config:
    binding_protocol: 'auto'

Help & Support

This is a Memcached Docker image provided by Nanobox. If you need help with this image, you can reach out to us in the #nanobox IRC channel. If you are running into an issue with the image, feel free to create a new issue on this project.

License

Mozilla Public License, version 2.0