Apigee hybrid UI

To access the hybrid UI and add an environment, perform the following steps:

1. Open theApigee UI. If this is the first time you are logging in, hybrid displays a consent dialog. If you are prompted to select from more than one account, choose the account that owns the project you created inStep 2: Create a Google Cloud project. Then clickAllow.

Your browser navigates to the hybrid UI main landing page:



2. Ensure that your hybrid-enabled organization is selected from the organization drop-down list. If it is not selected, select it from the drop-down list, as the following example shows:

   

   Note: When you select a hybrid-enabled organization from the drop-down list, the hybrid UI displays the Apigee organization name and the Google Cloud project name in the header. The Apigee organization name and Google Cloud project name are the same.
3. ClickAdmin > Environments > Overview.

   

   TheEnvironments view is displayed, with no environments (yet):

   

4. Click+Environment.

   TheNew environment dialog is displayed:

   

5. Enter the following information in theNew Environment dialog:
   1. Display name(Required): A friendly name for the environment that is used in the UI. For example, "My First Environment" or "test". Unlike theEnvironment name, theDisplay name can include uppercase and other special characters.
   2. Environment name(Required): The programmatic name for the environment; also known as theenvironment ID.

      For example, "my-environment" or "test".

      Caution: An environment name can contain only lowercase letters, numbers, and hyphens. You cannot use uppercase letters or any other special characters. In addition, theEnvironment name can be up to a maximum of 32 characters long. For example:my-test-env ormy-test-env-42.

      TheDisplay name and theEnvironment name can be different.

   3. Description (Optional): Additional information about the environment that you want to add as a reminder of the purpose of the environment. For example, "Created during initial installation".
6. ClickCreate.

   Apigee creates the new environment and indicates that it isPending Provisioning:

   

   In a few moments, it changes toprovisioned:

   

   However, you’re not quite done. You also need to add your new environment to the runtime'soverrides.yaml file—but first you've got to install the runtime, so let's not get ahead of ourselves.

gcloud CLI

To create an environment with theCreate environments API, perform the following steps:

1. Open a terminal on the device you are using to manage Apigee.

2. On the command line, get yourgcloud authentication credentials, as the following example shows:

   TOKEN=$(gcloud auth print-access-token)

   To check that your token was populated, useecho, as the following example shows:

   echo $TOKEN

   This should display your token as an encoded string.

   For more information, seegcloud command-line tool overview.

3. Create environment variables for the elements of the environment. You will use the following variable in the command to create it:
   • ENV_NAME(Required) is the programmatic ID for your environment. The environment name can contain lowercase letters, dashes, and numbers and must start with a lowercase letter. This name will be used as the identifier and cannot be changed after creation

     export ENV_NAME=environment_name

   • ENV_DISPLAY_NAME(Required) is the user-friendly name of your environment. This value does not need to be unique, and can include spaces and special characters. For example, "My Example Environment".

     ENV_DISPLAY_NAME=friendly_name

   • ORG_NAME(Required) is your organization ID. Make sure you have defined theORG_NAME environment variable fromStep 4: Create an organization:

     echo $ORG_NAME

   • ENV_DESCRIPTION(Optional) is information about the environment that you'd like to use as a reminder of its purpose. For example, "Example environment for Apigee Hybrid instructions".

     ENV_DESCRIPTION=description_text

4. Send an authenticatedPOST request to the Create environments API.Note: After you create a hybrid-enabled organization, you cannot delete the organization, change the organization ID, or change the Google Cloud project that is bound to your organization. To change any of these things, contactGoogle Cloud Customer Care.

   The following example shows the request structure that creates an organization, using the following command:

   curl -H "Authorization: Bearer$TOKEN" -X POST -H "content-type:application/json"   -d '{    "name": "'"$ENV_NAME"'",    "displayName": "'"$ENV_DISPLAY_NAME"'",    "description": "'"$ENV_DESCRIPTION"'"  }'   "https://apigee.googleapis.com/v1/organizations/$ORG_NAME/environments"

   On a successful creation request, the Environments API should respond with a message similar to the following:

   {"name":"organizations/hybrid-example/operations/c2aee040-7e79-4fd4-b0cf-79ca1b7098a8","metadata":{"@type":"type.googleapis.com/google.cloud.apigee.v1.OperationMetadata","operationType":"INSERT","targetResourceName":"organizations/hybrid-example/environments/example-env","state":"IN_PROGRESS"}}

   As thestate property in the response indicates, Apigee has started to create the new environment, so its state isIN_PROGRESS. This process can take several minutes.

1. Open theApigee UI.

Your browser navigates to the hybrid UI main landing page.

2. Ensure that your hybrid-enabled organization is selected from the organization drop-down list. If it is not selected, select it from the drop-down list.
3. ClickAdmin > Environments > Groups.

   TheEnvironment Groups Overview view is displayed, with any created environment groups:

   

4. Click+Environment Group.

   TheAdd an Environment Group dialog is displayed.

   

5. Enter a name and then clickAdd.

6. Hold the pointer over the newly-created environment group and then clickEdit edit.

   Add a hostname that all proxies deployed to environments within this group will use. This is the domain you used inStep 5: Configure your DNS.



7. ClickAdd (+).
8. TheAdd environment dialog displays.



9. Select an environment from the list and then clickAdd.

gcloud CLI

To create an environment group using the command line, perform the following steps:

1. On the command line, get yourgcloud authentication credentials, as the following example shows:

   TOKEN=$(gcloud auth print-access-token)

   To check that your token was populated, useecho, as the following example shows:

   echo $TOKEN

   This should display your token as an encoded string.

   For more information, seegcloud command-line tool overview.

2. Make sure you have theDOMAIN environment variable set as the following example shows:

   echo$DOMAIN

   This is the hostname that all proxies deployed to environments within this group will use. Use the same domain you used inStep 5: Configure your DNS.

   If it is not set, create it with the domain you plan to use for your Apigee hybrid installation. For example:

   export DOMAIN=domain-name.com

3. Make sure you have theENV_NAME environment variable set to the environment you just created in the previous steps. For example:

   echo$ENV_NAME

4. Create an environment variable for your intended environmnet group name. For example:

   export ENV_GROUP=environment-group-name

5. Create the environment group with the following command:

   curl -H "Authorization: Bearer$TOKEN" -X POST -H "content-type:application/json" \   -d '{     "name": "'"$ENV_GROUP"'",     "hostnames":["'"$DOMAIN"'"]   }' \   "https://apigee.googleapis.com/v1/organizations/$ORG_NAME/envgroups"

6. Assign the environment to the new group with the following command:

   curl -H "Authorization: Bearer$TOKEN" -X POST -H "content-type:application/json" \   -d '{     "environment": "'"$ENV_NAME"'",   }' \   "https://apigee.googleapis.com/v1/organizations/$ORG_NAME/envgroups/$ENV_GROUP/attachments"