Step 3: Configure the GKE 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 directory.
2. Copy the overrides-small.yaml file from the $APIGEECTL_HOME /examples directory to your overrides directory:

   cp $APIGEECTL_HOME 
   /examples/overrides-small.yaml ./overrides/overrides.yaml

   This example file provides a basic configuration for a small-footprint hybrid runtime installation, a configuration that is suitable for a your first installation.

3. cd into the overrides directory:

cd overrides

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

   Syntax

   The overrides.yaml file has the following structure and syntax. Values in red, bold italics are property values that you must provide:

   gcpProjectID: project-id 
   k8sClusterName: cluster-name 
   org: org-name 
   envs:
     - name: environment-name 
   # The same name of the env you created in the UI
       hostAlias: test-host-alias 
   sslCertPath: ./certs/ test-cert-name 
   .pem
       sslKeyPath: ./certs/ test-key-name 
   .key
       serviceAccountPaths:
         synchronizer: ./service-accounts/ synchronizer-service-account-name 
   .json
         udca: ./service-accounts/ udca-service-account-name 
   .json
   
   mart:
     hostAlias: mart-host-alias 
   serviceAccountPath: ./service-accounts/ mart-service-account-name 
   .json
     sslCertPath: ./certs/ mart-cert-name 
   .pem
     sslKeyPath: ./certs/ mart-key-name 
   .key
   
   metrics:
     serviceAccountPath: ./service-accounts/ metrics-service-account-name 
   .json
   
   logger:
     enabled: false

   Example

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

   gcpProjectID: hybrid-project
   k8sClusterName: apigee-hybrid
   org: hybrid-org
   
   envs: - 
   name: test
       hostAlias: "*"
       sslCertPath: ./certs/keystore.pem
       sslKeyPath: ./certs/keystore.key
       serviceAccountPaths:
         synchronizer: ./service-accounts/hybrid-project-apigee-synchronizer.json
         udca: ./service-accounts/hybrid-project-apigee-udca.json
   
   mart:
     hostAlias: "mart.apigee-hybrid-docs.net"
     serviceAccountPath: ./service-accounts/hybrid-project-apigee-mart.json
     sslCertPath: ./certs/fullchain.pem
     sslKeyPath: ./certs/privkey.key
   
   metrics:
     serviceAccountPath: ./service-accounts/hybrid-project-apigee-metrics.json
   
   logger:
     enabled: false

5. When your finished, save the file.

The following table describes each of the property values that you must provide in the overrides file.

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

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

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

sslCertPath: ./certs/fullchain.pem
sslKeyPath: ./certs/privkey.key

serviceAccountPath: ./service-accounts/hybrid-project-apigee-metrics.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.