Delete environments

This topic explains how to delete environments in Apigee hybrid. See also About environments and environment groups.

How to delete an environment

Assume that you have two environments, test and prod. In your overrides file, the definitions might look something like this: 

...
envs:
  - name: test
    serviceAccountPaths:
      synchronizer: "your_keypath/synchronizer-manager-service-account.json
      udca: "your_keypath/analytic-agent-service-account.json
  - name: prod
    serviceAccountPaths:
      synchronizer: "your_keypath/synchronizer-manager-service-account.json
      udca: "your_keypath/analytic-agent-service-account.json
...

To delete the prod environment, follow these steps:

  1. Get your gcloud authentication credentials: 
    TOKEN=$(gcloud auth print-access-token)
  2. Delete the environment from any associated environment groups, one at a time:

    No data residency

    curl -X DELETE -H "Authorization: Bearer $TOKEN" \
  "https://apigee.googleapis.com/v1/organizations/$ORG_NAME/envgroups/$ENV_GROUP/attachments/prod"

    Data residency

    curl -X DELETE -H "Authorization: Bearer $TOKEN" \
  "https://$CONTROL_PLANE_LOCATION-apigee.googleapis.com/v1/organizations/$ORG_NAME/envgroups/$ENV_GROUP/attachments/prod"
  3. Do a dry run to test removal of the runtime components: 
    helm delete $ENV_NAME -n apigee --dry-run

    The --dry-run command will return the same results as the command without the --dry-run option. For example:

    helm -n apigee delete example-env
release "example-env" uninstalled
  4. If the dry run is error-free, remove the runtime components: 
    helm delete $ENV_NAME -n apigee
  5. Open your overrides file and remove the prod environment definition from envs and virtualhosts, leaving only the test definitions. For example: 
    ...
envs:
  - name: test
    serviceAccountPaths:
      synchronizer: "your_keypath/synchronizer-manager-service-account.json
      udca: "your_keypath/analytic-agent-service-account.json
...
  6. Save the file.