# Configure Aerospike Database This page describes how to configure a Database cluster node using the configuration file, `aerospike.conf`. The configuration file is divided into different _contexts_, some of which are optional. These contexts can be in any order in the configuration file. A context can be further divided into sub-contexts. The maximum length of a line in the configuration file is 1,024 characters. The default location of the configuration file is `/etc/aerospike/aerospike.conf`. ## Sample configuration file The following sample file shows the structure of `aerospike.conf` with the most common contexts and sub-contexts. The contexts in this example are empty and do not have actual parameters, indicated by empty braces `{}`. Sub-contexts are indented. ::: caution This is not a working configuration example. Do not copy and try to use it as-is. It will not work without adding your parameters. ::: ```ruby service {} # Tuning parameters, process owner, feature # key file network { # Used to configure intracluster and # application-node communications service {} # Tools/Application communications protocol fabric {} # Intracluster communications protocol info {} # Administrator telnet console protocol heartbeat {} # Cluster formation protocol } security { # (Optional, Enterprise Edition only) to enable # access control on the cluster } logging {} # Logging configuration xdr { # (Optional, Enterprise Edition only) Configure # Cross-Datacenter Replication } namespace { # Define namespace record policies and storage # engine storage-engine {} # Configure data storage for the namespace set {} # (Optional) Set specific record policies } mod-lua { # location of UDF modules } ``` ## Configuration file changes The following examples show how `aerospike.conf` changed in Database 7.0.0. ### Database 7.0.0 and later ```ruby # Aerospike database developer configuration file. service { run-as-daemon false # To work with gdb, and make console logging visible. # The number of concurrent connections to the database is limited by # proto-fd-max, and by the system's maximum number of open file descriptors. # See "man limits.conf" for how to set the system's "nofile" limit. proto-fd-max 1024 work-directory run/work pidfile run/asd.pid cluster-name cakery } mod-lua { user-path run/work/usr/udf/lua } logging { # Log file must be an absolute path. file run/log/aerospike.log { context any info } console { context any info } } network { service { address any port 3000 } heartbeat { mode multicast multicast-group 239.1.99.222 port 9918 # To use unicast-mesh heartbeats, remove the 3 lines above, and see # aerospike_mesh.conf for alternative. interval 150 timeout 10 } fabric { port 3001 } # info { # port 3003 # } } namespace test { replication-factor 2 storage-engine memory { data-size 4G } } ``` ### Prior to Database 7.0.0 ```ruby # Aerospike database configuration file. service { user root group root pidfile /var/run/aerospike/asd.pid proto-fd-max 15000 } logging { # Log file must be an absolute path. file /var/log/aerospike/aerospike.log { context any info } } network { service { address any port 3000 } heartbeat { mode multicast multicast-group 239.1.99.222 port 9918 # To use unicast-mesh heartbeats, remove the 3 lines above, and see # aerospike_mesh.conf for alternative. interval 150 timeout 10 } fabric { port 3001 } info { port 3003 } } namespace test { replication-factor 2 memory-size 4G storage-engine memory } ``` ::: note You can use any port between 1024 and 65335 for Aerospike, as long as the port is not in use by an existing process. ::: ## YAML configuration Starting with Database 8.1.1, Aerospike supports YAML format configuration files as an experimental feature. This format is similar to that used by the [asconfig](https://aerospike.com/docs/database/tools/asconfig) tool and the [Aerospike Kubernetes Operator](https://aerospike.com/docs/kubernetes). ::: note YAML configuration support is a preview feature and requires the `--experimental` flag when [starting the server](https://aerospike.com/docs/database/advanced/cli-options). Functionality may change in future releases. ::: ### Configuration steps 1. (If necessary) Obtain a [feature-key file](https://aerospike.com/docs/database/manage/planning/feature-key). 2. Configure [network](https://aerospike.com/docs/database/manage/network) service and heartbeat sub-contexts. 3. Configure [namespaces](https://aerospike.com/docs/database/manage/namespace). 4. [Configuring Log Files](https://aerospike.com/docs/database/manage/logging/logs) and [Manually Rotating the Aerospike Log File](https://aerospike.com/docs/database/manage/logging/rotation). 5. (Optional) Configure [security](https://aerospike.com/docs/database/manage/security/rbac). 6. (Optional) Configure [rack-awareness](https://aerospike.com/docs/database/manage/namespace/rack-aware). 7. (Optional) Configure [cross-datacenter replication](https://aerospike.com/docs/database/manage/xdr/dynamic-xdr). ### Enable YAML configuration To use a YAML configuration file, start the server with the `--experimental` flag: Terminal window ```bash asd --experimental --config-file /etc/aerospike/aerospike.yaml ``` The server validates the YAML configuration against the default JSON schema packaged at `/opt/aerospike/schema`. To use a custom schema, specify the `--schema-file` flag: Terminal window ```bash asd --experimental --config-file /etc/aerospike/aerospike.yaml --schema-file /path/to/custom/schema.json ``` ### Convert existing configurations Use the [asconfig](https://aerospike.com/docs/database/tools/asconfig) tool to convert an existing Aerospike configuration file to YAML format: Terminal window ```bash asconfig convert --aerospike-version "8.1.0" --output aerospike.yaml aerospike.conf ``` ### Required updates after running `asconfig` While `asconfig` generates a standard YAML format, minor updates are required to align it with the server’s latest experimental validation requirements. Once you’ve converted your configuration, apply the following adjustments: 1. **Convert arrays to maps (keyed objects)**: - `namespaces`, `namespaces[].sets` - `network.tls` - `xdr.dcs`, `xdr.dcs[].namespaces` 2. **Remove `name` fields** that were used inside array entries; the name now becomes the map key. 3. **Update logging sinks** to typed entries with `contexts` (see schema for valid types/contexts): - `type: console` uses only `contexts` - `type: file` requires `path` plus `contexts` - `type: syslog` supports `facility`, `path`, `tag`, and `contexts` 4. **(Optional) Use unit-aware values** for size/time settings. Optionally use `{ value, unit }` objects where supported. Plain numeric values are still valid. Refer to the schema for the authoritative list of unit-capable fields and allowed units. For the authoritative format, reference `/opt/aerospike/schema/aerospike_config_schema.json`. ### Example config changes YAML configuration as output by asconfig. ```yaml # asconfig output (not valid for the server’s experimental YAML) service: cluster-name: my-cluster pidfile: /var/run/aerospike/asd.pid logging: - name: console any: info network: service: addresses: - any port: 3000 fabric: port: 3001 heartbeat: mode: mesh port: 3002 addresses: - local interval: 150 timeout: 10 namespaces: - name: test replication-factor: 2 storage-engine: type: memory data-size: 4294967296 ``` The configuration after aligning it with the database schema. ```yaml # server experimental YAML format service: cluster-name: my-cluster pidfile: /var/run/aerospike/asd.pid logging: - type: console contexts: any: info network: service: addresses: - any port: 3000 fabric: port: 3001 heartbeat: mode: mesh port: 3002 addresses: - local interval: 150 timeout: 10 namespaces: test: replication-factor: 2 storage-engine: type: memory data-size: value: 4 unit: g ``` ### Related content - [Troubleshooting guide](https://aerospike.com/docs/database/advanced/troubleshoot) - [Knowledge base](https://support.aerospike.com/s/topiccatalog) - Reference manuals: - [Configuration parameters](https://aerospike.com/docs/database/reference/config) - [Info commands](https://aerospike.com/docs/database/reference/info) - [Metrics](https://aerospike.com/docs/database/reference/metrics) - [Server log messages](https://aerospike.com/docs/database/reference/logs)