Manage environments

You can manage your environments with a combination of the Apigee Hybrid UI and the Hybrid runtime configuration file. This section describes how to create a new environment, edit an environment’s details, and delete an existing environment with the Hybrid UI. You must then update your overrides.yaml on the runtime plane to complete the creation or deletion of an environment.

Create a new environment in the Hybrid UI

To create a new environment, you must do the following (in this order):

  1. Create a new environment in the Hybrid UI, as described in this section

    AND

  2. Provision the new environment in the overrides.yaml file, as described in Configure an environment

Apigee recommends that you create no more than 25 environments.

To create a new environment:

  1. Open the Hybrid UI in a browser.
  2. Select Admin > Environments > Overview in the left navigation menu.

    The Hybrid UI displays a set of cards, each one representing an existing environment:

    If this is your first time accessing this view in the UI, there will be no environments.

  3. Click +Environment in the upper right corner of the UI.

    The Define a new environment dialog box displays:

  4. Enter the following information in the New Information dialog box:
    1. Display name: A friendly name for the environment that is used in the UI. For example, “My Test Environment”.
    2. Environment name: The programmatic name for the environment. This must match the value that you set in the overrides.yaml file when you add the environment in the Hybrid runtime. This value will be part of the request URL for your API proxies and should not contain any spaces or other special characters. It can only letters, numbers, and hyphens. For example, “MyEnvironment”.
    3. Description (optional): Additional information about the environment that you want to add as a reminder.

    All fields except Description are required.

  5. Click OK.

    The card displays "Pending Provisioning" label while Apigee creates the new environment, as the following example shows:

    There can be a several minute delay before the new environment is provisioned.

    Even when provisioning is done, you have one more step to perform. You must still add the environment to the runtime’s overrides.yaml file.

  6. On the Kubernetes administration machine, add the new environment to the runtime’s overrides.yaml file, as described in Configure an environment.

Edit an existing environment in the Hybrid UI

You can change the following properties of an existing environment in the Hybrid UI:

  • Display name
  • Description

To edit an existing environment:

  1. Open the Hybrid UI in a browser.
  2. Select the Environments option in the left navigation menu.
  3. Locate the card for the environment that you want to edit.

    The following example shows cards for 4 different environments:

  4. Click the environment’s card.

    The Hybrid UI displays details about that environment in the About view:

  5. Click the pencil icon in the About view.

    The Edit Environment dialog box displays:

  6. Edit the values in the Display name and/or Description fields.
  7. Click Save.

Delete an existing environment in the Hybrid UI

To delete an existing environment, you must do the following (in this order):

  1. Delete the environment in the Hybrid UI, as described in this section

    AND

  2. Delete the environment from the runtime, as described in Configure environments

To delete an existing environment:

  1. Open the Hybrid UI in a browser.
  2. Select the Environments option in the left navigation menu.

    The Hybrid UI displays a set of cards, each representing an environment within your Hybrid organization.

  3. Locate the card for the environment that you want to delete.
  4. Click the environment’s 3-dot menu and select Delete.

    The Hybrid UI displays a confirmation dialog box.

  5. Click OK to delete the environment.

    The environment's card in the UI displays a "Pending Deletion" label while Apigee deletes the environment.

    There can be a several minute delay before the deletion is completed.

  6. Delete the environment from the runtime’s overrides.yaml file, as described in Configure environments.