MarkLogic Server 11.0 Product Documentation

cma.generateConfig

cma.generateConfig(
   [config as (binary()|node())?],
   [config-options as Object?],
   [default-params as Object?],
   [format as String?],
   [scenario as String?]
) as (binary()|node())

Summary

Retrieve an individual resource, set of resources, or full cluster configuration; generate a configuration from scenarios.

Usage Notes

This function retrieves selected resource(s) configuration or generates a configuration from scenarios. Configuration options define how the configuration is generated.

The default namespace for configuration packages is http://marklogic.com/manage/config.

<configuration xmlns="http://marklogic.com/manage/config">
      

The available core scenarios are summarized below. The details on each scenario follow.

• HA Local Failover

HA Local Failover

The parameters for HA Local Failover scenario are:

replicaSameZoneAsMaster

Create forests on hosts in the same zone. The allowed values are true or false. The default value is true.

masterDatabase

Create if does not exist, add replicas (if none exist). The value is string, for example "myHADatabase".

triggersDatabase

Create if does not exist, add replicas (if none exist). The value is string, for example "myHATriggers".

schemasDatabase

Create if does not exist, add replicas (if none exist). The value is string, for example "myHASchemas".

securityDatabase

When defined, will attempt to add replicas to xdmp:security-database() (if none exist) if create-security-database-replicas is set to true.

addReplicaToExistingForests

When set to false - no attempt is made to add replicas; when set to true - replicas will be added to the forest, with total summing up to number-of-replicas-per-forest. The allowed values are true or false. The default value is false.

createSecurityDatabaseReplicas

When set to true, will create replicas for security database. Note that this is particularly dangerous when uninstalling a package. The default value is false.

numberOfMasterForests

Calculated number of master forests. The value is positive integer.

numberOfAncillaryForests

Number of master forests for ancillary databases (e.g. triggers and schemas databases). The value is positive integer.

numberOfReplicasPerMasterForest

Calculated number of replicas per master forest. The value is positive integer.

numberOfReplicasPerAncillaryForest

Calculated number of replicas per ancillary forest. The value is positive integer.

numberOfMasterForestsPerHost

When set overrides number-of-forests-per-host, arbitrarily setting absolute number of master forests per host. The value is positive integer.

numberOfForestsPerHost

Calculated based on number of available hosts, equally balance forests across hosts. The value is positive integer.

masterDataDirectory

Data directory used by master forests. The value is string, for example "/tmp" (e.g. returned by xdmp:data-directory()) function call).

masterFastDataDirectory

Fast directory used by master forests. The value is string, for example "/tmp".

masterLargeDataDirectory

Large directory used by master forests. The value is string, for example "/tmp".

masterReplicaDataDirectory

Data directory used by master forest replicas. The value is string, for example "/tmp".

masterReplicaFastDataDirectory

Fast directory used by master forest replicas. The value is string, for example "/tmp".

masterReplicaLargeDataDirectory

Large directory used by master forest replicas. The value is string, for example "/tmp".

Example

// Generate configuration of the entire cluster.
'use strict';
const cma = require('/MarkLogic/cma.sjs');
cma.generateConfig();
    

Example

// Generate configuration, selecting all forests with resourceType configuration option.
'use strict';
const cma = require('/MarkLogic/cma.sjs');
cma.generateConfig({},{"resourceType":"forest"});
    

Example

// Generate configuration JSON of ha-local scenario.
'use strict';
const cma = require('/MarkLogic/cma.sjs');
cma.generateConfig({},{},{},"json","ha-local");
    

Example

// Generate configuration XML of ha-local scenario where replicas will be added to the existing forests.
'use strict';
const cma = require('/MarkLogic/cma.sjs');
cma.generateConfig(null,null,{"numberOfForestsPerHost":3},"xml","ha-local");