Search <book_title>...

Cluster Server 8.0.2 Bundled Agents Reference Guide - Linux

Last Published: 2024-05-20

Product(s): InfoScale & Storage Foundation (8.0.2)

Platform: Linux

GoogleIP agent

The GoogleIP agent manages the following networking resources in a Google Cloud Platform (GCP) environment:

Private IP - A private IP is a private numerical address that networked devices use to communicate with one another. It is used for communication between a GCP virtual private cloud (VPC) network and an on-premises network. A private IP is also referred to as Alias IP in GCP. To extend an on-premises network to a GCP VPC network, you use a VPN gateway.
Overlay IP - An overlay IP provides IP failover functionality for the InfoScale cluster nodes that are spread across subnets. It lets you redirect IP address traffic to another cluster node belonging to different subnet within the same VPC. An overlay IP must be defined outside the VPC Classless Inter-Domain Routing (CIDR) block.

The GoogleIP agent performs the following activities:

Fetches the NIC details, associates the private IP with the NIC, and disassociates the private IP from the NIC
Manages the route table entries of the overlay IP for failover across subnets

The GoogleIP agent uses GCP Python APIs to associate IP resources with a GCP VM instance.

Note:

An InfoScale deployment in GCP does not support IPv6 because VPC networks in GCP do not support IPv6 traffic within the network. For details, refer to the GCP documentation on VPC networks.

Prerequisites

The Google service account associated with the VM instance have the following roles assigned, at a minimum:
- compute.globalOperations.get
- compute.instances.get
- compute.instances.updateNetworkInterface
- compute.networks.updatePolicy
- compute.projects.get
- compute.routes.create
- compute.routes.delete
- compute.routes.get
- compute.routes.list
- compute.zoneOperations.get
- iam.serviceAccountUser
To access Google APIs, the google-api-python-client Python module must be present on the InfoScale cluster nodes.

Install Python SDK for GCP on each of the cluster nodes as follows:

# /opt/VRTSpython/bin/pip install google-api-python-client

Dependencies

A GoogleIP resource depends on the IP and the NIC resources.

Figure: Sample service group dependency

Agent functions

Online

Private IP: Associates the private IP with the network interface.
Overlay IP: Creates a route in route table with the required base IP. Sets the overlay IP as the destination and the private IP as the next hop of the primary NIC.

Offline

and

Clean

Private IP: Disassociates the private IP from the network interface.
Overlay IP: Deletes the route from the route table.

Monitor

Private IP: Monitors the association between the private IP and the network interface.
Overlay IP: Monitors the routing information and checks whether the route table entry exists for the overlay IP.

State definitions

ONLINE	Private IP: Indicates that the private IP is assigned to the NIC. Overlay IP: Indicates that route table entry exists for the overlay IP.
OFFLINE	Private IP: Indicates that the private IP is not assigned to the NIC. Overlay IP: Indicates that route table entry does not exist for the overlay IP.
UNKNOWN	This state indicates that one of the following situations may have occurred: The required GCP Python SDKs are not installed. The privileges that are needed to perform operations on the NIC and the VM instance are not provided. The private IP or the overlay IP is specified in an incorrect format. NICDevice attribute value is invalid. The route that is associated with the overlay IP in the route table is missing. Either overlay IP and private IP are both set, or none of them are set - only one of them should be set at a time.
FAULTED	Indicates that the IP resources cannot be brought online or were abruptly stopped outside of VCS control.

Limitation

When an IP address that is associated with an OverlayIP resource is already online elsewhere in the VPC network, the GoogleIP service group with that OverlayIP resource should not come online. However, the service group does come online, and then the IP resource faults in both the clusters.

Workaround: Do not configure the IP address that is associated with the OverlayIP resource for any other device within the same VPC network.

Attributes

Table: Required attributes

Attribute	Description
PrivateIP	Secondary private IP address, also known as Alias IP, of the Google VM. You must specify a value for this attribute if no value is specified for OverlayIP. Type and dimension: string-scalar
NICDevice	Name of the network device. Run the ip addr command on the system to list all its network adapters. Example: eth0 (Indicates that the private IP address should be assigned to the next available alias of eth0.) Type and dimension: string-scalar
OverlayIP	Overlay IP provides IP failover functionality for the InfoScale cluster nodes that are spread across subnets. Overlay IP must be outside of the VPC CIDR block in which the nodes are present. You must specify a value for this attribute if no value is specified for PrivateIP. Type and dimension: string-scalar

Attribute

Description

PrivateIP

Secondary private IP address, also known as Alias IP, of the Google VM.

You must specify a value for this attribute if no value is specified for OverlayIP.

Type and dimension: string-scalar

NICDevice

Name of the network device.

Run the ip addr command on the system to list all its network adapters.

Example: eth0 (Indicates that the private IP address should be assigned to the next available alias of eth0.)

Type and dimension: string-scalar

OverlayIP

Overlay IP provides IP failover functionality for the InfoScale cluster nodes that are spread across subnets.

Overlay IP must be outside of the VPC CIDR block in which the nodes are present.

You must specify a value for this attribute if no value is specified for PrivateIP.

Type and dimension: string-scalar

Table: Optional attributes

Attribute	Description
ProjectID	The customized name that you choose when you create a GCP project, or when you activate an API that requires you to create a project ID. Type and dimension: string-scalar
VMName	Name of the GCP VM instance on which the agent is running. Type and dimension: string-scalar
Zone	The GCP zone to which the VM instance belongs. Type and dimension: string-scalar

Attribute

Description

ProjectID

The customized name that you choose when you create a GCP project, or when you activate an API that requires you to create a project ID.

Type and dimension: string-scalar

VMName

Name of the GCP VM instance on which the agent is running.

Type and dimension: string-scalar

Zone

The GCP zone to which the VM instance belongs.

Type and dimension: string-scalar

Resource type definition

type GoogleIP (
    static keylist RegList = { Device }
    static str ArgList[] = { PrivateIP, Device, OverlayIP, 
      ProjectID, Zone, VMName, tempProjectName, tempVMName, 
      tempZoneName, tempRouteName, tempDeviceName }
    temp str tempProjectName
    temp str tempRouteName
    temp str tempZoneName
    temp str tempVMName
    temp str tempDeviceName
    str PrivateIP
    str Device
    str OverlayIP
    str ProjectID
    str Zone
    str VMName
)

Sample configurations

Sample configuration with Private IP:

GoogleIP Googlevipres (
    PrivateIP = "10.209.1.5"
    Device = eth0
)

IP ipres (
    Device = eth0
    Address = "10.209.1.5"
    NetMask = "255.255.255.255"
)

NIC nicres (
    Device = eth0
)

Googlevipres requires ipres	
ipres requires nicres

Sample configuration with Overlay IP:

GoogleIP Googleipres (
    Device = eth0
    OverlayIP = "192.168.10.10"
)

IP ipres (
    Device = eth0
    Address = "192.168.10.10"
    NetMask = "255.255.255.255"
)

NIC nicres (
    Device = eth0
)

ipres  requires nicres
Googleipres requires  ipres

Debug log levels

The GoogleIP agent uses the DBG_1 debug log level.

Modules tested

Veritas has tested and approved the GoogleIP agent with the following modules:

GCP Python module	Version
cachetools	5.3.0
google-api-python-client	2.85.0
google-auth	2.17.3
google-auth-httplib2	0.1.0
httplib2	0.22.0
pyasn1	0.4.8
pyasn1-modules	0.2.8
rsa	4.9
six	1.16.0
uritemplate	4.1.1