You are currently viewing version 1.13 of the Apigee hybrid documentation.This version is end of life. You should upgrade to a newer version. For more information, seeSupported versions.

This topic explains how to create new environments for Apigee hybrid. For an introduction, seeAbout environments and environment groups.

About environment creation

Environment creation is a two-step process:

• Create an environment in the management plane using either the UI or an Apigee API.
• Add configuration for that environment to your overrides file and apply it to the cluster.

The steps for adding an environment are described in adding and configuring an environment are explained inStep 5: Add an environment and Specify configuration overrides.

How to create an environment

1. Create one or more new environments in theApigee UI or with theCreate environments API. For the basic steps, seeStep 5: Add an environment.

2. Add a new environment definition to theenvs[] property in your overrides file. Note that the property is an array; therefore, you can add more than one environment definition to it. Give the new environment the same name as the environment you created in the UI. For example, the following configuration defines two environments:test andprod:

   namespace:my-namespaceorg:my-organization...envs:-name:testserviceAccountPaths:synchronizer:"your_keypath/synchronizer-manager-service-account.json      udca: "your_keypath/analytic-agent-service-account.json-name:prodserviceAccountPaths:synchronizer:"your_keypath/synchronizer-manager-service-account.json      udca: "your_keypath/analytic-agent-service-account.json...

3. Apply any changes to the cluster. Apply the changes to each environment in sequence.

   helm upgradeENV_RELEASE_NAME apigee-env/ \  --install \  --namespaceAPIGEE_NAMESPACE \  --set env=ENV_NAME \  -fOVERRIDES_FILE \  --dry-run=server

   ENV_RELEASE_NAME is a name used track installation and upgrades of theapigee-env chart. Helm release names must be unique within your Apigee hybrid installation. If you environment name is unique, this can be the same asENV_NAME. However, if you have the same name for your environment and environment group, make sure to enter a unique Helm release name for each. For example, if both are nameddev you could use something likedev-env-release anddev-envgroup-release.

   For more information on releases in Helm, seeThree big concepts in the Helm documentation.

   Thetest environment:

   helm upgradetest-release apigee-env/ \  --namespaceapigee \  --atomic \  --set env=test \  -fOVERRIDES_FILE.yaml

   Note: If you see an error sayingError: UPGRADE FAILED: "test" has no deployed releases, replaceupgrade withinstall and try the command again.

   Theprod environment:

   helm upgradeprod-release apigee-env/ \  --namespaceapigee \  --set env=prod \  --atomic \  -fOVERRIDES_FILE.yaml

For more information about virtual host configuration seeConfigure virtual hosts. For a complete list of environment configuration elements, seeenvs in theConfiguration property reference.