Enabling DSEFS

Steps to enable DSEFS on DataStax Enterprise nodes.

DSEFS is automatically enabled on analytics nodes, and disabled on non-analtyics nodes. You can enable the DSEFS service on any node in a DataStax Enterprise cluster. Nodes within the same datacenter with DSEFS enabled will join together to behave as a DSEFS cluster.


The location of the dse.yaml file depends on the type of installation:

Package installations
Installer-Services installations


Tarball installations
Installer-No Services installations



DataStax Enterprise 5.0 or later is required..


On each node:
  1. In the dse.yaml file, set the properties for the DSE File System options:
        enabled: false
        keyspace_name: dsefs
        work_dir: /var/lib/dsefs
        public_port: 5598
        private_port: 5599
          - dir: /var/lib/dsefs/data
            storage_weight: 1.0
            min_free_space: 5368709120
    1. Enable DSEFS:
      enabled: true
      If enabled is blank or commented out, DSEFS starts only if the node is configured to run analytics workloads.
    2. Define the keyspace for storing the DSEFS metadata:
      keyspace_name: dsefs
      You can optionally configure multiple DSEFS file systems in a single datacenter.
    3. Define the work directory for storing the DSEFS metadata for the local node. The work directory should not be shared with other DSEFS nodes:
      work_dir: /var/lib/dsefs
    4. Define the public port on which DSEFS listens for clients:
      public_port: 5598
      DataStax recommends that all nodes in the cluster have the same value. Firewalls must open this port to trusted clients. The service on this port is bound to the RPC address.
    5. Define the private port for DSEFS inter-node communication:
      private_port: 5599
      Do not open this port to firewalls; this private port must be not visible from outside of the cluster.
    6. Set the data directories where the file data blocks are stored locally on each node.
          - dir: /var/lib/dsefs/data
      If you use the default /var/lib/dsefs/data data directory, verify that the directory exists and that you have root access. Otherwise, you can define your own directory location, change the ownership of the directory, or both:
      sudo mkdir -p /var/lib/dsefs/data; sudo chown -R  $USER:$GROUP /var/lib/dsefs/data
      Ensure that the data directory is writeable by the DataStax Enterprise user. Put the data directories on different physical devices than the database. Using multiple data directories on JBOD improves performance and capacity.
    7. For each data directory, set the weighting factor to specify how much data to place in this directory, relative to other directories in the cluster. This soft constraint determines how DSEFS distributes the data. For example, a directory with a value of 3.0 receives about three times more data than a directory with a value of 1.0.
          - dir: /var/lib/dsefs/data
            storage_weight: 1.0
    8. For each data directory, define the reserved space, in bytes, to not use for storing file data blocks. You can use a unit of measure suffix to specify other size units. For example: terabyte (1 TB), gigabyte (10 GB), and megabyte (5000 MB).
          - dir: /var/lib/dsefs/data
            storage_weight: 1.0
            min_free_space: 5368709120
  2. Restart the node.
  3. Repeat steps for the remaining nodes.
  4. Optional: With guidance from DataStax Support, you can tune advanced DSEFS properties:
    # Advanced properties for DSEFS
    # service_startup_timeout_ms: 30000
    # service_close_timeout_ms: 600000
    # server_close_timeout_ms: 600000
    # compression_frame_max_size: 1048576
    # query_cache_size: 2048
    # query_cache_expire_after_ms: 2000
    # gossip_options:
      #   round_delay_ms: 5000
      #   startup_delay_ms: 5000
      #   shutdown_delay_ms: 30000
    # rest_options:
      #   request_timeout_ms: 330000
      #   connection_open_timeout_ms: 55000
      #   client_close_timeout_ms: 60000
      #   server_request_timeout_ms: 300000
      #   idle_connection_timeout_ms: 0
      #   internode_idle_connection_timeout_ms: 120000
      #   core_max_concurrent_connections_per_host: 8
    # transaction_options:
      #   transaction_timeout_ms: 3000
      #   conflict_retry_delay_ms: 200
      #   conflict_retry_count: 40
      #   execution_retry_delay_ms: 1000
      #   execution_retry_count: 3
  5. Continue with using DSEFS.