Moving Apigee servers

Edge for Private Cloud v4.19.01

Moving components from one machine to another may cause a configuration mismatch if you do not keep the IP addresses in your component configuration files in sync.

This section describes how to diagnos and fix configuration mismatches.

IP addresses versus host names

You should use IP addresses rather than host names in your component configuration files.

While some component configuration files allow you to use host names rather than IP addresses, using host names can complicate troubleshooting. For example, host names can be the source of issues related to DNS server connectivity, lookup failures, and synchronization.

As a result, Apigee strongly recommends using IP addresses for all component configurations. In some cases, such as with Cassandra, you must use IP addresses and cannot use host names. Most examples in the documentation use IP addresses for component configuration.

For host names and IP addresses, consider the implications of the following scenarios when moving Apigee servers:

Scenario	Impact on moving servers
Change in IP address	Update all related files that reference the original IP address
Hostname change without change in IP address	No impact
Hostname change with change in IP address	Same as a change in IP address

Changing the IP Address of a Cassandra Node

To change the IP address of a Cassandra node, perform the following steps:

For configurations with a single Cassandra node

Edit /opt/apigee/customer/application/cassandra.properties on the system being modified. If the file does not exist, create it.
Change the following parameters:
- Set the conf_cassandra_seeds and conf_cassandra_listen_address parameters to specify the system's new IP address.
- Change the conf_cassandra_rpc_address to use either the new IP address or 0.0.0.0 (which allows Cassandra Thrift to listen on all interfaces).
Open /opt/apigee/apigee-cassandra/conf/cassandra-topology.properties in an editor. You should see the old IP address and default setting in the form:
```
192.168.56.101=dc-1:ra-1
default=dc-1:ra-1
```
Save that information.
Edit /opt/apigee/customer/application/cassandra.properties to change the old IP address specified to the new IP address:
```
conf_cassandra-topology_topology=192.168.56.103=dc-1:ra-1\ndefault=dc-1:ra-1\n
```
Ensure that you insert "\n" after the IP address, and specify the same default settings as you found above in Step 3.

Restart Cassandra:

/opt/apigee/apigee-service/bin/apigee-service apigee-cassandra restart

If necessary also repair ZooKeeper (see below), else restart every Apigee platform component starting with Management Server.

For configurations with multiple Cassandra nodes (ring)

If the node being changed is a seed node, edit /opt/apigee/customer/application/cassandra.properties file on each system in the ring, and change the conf_cassandra_seeds parameter to include the modified system's new IP. If the cassandra.properties file does not exist, create it.
Edit /opt/apigee/customer/application/cassandra.properties on the system being modified, and change the following parameters:
- Set conf_cassandra_listen_address to use the new IP address.
- Set conf_cassandra_rpc_address to use either the new IP address or "0.0.0.0" (which allows Cassandra Thrift to listen on all interfaces).
Open /opt/apigee/apigee-cassandra/conf/cassandra-topology.properties in an editor. You should see all Cassandra IP addresses and default setting in the form:
```
192.168.56.101=dc-1:ra-1
192.168.56.102=dc-1:ra-1
192.168.56.103=dc-1:ra-1
default=dc-1:ra-1
```
Save that information.
Edit /opt/apigee/customer/application/cassandra.properties to change the old IP address specified to the new IP address:
```
conf_cassandra-topology_topology=192.168.56.101=dc-1:ra-1\n192.168.56.102=dc-1:ra-1\n192.168.56.104=dc-1:ra-1\ndefault=dc-1:ra-1\n
```
Ensure that you insert "\n" after each IP address, and use the same default settings as you recorded above in Step 3.
Restart Cassandra on the modified system. If the modified system is a seed node, also restart each system that used the modified seed node.
```
/opt/apigee/apigee-service/bin/apigee-service apigee-cassandra restart
```
Run the nodetool ring command on the modified node to ensure that the ring is complete. The utility can be found at /opt/apigee/apigee-cassandra/bin.
```
nodetool [-u username -pw password] -h localhost ring
```
You only need to pass your username and password if you enabled JMX authentication for Cassandra.
Run nodetool repair on the modified node. Note that this process may take some time, so it is highly recommended that this not be done during peak API traffic hours.
```
nodetool [-u username -pw password] -h localhost repair -pr
```
If necessary, repair ZooKeeper (see below), then restart every Apigee platform component, beginning with the Management Server.

Update datastore registrations

Find the UUIDs of datastore registrations specifying the old IP address by using the commands below. Take note of the "type" and "UUID" parameters:

curl -u ADMINEMAIL:PW "http://$MSIP:$port/v1/servers?pod=central&region=DC" | egrep -i '[type|internalip|uuid|region]'

curl -u ADMINEMAIL:PW "http://$MSIP:$port/v1/servers?pod=gateway&region=DC" | egrep -i '[type|internalip|uuid|region]'

curl -u ADMINEMAIL:PW "http://$MSIP:$port/v1/servers?pod=analytics&region=DC" | egrep -i '[type|internalip|uuid|region]'

Where DC is the data center name. In a single data center installation, the value is typically "dc-1".

Register the new IP addresses using one of the commands below. The command needed will depend on the type of the changed node.

For type="application-datastore":

curl -u ADMINEMAIL:PW "http://MSIP:port/v1/servers -d \
  "Type=application-datastore&Type=audit-datastore&InternalIP=NEWIP&region=REGION&pod=central" \
  -H 'content-type: application/x-www-form-urlencoded' -X POST

For type="kms-datastore":

curl -u ADMINEMAIL:PW "http://MSIP:port/v1/servers -d \
  "Type=kms-datastore&Type=dc-datastore&Type=keyvaluemap-datastore&Type=counter-datastore&Type=cache-datastore \
  &InternalIP=NEWIP&region=REGION&pod=GATEWAY_POD" -H 'content-type: \
  application/x-www-form-urlencoded' -X POST

For type="reportcrud-datastore":

curl -u ADMINEMAIL:PW "http://MSIP:port/v1/servers" -d \
  "Type=reportcrud-datastore&InternalIP=NEW_IP&region=REGION&pod=analytics" \
  -H 'content-type: application/x-www-form-urlencoded' -X POST

Delete old registrations for the UUID of the system on which the IP address was changed. For each of these UUIDs issue:
```
curl -u ADMINEMAIL:PW "http://MSIP:port/v1/servers/OLD_UUID" -X DELETE
```

Changing the IP address of a ZooKeeper node

Follow the steps below to change the IP address of a ZooKeeper node:

Change the IP Address and restart the ZooKeeper ensemble (for multi-node ensemble configurations only)

Open /opt/apigee/apigee-zookeeper/conf/zoo.cfg in an editor. You should see all ZooKeeper IP addresses and default setting in the form:
```
server.1=192.168.56.101:2888:3888
server.2=192.168.56.102:2888:3888
server.3=192.168.56.103:2888:3888
```
Save that information.
On each ZooKeeper node, edit the file /opt/apigee/customer/application/zookeeper.properties file to set the conf_zoo_quorum property to the correct IP addresses. If the file does not exist, create it.
```
conf_zoo_quorum=server.1=192.168.56.101:2888:3888\nserver.2=192.168.56.102:2888:3888\nserver.3=192.168.56.104:2888:3888\n
```
Ensure that you insert "\n" after each IP address and that entries are in the same order on every node.
Find the leader of the ZooKeeper ensemble by using the following command (replace node with the IP address of the Zookeeper machine):
```
echo srvr | nc node 2181
```
The Mode line in the output should say "leader".
Restart one ZooKeeper after the other starting with the leader and ending with the node on which the IP address was changed. If more than one zookeeper node changed IP addresses it may be necessary to restart all nodes.
```
/opt/apigee/apigee-service/bin/apigee-service apigee-zookeeper restart
```
Use the echo command described above to verify each ZooKeeper node.

Inform the Apigee nodes of the changed configuration

On each Router node, edit the file /opt/apigee/customer/application/router.properties as follows. If the file does not exist, create it.
- Change the conf_zookeeper_connection.string parameter to include the new IP address
- Change the conf_zookeeper_zk1.host parameter to include the new IP address
On every Message Processor node, edit the file /opt/apigee/customer/application/message-processor.properties as follows. If the file does not exist, create it.
- Change the conf_zookeeper_connection.string parameter to include the new IP address
- Change the conf_zookeeper_zk1.host parameter to include the new IP address
On the Management Server node, edit the file /opt/apigee/customer/application/management-server.properties as follows. If the file does not exist, create it.
- Change the conf_zookeeper_connection.string parameter to include the new IP address
- Change the conf_zookeeper_zk1.host parameter to include the new IP address
Restart all Apigee platform component by running the following command on each node:
```
/opt/apigee/apigee-service/bin/apigee-all restart
```

Changing the IP address of a LDAP server (OpenLDAP)

To change the IP address of an OpenLDAP node, do the following:

On the Management Server node, edit the file /opt/apigee/customer/application/management-server.properties file. If the file does not exist, create it.
In the management-server.properties file, set the conf_security_ldap.server.host parameter to the new IP address.

Restart the Management Server:

/opt/apigee/apigee-service/bin/apigee-service edge-management-server restart

Changing the IP address of other Apigee node types

To change the IP address of any of these node types (Router, Message Processor, Postgres Server (not postgresql) and Qpid Server (not qpidd):

Use the following curl command to register the new internal and external IP address:

curl -u ADMINEMAIL:PW -X PUT \
  http://MSIP:8080/v1/servers/uuid -d ExternalIP=ip
curl -u ADMINEMAIL:PW -X PUT \
  http://$MSIP:8080/v1/servers/uuid -d InternalIP=ip

Where uuid is the UUID of the node.

For information on how to get a component's UUID, see Get UUIDs.