This topic explains how to add a second Apigee hybrid organization (org) to an existing
Kubernetes cluster. In this multi-org per cluster configuration, both orgs use and share the same Cassandra
ring. Each org can have multiple environments and environment groups configured.
Limitations
A multi-org per cluster configuration is supported with the following limitations. Until these
limitations are mitigated, we do not recommend that you use this configuration.
If you are going to have multiple Apigee hybrid instances, each instance should have
its own cluster. Multiple Apigee hybrid instances running on the same kubernetes cluster can
lead to issues of instability potentially causing downtime.
Pod metrics are only sent to the first Google Cloud project that was configured. This
limitation is most apparent in the Cloud Monitoring tool. It only affects cluster metrics;
API analytics are not affected. The metrics for the other Apigee orgs will not be sent
to the matching Google Cloud project.
All logging from the pods are sent to the first Google Cloud project that was configured. This
limitation is most apparent in the Cloud Logging tool. The logs for the other Apigee orgs will not
be sent to the matching Google Cloud project. Logs are still captured at the pod level and can
be retrieved with kubectl commands. However, they are not sent to the correct Cloud
project through Cloud Logging.
You cannot delete org data in the Cassandra database for just one org. This means that
you cannot remove orgs selectively. Any modification to the database configuration affects all
orgs that are deployed to that cluster.
The hybrid upgrade procedure upgrades the entire cluster all at once.
Backup and restore is done as a cluster, and cannot be done for a specific org.
The Apigee API Monitoring feature (Timeline, Recent, Investigate) only works for the first
org that was configured and deployed. It will not work for the other orgs in a multi-org
cluster.
Multi-org options
This section describes how Apigee Support handles existing multi-org clusters and recommendations
for future deployments:
If you have existing multi-org Kubernetes clusters deployed in non-production and production
contexts, Apigee Support will continue to support them. However, note the technical limitations outlined
in the next section. We recommend that you
change any future production deployments to use one Apigee org per cluster.
If you have existing multi-org clusters in non-production contexts, Apigee Support
will continue to support them. We recommend that you migrate any production clusters to a new
configuration that uses one Apigee org per cluster.
Prerequisites
Before continuing, note the following:
You must have an existing hybrid org with one or more environments installed and configured
in an existing Kubernetes cluster. See the hybrid installation instructions.
When combining multiple orgs in a single cluster, the hybrid
versions must all match. Before adding a second org to a cluster, upgrade the existing
hybrid installation, if necessary. See Upgrading Apigee hybrid.
In the following steps, you will create a new overrides file and configure it for the
new org.
An overrides.yaml file can only support one org's information. Therefore, you must
create a new overrides.yaml file and apply it to the existing Kubernetes cluster.
Make note of the TLS certificate files (.key and .pem) in your
certs directory. If you need to create them again, you can follow the instructions in
Create TLS certificates.
Copy your existing overrides.yaml to a new file to use as a starting point
for configuring your new org. For
example: new-overrides.yaml.
Edit the new overrides file with the following configurations:
The following table describes each of the property values that you must provide in the
overrides file. For more information, see Configuration property reference.
Variable
Description
new-org-name
The name of your new org.
instance-id
All orgs in
in this cluster must have the same instance ID. Therefore this must match the
instanceID entry in the overrides file for your original org.
existing-cluster-name
The name of the cluster you are adding this org to. It
must match the k8sCluster.name entry in the overrides file for your original
cluster.
existing-cluster-analytics-region
The region where the original cluster is
provisioned. It must match the k8sCluster.region entry in the overrides file
for your original cluster.
new-project-id
The project ID of your new project. The project ID and org
name are the same.
new-project-default-location
The analytics region you specified when you
created the new org. It does not have to be the same as the region for the existing org.
namespace
All orgs in the cluster must share the same namespace. Be sure to
use the same namespace that was used for the original org. Note that the default namespace is
apigee.
new-environment-group-name
The new environment group you created for the new
org.
cert-file-name and key-file-name
The TLS cert and key files for
the cluster that you checked or created in step 1 in this
section.
new-environment-name
The name of the environment you created for the new
org.
new-service-accounts-directory
The directory where the service account key files you created for the new org are located.
Apply the configuration
Apply the new org configuration to your cluster:
Do a dry run installation to check for any problems:
If there are no issues, apply the org-level components. This step installs the Cassandra
jobs (user and schema), Apigee Connect, Apigee Watcher and MART services:
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-26 UTC."],[[["\u003cp\u003eThis document explains how to add a second Apigee hybrid organization to an existing Kubernetes cluster, which shares the same Cassandra ring with the initial organization.\u003c/p\u003e\n"],["\u003cp\u003eA multi-org per cluster configuration has limitations, such as issues with pod metrics and logging being sent only to the first configured Google Cloud project, and no selective deletion, upgrade or backup/restore of a single org is possible.\u003c/p\u003e\n"],["\u003cp\u003eThe recommendation is to use one Apigee organization per cluster for production deployments, and it is advised to migrate existing multi-org production clusters to this single-org setup.\u003c/p\u003e\n"],["\u003cp\u003eAdding a new organization involves creating a new \u003ccode\u003eoverrides.yaml\u003c/code\u003e file with specific configurations, including a new organization name, matching the instance ID, cluster name, and namespace with the existing organization.\u003c/p\u003e\n"],["\u003cp\u003eApplying the new configuration requires running \u003ccode\u003eapigeectl\u003c/code\u003e commands to deploy the org, its environments, and update the load balancer, and synchronizer access must also be enabled for the new org.\u003c/p\u003e\n"]]],[],null,["# Adding multiple hybrid orgs to a cluster\n\n| You are currently viewing version 1.8 of the Apigee hybrid documentation. **This version is end of life.** You should upgrade to a newer version. For more information, see [Supported versions](/apigee/docs/hybrid/supported-platforms#supported-versions).\n\n\nThis topic explains how to add a second Apigee hybrid organization (org) to an existing\nKubernetes cluster. In this multi-org per cluster configuration, both orgs use and share the same Cassandra\nring. Each org can have multiple environments and environment groups configured.\n| **Warning:** A multi-org per cluster configuration is supported with specific [limitations](#limitations). Until these limitations are mitigated, we do not recommend that you use this configuration.\n| **Note:** If you are already using multi-org clusters and would like to migrate the orgs to single org clusters, see [Migrating an org to another cluster](/apigee/docs/hybrid/v1.8/migrate-org).\n\nLimitations\n-----------\n\n\nA multi-org per cluster configuration is supported with the following limitations. **Until these\nlimitations are mitigated, we do not recommend that you use this configuration.**\n| **Note:** The maximum number of orgs that you can add to a single cluster is limited. See [Limits](/apigee/docs/api-platform/reference/limits) for details.\n\n- If you are going to have multiple Apigee hybrid instances, each instance should have its own cluster. Multiple Apigee hybrid instances running on the same kubernetes cluster can lead to issues of instability potentially causing downtime.\n- Pod metrics are only sent to the first Google Cloud project that was configured. This limitation is most apparent in the Cloud Monitoring tool. It only affects cluster metrics; API analytics are not affected. The metrics for the other Apigee orgs will not be sent to the matching Google Cloud project.\n- All logging from the pods are sent to the first Google Cloud project that was configured. This limitation is most apparent in the Cloud Logging tool. The logs for the other Apigee orgs will not be sent to the matching Google Cloud project. Logs are still captured at the pod level and can be retrieved with `kubectl` commands. However, they are not sent to the correct Cloud project through Cloud Logging.\n- You cannot delete org data in the Cassandra database for just one org. This means that you cannot remove orgs selectively. Any modification to the database configuration affects all orgs that are deployed to that cluster.\n- The hybrid upgrade procedure upgrades the entire cluster all at once.\n- Backup and restore is done as a cluster, and cannot be done for a specific org.\n- The Apigee API Monitoring feature (Timeline, Recent, Investigate) only works for the first org that was configured and deployed. It will not work for the other orgs in a multi-org cluster.\n\nMulti-org options\n-----------------\n\n\nThis section describes how Apigee Support handles existing multi-org clusters and recommendations\nfor future deployments:\n\n- If you have existing multi-org Kubernetes clusters deployed in non-production and production contexts, Apigee Support will continue to support them. However, note the technical limitations outlined in the next section. We recommend that you change any future production deployments to use one Apigee org per cluster.\n- If you have existing multi-org clusters in non-production contexts, Apigee Support will continue to support them. We recommend that you migrate any production clusters to a new configuration that uses one Apigee org per cluster.\n\nPrerequisites\n-------------\n\n\nBefore continuing, note the following:\n\n- You must have an existing hybrid org with one or more environments installed and configured in an existing Kubernetes cluster. See the [hybrid installation instructions](./precog-overview).\n- When combining multiple orgs in a single cluster, the hybrid versions must all match. Before adding a second org to a cluster, upgrade the existing hybrid installation, if necessary. See [Upgrading Apigee hybrid](/apigee/docs/hybrid/v1.8/upgrade).\n\nCreate an org to add to the existing cluster\n--------------------------------------------\n\n\nTo create the additional org, follow the steps in\n[Part 1: Project and org setup.](./precog-overview)\n| **Note:** If you have an existing org you want to add to your Apigee hybrid installation, you can skip to [Configure the new\n| org](#configuring).\n\nConfigure the new org\n---------------------\n\n\nIn the following steps, you will create a new overrides file and configure it for the\nnew org.\nAn `overrides.yaml` file can only support one org's information. Therefore, you must\ncreate a new `overrides.yaml` file and apply it to the existing Kubernetes cluster.\n\n1. Create service accounts for use with the new org. See [Create service accounts](./install-service-accounts).\n2. Make note of the TLS certificate files (`.key` and `.pem`) in your `certs` directory. If you need to create them again, you can follow the instructions in [Create TLS certificates](/apigee/docs/hybrid/v1.8/install-create-tls-certificates).\n3. Copy your existing `overrides.yaml` to a new file to use as a starting point for configuring your new org. For example: `new-overrides.yaml`.\n4. Edit the new overrides file with the following configurations: \n\n ```verilog\n org: \"\u003cvar translate=\"no\"\u003enew-org-name\u003c/var\u003e\"\n instanceID: \"\u003cvar translate=\"no\"\u003einstance-id\u003c/var\u003e\" ## Must match the instanceID of your existing org.\n\n k8sCluster:\n name: \"\u003cvar translate=\"no\"\u003eexisting-cluster-name\u003c/var\u003e\"\n region: \"\u003cvar translate=\"no\"\u003eexisting-cluster-analytics-region\u003c/var\u003e\"\n\n gcp:\n projectID: \"\u003cvar translate=\"no\"\u003enew-project-id\u003c/var\u003e\"\n name: \"\u003cvar translate=\"no\"\u003enew-project-id\u003c/var\u003e\"\n region: \"\u003cvar translate=\"no\"\u003enew-project-default-location\u003c/var\u003e\"\n\n namespace: namespace ## must be the same for both new and existing orgs\n\n virtualhosts:\n - name: new-environment-group-name\n sslCertPath: ./certs/cert-file-name # .crt or .pem\n sslKeyPath: ./certs/key-file-name # .key\n\n envs:\n - name: new-environment-name\n serviceAccountPaths:\n runtime: ./new-service-accounts-directory/new-project-id-apigee-runtime.json\n synchronizer: ./new-service-accounts-directory/new-project-id-apigee-synchronizer.json\n udca: ./new-service-accounts-directory/new-project-id-apigee-udca.json\n\n connectAgent:\n serviceAccountPath: ./new-service-accounts-directory/new-project-id-apigee-mart.json\n\n mart:\n serviceAccountPath: ./new-service-accounts-directory/new-project-id-apigee-mart.json\n\n metrics:\n serviceAccountPath: ./new-service-accounts-directory/new-project-id-apigee-metrics.json\n\n watcher:\n serviceAccountPath: ./new-service-accounts-directory/new-project-id-apigee-watcher.json\n ```\n\n\n The following table describes each of the property values that you must provide in the\n overrides file. For more information, see [Configuration property reference](./config-prop-ref).\n\nApply the configuration\n-----------------------\n\n\nApply the new org configuration to your cluster:\n\n1. Do a dry run installation to check for any problems: \n\n ```\n apigeectl apply -f overrides/new-overrides.yaml --org --dry-run=client\n ```\n | **Note:** It's a good practice to do a dry run before applying the configuration to determine if there are any issues.\n2. If there are no issues, apply the org-level components. This step installs the Cassandra jobs (user and schema), Apigee Connect, Apigee Watcher and MART services: \n\n ```\n apigeectl apply -f overrides/new-overrides.yaml --org\n ```\n3. Install the environment. This step installs apigee-runtime, synchronizer and UDCA components, per environment: \n\n ```\n apigeectl apply -f overrides/new-overrides.yaml --env ${ENV_NAME} --dry-run=client\n ``` \n\n ```\n apigeectl apply -f overrides/new-overrides.yaml --env ${ENV_NAME}\n ```\n | **Note:** If you have multiple environments in your new org, repeat this step for each environment.\n 4. Apply the load balancer changes. This step configures the ingress to listen to the new virtual host(s) for the second org: **Important:** Do not duplicate hostnames/domain names between two orgs, as it can result in unpredictable routing. \n\n ```\n apigeectl apply -f overrides/new-overrides.yaml --settings virtualhosts --dry-run=client\n ``` \n\n ```\n apigeectl apply -f overrides/new-overrides.yaml --settings virtualhosts\n ```\n5. Enable synchronizer access for your new org following the steps in [Enable Synchronizer access](/apigee/docs/hybrid/v1.8/install-enable-synchronizer-access)."]]
