Archiver Appliance

services.archiver-appliance
services.archiver-appliance.enable boolean[source]

Whether to enable Archiver Appliance.

Archiver Appliance listens on port 8080.

Default value
false
Example
true
services.archiver-appliance.appliancesXml string[source]

Content of the appliances.xml file.

See the appliances.xml documentation for more details.

Default value
''
  <appliances>
    <appliance>
      <identity>appliance0</identity>
      <cluster_inetport>localhost:16670</cluster_inetport>
      <mgmt_url>http://localhost:8080/mgmt/bpl</mgmt_url>
      <engine_url>http://localhost:8080/engine/bpl</engine_url>
      <etl_url>http://localhost:8080/etl/bpl</etl_url>
      <retrieval_url>http://localhost:8080/retrieval/bpl</retrieval_url>
      <data_retrieval_url>http://localhost:8080/retrieval</data_retrieval_url>
    </appliance>
  </appliances>
''
services.archiver-appliance.openFirewall boolean[source]

Open the firewall for the Archiver Appliance service.

Warning

This opens the firewall on all network interfaces.

Default value
false
services.archiver-appliance.package package[source]

Archiver Appliance package to use.

Default value
pkgs.epnix.archiver-appliance
services.archiver-appliance.settings attribute set of (string or path)[source]

Configuration for Archiver Appliance.

These options will be put into the Archiver Appliance’s environment.

Default value
{ }
services.archiver-appliance.settings.ARCHAPPL_APPLIANCES path[source]

Path to an appliances.xml file.

By default this NixOS module will generate a file from the services.archiver-appliance.appliancesXml option, so you might want to modify that instead.

Default value
pkgs.writeText "appliances.xml" cfg.appliancesXml
services.archiver-appliance.settings.ARCHAPPL_LONG_TERM_FOLDER path[source]

Path to the Long Term Store (MTS) folder.

Default value
"/arch/lts/ArchiverStore"
services.archiver-appliance.settings.ARCHAPPL_MEDIUM_TERM_FOLDER path[source]

Path to the Medium Term Store (MTS) folder.

Default value
"/arch/mts/ArchiverStore"
services.archiver-appliance.settings.ARCHAPPL_MYIDENTITY string[source]

The identity of the current appliance.

If you change this value, you will need to modify the content of appliances.xml: the specified identity must match an identity of one of the appliance XML elements.

See also

services.archiver-appliance.appliancesXml

Default value
"appliance0"
services.archiver-appliance.settings.ARCHAPPL_POLICIES path[source]

Path to a policies.py file.

This file specifies the various policies that can be used when archiving a PV. For example, you can specify that a given policy archives PVs at a rate of 2Hz.

By default, the policies.py found in src/sitespecific/tests/classpathfiles/policies.py is used.

Default value
"${cfg.package}/share/archappl/policies.py"
services.archiver-appliance.settings.ARCHAPPL_SHORT_TERM_FOLDER path[source]

Path to the Short Term Store (STS) folder.

Default value
"/arch/sts/ArchiverStore"
services.archiver-appliance.settings.EPICS_CA_ADDR_LIST list of string[source]

List of Channel Access destination IP addresses.

Each IP address can be a unicast address, or a broadcast address.

This option is ignored of EPICS_CA_AUTO_ADDR_LIST is enabled (the default).

Default value
[ ]
services.archiver-appliance.settings.EPICS_CA_AUTO_ADDR_LIST boolean[source]

If set, behave as if every broadcast address of every network interface is added to EPICS_CA_ADDR_LIST.

Default value
true
services.archiver-appliance.stores
services.archiver-appliance.stores.configure boolean[source]

Whether to automatically configure the local STS, MTS, and LTS directories.

Default value
true
services.archiver-appliance.stores.lts
services.archiver-appliance.stores.lts.location string[source]

Backing directory containing the LTS.

Example
"/data/lts"
services.archiver-appliance.stores.mts
services.archiver-appliance.stores.mts.location string[source]

Backing directory containing the MTS.

Example
"/data/mts"
services.archiver-appliance.stores.sts
services.archiver-appliance.stores.sts.size null or string[source]

Size of the STS in bytes.

If null, the size will depend on the amount of RAM available, normally half of your physical RAM without swap.

Warning

If you oversize it, the machine will deadlock since the OOM handler will not be able to free that memory.

Default value
null
Example
"20g"