This topic explains how to delete environments. For an introduction, seeAbout environments and environment groups.

About deleting environments

To delete an environment properly, you must make several configuration changes and apply them to your cluster. These changes include removing the environment definition from your overrides file, deleting thesynchronizer,runtime, andudca components, and finally re-applying your overrides to restore your cluster without including the environment you wish to delete.

The reason you can't only delete the environment in one step is because the other elements,synchronizer,runtime, andudca are connected to each environment through their internal configurations. Only by deleting them and re-applying them can you properly delete an environment.

How to delete an environment

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

...envs:  - name:test    sslCertPath: "your_certpath/ingress-cert.crt"    sslKeyPath: "your_keypath/ingress-key.key"    hostAlias: "apitest.example.com"    serviceAccountPaths:      synchronizer: "your_keypath/synchronizer-manager-service-account.json      udca: "your_keypath/analytic-agent-service-account.json  - name:prod    sslCertPath: "your_certpath/ingress-cert.crt"    sslKeyPath: "your_keypath/ingress-key.key"    hostAlias: "apiprod.example.com"    serviceAccountPaths:      synchronizer: "your_keypath/synchronizer-manager-service-account.json      udca: "your_keypath/analytic-agent-service-account.json...

To delete theprod environment, follow these steps:

1. Copy your original overrides file -- the one that contains both theprod andtest environment definitions -- to a new file called, for example,prod-delete.yaml.
2. Openprod-delete.yaml.
3. Delete thetest environment definition fromenvs, leaving only theprod definition. For example:

   ...envs:  - name:prod    sslCertPath: "your_certpath/ingress-cert.crt"    sslKeyPath: "your_keypath/ingress-key.key"    hostAlias: "apitest.example.com"    serviceAccountPaths:      synchronizer: "your_keypath/synchronizer-manager-service-account.json      udca: "your_keypath/analytic-agent-service-account.json

4. Remove everything else fromprod-delete.yamlexcept thecassandra config, if present:

   After making the above changes, your overrides file should look something like this:

   ...envs:  - name:prod    sslCertPath: "your_certpath/ingress-cert.crt"    sslKeyPath: "your_keypath/ingress-key.key"    hostAlias: "apitest.example.com"    serviceAccountPaths:      synchronizer: "your_keypath/synchronizer-manager-service-account.json      udca: "your_keypath/analytic-agent-service-account.jsoncassandra:  replicaCount: 3  resources:    requests:      cpu: 3500m      memory: 7Gi  storage:    storageClass: pd-ssd    capacity: 10Gi

5. Run this command to delete the specified components:

   apigeectl delete -f prod-delete.yaml -c runtime, udca, synchronizer

6. Open youroriginal overrides file (the one that includes both the test and prod environment definitions).
7. Delete theprod environment definition from theenvs element. You only want thetest environment definition to be present in the file.
8. Apply the modified overrides file to your cluster. This command will recreate the deleted elements and, because it is omitted, not recreate theprod environment.

   apigeectl apply -f prod-delete.yaml -c runtime, udca, synchronizer

9. Save your changes.

You're not quite done. You must now update the environments in the hybrid UI.

10. Open a browser and navigate to the hybrid UI atApigee UI.
11. Remove the environment using the steps describedDelete an existing environment in the Hybrid UI.