Deployment overview

This page applies to Apigee and Apigee hybrid.

View Apigee Edge documentation.

Note: To deploy API proxies in environments enabled for archive deployments, see Deploying and managing archives in an Apigee environment.

When you make a change to an API proxy, you can save it as a new revision and deploy it to your cluster.

Quick Start:

• Deploying an API proxy
• Undeploying an API proxy

About deployment

The deployment lifecycle of an API proxy revision on Apigee is shown in the following figure.

Note: In Apigee, MPs act independently of one another and any given MP can be in a different state than the other MPs (such as active or disabled). This is known as an eventually consistent deployment model for API proxies.

API proxy revisions limitations

The following limitations apply to API proxy revisions:

• If you make any changes to an API proxy, you must deploy it as a new revision.
• After you deploy an API proxy, the revision is read-only. You cannot change an API proxy revision (such as to make incremental changes); the only way to change a revision is to create a new revision and deploy it.
• MPs can deploy a proxy bundle only in its entirety. If you make changes to individual fragments or policies, the MPs will still deploy the entire proxy bundle.
• If your Apigee usage distinguishes between Standard and Extensible proxies, when deploying a revision that changes an API proxy from a Standard proxy to an Extensible proxy:
  • a cost might be incurred. If you are a Pay-as-you-go customer, see the Pay-as-you-go entitlements. If you are a Subscription customer, see your plan's details.
  • the deployment requires additional time. During the deployment window the API call flow is not disrupted but you can't deploy, undeploy, or delete the proxy. Also, current or new revisions cannot be deleted during the deployment window. Changes to the API proxy and new revision creation are allowed.

Zero-downtime deployment

All successful API proxy deployments to Apigee, are zero-downtime deployments. API proxy deployments happen in this order:

1. Revision 1 of the API proxy /hello is deployed and handling traffic.
2. Revision 2 of /hello is deployed.
3. Revision 2 is deployed to the Message Processors in the runtime plane.
4. Revision 1 is undeployed.

The API proxy revision deployment is now complete with no downtime.

Note: If the deployment of Revision 2 fails for any reason, the previous version, Revision 1 is still undeployed. In this case, you can re-deploy the previous revision to restore it. Then, you can fix the new revision and deploy it.

Viewing deployment status

Deploying an API proxy on Apigee does not make it immediately available. It takes time for the API proxy to be synchronized across all MPs in the runtime plane. However, Apigee provides tools that can give you some information about the status of your API proxy revisions.

Classic Apigee UI

Within the Apigee UI, there are several views that provide the deployment status of your API proxies.

Apigee UI View

Steps & Description

Proxies

Select Develop > API Proxies: The Apigee UI uses the following icons to give a quick status for each API proxy: Indicates that the API proxy has not been deployed to the selected environment. Indicates that there are no errors or warnings for that proxy in the selected environment. Indicates that some routing did not update due to base path conflicts. Indicates that there was an error deploying the API proxy. To view the status icon, click the Develop tab. Alternatively, you can select Develop > API Proxies and click an API proxy

Apigee API

To view the deployment status of your API proxy revision in an environment, use the following API call:

curl "https://apigee.googleapis.com/v1/organizations/$ORG/environments/$ENV/apis/$API/revisions/$REV/deployments" \
  -X GET \
  -H "Authorization: Bearer $TOKEN"

Where $TOKEN is set to your OAuth 2.0 access token, as described in Obtaining an OAuth 2.0 access token. For information about the curl options used in this example, see Using curl. For a description of the environment variables used, see Setting environment variables for Apigee API requests.

The following provides an example of the response. This examples shows deployment status for revision 1 of the helloworld API proxy that is deployed in the test environment:

{
  "environment": "test",
  "apiProxy": "helloworld",
  "revision": "1",
  "deployStartTime": "1559149080457",
  "pods": [
    {
      "podName": "apigee-runtime-myorg-test-f8bdf9d-2s72w",
      "deploymentStatus": "deployed",
      "statusCodeDetails": "Deployment Success",
      "podStatus": "active",
      "podStatusTime": "1595357668001"
    }
  ],
  "state": "READY"
}

For more information, see the API proxy revision environment deployments API.

gcloud

To view the deployment status of your API proxy revision in an environment, use the following gcloud command:

gcloud alpha apigee deployments describe --api=$API --environment=$ENV

For more information and a description of the environment variables used in the examples, see Getting started using gcloud with Apigee.

The following provides an example of the response. This examples shows deployment status for revision 1 of the helloworld API proxy that is deployed in the test environment:

Using Apigee organization `my-org`
Using deployed revision `1`
apiProxy: helloworld
deployStartTime: '1598032332802'
environment: test
pods:
- deploymentStatus: deployed
  podName: apigee-runtime-myorg-test-f8bdf9d-2s72w
  podStatus: active
  podStatusTime: '1598302128087'
  statusCodeDetails: Deployment Success
revision: '1'
state: READY

For more information, see Describe deployments CLI.

View proxy deployment usage

The usage of API proxies in your organization may be subject to a deployments quota, which is a limit on how many deployment units you can use at a time. See your entitlements (Pay-as-you-go or Subscription) for details. You can view your organization's proxy deployment usage from several places within the Apigee UI in Cloud console, as described below.

Note: If your organization is Apigee hybrid-enabled, only a sub-set of these usage metrics are displayed.

View deployment usage on the Apigee Overview page

To view your API proxy deployment usage from the Apigee Overview page:

1. Open the Overview page in the Apigee UI in Google Cloud console.

   Go to Overview

2. You can view proxy deployment usage for your organization at a glance using the Proxy Usage card, which displays the following information for your organization:
   • Total proxies created: The total number of API proxies created, including deployed and undeployed proxies.
   • Proxies deployed: The total number of API proxies deployed across all environment(s) in the organization.
   • Proxy deployment units: The total number of API proxy or shared flow revisions deployed in your organization. Each deployment per environment, per instance, is counted as one unit.
   • Proxies and shared flows deployed against limit: Total number of API proxies and shared flows deployed in the organization, against the limit for your organization type.
   • Extensible deployment units: The number of extensible API proxy revisions deployed in your organization. Each deployment per environment, per instance, is counted as one unit.
   • Standard deployment units: The number of standard API proxy revisions deployed in your organization. Each deployment per environment, per instance, is counted as one unit.

View deployment usage on the API Proxies page

To view your API proxy deployment usage from the API Proxies page:

1. Open the API Proxies page in the Apigee UI in Google Cloud console.

   Go to API proxies

2. The API Proxies page displays the following information:
   • Total proxies created: The total number of API proxies developed in your organization, including deployed and undeployed proxies.
   • Proxies deployed: The total number of API proxy revisions deployed across all environments in your organization.
   • Proxy deployment units: The total number of API proxy or shared flow revisions deployed across all environments in your organization. Each deployment per environment, per instance, is counted as one unit.
   • Extensible proxy deployment units: The number of extensible API proxy revisions deployed across all environments in your organization. Each deployment per environment, per instance, is counted as one unit.
   • Standard proxy deployment units: The number of standard API proxy revisions deployed across all environments in your organization. Each deployment per environment, per instance, is counted as one unit.

View deployment usage on the Environments page

To view your API proxy deployment usage from the Environments page:

1. Open the Environments page in the Apigee UI in Google Cloud console.

   Go to Environments

2. Select the Environments overview tab to display the following information for all of the environments:
   • Total proxy deployment units: The total number of API proxy or shared flow revisions deployed across all environments in your organization.
   • Extensible proxy deployment units: The number of extensible API proxy revisions deployed across all environments in your organization. Each deployment per environment, per instance, is counted as one unit.
   • Standard proxy deployment units: The number of standard API proxy revisions deployed across all environments in your organization. Each deployment per environment, per instance, is counted as one unit.
   • Shared flow deployment units: The total number of shared flow revisions deployed across all environments in your organization. Each deployment per environment, per instance, is counted as one unit.
3. To view proxy deployment usage for a single environment:
   1. In the Environments list, select an environment name to view its details.
   2. Select the Deployments tab to view deployment unit usage for the selected environment.

Next steps

Learn how to deploy: Deploying an API Proxy

Learn how to undeploy: Undeploying an API Proxy