Attributes

Owned by SungEun Kim
Last updated: 2023/03/09
9 min read

Overview

version

1.1-A5, 1.2-A1

XML notation

The configuration file content in XML format obtained via dump-xml is missing the userdata attribute.

  • tag name

    • Indicates that a tag exists at the parent of the property as follows,
      Ex) tag1/tag2

      <tag1> <tag2></tag2> </tag1>

  • ATTRIBUTE

    • Use the attribute of the tag

  • TEXT

    • Use the text of that tag

Dynamic adjusting notation

  • NO

    • Properties that are not dynamically applied. Service restart in case of system configuration, Down/Up procedure in case of resource configuration is required

  • ADJUST

    • Attributes updated through configuration adjustment commands

  • ADJUST_EACH

    • After running a system configuration adjustment command, to apply it to a running resource, you must also run a configuration adjustment command for that resource.

  • RECONN

    • Attributes that require reconnection between nodes after executing a configuration adjustment command

  • PROMOTE

    • Attributes that require demote/promote after configuration reconciliation command is executed

range of numeric datatypes

  • 32-bit integer: 0 to 2 31 -1 (2147483647)

system settings

{ "options": { "hostname": "", "resources_path": ".", "database_path": "../db", "enable_auto_up": true, "rpc_address": "0.0.0.0:5168", "rest_address": "0.0.0.0:5167", "file_handle_limit": 128 }, "log": { "level": "debug", "console": { "enable": true }, "file": { "enable": true, "location": "../logs", "size_limit": 10, "rotate_count": 10 } }, "file_buffer": { "location": "../buffer", "limit": 1024, "warn": 10, "auto_recover": false }, "disk": { "minimum": 0, "period": 0 }, "archive": { "period": 0, "location": "../archives" }, "userdata": null }
<system> <options hostname="node1" auto_up="true" file_handle_limit="128" sync_hash_type="crc32"> <paths> <resources>.</resources> <database>../db1</database> </paths> <addresses> <rpc>0.0.0.0:5168</rpc> <rest>0.0.0.0:5167</rest> </addresses> </options> <log level="info"> <console enable="true"></console> <file enable="true" size_limit="10" rotate_count="10">../logs/node1</file> </log> <file_buffer limit="1024" warn="10" auto_recover="true">../buffer</file_buffer> <disk minimum="1024" period="3"></disk> <archive enable="true" period="3">../archive</archive> </system>

structure

  • options

    • hostname

    • resources_path

    • database_path

    • enable_auto_up

    • rpc_address

    • rest_address

    • file_handle_limit

    • sync_hash_type

    • max_block_size

  • log

    • level

    • console

      • enable

    • file

      • enable

      • location

      • size_limit

      • size_limit

  • file_buffer

    • location

    • limit

    • warn

    • auto_recover

  • disk

    • minimum

    • period

  • archive

    • period

    • location

  • snapshot

    • type

  • userdata

Option by item

options

Settings used at program startup. It is not applied dynamically.

item

default value

setting range

unit

dynamic adjusting

Description

XML

note

item

default value

setting range

unit

dynamic adjusting

Description

XML

note

hostname

 

hostname

string

NO

If the host name to be used in FSR
is not set, the host name of the device is used.

ATTRIBUTE

 

resources_path

.

 

directory path

NO

 

It operates as a relative path based on the location of the path setting file where resource files are located.

paths/resources/TEXT

 

database_path

../db

 

directory path

NO

 

It operates as a relative path based on the path setting file location for saving the resource state.

paths/database/TEXT

 

enable_auto_up
(auto_up in 1.0.x)

true

true / false

Boolean

NO

If true, resource UP is performed at FSR start.

ATTRIBUTE

1.1-A1

rpc_address

0.0.0.0:5168

IPv4 / IPv6

{ip}:{port}

NO

gRPC Listen address

addresses/rpc/TEXT

 

rest_address

0.0.0.0:5167

IPv4 / IPv6

{ip}:{port}

NO

REST-API Listen address

addresses/rest/TEXT

 

file_handle_limit

128

32-bit integer

Count

ADJUST

Limit the number of concurrently open file handles for replication
Use default value when set to 0

ATTRIBUTE

 

sync_hash_type

crc32

crc32 / md5 / sha1 / sha256 / sha512

hash type

ADJUST

The type of hash algorithm to use for synchronization

ATTRIBUTE

0.9

max_block_size

One

1 to 30

MB

PROMOTE

Max Replicated I/O Block Size

ATTRIBUTE

1.0-A2

log

Log-related settings.

item

default value

setting range

unit

dynamic adjusting

Description

XML

note

item

default value

setting range

unit

dynamic adjusting

Description

XML

note

level

debug

debug / info / warn / error / fatal / panic

log level

ADJUST

log output level

ATTRIBUTE

 

console

enable

true

true / false

Boolean

ADJUST

log console output

console/ATTRIBUTE

 

file

enable

true

true / false

Boolean

ADJUST

Whether to use log files

file/ATTRIBUTE

 

location

../logs

 

file path

ADJUST

Log file path and file name
settings Operate as a relative path based on the file location.

file/TEXT

 

size_limit

10

32-bit integer

MB

ADJUST

 

Use the default value when setting the log file individual size limit to 0

file/ATTRIBUTE

 

rotate_count

10

32-bit integer

Count

ADJUST

Number of log files to retain when rolling,
use default value when set to 0

file/ATTRIBUTE

 

file_buffer

File buffer settings.

item

default value

setting range

unit

dynamic adjusting

Description

XML

note

item

default value

setting range

unit

dynamic adjusting

Description

XML

note

location

../buffer

 

directory path

NO

file buffer default location

TEXT

 

limit

1024M

32-bit integer

MB

ADJUST_EACH

maximum size. When dynamically applied, the resource adjustment command must also be executed to apply.
When set to 0, the file buffer is not used.

ATTRIBUTE

 

warn

10M

32-bit integer

MB

ADJUST_EACH

 

Disabling Alerts when Usage Alert Threshold is set to 0

ATTRIBUTE

 

auto_recover

false

true / false

Boolean

-

Whether to automatically restart when the stop motion threshold is reached

ATTRIBUTE

unused

disk

disk monitoring.

item

default value

setting range

unit

dynamic adjusting

Description

XML

note

item

default value

setting range

unit

dynamic adjusting

Description

XML

note

minimum

1024

32-bit integer

MB

ADJUST

Stopping operation due to remaining disk capacity Threshold
Disable monitoring when set to 0

ATTRIBUTE

 

period

30

32-bit integer

candle

ADJUST

 

Disable monitoring when disk remaining capacity check cycle is set to 0

ATTRIBUTE

 

archive

Archive deleted/orphaned files

item

default value

setting range

unit

dynamic adjusting

Description

XML

note

item

default value

setting range

unit

dynamic adjusting

Description

XML

note

period

0

32-bit integer

Storage period (day)

ADJUST

Deleted/orphaned files are
kept indefinitely when set to 0

ATTRIBUTE

 

location

../archives

 

directory path

ADJUST

Set the storage location for deleted/orphaned files
Operates with a relative path based on the file location

TEXT

 

snapshot

snapshot

item

default value

setting range

unit

dynamic adjusting

Description

XML

note

item

default value

setting range

unit

dynamic adjusting

Description

XML

note

type

copy

not_set / copy / full / incremental / differential

backup type

ADJUST

Snapshot Backup Type

ATTRIBUTE

1.2

userdata

user properties. Object type data can be freely added.

resource settings

structure

  • id

  • description

  • auto_up

  • nodes

    • index

    • name

    • hostname

    • url

    • files

      • path

      • type

      • recursive

      • exclude_patterns

      • sync

        • attributes

        • permissions

      • archive

        • enable

        • period

        • location

    • periodic_sync

      • period

      • comparison_level

      • report

    • buffer

      • size

    • file_buffer

      • location

      • limit

      • warn

    • auto_up

    • auto_file_lock

    • database_path

    • group

  • connections

    • node1

      • name

      • type

      • url

      • proxy

    • node2

      • name

      • type

      • url

      • proxy

    • buffer

      • size

    • file_buffer

      • limit

      • warn

    • network

      • ping_interval

      • compress

      • tls

      • limit

  • options

    • recursive

    • exclude_patterns

    • auto_file_lock

    • database_path

    • sync

      • attributes

      • permissions

      • comparison_level

      • hash_type

  • network

    • ping_interval

    • compress

    • tls

    • limit

  • handlers

    • options

      • timeout

      • timeout_action

    • after_resync_target

    • before_resync_target

    • before_resync_source

    • out_of_sync

    • local_io_error

    • before_snapshot_create

    • after_snapshot_create

    • before_snapshot_recovery

    • after_snapshot_recovery

  • proxy

    • the murmur

    • bullimt

    • plugin

  • snapshot

    • type

  • userdata

Option by item

The node list is applied based on 'name' when applying dynamically, so the order of creation does not matter. Since there are network-related properties that require reconnection, the corresponding properties are specified as 'RECONN'.

top option

Default settings of resources

item

default value

setting range

unit

dynamic adjusting

Description

XML

note

item

default value

setting range

unit

dynamic adjusting

Description

XML

note

id

 

Must be available as filename

string

NO

The ID of the resource
must be the same as the resource file name

ATTRIBUTE

 

description

 

 

string

ADJUST

Description of the resource

description/TEXT

unused

auto_up

true

true / false

Boolean

NO

If true, resource UP is performed at FSR start.

ATTRIBUTE

 

nodes

A list of nodes in the replication network.
(XML: nodes/node)

item

default value

setting range

unit

dynamic adjusting

Description

 

note

item

default value

setting range

unit

dynamic adjusting

Description

 

note

index

0

32-bit integer

a number greater than or equal to 0

ADJUST

node's unique number

ATTRIBUTE

1.0-A3

name

 

 

string

ADJUST

node name or host name

ATTRIBUTE

 

hostname

 

 

string

ADJUST

node's hostname

hostname/TEXT

 

url

 

IPv4 / IPv6

{ip}:{port}

RECONN

replication connection address

ATTRIBUTE

 

files
(list)

path

 

 

directory path

ADJUST

clone target

files/file/ATTRIBUTE

 

type

directory

directory / file

target type

ADJUST

Replication target type

files/file/ATTRIBUTE

0.9

recursive

true

true / false

Boolean

ADJUST

Whether to include subdirectories

files/file/ATTRIBUTE

 

exclude_patterns (list)

 

 

exclusion pattern

ADJUST

exclusion pattern

files/file/exclude_patterns/pattern/TEXT

 

sync

attributes

true

true / false

Boolean

ADJUST

Attribute sync?

files/file/sync/ATTRIBUTE

1.0

permissions

name

name / sid / none

string flag

ADJUST

Security Settings Replication Criteria

files/file/sync/ATTRIBUTE

0.9.1

archive

enable

false

true / false

Boolean

ADJUST

Whether to keep orphaned files

files/file/archive/ATTRIBUTE

 

period

0

32-bit integer

Storage period (day)

ADJUST

Orphaned file retention period
Indefinite if set to 0

files/file/archive/ATTRIBUTE

 

location

 

 

directory path

ADJUST

Where to keep orphan files

files/file/archive/TEXT

 

periodic_sync

period

 

ex) 30s, 30m, 1h

hour

ADJUST

periodic synchronization cycle

files/file/periodic_sync/ATTRIBUTE

1.1-A1

comparison_level

One

0/1/2

 

ADJUST

sync file comparison level

files/file/periodic_sync/ATTRIBUTE

1.1-A1

report

nothing

nothing / summary / full

 

ADJUST

Report generation level

files/file/periodic_sync/ATTRIBUTE

1.1-A1

buffer

size

10

32-bit integer

MB

PROMOTE

 

Memory buffer not used when BAB size is set to 0

buffer/ATTRIBUTE

1.0-A3

file_buffer

limit

1024M

32-bit integer

MB

ADJUST

File buffer max size
set to 0 disables file buffer

file_buffer/ATTRIBUTE

 

warn

10M

32-bit integer

MB

ADJUST

 

Disabling Alerts when Usage Alert Threshold is set to 0

file_buffer/ATTRIBUTE

0.9.1

location

 

 

directory path

PROMOTE

file buffer location

file_buffer/TEXT

 

auto_up

 

true / false

Boolean

NO

Auto Up

ATTRIBUTE

0.9.4

auto_file_lock

 

off, on, read_only

string

ADJUST

Automatic file locking type

ATTRIBUTE

0.9

database_path

 

 

directory path

NO

path to store resource state

database_path/TEXT

1.1-A1

group

 

 

string

ADJUST

group name

ATTRIBUTE

1.1-A1

significant

  • If the attribute added in 0.7 is not specified , the attribute plays the role of node name and host name at the same time hostnameas before .name

connections

Definition of connections between nodes. Record the definition of the connection between node1 and node2, and use the default value for connections between nodes for which connection settings are not defined.
(XML: connections/connections)

item

default value

setting range

unit

dynamic adjusting

Description

XML

note

item

default value

setting range

unit

dynamic adjusting

Description

XML

note

node1

name

 

 

string

ADJUST

The hostname of the node to establish a connection to

node1/ATTRIBUTE

 

type

node

node / group

string

ADJUST

the type specified by the name entry

node1/ATTRIBUTE

1.1-A2

url

 

IPv4 / IPv6

{ip}:{port}

RECONN

replication connection address

node1/ATTRIBUTE

 

proxy

 

 

 

RECONN

DRX connection settings

node1/proxy

1.2

node2

name

 

 

string

ADJUST

The hostname of the node to establish a connection to

node2/ATTRIBUTE

 

type

node

node / group

string

ADJUST

the type specified by the name entry

node1/ATTRIBUTE

1.1-A2

url

 

IPv4 / IPv6

{ip}:{port}

RECONN

replication connection address

node2/ATTRIBUTE

 

proxy

 

 

 

RECONN

DRX connection settings (written separately below)

node2/proxy

1.2

buffer

size

10

32-bit integer

MB

PROMOTE

 

Memory buffer not used when BAB size is set to 0

buffer/ATTRIBUTE

 

file_buffer

limit

1024

32-bit integer

MB

ADJUST

File buffer max size
set to 0 disables file buffer

file_buffer/ATTRIBUTE

 

warn

10M

32-bit integer

MB

ADJUST

 

Disabling Alerts when Usage Alert Threshold is set to 0

file_buffer/ATTRIBUTE

0.9.1

network

ping_interval

10

32-bit integer

candle

RECONN

 

Disable when PING transmission interval is set to 0

network/ATTRIBUTE

 

compress

false

true / false

Boolean

ADJUST

protocol compression

network/ATTRIBUTE

 

tls

false

true / false

Boolean

RECONN

Encrypted communication

network/ATTRIBUTE

 

limit

0

32-bit integer

bps

ADJUST

 

No limit if bits per seconds is set to 0

network/ATTRIBUTE

 

sync_ratio

 

 

{replication}:{sync}

ADJUST

Transmission amount of synchronization data compared to replication data transmission.
Only whole numbers are supported for two numbers. (eg: 1:1, 100:50)

network/ATTRIBUTE

1.2

sync_min

0

32-bit integer

bps

ADJUST

Sync transfer amount minimum guaranteed value

network/ATTRIBUTE

1.2

sync_max

0

32-bit integer

bps

ADJUST

Synchronization transmission amount maximum value limit

network/ATTRIBUTE

1.2

proxy

Proxy settings for DRX connections. (1.2 or later)
FSR uses only the inside value and does not parse the plugin area.

item

default value

setting range

unit

dynamic adjusting

Description

XML

note

item

default value

setting range

unit

dynamic adjusting

Description

XML

note

name

 

 

string

-

Connection name used by DRX

ATTRIBUTE

1.2

inside

 

IPv4 / IPv6

{ip}:{port}

RECONN

Address of the local DRX to connect to in FSR

ATTRIBUTE

1.2

outside

 

IPv4 / IPv6

{ip}:{port}

RECONN

Address of the local DRX to be connected from the other DRX

ATTRIBUTE

1.2

hostname

 

 

string

-

Hostname of the DRX device

ATTRIBUTE

1.2

options

the murmur

1M

 

{number}:{unit}

-

TX BAB size

options/ATTRIBUTE

1.2

bullimt

 

 

{number}:{unit}

-

Transmission per second limit

options/ATTRIBUTE

1.2

plugin

svc_autostart

true

true, yes, on,1

false, no, off, 0

String or Boolean

-

Automatically start resources on DRX startup

-

1.2

rx_memlimit

 

 

{number}:{unit}

-

RX BAB size

-

1.2

crypto

 

openssl

string

-

encryption plugin

-

1.2

compressor

 

zlib or lz4

string

-

compression plugin

-

1.2

compressor_level

One

 

string or 32-bit integer

-

Compression level of the compression plugin

-

1.2

options

Resource global replication/sync settings.

item

default value

setting range

unit

dynamic adjusting

Description

XML

note

item

default value

setting range

unit

dynamic adjusting

Description

XML

note

recursive

true

true / false

Boolean

ADJUST

Whether to include subdirectories

ATTRIBUTE

 

exclude_patterns (list)

 

 

exclusion pattern

ADJUST

exclusion pattern

exclude_patterns/patterns/TEXT

 

auto_file_lock

read_only

off, on, read_only

string

ADJUST

File lock type

ATTRIBUTE

0.9

database_path

 

 

directory path

NO

path to store resource state

database_path/TEXT

 

sync

attributes

true

true / false

Boolean

ADJUST

Attribute sync?

sync/ATTRIBUTE

0.9.1

permissions

name

name / sid / none

string flag

ADJUST

Security Settings Replication Criteria

sync/ATTRIBUTE

 

comparison_level

One

0/1/2

 

ADJUST

sync file comparison level

sync/ATTRIBUTE

1.1-A1

hash_type

 

crc32 / md5 / sha1 / sha256 / sha512

hash algorithm

ADJUST

Synchronized Hash Comparison Algorithm Type

sync/ATTRIBUTE

1.1-A1

network

Resource global network settings.

item

default value

setting range

unit

dynamic adjusting

Description

XML

note

item

default value

setting range

unit

dynamic adjusting

Description

XML

note

ping_interval

10

32-bit integer

candle

RECONN

 

Disable when PING transmission interval is set to 0

ATTRIBUTE

 

compress

false

true / false

Boolean

ADJUST

protocol compression

ATTRIBUTE

 

tls

false

true / false

Boolean

RECONN

Encrypted communication

ATTRIBUTE

 

limit

0

32-bit integer

bps

ADJUST

 

No limit if bits per seconds is set to 0

ATTRIBUTE

 

sync_ratio

 

 

{replication}:{sync}

ADJUST

Transmission amount of synchronization data compared to replication data transmission.
Only whole numbers are supported for two numbers. (eg: 1:1, 100:50)

ATTRIBUTE

1.2

sync_min

0

32-bit integer

bps

ADJUST

Sync transfer amount minimum guaranteed value

ATTRIBUTE

1.2

sync_max

0

32-bit integer

bps

ADJUST

Synchronization transmission amount maximum value limit

ATTRIBUTE

1.2

handlers

Script to be executed according to resource situation

item

default value

setting range

unit

dynamic adjusting

Description

XML

note

item

default value

setting range

unit

dynamic adjusting

Description

XML

note

options

timeout

0

32-bit integer

candle

ADJUST

Handler Execution Timeout
No limit when set to 0

options/ATTRIBUTE

 

timeout_action

kill

kill / continue

string flag

ADJUST

Behavior after run time

options/ATTRIBUTE

 

after_resync_target

 

string

script

ADJUST

Script to run on target after synchronization

scripts/after_resync_target/TEXT

 

before_resync_target

 

string

script

ADJUST

Script to run on target before sync

scripts/before_resync_target/TEXT

 

before_resync_source

 

string

script

ADJUST

Script to run on source before synchronization

scripts/before_resync_source/TEXT

 

out_of_sync

 

string

script

ADJUST

Script to be executed when OOS occurs in synchronization or consistency verification

scripts/out_of_sync/TEXT

 

local_io_error

 

string

script

ADJUST

Script to run when an IO error occurs

scripts/local_io_error/TEXT

 

before_snapshot_create

 

string

script

ADJUST

Script to run before snapshot creation

scripts/before_snapshot_create/TEXT

1.2

after_snapshot_create

 

string

script

ADJUST

Script to run after snapshot creation

scripts/after_snapshot_create/TEXT

1.2

before_snapshot_recovery

 

string

script

ADJUST

Script to run before snapshot recovery

scripts/before_snapshot_recovery/TEXT

1.2

after_snapshot_recovery

 

string

script

ADJUST

Script to run after snapshot restore

scripts/after_snapshot_recovery/TEXT

1.2

proxy

Proxy global settings for DRX. (1.2+)

item

default value

setting range

unit

dynamic adjusting

Description

XML

note

item

default value

setting range

unit

dynamic adjusting

Description

XML

note

the murmur

1M

 

{number}:{unit}

-

TX BAB size

ATTRIBUTE

1.2

bullimt

 

 

{number}:{unit}

-

Transmission per second limit

ATTRIBUTE

1.2

plugin

svc_autostart

true

true, yes, on,1

false, no, off, 0

String or Boolean

-

Automatically start resources on DRX startup

-

1.2

rx_memlimit

 

 

{number}:{unit}

-

RX BAB size

-

1.2

crypto

 

openssl

string

-

encryption plugin

-

1.2

compressor

 

zlib or lz4

string

-

compression plugin

-

1.2

compressor_level

One

 

string or 32-bit integer

-

Compression level of the compression plugin

-

1.2

snapshot

snapshot

item

default value

setting range

unit

dynamic adjusting

Description

XML

note

item

default value

setting range

unit

dynamic adjusting

Description

XML

note

type

not_set

not_set / copy / full / incremental / differential

backup type

ADJUST

Snapshot Backup Type

ATTRIBUTE

1.2

userdata

user properties. Object type data can be freely added.

Procedure for Applying Attributes

If items with the same name are defined in different sections, the value of the subsection is used to operate. That is, it can be overridden in subsections.
The top-down relationship of each section is as follows. (subsection on the right)

system configuration > parent properties (network, options) of resource configuration > nodes of resource configuration > connections of resource configuration

For values ​​defined as lists (e.g. exclusion filters), this works by merging the values ​​in the parent section with the values ​​in the subsection.

For example, for the following items, the value on the right is applied first.

  • resource.options.recursive → resource.nodes.files.recursive

  • resource.options.sync.attributes → resource.nodes.files.sync.attributes

  • resource.options.sync.permissions → resource.nodes.files.sync.permissions

  • system.archive.period → resource.nodes.files.archive.period

  • system.archive.location → resource.nodes.files.archive.location

  • resource.nodes.buffer.size → resource.connections.buffer.size

  • system.file_buffer.location → resource.nodes.file_buffer.location

  • system.file_buffer.limit → resource.nodes.file_buffer.limit → resource.connections.file_buffer.limit

  • system.file_buffer.warn → resource.nodes.file_buffer.warn → resource.connections.file_buffer.warn

  • resource.network.ping_interval → resource.connections.network.ping_interval

  • resource.network.compress → resource.connections.network.compress

  • resource.network.tls → resource.connections.network.tls

  • resource.network.limit → resource.connections.network.limit

  • system.snapshot.type → resource.snapshot.type

The following items operate differently from the above method.

  • Items that are merged and used

    • resource.options.exclude_patterns + resource.nodes.files.exclude_patterns

  • Items that operate in a hierarchical relationship

    • system.auto_up / resource.auto_up

      • The resource configuration value is valid only when the system configuration value is set to true.