This topic describes a multi-region deployment for Apigee hybrid on GKE, Anthos GKE deployed on-prem, Microsoft® Azure Kubernetes Service (AKS), Amazon Elastic Kubernetes Service (EKS), and on RedHat OpenShift. Select your platform in the prerequisites and procedures.
Topologies for multi-region deployment include the following:
- Active-Active: When you have applications deployed in multiple geographic locations and you require low latency API response for your deployments. You have the option to deploy hybrid in multiple geographic locations nearest to your clients. For example: US West Coast, US East Coast, Europe, APAC.
- Active-Passive: When you have a primary region and a failover or disaster recovery region.
The regions in a multi-region hybrid deployment communicate via Cassandra, as the following image shows:
Prerequisites
Before configuring hybrid for multiple regions, you must complete the following prerequisites:
GKE
- When installing multi-region Apigee deployments between different networks (e.g. different cloud providers, different VPC networks, cloud and on-prem, etc), you must provide internal connectivity between these separate networks that Cassandra can use to communicate between nodes. This can be accomplished with VPNs or cloud-specific connectivity solutions.
- If you are using Workload Identity in one to cluster authenticate service accounts, each cluster you expand to must also use Workload Identity. See Enabling Workload Identity with Apigee hybrid .
- Set up Kubernetes clusters in multiple regions with different CIDR blocks
- Make sure cert-manager is installed in each cluster
- Set up cross-region communication
- Make sure all Cassandra pods are able to resolve their own hostnames. If hostNetworkis set to false, then the hostname is the Cassandra pod name. If hostNetworkis set to true, then the hostname is the Kubernetes node hostname running the Cassandra pod.
- Cassandra Multi Region requirements:
- Make sure the pod network namespace has connectivity across the regions, including firewalls, vpn, vpc peering and vNet peering. This is the case for most GKE installations.
- If the pod network namespace does not have connectivity between clusters (the clusters
are running in "island network mode"), enable the Kubernetes
hostNetwork
feature by settingcassandra.hostNetwork: true
in the overrides file for all of the regions in your Apigee hybrid multi-regions installation.For more information on the need for
hostNetwork
, see Island mode clusters and hostNetwork below. - Enable
hostNetwork
on existing clusters before expanding your multi-region configuration to new regions. - When
hostNetwork
is enabled, make sure worker nodes can perform forward DNS lookup of their hostnames. Apigee Cassandra uses forward DNS lookup to obtain the host IP while starting. - Open TCP port 7001 between Kubernetes clusters across all regions to enable worker nodes across regions and datacenters to communicate. See Configure ports for information about the Cassandra port numbers.
For detailed information, see Kubernetes documentation.
GKE on-prem
- When installing multi-region Apigee deployments between different networks (e.g. different cloud providers, different VPC networks, cloud and on-prem, etc), you must provide internal connectivity between these separate networks that Cassandra can use to communicate between nodes. This can be accomplished with VPNs or cloud-specific connectivity solutions.
- Set up Kubernetes clusters in multiple regions with different CIDR blocks
- Make sure cert-manager is installed in each cluster
- Set up cross-region communication
- Make sure all Cassandra pods are able to resolve their own hostnames. If hostNetworkis set to false, then the hostname is the Cassandra pod name. If hostNetworkis set to true, then the hostname is the Kubernetes node hostname running the Cassandra pod.
- Cassandra Multi Region requirements:
- If the pod network namespace does not have connectivity between clusters (the clusters
are running in "island network mode", the default case in GKE on-prem installations), enable
the Kubernetes
hostNetwork
feature by settingcassandra.hostNetwork: true
in the overrides file for all of the regions in your Apigee hybrid multi-regions installation.For more information on the need for
hostNetwork
, see Island mode clusters and hostNetwork below. - Enable
hostNetwork
on existing clusters before expanding your multi-region configuration to new regions. - When
hostNetwork
is enabled, make sure worker nodes can perform forward DNS lookup of their hostnames. Apigee Cassandra uses forward DNS lookup to obtain the host IP while starting. - Open Cassandra ports between Kubernetes clusters across all regions to enable worker nodes across regions and datacenters to communicate. See Configure ports for the Cassandra port numbers.
- If the pod network namespace does not have connectivity between clusters (the clusters
are running in "island network mode", the default case in GKE on-prem installations), enable
the Kubernetes
For detailed information, see Kubernetes documentation.
AKS
- When installing multi-region Apigee deployments between different networks (e.g. different cloud providers, different VPC networks, cloud and on-prem, etc), you must provide internal connectivity between these separate networks that Cassandra can use to communicate between nodes. This can be accomplished with VPNs or cloud-specific connectivity solutions.
- Follow the hybrid installation guide for any prerequisites like Google Cloud and org configuration before moving to cluster setup steps.
- Make sure cert-manager is installed in each cluster
- Make sure all Cassandra pods are able to resolve their own hostnames. If hostNetworkis set to false, then the hostname is the Cassandra pod name. If hostNetworkis set to true, then the hostname is the Kubernetes node hostname running the Cassandra pod.
- Cassandra Multi Region requirements:
- If the pod network namespace does not have connectivity between clusters (the clusters
are running in "island network mode", the default case in AKS installations), enable
the Kubernetes
hostNetwork
feature by settingcassandra.hostNetwork: true
in the overrides file for all of the regions in your Apigee hybrid multi-regions installation.For more information on the need for
hostNetwork
, see Island mode clusters and hostNetwork below. - Enable
hostNetwork
on existing clusters before expanding your multi-region configuration to new regions. - When
hostNetwork
is enabled, make sure worker nodes can perform forward DNS lookup of their hostnames. Apigee Cassandra uses forward DNS lookup to obtain the host IP while starting. - Open Cassandra ports between Kubernetes clusters across all regions to enable worker nodes across regions and datacenters to communicate. See Configure ports for the Cassandra port numbers.
- If the pod network namespace does not have connectivity between clusters (the clusters
are running in "island network mode", the default case in AKS installations), enable
the Kubernetes
For detailed information, see Kubernetes documentation.
EKS
- When installing multi-region Apigee deployments between different networks (e.g. different cloud providers, different VPC networks, cloud and on-prem, etc), you must provide internal connectivity between these separate networks that Cassandra can use to communicate between nodes. This can be accomplished with VPNs or cloud-specific connectivity solutions.
- Follow the hybrid installation guide for any prerequisites like Google Cloud and org configuration before moving to cluster setup steps.
- Make sure cert-manager is installed in each cluster
- Make sure all Cassandra pods are able to resolve their own hostnames. If hostNetworkis set to false, then the hostname is the Cassandra pod name. If hostNetworkis set to true, then the hostname is the Kubernetes node hostname running the Cassandra pod.
- Cassandra Multi Region requirements:
- If the pod network namespace does not have connectivity between clusters (the clusters
are running in "island network mode"), enable
the Kubernetes
hostNetwork
feature by settingcassandra.hostNetwork: true
in the overrides file for all of the regions in your Apigee hybrid multi-regions installation. Amazon EKS uses the fully integrated network model by default.For more information on the need for
hostNetwork
, see Island mode clusters and hostNetwork below. - Enable
hostNetwork
on existing clusters before expanding your multi-region configuration to new regions. - When
hostNetwork
is enabled, make sure worker nodes can perform forward DNS lookup of their hostnames. Apigee Cassandra uses forward DNS lookup to obtain the host IP while starting. - Open Cassandra ports between Kubernetes clusters across all regions to enable worker nodes across regions and datacenters to communicate. See Configure ports for the Cassandra port numbers.
- If the pod network namespace does not have connectivity between clusters (the clusters
are running in "island network mode"), enable
the Kubernetes
For detailed information, see Kubernetes documentation.
OpenShift
- When installing multi-region Apigee deployments between different networks (e.g. different cloud providers, different VPC networks, cloud and on-prem, etc), you must provide internal connectivity between these separate networks that Cassandra can use to communicate between nodes. This can be accomplished with VPNs or cloud-specific connectivity solutions.
- Follow the hybrid installation guide for any prerequisites like Google Cloud and org configuration before moving to cluster setup steps.
- Make sure cert-manager is installed in each cluster
- Make sure all Cassandra pods are able to resolve their own hostnames. If hostNetworkis set to false, then the hostname is the Cassandra pod name. If hostNetworkis set to true, then the hostname is the Kubernetes node hostname running the Cassandra pod.
- Cassandra Multi Region requirements:
- If the pod network namespace does not have connectivity between clusters (the clusters
are running in "island network mode", the default case in OpenShift installations), enable
the Kubernetes
hostNetwork
feature by settingcassandra.hostNetwork: true
in the overrides file for all of the regions in your Apigee hybrid multi-regions installation.For more information on the need for
hostNetwork
, see Island mode clusters and hostNetwork below. - Enable
hostNetwork
on existing clusters before expanding your multi-region configuration to new regions. - When
hostNetwork
is enabled, make sure worker nodes can perform forward DNS lookup of their hostnames. Apigee Cassandra uses forward DNS lookup to obtain the host IP while starting. - Open Cassandra ports between Kubernetes clusters across all regions to enable worker nodes across regions and datacenters to communicate. See Configure ports for the Cassandra port numbers.
- If the pod network namespace does not have connectivity between clusters (the clusters
are running in "island network mode", the default case in OpenShift installations), enable
the Kubernetes
For detailed information, see Kubernetes documentation.
Island mode clusters and hostNetwork
There are two main network models for Kubernetes clusters: fully integrated (or flat) and island mode. Apigee recommends using the flat network model where possible, as it makes multi-region Cassandra connectivity simpler. When a Kubernetes cluster is configured in island mode, the pod network is isolated. Pods can not communicate directly with pods running in other clusters using the pod IP address. See Typical network model implementations for further information about the differences between these two network models and examples of each.
When Apigee Hybrid is running on two or more Kubernetes clusters using an island mode networking
model, it is required to enable the hostNetwork
setting for Cassandra through the cassandra.hostNetwork
property. By default, Kubernetes pods are isolated into individual network namespaces that
prevents them from using the Kubernetes worker node IP. When hostNetwork
is set to true
, the pod is not isolated within its own network namespace, and instead uses
the IP address and hostname of the Kubernetes worker node the pod is scheduled on. This allows
Cassandra to natively use the Kubernetes worker node IP as its IP, providing a means for
Cassandra to establish a full mesh between all Cassandra pods in multiple clusters running in
island mode.
Cassandra hostname resolution
Though a Cassandra pod does not resolve other Cassandra pods by hostname, at startup Cassandra
checks that its own hostname is resolvable by DNS. As the pod hostname is the same as the
Kubernetes worker node hostname when hostNetwork
is set to true, the worker node
hostname must be resolvable to an IP address via the cluster DNS service. If the Kubernetes
worker node hostname is not resolvable, the Cassandra pod will fail to fully start. Therefore,
it is important that Kubernetes worker node hostnames are resolvable from pods in the cluster
when setting hostNetwork
to true
.
Configure Apigee hybrid for multi-region
This section describes how to configure Apigee hybrid for multi-region.
GKE
Configure the multi-region seed host
This section describes how to expand the existing Cassandra cluster to a new region. This setup allows the new region to bootstrap the cluster and join the existing data center. Without this configuration, the multi-region Kubernetes clusters would not know about each other.
- Set the kubectl context to the original cluster before retrieving the seed name:
kubectl config use-context original-cluster-name
-
Run the following
kubectl
command to identify a seed host address for Cassandra in the current region.A seed host address allows a new regional instance to find the original cluster on the very first startup to learn the topology of the cluster. The seed host address is designated as the contact point in the cluster.
kubectl get pods -o wide -n apigee -l app=apigee-cassandra --field-selector status.phase=Running
NAME READY STATUS RESTARTS AGE IP NODE NOMINATED NODE apigee-cassandra-default-0 1/1 Running 0 5d 10.0.0.11 gke-k8s-dc-2-default-pool-a2206492-p55d apigee-cassandra-default-1 1/1 Running 0 5d 10.0.2.4 gke-k8s-dc-2-default-pool-e9daaab3-tjmz apigee-cassandra-default-2 1/1 Running 0 5d 10.0.3.5 gke-k8s-dc-2-default-pool-e589awq3-kjch
- Decide which of the IPs returned from the previous command will be the multi-region seed host.
- In data center 2, configure
cassandra.multiRegionSeedHost
andcassandra.datacenter
in Manage runtime plane components , wheremultiRegionSeedHost
is one of the IPs returned by the previous command:cassandra : multiRegionSeedHost : seed_host_IP datacenter : data_center_name rack : rack_name hostNetwork : false clusterName : cluster_name # must be the same for all regions
For example:
cassandra : multiRegionSeedHost : 10.0 . 0.11 datacenter : "dc-2" rack : "ra-1" hostNetwork : false clusterName : my - apigee - cluster
- In the new data center/region, before you install hybrid, set the same TLS certificates and
credentials in
overrides.yaml
as you set in the first region.
Set up the new region
After you configure the seed host, you can set up the new region.
To set up the new region:
- Copy your certificate from the existing cluster to the new cluster. The new CA root is
used by Cassandra and other hybrid components for mTLS. Therefore, it is essential to have
consistent certificates across the cluster.
- Set the context to the original namespace:
kubectl config use-context original-cluster-name
- Export the current namespace configuration to a file:
kubectl get namespace namespace -o yaml > apigee-namespace.yaml
- Export the
apigee-ca
secret to a file:kubectl -n cert-manager get secret apigee-ca -o yaml > apigee-ca.yaml
- Set the context to the new region's cluster name:
kubectl config use-context new-cluster-name
- Import the namespace configuration to the new cluster. Be sure to update the
"namespace" in the file if you're using a different namespace
in the new region:
kubectl apply -f apigee-namespace.yaml
-
Import the secret to the new cluster:
kubectl -n cert-manager apply -f apigee-ca.yaml
- Set the context to the original namespace:
- Install hybrid in the new region. Be sure that the
overrides- DC_name .yaml
file includes the same TLS certificates that are configured in the first region, as explained in the previous section.Execute the following two commands to install hybrid in the new region:
apigeectl init -f overrides/overrides- DC_name .yaml
apigeectl apply -f overrides/overrides- DC_name .yaml
- Verify the hybrid installation is successful by running the following command:
apigeectl check-ready -f overrides_ DC_name .yaml
- Verify the Cassandra cluster setup by running the following command. The output should
show both the existing and new data centers.
kubectl exec apigee-cassandra-default-0 -n apigee \ -- nodetool -u APIGEE_JMX_USER -pw APIGEE_JMX_PASSWORD status
Example showing a successful setup:
Datacenter : dc - 1 ==================== Status = Up / Down |/ State = Normal /Leaving/Joining/ Moving -- Address Load Tokens Owns Host ID Rack UN 10.132 . 87.93 68.07 GiB 256 ? fb51465c - 167 a - 42 f7 - 98 c9 - b6eba1de34de c UN 10.132 . 84.94 69.9 GiB 256 ? f621a5ac - e7ee - 48 a9 - 9 a14 - 73 d69477c642 b UN 10.132 . 84.105 76.95 GiB 256 ? 0561086 f - e95b - 4232 - ba6c - ad519ff30336 d Datacenter : dc - 2 ==================== Status = Up / Down |/ State = Normal /Leaving/Joining/ Moving -- Address Load Tokens Owns Host ID Rack UN 10.132 . 0.8 71.61 GiB 256 ? 8894 a98b - 8406 - 45 de - 99 e2 - f404ab10b5d6 c UN 10.132 . 9.204 75.1 GiB 256 ? afa0ffa3 - 630 b - 4 f1e - b46f - fc3df988092e a UN 10.132 . 3.133 68.08 GiB 256 ? 25 ae39ab - b39e - 4 d4f - 9 cb7 - de095ab873db b
- Set up Cassandra on all the pods in the new data centers.
- Get
apigeeorg
from the cluster with the following command:kubectl get apigeeorg -n apigee -o json | jq .items[].metadata.name
For example:
Ex: kubectl get apigeeorg -n apigee -o json | jq .items[].metadata.name "rg-hybrid-b7d3b9c"
- Create a cassandra data replication custom resource (
YAML
) file. The file can have any name. In the following examples the file will have the namedatareplication.yaml
.The file must contain the following:
apiVersion: apigee.cloud.google.com/v1alpha1 kind: CassandraDataReplication metadata: name: REGION_EXPANSION namespace: NAMESPACE spec: organizationRef: APIGEEORG_VALUE force: false source: region: SOURCE_REGION
Where:
- REGION_EXPANSION is the name you are giving this metadata. You can use any name.
- NAMESPACE
is the same namespace that is provided in
overrides.yaml
. This is usually "apigee
". - APIGEEORG_VALUE
is the value output from the
kubectl get apigeeorg -n apigee -o json | jq .items[].metadata.name
command in the previous step. For example,rg-hybrid-b7d3b9c
- SOURCE_REGION is the source region, datacenter value under cassandra section from source region overrides.yaml
For example:
apiVersion : apigee . cloud . google . com / v1alpha1 kind : CassandraDataReplication metadata : name : region - expansion namespace : apigee spec : organizationRef : rg - hybrid - b7d3b9c force : false source : region : "dc-1"
- Apply the
CassandraDataReplication
with the following command:kubectl apply -f datareplication.yaml
- Verify the rebuild status using the following command.
kubectl -n apigee get apigeeds -o json | jq .items[].status.cassandraDataReplication
The results should look something like:
{ "rebuildDetails": { "apigee-cassandra-default-0": { "state": "complete", "updated": 1623105760 }, "apigee-cassandra-default-1": { "state": "complete", "updated": 1623105765 }, "apigee-cassandra-default-2": { "state": "complete", "updated": 1623105770 } }, "state": "complete", "updated": 1623105770 }
- Get
- Verify the rebuild processes from the logs. Also, verify the data size
using the
nodetool status
command.kubectl logs apigee-cassandra-default-0 -f -n apigee
kubectl exec apigee-cassandra-default-0 -n apigee -- nodetool -u APIGEE_JMX_USER -pw APIGEE_JMX_PASSWORD status
The following example shows example log entries:
INFO 01:42:24 rebuild from dc: dc-1, (All keyspaces), (All tokens) INFO 01:42:24 [Stream #3a04e810-580d-11e9-a5aa-67071bf82889] Executing streaming plan for Rebuild INFO 01:42:24 [Stream #3a04e810-580d-11e9-a5aa-67071bf82889] Starting streaming to /10.12.1.45 INFO 01:42:25 [Stream #3a04e810-580d-11e9-a5aa-67071bf82889, ID#0] Beginning stream session with /10.12.1.45 INFO 01:42:25 [Stream #3a04e810-580d-11e9-a5aa-67071bf82889] Starting streaming to /10.12.4.36 INFO 01:42:25 [Stream #3a04e810-580d-11e9-a5aa-67071bf82889 ID#0] Prepare completed. Receiving 1 files(0.432KiB), sending 0 files(0.000KiB) INFO 01:42:25 [Stream #3a04e810-580d-11e9-a5aa-67071bf82889] Session with /10.12.1.45 is complete INFO 01:42:25 [Stream #3a04e810-580d-11e9-a5aa-67071bf82889, ID#0] Beginning stream session with /10.12.4.36 INFO 01:42:25 [Stream #3a04e810-580d-11e9-a5aa-67071bf82889] Starting streaming to /10.12.5.22 INFO 01:42:26 [Stream #3a04e810-580d-11e9-a5aa-67071bf82889 ID#0] Prepare completed. Receiving 1 files(0.693KiB), sending 0 files(0.000KiB) INFO 01:42:26 [Stream #3a04e810-580d-11e9-a5aa-67071bf82889] Session with /10.12.4.36 is complete INFO 01:42:26 [Stream #3a04e810-580d-11e9-a5aa-67071bf82889, ID#0] Beginning stream session with /10.12.5.22 INFO 01:42:26 [Stream #3a04e810-580d-11e9-a5aa-67071bf82889 ID#0] Prepare completed. Receiving 3 files(0.720KiB), sending 0 files(0.000KiB) INFO 01:42:26 [Stream #3a04e810-580d-11e9-a5aa-67071bf82889] Session with /10.12.5.22 is complete INFO 01:42:26 [Stream #3a04e810-580d-11e9-a5aa-67071bf82889] All sessions completed
- Update the seed hosts. Remove
multiRegionSeedHost: 10.0.0.11
fromoverrides- DC_name .yaml
and reapply.apigeectl apply -f overrides/overrides- DC_name .yaml
Check the Cassandra cluster status
The following command is useful to see if the cluster setup is successful in two data centers. The command checks the nodetool status for the two regions.
kubectl exec apigee-cassandra-default-0 -n apigee -- nodetool -u APIGEE_JMX_USER -pw APIGEE_JMX_PASSWORD status Datacenter: dc-1 ======================= Status=Up/Down |/ State=Normal/Leaving/Joining/Moving -- Address Load Tokens Owns (effective) Host ID Rack UN 10.12.1.45 112.09 KiB 256 100.0% 3c98c816-3f4d-48f0-9717-03d0c998637f ra-1 UN 10.12.4.36 95.27 KiB 256 100.0% 0a36383d-1d9e-41e2-924c-7b62be12d6cc ra-1 UN 10.12.5.22 88.7 KiB 256 100.0% 3561f4fa-af3d-4ea4-93b2-79ac7e938201 ra-1 Datacenter: us-west1 ==================== Status=Up/Down |/ State=Normal/Leaving/Joining/Moving -- Address Load Tokens Owns (effective) Host ID Rack UN 10.0.4.33 78.69 KiB 256 100.0% a200217d-260b-45cd-b83c-182b27ff4c99 ra-1 UN 10.0.0.21 78.68 KiB 256 100.0% 9f3364b9-a7a1-409c-9356-b7d1d312e52b ra-1 UN 10.0.1.26 15.46 KiB 256 100.0% 1666df0f-702e-4c5b-8b6e-086d0f2e47fa ra-1
GKE on-prem
Configure the multi-region seed host
This section describes how to expand the existing Cassandra cluster to a new region. This setup allows the new region to bootstrap the cluster and join the existing data center. Without this configuration, the multi-region Kubernetes clusters would not know about each other.
- In the
overrides.yaml
file for your original cluster, make surecassandra:hostNetwork
is set totrue
. For example:cassandra : hostNetwork : true
See Prerequisites for more information about when to set
hostNetwork: true
. - If the
cassandra:hostNetwork
is not set totrue
, do the following:- Change
cassandra.hostNetwork
totrue
. - Apply the
overrides.yaml
config file with the command:apigeectl apply -f overrides.yaml --datastore
- Wait for the Cassandra pods to complete a rolling restart.
-
Verify the Cassandra cluster is healthy with the following commands:
kubectl exec -it -n apigee apigee-cassandra-default-0 -- /bin/bash
nodetool -u APIGEE_JMX_USER -pw APIGEE_JMX_PASSWORD status
Make sure all Cassandra nodes in the output are in UN (Up/Normal) status:
nodetool -u APIGEE_JMX_USER -pw APIGEE_JMX_PASSWORD describecluster
Make sure there are no unreachable nodes listed in the output.
- Change
- Set the kubectl context to the original cluster before retrieving the seed name:
kubectl config use-context original-cluster-name
-
Run the following
kubectl
command to identify a seed host address for Cassandra in the current region.A seed host address allows a new regional instance to find the original cluster on the very first startup to learn the topology of the cluster. The seed host address is designated as the contact point in the cluster.
kubectl get pods -o wide -n apigee -l app=apigee-cassandra --field-selector status.phase=Running
NAME READY STATUS RESTARTS AGE IP NODE NOMINATED NODE apigee-cassandra-default-0 1/1 Running 0 5d 10.0.0.11 gke-k8s-dc-2-default-pool-a2206492-p55d apigee-cassandra-default-1 1/1 Running 0 5d 10.0.2.4 gke-k8s-dc-2-default-pool-e9daaab3-tjmz apigee-cassandra-default-2 1/1 Running 0 5d 10.0.3.5 gke-k8s-dc-2-default-pool-e589awq3-kjch
- Decide which of the IPs returned from the previous command will be the multi-region seed host.
- In data center 2, configure
cassandra.multiRegionSeedHost
in your overrides file, wheremultiRegionSeedHost
is one of the IPs returned by the previous command:cassandra : hostNetwork : true multiRegionSeedHost : seed_host_IP datacenter : data_center_name rack : rack_name clusterName : cluster_name # must be the same for all regions
For example:
cassandra : hostNetwork : true multiRegionSeedHost : 10.0 . 0.11 datacenter : "dc-2" rack : "ra-1" clusterName : my - apigee - cluster
- In the new data center/region, before you install hybrid, set the same TLS certificates and
credentials in
overrides.yaml
as you set in the first region.
Set up the new region
After you configure the seed host, you can set up the new region.
To set up the new region:
- Copy your certificate from the existing cluster to the new cluster. The new CA root is
used by Cassandra and other hybrid components for mTLS. Therefore, it is essential to have
consistent certificates across the cluster.
- Set the context to the original namespace:
kubectl config use-context original-cluster-name
- Export the current namespace configuration to a file:
kubectl get namespace namespace -o yaml > apigee-namespace.yaml
- Export the
apigee-ca
secret to a file:kubectl -n cert-manager get secret apigee-ca -o yaml > apigee-ca.yaml
- Set the context to the new region's cluster name:
kubectl config use-context new-cluster-name
- Import the namespace configuration to the new cluster. Be sure to update the
"namespace" in the file if you're using a different namespace
in the new region:
kubectl apply -f apigee-namespace.yaml
-
Import the secret to the new cluster:
kubectl -n cert-manager apply -f apigee-ca.yaml
- Set the context to the original namespace:
- Install hybrid in the new region. Be sure that the
overrides- DC_name .yaml
file includes the same TLS certificates that are configured in the first region, as explained in the previous section.Execute the following two commands to install hybrid in the new region:
apigeectl init -f overrides/overrides- DC_name .yaml
apigeectl apply -f overrides/overrides- DC_name .yaml
- Verify the hybrid installation is successful by running the following command:
apigeectl check-ready -f overrides_ DC_name .yaml
- Verify the Cassandra cluster setup by running the following command. The output should
show both the existing and new data centers.
kubectl exec apigee-cassandra-default-0 -n apigee \ -- nodetool -u APIGEE_JMX_USER -pw APIGEE_JMX_PASSWORD status
Example showing a successful setup:
Datacenter : dc - 1 ==================== Status = Up / Down |/ State = Normal /Leaving/Joining/ Moving -- Address Load Tokens Owns Host ID Rack UN 10.132 . 87.93 68.07 GiB 256 ? fb51465c - 167 a - 42 f7 - 98 c9 - b6eba1de34de c UN 10.132 . 84.94 69.9 GiB 256 ? f621a5ac - e7ee - 48 a9 - 9 a14 - 73 d69477c642 b UN 10.132 . 84.105 76.95 GiB 256 ? 0561086 f - e95b - 4232 - ba6c - ad519ff30336 d Datacenter : dc - 2 ==================== Status = Up / Down |/ State = Normal /Leaving/Joining/ Moving -- Address Load Tokens Owns Host ID Rack UN 10.132 . 0.8 71.61 GiB 256 ? 8894 a98b - 8406 - 45 de - 99 e2 - f404ab10b5d6 c UN 10.132 . 9.204 75.1 GiB 256 ? afa0ffa3 - 630 b - 4 f1e - b46f - fc3df988092e a UN 10.132 . 3.133 68.08 GiB 256 ? 25 ae39ab - b39e - 4 d4f - 9 cb7 - de095ab873db b
- Set up Cassandra on all the pods in the new data centers.
- Get
apigeeorg
from the cluster with the following command:kubectl get apigeeorg -n apigee -o json | jq .items[].metadata.name
For example:
Ex: kubectl get apigeeorg -n apigee -o json | jq .items[].metadata.name "rg-hybrid-b7d3b9c"
- Create a cassandra data replication custom resource (
YAML
) file. The file can have any name. In the following examples the file will have the namedatareplication.yaml
.The file must contain the following:
apiVersion: apigee.cloud.google.com/v1alpha1 kind: CassandraDataReplication metadata: name: REGION_EXPANSION namespace: NAMESPACE spec: organizationRef: APIGEEORG_VALUE force: false source: region: SOURCE_REGION
Where:
- REGION_EXPANSION is the name you are giving this metadata. You can use any name.
- NAMESPACE
is the same namespace that is provided in
overrides.yaml
. This is usually "apigee
". - APIGEEORG_VALUE
is the value output from the
kubectl get apigeeorg -n apigee -o json | jq .items[].metadata.name
command in the previous step. For example,rg-hybrid-b7d3b9c
- SOURCE_REGION is the source region, datacenter value under cassandra section from source region overrides.yaml
For example:
apiVersion : apigee . cloud . google . com / v1alpha1 kind : CassandraDataReplication metadata : name : region - expansion namespace : apigee spec : organizationRef : rg - hybrid - b7d3b9c force : false source : region : "dc-1"
- Apply the
CassandraDataReplication
with the following command:kubectl apply -f datareplication.yaml
- Verify the rebuild status using the following command.
kubectl -n apigee get apigeeds -o json | jq .items[].status.cassandraDataReplication
The results should look something like:
{ "rebuildDetails": { "apigee-cassandra-default-0": { "state": "complete", "updated": 1623105760 }, "apigee-cassandra-default-1": { "state": "complete", "updated": 1623105765 }, "apigee-cassandra-default-2": { "state": "complete", "updated": 1623105770 } }, "state": "complete", "updated": 1623105770 }
- Get
- Verify the rebuild processes from the logs. Also, verify the data size
using the
nodetool status
command.kubectl logs apigee-cassandra-default-0 -f -n apigee
kubectl exec apigee-cassandra-default-0 -n apigee -- nodetool -u APIGEE_JMX_USER -pw APIGEE_JMX_PASSWORD status
The following example shows example log entries:
INFO 01:42:24 rebuild from dc: dc-1, (All keyspaces), (All tokens) INFO 01:42:24 [Stream #3a04e810-580d-11e9-a5aa-67071bf82889] Executing streaming plan for Rebuild INFO 01:42:24 [Stream #3a04e810-580d-11e9-a5aa-67071bf82889] Starting streaming to /10.12.1.45 INFO 01:42:25 [Stream #3a04e810-580d-11e9-a5aa-67071bf82889, ID#0] Beginning stream session with /10.12.1.45 INFO 01:42:25 [Stream #3a04e810-580d-11e9-a5aa-67071bf82889] Starting streaming to /10.12.4.36 INFO 01:42:25 [Stream #3a04e810-580d-11e9-a5aa-67071bf82889 ID#0] Prepare completed. Receiving 1 files(0.432KiB), sending 0 files(0.000KiB) INFO 01:42:25 [Stream #3a04e810-580d-11e9-a5aa-67071bf82889] Session with /10.12.1.45 is complete INFO 01:42:25 [Stream #3a04e810-580d-11e9-a5aa-67071bf82889, ID#0] Beginning stream session with /10.12.4.36 INFO 01:42:25 [Stream #3a04e810-580d-11e9-a5aa-67071bf82889] Starting streaming to /10.12.5.22 INFO 01:42:26 [Stream #3a04e810-580d-11e9-a5aa-67071bf82889 ID#0] Prepare completed. Receiving 1 files(0.693KiB), sending 0 files(0.000KiB) INFO 01:42:26 [Stream #3a04e810-580d-11e9-a5aa-67071bf82889] Session with /10.12.4.36 is complete INFO 01:42:26 [Stream #3a04e810-580d-11e9-a5aa-67071bf82889, ID#0] Beginning stream session with /10.12.5.22 INFO 01:42:26 [Stream #3a04e810-580d-11e9-a5aa-67071bf82889 ID#0] Prepare completed. Receiving 3 files(0.720KiB), sending 0 files(0.000KiB) INFO 01:42:26 [Stream #3a04e810-580d-11e9-a5aa-67071bf82889] Session with /10.12.5.22 is complete INFO 01:42:26 [Stream #3a04e810-580d-11e9-a5aa-67071bf82889] All sessions completed
- Update the seed hosts. Remove
multiRegionSeedHost: 10.0.0.11
fromoverrides- DC_name .yaml
and reapply.apigeectl apply -f overrides/overrides- DC_name .yaml
Check the Cassandra cluster status
The following command is useful to see if the cluster setup is successful in two data centers. The command checks the nodetool status for the two regions.
kubectl exec apigee-cassandra-default-0 -n apigee -- nodetool -u APIGEE_JMX_USER -pw APIGEE_JMX_PASSWORD status Datacenter: dc-1 ======================= Status=Up/Down |/ State=Normal/Leaving/Joining/Moving -- Address Load Tokens Owns (effective) Host ID Rack UN 10.12.1.45 112.09 KiB 256 100.0% 3c98c816-3f4d-48f0-9717-03d0c998637f ra-1 UN 10.12.4.36 95.27 KiB 256 100.0% 0a36383d-1d9e-41e2-924c-7b62be12d6cc ra-1 UN 10.12.5.22 88.7 KiB 256 100.0% 3561f4fa-af3d-4ea4-93b2-79ac7e938201 ra-1 Datacenter: us-west1 ==================== Status=Up/Down |/ State=Normal/Leaving/Joining/Moving -- Address Load Tokens Owns (effective) Host ID Rack UN 10.0.4.33 78.69 KiB 256 100.0% a200217d-260b-45cd-b83c-182b27ff4c99 ra-1 UN 10.0.0.21 78.68 KiB 256 100.0% 9f3364b9-a7a1-409c-9356-b7d1d312e52b ra-1 UN 10.0.1.26 15.46 KiB 256 100.0% 1666df0f-702e-4c5b-8b6e-086d0f2e47fa ra-1
AKS
Create a virtual network in each region
Follow the Azure recommendations for establishing cross-region communication here: VNet-to-VNet: Connecting Virtual Networks in Azure across Different Regions .
Create multi-regional clusters
Set up Kubernetes clusters in multiple regions with different CIDR blocks. See also Step 1: Create a cluster . Use the locations and virtual network names you created previously.
Open Cassandra ports between Kubernetes clusters across all regions to enable worker nodes across regions and datacenters to communicate. See Configure ports for the Cassandra port numbers.
Configure the multi-region seed host
This section describes how to expand the existing Cassandra cluster to a new region. This setup allows the new region to bootstrap the cluster and join the existing data center. Without this configuration, the multi-region Kubernetes clusters would not know about each other.
- In the
overrides.yaml
file for your original cluster, make surecassandra:hostNetwork
is set totrue
. For example:cassandra : hostNetwork : true
See Prerequisites for more information about when to set
hostNetwork: true
. - If the
cassandra:hostNetwork
is not set totrue
, do the following:- Change
cassandra.hostNetwork
totrue
. - Apply the
overrides.yaml
config file with the command:apigeectl apply -f overrides.yaml --datastore
- Wait for the Cassandra pods to complete a rolling restart.
-
Verify the Cassandra cluster is healthy with the following commands:
kubectl exec -it -n apigee apigee-cassandra-default-0 -- /bin/bash
nodetool -u APIGEE_JMX_USER -pw APIGEE_JMX_PASSWORD status
Make sure all Cassandra nodes in the output are in UN (Up/Normal) status:
nodetool -u APIGEE_JMX_USER -pw APIGEE_JMX_PASSWORD describecluster
Make sure there are no unreachable nodes listed in the output.
- Change
- Set the kubectl context to the original cluster before retrieving the seed name:
kubectl config use-context original-cluster-name
-
Run the following
kubectl
command to identify a seed host address for Cassandra in the current region.A seed host address allows a new regional instance to find the original cluster on the very first startup to learn the topology of the cluster. The seed host address is designated as the contact point in the cluster.
kubectl get pods -o wide -n apigee -l app=apigee-cassandra --field-selector status.phase=Running
apigee-cassandra-default-0 1/1 Running 0 4d17h 120.38.1.9 aks-agentpool-21207753-vmss000000
- Decide which of the IPs returned from the previous command will be the multi-region seed
host. In this example, where only a single node cassandra cluster is running, the seed host
is
120.38.1.9
. - In data center 2, copy your overrides file to a new file whose name includes the cluster
name. For example,
overrides_ your_cluster_name .yaml
. - In data center 2, configure
cassandra.multiRegionSeedHost
andcassandra.datacenter
inoverrides_ your_cluster_name .yaml
, wheremultiRegionSeedHost
is one of the IPs returned by the previous command:cassandra : multiRegionSeedHost : seed_host_IP datacenter : data_center_name rack : rack_name hostNetwork : true clusterName : cluster_name # must be the same for all regions
For example:
cassandra : multiRegionSeedHost : 120.38 . 1.9 datacenter : "centralus" rack : "ra-1" hostNetwork : truev
- In the new data center/region, before you install hybrid, set the same TLS certificates and
credentials in
overrides_ your_cluster_name .yaml
as you set in the first region.
Set up the new region
After you configure the seed host, you can set up the new region.
To set up the new region:
- Copy your certificate from the existing cluster to the new cluster. The new CA root is
used by Cassandra and other hybrid components for mTLS. Therefore, it is essential to have
consistent certificates across the cluster.
- Set the context to the original namespace:
kubectl config use-context original-cluster-name
- Export the current namespace configuration to a file:
kubectl get namespace namespace -o yaml > apigee-namespace.yaml
- Export the
apigee-ca
secret to a file:kubectl -n cert-manager get secret apigee-ca -o yaml > apigee-ca.yaml
- Set the context to the new region's cluster name:
kubectl config use-context new-cluster-name
- Import the namespace configuration to the new cluster. Be sure to update the
"namespace" in the file if you're using a different namespace
in the new region:
kubectl apply -f apigee-namespace.yaml
-
Import the secret to the new cluster:
kubectl -n cert-manager apply -f apigee-ca.yaml
- Set the context to the original namespace:
- Install hybrid in the new region. Be sure that the
overrides_ your_cluster_name .yaml
file includes the same TLS certificates that are configured in the first region, as explained in the previous section.Execute the following two commands to install hybrid in the new region:
apigeectl init -f overrides_ your_cluster_name .yaml
apigeectl apply -f overrides_ your_cluster_name .yaml
- Verify the hybrid installation is successful by running the following command:
apigeectl check-ready -f overrides_ your_cluster_name .yaml
- Verify the Cassandra cluster setup by running the following command. The output should
show both the existing and new data centers.
kubectl exec apigee-cassandra-default-0 -n apigee \ -- nodetool -u APIGEE_JMX_USER -pw APIGEE_JMX_PASSWORD status
Example showing a successful setup:
Datacenter : dc - 1 ==================== Status = Up / Down |/ State = Normal /Leaving/Joining/ Moving -- Address Load Tokens Owns Host ID Rack UN 10.132 . 87.93 68.07 GiB 256 ? fb51465c - 167 a - 42 f7 - 98 c9 - b6eba1de34de c UN 10.132 . 84.94 69.9 GiB 256 ? f621a5ac - e7ee - 48 a9 - 9 a14 - 73 d69477c642 b UN 10.132 . 84.105 76.95 GiB 256 ? 0561086 f - e95b - 4232 - ba6c - ad519ff30336 d Datacenter : dc - 2 ==================== Status = Up / Down |/ State = Normal /Leaving/Joining/ Moving -- Address Load Tokens Owns Host ID Rack UN 10.132 . 0.8 71.61 GiB 256 ? 8894 a98b - 8406 - 45 de - 99 e2 - f404ab10b5d6 c UN 10.132 . 9.204 75.1 GiB 256 ? afa0ffa3 - 630 b - 4 f1e - b46f - fc3df988092e a UN 10.132 . 3.133 68.08 GiB 256 ? 25 ae39ab - b39e - 4 d4f - 9 cb7 - de095ab873db b
- Set up Cassandra on all the pods in the new data centers.
- Get
apigeeorg
from the cluster with the following command:kubectl get apigeeorg -n apigee -o json | jq .items[].metadata.name
For example:
Ex: kubectl get apigeeorg -n apigee -o json | jq .items[].metadata.name "rg-hybrid-b7d3b9c"
- Create a cassandra data replication custom resource (
YAML
) file. The file can have any name. In the following examples the file will have the namedatareplication.yaml
.The file must contain the following:
apiVersion: apigee.cloud.google.com/v1alpha1 kind: CassandraDataReplication metadata: name: REGION_EXPANSION namespace: NAMESPACE spec: organizationRef: APIGEEORG_VALUE force: false source: region: SOURCE_REGION
Where:
- REGION_EXPANSION is the name you are giving this metadata. You can use any name.
- NAMESPACE
is the same namespace that is provided in
overrides.yaml
. This is usually "apigee
". - APIGEEORG_VALUE
is the value output from the
kubectl get apigeeorg -n apigee -o json | jq .items[].metadata.name
command in the previous step. For example,rg-hybrid-b7d3b9c
- SOURCE_REGION is the source region, datacenter value under cassandra section from source region overrides.yaml
For example:
apiVersion : apigee . cloud . google . com / v1alpha1 kind : CassandraDataReplication metadata : name : region - expansion namespace : apigee spec : organizationRef : rg - hybrid - b7d3b9c force : false source : region : "dc-1"
- Apply the
CassandraDataReplication
with the following command:kubectl apply -f datareplication.yaml
- Verify the rebuild status using the following command.
kubectl -n apigee get apigeeds -o json | jq .items[].status.cassandraDataReplication
The results should look something like:
{ "rebuildDetails": { "apigee-cassandra-default-0": { "state": "complete", "updated": 1623105760 }, "apigee-cassandra-default-1": { "state": "complete", "updated": 1623105765 }, "apigee-cassandra-default-2": { "state": "complete", "updated": 1623105770 } }, "state": "complete", "updated": 1623105770 }
- Get
- Verify the rebuild processes from the logs. Also, verify the data size
using the
nodetool status
command.kubectl logs apigee-cassandra-default-0 -f -n apigee
kubectl exec apigee-cassandra-default-0 -n apigee -- nodetool -u APIGEE_JMX_USER -pw APIGEE_JMX_PASSWORD status
The following example shows example log entries:
INFO 01:42:24 rebuild from dc: dc-1, (All keyspaces), (All tokens) INFO 01:42:24 [Stream #3a04e810-580d-11e9-a5aa-67071bf82889] Executing streaming plan for Rebuild INFO 01:42:24 [Stream #3a04e810-580d-11e9-a5aa-67071bf82889] Starting streaming to /10.12.1.45 INFO 01:42:25 [Stream #3a04e810-580d-11e9-a5aa-67071bf82889, ID#0] Beginning stream session with /10.12.1.45 INFO 01:42:25 [Stream #3a04e810-580d-11e9-a5aa-67071bf82889] Starting streaming to /10.12.4.36 INFO 01:42:25 [Stream #3a04e810-580d-11e9-a5aa-67071bf82889 ID#0] Prepare completed. Receiving 1 files(0.432KiB), sending 0 files(0.000KiB) INFO 01:42:25 [Stream #3a04e810-580d-11e9-a5aa-67071bf82889] Session with /10.12.1.45 is complete INFO 01:42:25 [Stream #3a04e810-580d-11e9-a5aa-67071bf82889, ID#0] Beginning stream session with /10.12.4.36 INFO 01:42:25 [Stream #3a04e810-580d-11e9-a5aa-67071bf82889] Starting streaming to /10.12.5.22 INFO 01:42:26 [Stream #3a04e810-580d-11e9-a5aa-67071bf82889 ID#0] Prepare completed. Receiving 1 files(0.693KiB), sending 0 files(0.000KiB) INFO 01:42:26 [Stream #3a04e810-580d-11e9-a5aa-67071bf82889] Session with /10.12.4.36 is complete INFO 01:42:26 [Stream #3a04e810-580d-11e9-a5aa-67071bf82889, ID#0] Beginning stream session with /10.12.5.22 INFO 01:42:26 [Stream #3a04e810-580d-11e9-a5aa-67071bf82889 ID#0] Prepare completed. Receiving 3 files(0.720KiB), sending 0 files(0.000KiB) INFO 01:42:26 [Stream #3a04e810-580d-11e9-a5aa-67071bf82889] Session with /10.12.5.22 is complete INFO 01:42:26 [Stream #3a04e810-580d-11e9-a5aa-67071bf82889] All sessions completed
- Update the seed hosts. Remove
multiRegionSeedHost: 10.0.0.11
fromoverrides- DC_name .yaml
and reapply.apigeectl apply -f overrides/overrides- DC_name .yaml
Check the Cassandra cluster status
The following command is useful to see if the cluster setup is successful in two data centers. The command checks the nodetool status for the two regions.
kubectl exec apigee-cassandra-default-0 -n apigee -- nodetool -u APIGEE_JMX_USER -pw APIGEE_JMX_PASSWORD status Datacenter: dc-1 ======================= Status=Up/Down |/ State=Normal/Leaving/Joining/Moving -- Address Load Tokens Owns (effective) Host ID Rack UN 10.12.1.45 112.09 KiB 256 100.0% 3c98c816-3f4d-48f0-9717-03d0c998637f ra-1 UN 10.12.4.36 95.27 KiB 256 100.0% 0a36383d-1d9e-41e2-924c-7b62be12d6cc ra-1 UN 10.12.5.22 88.7 KiB 256 100.0% 3561f4fa-af3d-4ea4-93b2-79ac7e938201 ra-1 Datacenter: us-west1 ==================== Status=Up/Down |/ State=Normal/Leaving/Joining/Moving -- Address Load Tokens Owns (effective) Host ID Rack UN 10.0.4.33 78.69 KiB 256 100.0% a200217d-260b-45cd-b83c-182b27ff4c99 ra-1 UN 10.0.0.21 78.68 KiB 256 100.0% 9f3364b9-a7a1-409c-9356-b7d1d312e52b ra-1 UN 10.0.1.26 15.46 KiB 256 100.0% 1666df0f-702e-4c5b-8b6e-086d0f2e47fa ra-1
EKS
Create a virtual network in each region
Follow the AWS recommendations for establishing cross-region communication as described in: What is VPC peering? . The AWS term for using different regions is inter-Region VPC peering .
Create multi-regional clusters
Set up Kubernetes clusters in multiple regions with different CIDR blocks. See also Step 1: Create a cluster . Use the locations and virtual network names you created previously.
Open Cassandra ports between Kubernetes clusters across all regions to enable worker nodes across regions and datacenters to communicate. See Configure ports for the Cassandra port numbers.
Configure the multi-region seed host
This section describes how to expand the existing Cassandra cluster to a new region. This setup allows the new region to bootstrap the cluster and join the existing data center. Without this configuration, the multi-region Kubernetes clusters would not know about each other.
- In the
overrides.yaml
file for your original cluster, make surecassandra:hostNetwork
is set totrue
. For example:cassandra : hostNetwork : true
See Prerequisites for more information about when to set
hostNetwork: true
. - If the
cassandra:hostNetwork
is not set totrue
, do the following:- Change
cassandra.hostNetwork
totrue
. - Apply the
overrides.yaml
config file with the command:apigeectl apply -f overrides.yaml --datastore
- Wait for the Cassandra pods to complete a rolling restart.
-
Verify the Cassandra cluster is healthy with the following commands:
kubectl exec -it -n apigee apigee-cassandra-default-0 -- /bin/bash
nodetool -u $APIGEE_JMX_USER -pw $APIGEE_JMX_PASSWORD status
Make sure all Cassandra nodes in the output are in UN (Up/Normal) status:
nodetool -u $APIGEE_JMX_USER -pw $APIGEE_JMX_PASSWORD describecluster
Make sure there are no unreachable nodes listed in the output.
- Change
- Set the kubectl context to the original cluster before retrieving the seed name:
kubectl config use-context original-cluster-name
-
Run the following
kubectl
command to identify a seed host address for Cassandra in the current region.A seed host address allows a new regional instance to find the original cluster on the very first startup to learn the topology of the cluster. The seed host address is designated as the contact point in the cluster.
kubectl get pods -o wide -n apigee | grep apigee-cassandra
apigee-cassandra-default-0 1/1 Running 0 4d17h 120.38.1.9 aks-agentpool-21207753-vmss000000
- Decide which of the IPs returned from the previous command will be the multi-region seed
host. In this example, where only a single node cassandra cluster is running, the seed host
is
120.38.1.9
. - In data center 2, copy your overrides file to a new file whose name includes the cluster
name. For example,
overrides_ your_cluster_name .yaml
. - In data center 2, configure
cassandra.multiRegionSeedHost
andcassandra.datacenter
inoverrides_ your_cluster_name .yaml
, wheremultiRegionSeedHost
is one of the IPs returned by the previous command:cassandra : multiRegionSeedHost : seed_host_IP datacenter : data_center_name rack : rack_name hostNetwork : true clusterName : cluster_name # must be the same for all regions
For example:
cassandra : multiRegionSeedHost : 120.38 . 1.9 datacenter : "centralus" rack : "ra-1" hostNetwork : true clusterName : my - apigee - cluster
- In the new data center/region, before you install hybrid, set the same TLS certificates and
credentials in
overrides_ your_cluster_name .yaml
as you set in the first region.
Set up the new region
After you configure the seed host, you can set up the new region.
To set up the new region:
- Copy your certificate from the existing cluster to the new cluster. The new CA root is
used by Cassandra and other hybrid components for mTLS. Therefore, it is essential to have
consistent certificates across the cluster.
- Set the context to the original namespace:
kubectl config use-context original-cluster-name
- Export the current namespace configuration to a file:
kubectl get namespace namespace -o yaml > apigee-namespace.yaml
- Export the
apigee-ca
secret to a file:kubectl -n cert-manager get secret apigee-ca -o yaml > apigee-ca.yaml
- Set the context to the new region's cluster name:
kubectl config use-context new-cluster-name
- Import the namespace configuration to the new cluster. Be sure to update the
"namespace" in the file if you're using a different namespace
in the new region:
kubectl apply -f apigee-namespace.yaml
-
Import the secret to the new cluster:
kubectl -n cert-manager apply -f apigee-ca.yaml
- Set the context to the original namespace:
- Install hybrid in the new region. Be sure that the
overrides_ your_cluster_name .yaml
file includes the same TLS certificates that are configured in the first region, as explained in the previous section.Execute the following two commands to install hybrid in the new region:
apigeectl init -f overrides_ your_cluster_name .yaml
apigeectl apply -f overrides_ your_cluster_name .yaml
- Verify the hybrid installation is successful by running the following command:
apigeectl check-ready -f overrides_ your_cluster_name .yaml
- Verify the Cassandra cluster setup by running the following command. The output should
show both the existing and new data centers.
kubectl exec apigee-cassandra-default-0 -n apigee \ -- nodetool -u JMX_user -pw JMX_password status
Example showing a successful setup:
Datacenter : dc - 1 ==================== Status = Up / Down |/ State = Normal /Leaving/Joining/ Moving -- Address Load Tokens Owns Host ID Rack UN 10.132 . 87.93 68.07 GiB 256 ? fb51465c - 167 a - 42 f7 - 98 c9 - b6eba1de34de c UN 10.132 . 84.94 69.9 GiB 256 ? f621a5ac - e7ee - 48 a9 - 9 a14 - 73 d69477c642 b UN 10.132 . 84.105 76.95 GiB 256 ? 0561086 f - e95b - 4232 - ba6c - ad519ff30336 d Datacenter : dc - 2 ==================== Status = Up / Down |/ State = Normal /Leaving/Joining/ Moving -- Address Load Tokens Owns Host ID Rack UN 10.132 . 0.8 71.61 GiB 256 ? 8894 a98b - 8406 - 45 de - 99 e2 - f404ab10b5d6 c UN 10.132 . 9.204 75.1 GiB 256 ? afa0ffa3 - 630 b - 4 f1e - b46f - fc3df988092e a UN 10.132 . 3.133 68.08 GiB 256 ? 25 ae39ab - b39e - 4 d4f - 9 cb7 - de095ab873db b
- Set up Cassandra on all the pods in the new data centers.
- Get
apigeeorg
from the cluster with the following command:kubectl get apigeeorg -n apigee -o json | jq .items[].metadata.name
For example:
Ex: kubectl get apigeeorg -n apigee -o json | jq .items[].metadata.name "rg-hybrid-b7d3b9c"
- Create a cassandra data replication custom resource (
YAML
) file. The file can have any name. In the following examples the file will have the namedatareplication.yaml
.The file must contain the following:
apiVersion: apigee.cloud.google.com/v1alpha1 kind: CassandraDataReplication metadata: name: REGION_EXPANSION namespace: NAMESPACE spec: organizationRef: APIGEEORG_VALUE force: false source: region: SOURCE_REGION
Where:
- REGION_EXPANSION is the name you are giving this metadata. You can use any name.
- NAMESPACE
is the same namespace that is provided in
overrides.yaml
. This is usually "apigee
". - APIGEEORG_VALUE
is the value output from the
kubectl get apigeeorg -n apigee -o json | jq .items[].metadata.name
command in the previous step. For example,rg-hybrid-b7d3b9c
- SOURCE_REGION is the source region, datacenter value under cassandra section from source region overrides.yaml
For example:
apiVersion : apigee . cloud . google . com / v1alpha1 kind : CassandraDataReplication metadata : name : region - expansion namespace : apigee spec : organizationRef : rg - hybrid - b7d3b9c force : false source : region : "dc-1"
- Apply the
CassandraDataReplication
with the following command:kubectl apply -f datareplication.yaml
- Verify the rebuild status using the following command.
kubectl -n apigee get apigeeds -o json | jq .items[].status.cassandraDataReplication
The results should look something like:
{ "rebuildDetails": { "apigee-cassandra-default-0": { "state": "complete", "updated": 1623105760 }, "apigee-cassandra-default-1": { "state": "complete", "updated": 1623105765 }, "apigee-cassandra-default-2": { "state": "complete", "updated": 1623105770 } }, "state": "complete", "updated": 1623105770 }
- Get
- Verify the rebuild processes from the logs. Also, verify the data size
using the
nodetool status
command:kubectl logs apigee-cassandra-default-0 -f -n apigee
kubectl exec apigee-cassandra-default-0 -n apigee -- nodetool -u JMX_user -pw JMX_password status
The following example shows example log entries:
INFO 01:42:24 rebuild from dc: dc-1, (All keyspaces), (All tokens) INFO 01:42:24 [Stream #3a04e810-580d-11e9-a5aa-67071bf82889] Executing streaming plan for Rebuild INFO 01:42:24 [Stream #3a04e810-580d-11e9-a5aa-67071bf82889] Starting streaming to /10.12.1.45 INFO 01:42:25 [Stream #3a04e810-580d-11e9-a5aa-67071bf82889, ID#0] Beginning stream session with /10.12.1.45 INFO 01:42:25 [Stream #3a04e810-580d-11e9-a5aa-67071bf82889] Starting streaming to /10.12.4.36 INFO 01:42:25 [Stream #3a04e810-580d-11e9-a5aa-67071bf82889 ID#0] Prepare completed. Receiving 1 files(0.432KiB), sending 0 files(0.000KiB) INFO 01:42:25 [Stream #3a04e810-580d-11e9-a5aa-67071bf82889] Session with /10.12.1.45 is complete INFO 01:42:25 [Stream #3a04e810-580d-11e9-a5aa-67071bf82889, ID#0] Beginning stream session with /10.12.4.36 INFO 01:42:25 [Stream #3a04e810-580d-11e9-a5aa-67071bf82889] Starting streaming to /10.12.5.22 INFO 01:42:26 [Stream #3a04e810-580d-11e9-a5aa-67071bf82889 ID#0] Prepare completed. Receiving 1 files(0.693KiB), sending 0 files(0.000KiB) INFO 01:42:26 [Stream #3a04e810-580d-11e9-a5aa-67071bf82889] Session with /10.12.4.36 is complete INFO 01:42:26 [Stream #3a04e810-580d-11e9-a5aa-67071bf82889, ID#0] Beginning stream session with /10.12.5.22 INFO 01:42:26 [Stream #3a04e810-580d-11e9-a5aa-67071bf82889 ID#0] Prepare completed. Receiving 3 files(0.720KiB), sending 0 files(0.000KiB) INFO 01:42:26 [Stream #3a04e810-580d-11e9-a5aa-67071bf82889] Session with /10.12.5.22 is complete INFO 01:42:26 [Stream #3a04e810-580d-11e9-a5aa-67071bf82889] All sessions completed
- Update the seed hosts. Remove
multiRegionSeedHost: 10.0.0.11
fromoverrides- DC_name .yaml
and reapply.apigeectl apply -f overrides/overrides- DC_name .yaml
Check the Cassandra cluster status
The following command is useful to see if the cluster setup is successful in two data centers. The command checks the nodetool status for the two regions.
kubectl exec apigee-cassandra-default-0 -n apigee -- nodetool -u JMX_user -pw JMX_password status Datacenter: dc-1 ======================= Status=Up/Down |/ State=Normal/Leaving/Joining/Moving -- Address Load Tokens Owns (effective) Host ID Rack UN 10.12.1.45 112.09 KiB 256 100.0% 3c98c816-3f4d-48f0-9717-03d0c998637f ra-1 UN 10.12.4.36 95.27 KiB 256 100.0% 0a36383d-1d9e-41e2-924c-7b62be12d6cc ra-1 UN 10.12.5.22 88.7 KiB 256 100.0% 3561f4fa-af3d-4ea4-93b2-79ac7e938201 ra-1 Datacenter: us-west1 ==================== Status=Up/Down |/ State=Normal/Leaving/Joining/Moving -- Address Load Tokens Owns (effective) Host ID Rack UN 10.0.4.33 78.69 KiB 256 0.0% a200217d-260b-45cd-b83c-182b27ff4c99 ra-1 UN 10.0.0.21 78.68 KiB 256 0.0% 9f3364b9-a7a1-409c-9356-b7d1d312e52b ra-1 UN 10.0.1.26 15.46 KiB 256 0.0% 1666df0f-702e-4c5b-8b6e-086d0f2e47fa ra-1
OpenShift
Configure the multi-region seed host
This section describes how to expand the existing Cassandra cluster to a new region. This setup allows the new region to bootstrap the cluster and join the existing data center. Without this configuration, the multi-region Kubernetes clusters would not know about each other.
- In the
overrides.yaml
file for your original cluster, make surecassandra:hostNetwork
is set totrue
. For example:cassandra : hostNetwork : true
See Prerequisites for more information about when to set
hostNetwork: true
. - If the
cassandra:hostNetwork
is not set totrue
, do the following:- Change
cassandra.hostNetwork
totrue
. - Apply the
overrides.yaml
config file with the command:apigeectl apply -f overrides.yaml --datastore
- Wait for the Cassandra pods to complete a rolling restart.
-
Verify the Cassandra cluster is healthy with the following commands:
kubectl exec -it -n apigee apigee-cassandra-default-0 -- /bin/bash
nodetool -u APIGEE_JMX_USER -pw APIGEE_JMX_PASSWORD status
Make sure all Cassandra nodes in the output are in UN (Up/Normal) status:
nodetool -u APIGEE_JMX_USER -pw APIGEE_JMX_PASSWORD describecluster
Make sure there are no unreachable nodes listed in the output.
- Change
- Set the kubectl context to the original cluster before retrieving the seed name:
kubectl config use-context original-cluster-name
-
Run the following
kubectl
command to identify a seed host address for Cassandra in the current region.A seed host address allows a new regional instance to find the original cluster on the very first startup to learn the topology of the cluster. The seed host address is designated as the contact point in the cluster.
kubectl get pods -o wide -n apigee -l app=apigee-cassandra --field-selector status.phase=Running
NAME READY STATUS RESTARTS AGE IP NODE NOMINATED NODE apigee-cassandra-default-0 1/1 Running 0 5d 10.0.0.11 gke-k8s-dc-2-default-pool-a2206492-p55d apigee-cassandra-default-1 1/1 Running 0 5d 10.0.2.4 gke-k8s-dc-2-default-pool-e9daaab3-tjmz apigee-cassandra-default-2 1/1 Running 0 5d 10.0.3.5 gke-k8s-dc-2-default-pool-e589awq3-kjch
- Select the IP address of your source Cassandra host to use as the multi-region seed host. In
this example, this is the
apigee-cassandra-default-0
cluster is running, the seed host is10.0.0.11
. - In data center 2, copy your overrides file to a new file whose name includes the cluster
name. For example,
overrides_ your_cluster_name .yaml
. - In data center 2, configure
cassandra.multiRegionSeedHost
andcassandra.datacenter
inoverrides_ your_cluster_name .yaml
, wheremultiRegionSeedHost
is one of the IPs returned by the previous command:cassandra : hostNetwork : true multiRegionSeedHost : seed_host_IP # Cassandra pod IP address from the source region . datacenter : data_center_name rack : rack_name clusterName : cluster_name # must be the same for all regions
For example:
cassandra : hostNetwork : true multiRegionSeedHost : 10.0 . 0.11 datacenter : "dc-2" rack : "ra-1" clusterName : my - apigee - cluster
- In the new data center/region, before you install hybrid, set the same TLS certificates and
credentials in
overrides_ your_cluster_name .yaml
as you set in the first region.
Set up the new region
After you configure the seed host, you can set up the new region.
To set up the new region:
- Copy your certificate from the existing cluster to the new cluster. The new CA root is
used by Cassandra and other hybrid components for mTLS. Therefore, it is essential to have
consistent certificates across the cluster.
- Set the context to the original namespace:
kubectl config use-context original-cluster-name
- Export the current namespace configuration to a file:
kubectl get namespace namespace -o yaml > apigee-namespace.yaml
- Export the
apigee-ca
secret to a file:kubectl -n cert-manager get secret apigee-ca -o yaml > apigee-ca.yaml
- Set the context to the new region's cluster name:
kubectl config use-context new-cluster-name
- Import the namespace configuration to the new cluster. Be sure to update the
"namespace" in the file if you're using a different namespace
in the new region:
kubectl apply -f apigee-namespace.yaml
-
Import the secret to the new cluster:
kubectl -n cert-manager apply -f apigee-ca.yaml
- Set the context to the original namespace:
- Install hybrid in the new region. Be sure that the
overrides_ your_cluster_name .yaml
file includes the same TLS certificates that are configured in the first region, as explained in the previous section.Execute the following two commands to install hybrid in the new region:
apigeectl init -f overrides_ your_cluster_name .yaml
apigeectl apply -f overrides_ your_cluster_name .yaml
- Verify the hybrid installation is successful by running the following command:
apigeectl check-ready -f overrides_ your_cluster_name .yaml
- Verify the Cassandra cluster setup by running the following command. The output should
show both the existing and new data centers.
kubectl exec apigee-cassandra-default-0 -n apigee \ -- nodetool -u APIGEE_JMX_USER -pw APIGEE_JMX_PASSWORD status
Example showing a successful setup:
Datacenter : dc - 1 ==================== Status = Up / Down |/ State = Normal /Leaving/Joining/ Moving -- Address Load Tokens Owns Host ID Rack UN 10.132 . 87.93 68.07 GiB 256 ? fb51465c - 167 a - 42 f7 - 98 c9 - b6eba1de34de c UN 10.132 . 84.94 69.9 GiB 256 ? f621a5ac - e7ee - 48 a9 - 9 a14 - 73 d69477c642 b UN 10.132 . 84.105 76.95 GiB 256 ? 0561086 f - e95b - 4232 - ba6c - ad519ff30336 d Datacenter : dc - 2 ==================== Status = Up / Down |/ State = Normal /Leaving/Joining/ Moving -- Address Load Tokens Owns Host ID Rack UN 10.132 . 0.8 71.61 GiB 256 ? 8894 a98b - 8406 - 45 de - 99 e2 - f404ab10b5d6 c UN 10.132 . 9.204 75.1 GiB 256 ? afa0ffa3 - 630 b - 4 f1e - b46f - fc3df988092e a UN 10.132 . 3.133 68.08 GiB 256 ? 25 ae39ab - b39e - 4 d4f - 9 cb7 - de095ab873db b
- Set up Cassandra on all the pods in the new data centers.
- Get
apigeeorg
from the cluster with the following command:kubectl get apigeeorg -n apigee -o json | jq .items[].metadata.name
For example:
Ex: kubectl get apigeeorg -n apigee -o json | jq .items[].metadata.name "rg-hybrid-b7d3b9c"
- Create a cassandra data replication custom resource (
YAML
) file. The file can have any name. In the following examples the file will have the namedatareplication.yaml
.The file must contain the following:
apiVersion: apigee.cloud.google.com/v1alpha1 kind: CassandraDataReplication metadata: name: REGION_EXPANSION namespace: NAMESPACE spec: organizationRef: APIGEEORG_VALUE force: false source: region: SOURCE_REGION
Where:
- REGION_EXPANSION is the name you are giving this metadata. You can use any name.
- NAMESPACE
is the same namespace that is provided in
overrides.yaml
. This is usually "apigee
". - APIGEEORG_VALUE
is the value output from the
kubectl get apigeeorg -n apigee -o json | jq .items[].metadata.name
command in the previous step. For example,rg-hybrid-b7d3b9c
- SOURCE_REGION is the source region, datacenter value under cassandra section from source region overrides.yaml
For example:
apiVersion : apigee . cloud . google . com / v1alpha1 kind : CassandraDataReplication metadata : name : region - expansion namespace : apigee spec : organizationRef : rg - hybrid - b7d3b9c force : false source : region : "dc-1"
- Apply the
CassandraDataReplication
with the following command:kubectl apply -f datareplication.yaml
- Verify the rebuild status using the following command.
kubectl -n apigee get apigeeds -o json | jq .items[].status.cassandraDataReplication
The results should look something like:
{ "rebuildDetails": { "apigee-cassandra-default-0": { "state": "complete", "updated": 1623105760 }, "apigee-cassandra-default-1": { "state": "complete", "updated": 1623105765 }, "apigee-cassandra-default-2": { "state": "complete", "updated": 1623105770 } }, "state": "complete", "updated": 1623105770 }
- Get
- Verify the rebuild processes from the logs. Also, verify the data size
using the
nodetool status
command.kubectl logs apigee-cassandra-default-0 -f -n apigee
kubectl exec apigee-cassandra-default-0 -n apigee -- nodetool -u APIGEE_JMX_USER -pw APIGEE_JMX_PASSWORD status
The following example shows example log entries:
INFO 01:42:24 rebuild from dc: dc-1, (All keyspaces), (All tokens) INFO 01:42:24 [Stream #3a04e810-580d-11e9-a5aa-67071bf82889] Executing streaming plan for Rebuild INFO 01:42:24 [Stream #3a04e810-580d-11e9-a5aa-67071bf82889] Starting streaming to /10.12.1.45 INFO 01:42:25 [Stream #3a04e810-580d-11e9-a5aa-67071bf82889, ID#0] Beginning stream session with /10.12.1.45 INFO 01:42:25 [Stream #3a04e810-580d-11e9-a5aa-67071bf82889] Starting streaming to /10.12.4.36 INFO 01:42:25 [Stream #3a04e810-580d-11e9-a5aa-67071bf82889 ID#0] Prepare completed. Receiving 1 files(0.432KiB), sending 0 files(0.000KiB) INFO 01:42:25 [Stream #3a04e810-580d-11e9-a5aa-67071bf82889] Session with /10.12.1.45 is complete INFO 01:42:25 [Stream #3a04e810-580d-11e9-a5aa-67071bf82889, ID#0] Beginning stream session with /10.12.4.36 INFO 01:42:25 [Stream #3a04e810-580d-11e9-a5aa-67071bf82889] Starting streaming to /10.12.5.22 INFO 01:42:26 [Stream #3a04e810-580d-11e9-a5aa-67071bf82889 ID#0] Prepare completed. Receiving 1 files(0.693KiB), sending 0 files(0.000KiB) INFO 01:42:26 [Stream #3a04e810-580d-11e9-a5aa-67071bf82889] Session with /10.12.4.36 is complete INFO 01:42:26 [Stream #3a04e810-580d-11e9-a5aa-67071bf82889, ID#0] Beginning stream session with /10.12.5.22 INFO 01:42:26 [Stream #3a04e810-580d-11e9-a5aa-67071bf82889 ID#0] Prepare completed. Receiving 3 files(0.720KiB), sending 0 files(0.000KiB) INFO 01:42:26 [Stream #3a04e810-580d-11e9-a5aa-67071bf82889] Session with /10.12.5.22 is complete INFO 01:42:26 [Stream #3a04e810-580d-11e9-a5aa-67071bf82889] All sessions completed
- Update the seed hosts. Remove
multiRegionSeedHost: 10.0.0.11
fromoverrides- DC_name .yaml
and reapply.apigeectl apply -f overrides/overrides- DC_name .yaml
Check the Cassandra cluster status
The following command is useful to see if the cluster setup is successful in two data centers. The command checks the nodetool status for the two regions.
kubectl exec apigee-cassandra-default-0 -n apigee -- nodetool -u APIGEE_JMX_USER -pw APIGEE_JMX_PASSWORD status Datacenter: dc-1 ======================= Status=Up/Down |/ State=Normal/Leaving/Joining/Moving -- Address Load Tokens Owns (effective) Host ID Rack UN 10.12.1.45 112.09 KiB 256 100.0% 3c98c816-3f4d-48f0-9717-03d0c998637f ra-1 UN 10.12.4.36 95.27 KiB 256 100.0% 0a36383d-1d9e-41e2-924c-7b62be12d6cc ra-1 UN 10.12.5.22 88.7 KiB 256 100.0% 3561f4fa-af3d-4ea4-93b2-79ac7e938201 ra-1 Datacenter: us-west1 ==================== Status=Up/Down |/ State=Normal/Leaving/Joining/Moving -- Address Load Tokens Owns (effective) Host ID Rack UN 10.0.4.33 78.69 KiB 256 100.0% a200217d-260b-45cd-b83c-182b27ff4c99 ra-1 UN 10.0.0.21 78.68 KiB 256 100.0% 9f3364b9-a7a1-409c-9356-b7d1d312e52b ra-1 UN 10.0.1.26 15.46 KiB 256 100.0% 1666df0f-702e-4c5b-8b6e-086d0f2e47fa ra-1