Instance is not reporting status for environment group

You're viewing Apigee and Apigee hybrid documentation.
View Apigee Edge documentation.

Symptoms

Deployments of API proxies fail with Instance INSTANCE_NAME is not reporting status for environment group ENV_GROUP_NAME error in the Apigee hybrid UI.

Error Messages

The Instance INSTANCE_NAME is not reporting status for environment group ENV_GROUP_NAME error is displayed in the API proxies menu under the Overview tab when hovering over the red exclamation mark appearing in the Status column of Deployments section:

instance-not-reporting-status

Possible Causes

Cause Description
The selector app: apigee-ingressgateway is missing When using the Apigee ingress, the overrides.yaml file needs to have the selector app: apigee-ingressgateway under virtualhosts section

Cause: The selector app: apigee-ingressgateway is missing

When using the Apigee ingress gateway, the overrides.yaml file includes a section for virtualhosts configuration in which the selector app: apigee-ingressgateway needs to be configured.

Diagnosis

First, confirm that you are using the Apigee ingress gateway which is available with Hybrid version 1.8 and later (the following configuration does not work for customer-managed Istio ASM). In your overrides.yaml file which includes the environment group mentioned in the error, find the virtualhosts section and check if the following selectors are missing: 

  selector:
    app: apigee-ingressgateway
    ingress_name: INGRESS_NAME

Resolution

Edit the overrides.yaml file so that the virtualhosts[].selector section looks similar to the following example: 

    virtualhosts:
    - name: my-environment-group
      sslCertPath: my-cert.crt
      sslKeyPath: my-cert.key
      selector:
        app: apigee-ingressgateway
        ingress_name: INGRESS_NAME

After editing the overrides.yaml file apply the new configuration using Helm:

Dry run:

helm upgrade ENV_GROUP_RELEASE_NAME apigee-virtualhost/ \
--namespace APIGEE_NAMESPACE \
--atomic \
--set envgroup=ENV_GROUP \
-f OVERRIDES_FILE \
--dry-run=server

Make sure to include all of the settings shown, including --atomic so that the action rolls back on failure.

Your installation may or may not have been set up using an ENV_GROUP_RELEASE_NAME that differs from ENV_GROUP. For information on the settings, see Install Apigee hybrid using Helm.

Install the chart:

helm upgrade ENV_GROUP_RELEASE_NAME apigee-virtualhost/ \
--namespace APIGEE_NAMESPACE \
--atomic \
--set envgroup=ENV_GROUP \
-f OVERRIDES_FILE

References