Step 4: Configure the cluster

Specify configuration overrides

The Apigee hybrid installer uses defaults for many settings; however, there are a few settings that do not have defaults. You must provide values for these settings, as explained next.

1. Be sure you are in the hybrid-base-directory/hybrid-files/overrides/ directory.

   cd hybrid-base-directory/hybrid-files/overrides

2. Create a new file named overrides.yaml in your favorite text editor. For example:

   vi overrides.yaml

   The overrides.yaml provides the configuration for your unique Apigee hybrid installation. The overrides file in this step provides a basic configuration for a small-footprint hybrid runtime installation, suitable for your first installation.

3. In overrides.yaml, add the required property values, shown below. A detailed description of each property is also provided below:

   Syntax

   Make sure the overrides.yaml file has the following structure and syntax. Values in red, bold italics are property values that you must provide. They are described in the table below.

   
   gcp:
     region: analytics-region
     projectID: gcp-project-id
   
   k8sCluster:
     name: cluster-name
     region: cluster-region # Must be the same region where the cluster is running.
   
   org: org-name
   
   instanceID: "unique-instance-identifier"
   
   cassandra:
     hostNetwork: false #Set this to `true` for GKE-On-prem installations.
   
   virtualhosts:
     - name: environment-group-name
       sslCertPath: ./certs/cert-name.pem
       sslKeyPath: ./certs/key-name.key
   
   envs:
     - name: environment-name
       serviceAccountPaths:
         synchronizer: ./service-accounts/synchronizer-service-account-name.json
         udca: ./service-accounts/udca-service-account-name.json
   
   mart:
     serviceAccountPath: ./service-accounts/mart-service-account-name.json
   
   connectAgent:
     serviceAccountPath: ./service-accounts/mart-service-account-name.json
     # Same account used for mart and connectAgent
   
   metrics:
     serviceAccountPath: ./service-accounts/metrics-service-account-name.json
   
   watcher:
     serviceAccountPath: ./service-accounts/watcher-service-account-name.json
   
   logger:
     enabled: true
     serviceAccountPath: ./service-accounts/logger-service-account-name.json
   

   Example

   The following example shows a completed overrides file with example property values added:

   gcp:
     region: us-central1
     projectID: hybrid-example
   
   k8sCluster:
     name: apigee-hybrid
     region: us-central1
   
   org: hybrid-example
   
   instanceID: "my_hybrid_example"
   
   cassandra:
     hostNetwork: false #Set this to `true` for GKE-On Prem installations.
   
   virtualhosts:
     - name: example-env-group
       sslCertPath: ./certs/keystore.pem
       sslKeyPath: ./certs/keystore.key
   
   envs:
     - name: test
       serviceAccountPaths:
         synchronizer: ./service-accounts/hybrid-project-apigee-synchronizer.json
         udca: ./service-accounts/hybrid-project-apigee-udca.json
   
   mart:
     serviceAccountPath: ./service-accounts/hybrid-project-apigee-mart.json
   
   connectAgent:
     serviceAccountPath: ./service-accounts/example-hybrid-apigee-mart.json
   
   metrics:
     serviceAccountPath: ./service-accounts/hybrid-project-apigee-metrics.json
   
   watcher:
     serviceAccountPath: ./service-accounts/hybrid-project-apigee-watcher.json
   
   logger:
     enabled: true
     serviceAccountPath: ./service-accounts/logger-service-account-name.json
   
   

4. When you are finished, save the file.

The following table describes each of the property values that you must provide in the overrides file. For more information, see Configuration property reference.

sslCertPath: ./certs/keystore.pem
sslKeyPath: ./certs/keystore.key

serviceAccountPath:
  synchronizer: ./service-accounts/hybrid-project-apigee-synchronizer.json

serviceAccountPath:
  udca: ./service-accounts/hybrid-project-apigee-udca.json

metrics:
  serviceAccountPath: ./service-accounts/hybrid-project-apigee-metrics.json

watcher:
  serviceAccountPath: ./service-accounts/hybrid-project-apigee-watcher.json

Summary

The configuration file tells Kubernetes how to deploy the hybrid components to a cluster. Next, you will apply this configuration to your cluster.