A set of parameters for GPUdb::adminAddHost. More...

#include <gpudb/protocol/admin_add_host.h>

Public Member Functions
	AdminAddHostRequest ()
	Constructs an AdminAddHostRequest object with default parameters. More...

	AdminAddHostRequest (const std::string &hostAddress_, const std::map< std::string, std::string > &options_)
	Constructs an AdminAddHostRequest object with the specified parameters. More...

Public Attributes
std::string	hostAddress
	IP address of the host that will be added to the cluster. More...

std::map< std::string, std::string >	options
	Optional parameters. More...

Detailed Description

A set of parameters for GPUdb::adminAddHost.

Adds a host to an existing cluster.

Definition at line 18 of file admin_add_host.h.

Constructor & Destructor Documentation

◆ AdminAddHostRequest() [1/2]

gpudb::AdminAddHostRequest::AdminAddHostRequest ( )

inline

Constructs an AdminAddHostRequest object with default parameters.

Definition at line 23 of file admin_add_host.h.

◆ AdminAddHostRequest() [2/2]

gpudb::AdminAddHostRequest::AdminAddHostRequest	(	const std::string &	hostAddress_,
		const std::map< std::string, std::string > &	options_
	)

inline

Constructs an AdminAddHostRequest object with the specified parameters.

Parameters

[in]	hostAddress_	IP address of the host that will be added to the cluster. This host must have installed the same version of Kinetica as the cluster to which it is being added.
[in]	options_	Optional parameters. admin_add_host_dry_run: If set to true, only validation checks will be performed. No host is added. Supported values: admin_add_host_true admin_add_host_false The default value is admin_add_host_false. admin_add_host_accepts_failover: If set to true, the host will accept processes (ranks, graph server, etc.) in the event of a failover on another node in the cluster. Supported values: admin_add_host_true admin_add_host_false The default value is admin_add_host_false. admin_add_host_public_address: The publicly-accessible IP address for the host being added, typically specified for clients using multi-head operations. This setting is required if any other host(s) in the cluster specify a public address. admin_add_host_host_manager_public_url: The publicly-accessible full path URL to the host manager on the host being added, e.g., 'http://172.123.45.67:9300'. The default host manager port can be found in the list of ports used by Kinetica. admin_add_host_ram_limit: The desired RAM limit for the host being added, i.e. the sum of RAM usage for all processes on the host will not be able to exceed this value. Supported units: K (thousand), KB (kilobytes), M (million), MB (megabytes), G (billion), GB (gigabytes); if no unit is provided, the value is assumed to be in bytes. For example, if ram_limit is set to 10M, the resulting RAM limit is 10 million bytes. Set ram_limit to -1 to have no RAM limit. admin_add_host_gpus: Comma-delimited list of GPU indices (starting at 1) that are eligible for running worker processes. If left blank, all GPUs on the host being added will be eligible. The default value is an empty map.

Definition at line 121 of file admin_add_host.h.

Member Data Documentation

◆ hostAddress

std::string gpudb::AdminAddHostRequest::hostAddress

IP address of the host that will be added to the cluster.

This host must have installed the same version of Kinetica as the cluster to which it is being added.

Definition at line 132 of file admin_add_host.h.

◆ options

std::map<std::string, std::string> gpudb::AdminAddHostRequest::options

Optional parameters.

admin_add_host_dry_run: If set to true, only validation checks will be performed. No host is added. Supported values:
- admin_add_host_true
- admin_add_host_false
The default value is admin_add_host_false.
admin_add_host_accepts_failover: If set to true, the host will accept processes (ranks, graph server, etc.) in the event of a failover on another node in the cluster. Supported values:
- admin_add_host_true
- admin_add_host_false
The default value is admin_add_host_false.
admin_add_host_public_address: The publicly-accessible IP address for the host being added, typically specified for clients using multi-head operations. This setting is required if any other host(s) in the cluster specify a public address.
admin_add_host_host_manager_public_url: The publicly-accessible full path URL to the host manager on the host being added, e.g., 'http://172.123.45.67:9300'. The default host manager port can be found in the list of ports used by Kinetica.
admin_add_host_ram_limit: The desired RAM limit for the host being added, i.e. the sum of RAM usage for all processes on the host will not be able to exceed this value. Supported units: K (thousand), KB (kilobytes), M (million), MB (megabytes), G (billion), GB (gigabytes); if no unit is provided, the value is assumed to be in bytes. For example, if ram_limit is set to 10M, the resulting RAM limit is 10 million bytes. Set ram_limit to -1 to have no RAM limit.
admin_add_host_gpus: Comma-delimited list of GPU indices (starting at 1) that are eligible for running worker processes. If left blank, all GPUs on the host being added will be eligible.

The default value is an empty map.

Definition at line 194 of file admin_add_host.h.

The documentation for this struct was generated from the following file:

gpudb/protocol/admin_add_host.h

Public Member Functions