rs.xml reference

The rs.xml configuration file defines the EGO repository server (rs) service, which is available only with the IBM® Spectrum Symphony Advanced Edition. An entitlement key is required to enable advanced features.

Location

This configuration file is installed with IBM Spectrum Symphony at $EGO_TOP/eservice/esc/conf/services on Linux®, and at Installation_top\eservice\esc\conf\services on Windows.

REPOSITORY_SERVICE_PORT

Description: Specifies the port which is used by the EGO repository server service. This port must be free on every host in the cluster.

Default: No default. Set during to a free port.

RS_STORAGE_DIR

Description: The path to the EGO repository server service storage.

Default: {EGO_ESRVDIR}/rs/.cache

REPOSITORY_CACHE_TIMEOUT

The time, in seconds, when the EGO repository server service cache times out.

Default: 60

REPOSITORY_CACHE_SIZE

The size of the EGO repository server service cache, in MB. The value can range from 1 MB to 64000 MB.

Default: 1000

RSDEPLOY_HOST_TIMEOUT

The time, in seconds, when the EGO repository server service deployment host times out.

Default: 60

RS_DOWNLOAD_QUEUE_SIZE

The size of the EGO repository server service download queue, in KB.

Default: 5000

RS_MAX_DOWNLOADS

The maximum number of times the EGO repository server service will download per session.

Default: 10

RS_MAX_PARALLEL_PUSH _DEPLOYMENT

Speeds up processing for the rsdeploy command by executing the EGO remote start requests for the rsdeploy process on all compute hosts in parallel, up to this configured maximum value.

If this parameter is set to a small value, such as 1, starting the rsdeploy process will be a bottleneck as only one process can start up and contact the repository server to initiate downloading at one time. For larger clusters, set this parameter to a value of 100 or more so that rsdeploy will start up quickly.

Specify a minimum value of 4, and a maximum value of 2^31-1 (or 2,147,483,647)

Default: 100

RS_DOWNLOAD_CHUNK_SIZE_KB

The size of each data chunk that the EGO repository server service will download per session, in KB.

Default: 1024

GS_ENABLE_GRIDSYNC

Specifies whether or not grid synchronization is enabled on the repository server.

Default: Y

GS_SERVER_THREADS

The number of threads to handle command line and API push or pull requests to the repository server.

Default: 4

GS_MASTER_BACKEND_PORT

The listening port for repository server agents to connect. This port must be free on every host in the cluster; the GS_MASTER_BACKEND_PORT is set by the IBM Spectrum Symphony installer to a free port.

Default: No default. The GS_MASTER_BACKEND_PORT is set by the IBM Spectrum Symphony installer to a free port.

GS_PUSH_PULL_THRESHOLD_PERCENT

The percentage of hosts missing a data set before a push phase is triggered.

Default: 10

GS_PUSH_PULL_DELAY_SECONDS

The time, in seconds, to collect repository server agents that are missing a data set, before triggering a data set pull or pull phase base on the GS_PULL_THRESHOLD. This delay is triggered by a host entering the PULL WAITING action.

Default: 600

GS_TRANSFER_CHUNK_SIZE_KB

The maximum size of data, in KB, for each transfer between the command line or API and the repository server, or between the repository server and a repository server agent.

Default: 10240

GS_ENABLE_TOPOLOGY

Specifies whether or not to enable network topology on the repository server.

Default: N

GS_ROOT_TARGET_DIR_LIST

Optional list of target directories for data sets. When specified, data set target directories will be restricted to these locations.

Default: ..., which means data sets can be created anywhere on the system.

GS_TOPOLOGY_PLUGIN_DIR

The path to the network topology library. If GS_ENABLE_TOPOLOGY is enabled (set to Y), but GS_TOPOLOGY_PLUGIN_DIR is not set, the repository server makes a best effort to be network-aware, ordering hosts by IP address. This ordering is not necessarily optimized for all network configurations. If GS_ENABLE_TOPOLOGY is disabled (set to N), the repository server behavior is the same.
  • For Linux: ${EGO_TOP}/${EGO_VERSION}/${EGO_MACHINE_TYPE}/lib
  • For Windows: %{EGO_TOP}\%{EGO_VERSION}\%{EGO_MACHINE_TYPE}\lib

GS_TOPOLOGY_PLUGIN_CONFDIR

The path to the configuration file (ResourceTopology.xml) for the topology script which defines the network topology.
  • For Linux: ${EGO_ESRVDIR}/rs/conf
  • For Windows: %{EGO_ESRVDIR}%\rs\conf

GS_TOPOLOGY_NAMESPACE

The topology namespace for grid synchronization. By default, the namespace is Gridsync unless you define a different namespace using this environment variable. If you set a namespace for GS_TOPOLOGY_NAMESPACE, then ensure the namespace here matches the one in the NameSpace parameter within the ResourceTopology.xml file.

Default: Gridsync

GS_AGENT_HEARTBEAT_INTERVAL_SECONDS

The interval, in seconds, when the repository server agent will send a heartbeat to the repository server. Set the value for GS_AGENT_HEARTBEAT_INTERVAL_SECONDS the same for both the rs.xml and rsa.xml files.

Default: 300

Example of rs.xml file

<sc:ActivityDescription>
    ...
    <ego:ActivitySpecification>
      ...
		<ego:EnvironmentVariable name="REPOSITORY_SERVICE_PORT">7873
			</ego:EnvironmentVariable>
		<ego:EnvironmentVariable name="RS_STORAGE_DIR">${EGO_ESRVDIR}/rs/.cache
			</ego:EnvironmentVariable>
		<ego:EnvironmentVariable name="REPOSITORY_CACHE_TIMEOUT">60
			</ego:EnvironmentVariable>
		<ego:EnvironmentVariable name="REPOSITORY_CACHE_SIZE">1000
			</ego:EnvironmentVariable>
		<ego:EnvironmentVariable name="RSDEPLOY_HOST_TIMEOUT">60
			</ego:EnvironmentVariable>
		<ego:EnvironmentVariable name="RS_DOWNLOAD_QUEUE_SIZE">5000
			</ego:EnvironmentVariable>
		<ego:EnvironmentVariable name="RS_MAX_DOWNLOADS">10	
			</ego:EnvironmentVariable>
		<ego:EnvironmentVariable name="RS_MAX_PARALLEL_PUSH _DEPLOYMENT">100
			</ego:EnvironmentVariable>
		<ego:EnvironmentVariable name="RS_DOWNLOAD_CHUNK_SIZE_KB">1024
			</ego:EnvironmentVariable>
		<ego:EnvironmentVariable name="GS_ENABLE_GRIDSYNC">Y
			</ego:EnvironmentVariable>
		<ego:EnvironmentVariable name="GS_SERVER_THREADS">4
			</ego:EnvironmentVariable>
		<ego:EnvironmentVariable name="GS_MASTER_BACKEND_PORT">7882
			</ego:EnvironmentVariable>
		<ego:EnvironmentVariable name="GS_PUSH_PULL_THRESHOLD_PERCENT">10
			</ego:EnvironmentVariable>
		<ego:EnvironmentVariable name="GS_PUSH_PULL_DELAY_SECONDS">600
			</ego:EnvironmentVariable>
		<ego:EnvironmentVariable name="GS_TRANSFER_CHUNK_SIZE_KB">10240
			</ego:EnvironmentVariable>
		<ego:EnvironmentVariable name="GS_ENABLE_TOPOLOGY">N
			</ego:EnvironmentVariable>
		<ego:EnvironmentVariable name="GS_TOPOLOGY_PLUGIN_DIR">${EGO_TOP}/4.0/lib
			</ego:EnvironmentVariable>
		<ego:EnvironmentVariable name="GS_TOPOLOGY_PLUGIN_CONFDIR">${EGO_CONFDIR}
			</ego:EnvironmentVariable>
	<ego:EnvironmentVariable name="GS_TOPOLOGY_NAMESPACE">Gridsync
			</ego:EnvironmentVariable>
	<ego:EnvironmentVariable name="GS_AGENT_HEARTBEAT_INTERVAL_SECONDS">300
			</ego:EnvironmentVariable>
	<ego:EnvironmentVariable name="GS_ROOT_TARGET_DIR_LIST">...
			</ego:EnvironmentVariable>...
    </ego:ActivitySpecification>
  </sc:ActivityDescription>