configuremasters CLI command

Use this command to configure or modify masters in the Indexer cluster.

While installing the Indexers you can enable any one node as the master. After you set up the Indexer cluster, run this CLI command to configure additional nodes as the master or replace the current master node.

Each time you run this command, you must provide details of all the nodes that act as master nodes. For example, to retain the current master node and configure another node to act as a master node, while running this command, provide details for both the current master and the additional master. Generally, the minimum number of master nodes should be configured to a quorum (majority) of n/2 + 1 where n is the number of master eligible nodes for the cluster. If there are two nodes then n/2+1 = 2. That means, for the cluster to be completely functional, both the master eligible nodes should be running, but if there are three master eligible nodes then n/2 + 1 = 2, it means that even if one master eligible node is not functional due to some reasons, the cluster would be still functional.

Recommendation

Use the following recommendation as a guideline to decide the number of Indexers that must act as masters:

  • If the Indexer cluster contains upto two Indexers: At a minimum, one Indexer must act as master. However, if you have two regular nodes, you are in a conundrum. A quorum (majority of master eligible nodes) would be 2, but this means that a loss of one node will make your cluster inoperable. A setting of 1 will allow your cluster to function, but doesn’t protect against split brain (the existence of two masters in a single cluster). It is best to have a minimum of three nodes in situations like this.

  • If the Indexer cluster contains three or more Indexers: At a minimum, three Indexers must act as masters.

To understand the syntax and examples, see:

Syntax

Note

Before you run the command, note the following points:

configuremasters -d <hostname> -p <portNumber> -n <masterNodeDetails> -u <username> -w <password> [-l <locale>] [-s]

  • Angle brackets (< >) indicate a variable value that needs to be user defined.

  • Square brackets ([ ]) indicate optional parameters.

The following table describes the parameters used in the syntax:

ParameterDescription
-n

Details of the nodes that must be configured as masters in the Indexer cluster.

The value must be a comma-separated list of host names and corresponding port numbers.

The value must be specified in the format, <masterHostName1>:<masterPort1>,<masterHostName2>:<masterPort2>.

In the value, the following definitions apply:

  • <masterHostName1>:<masterPort1> refers to the host name and port number of one master.
  • <masterHostName2>:<masterPort2> refers to the host name and port number of second master.

To undersatand the number of masters that you must enable to act as master in a cluster, see the recommendation to decide the number of masters.

-d
Host name of the Console Server.
-p
Port number of the Console Server.
-u
User name to use to connect with the Console Server.
-v
(Optional) Version of the IT Data Analytics product.
-w
Password corresponding to the user name to use to connect with the Console Server.
-l

(Optional) Indicates the locale in which you want to display messages when the command is run.

You can set one of the following locales:

  • English
  • Simplified Chinese
  • German
  • French

By default, the messages are displayed in the locale of the system on which the CLI is run.

The value can be set to one of the following depending on the locale you choose:

  • English: en
  • Simplified Chinese: chs
  • German: de
  • French: fr

Example: If you want to set the locale as Simplified Chinese, you need to specify, l=chs.

-s
(Optional) Indicates an HTTPS connection.

Example inputs

The following example provides the input for configuring win-pun-01 and win-pun-02 as masters in the Indexer environment. 

configuremasters -u admin -w admin12345 -d localhost -p 9797 -n win-pun-01:9300, win-pun-02:9300

 

Was this page helpful? Yes No Submitting... Thank you

Comments