This pageapplies toApigee andApigee hybrid.

View Apigee Edge documentation.

This feature is subject to the "Pre-GA Offerings Terms" in the General Service Terms section of theService Specific Terms. Pre-GA features are available "as is" and might have limited support. For more information, see thelaunch stage descriptions.

In this step, you'll promote an archive of your API proxy configuration to a production environment in your Apigee organization.

1. Follow the steps inCreate an environment to perform the following:
   1. Create a newprod environment in your Apigee organization, enablingArchive as the deployment type. Use theUI orAPI.
   2. Attach the environment to a runtime instance using theInstances attachment API.

      This command triggers a long-running operation. Ensure that the environment has been attached to the runtime before continuing.

   3. Create an environment group if you do not already have one using theCreate environment groups API.

      Ensure that the environment group has been created before continuing. You can check the status of your new group using a request like the following:

      curl -i -H "$AUTH" -H "Content-Type:application/json" \  "https://apigee.googleapis.com/v1/organizations/$PROJECT_ID/environments/ENVIRONMENT_NAME"

   4. Attach the new environment to the environment group using theEnvironment group attachment API.

      Attaching an environment to the group makes the proxies in that environment routable via the hostnames in the group. This triggers a long-running operation that can take several minutes to complete. We recommend that you wait a minute or two before continuing to the next step. In the meantime you can check the status of the operation as before.

2. Create a newprod environment in your local development environment:
   1. In Apigee in VS Code, position your cursor over theenvironments folder in the Apigee section and click.

      

      The Create environment wizard opens.

   2. Enterprod for the environment name and pressEnter.

      The environment is created.

   3. Expand theprod environment folder in the Apigee section to view its contents.
   4. Position your cursor over thedeployments.json file in the Apigee section and click.

      The Deployments wizard opens.

   5. Select thehelloworld API proxy to add it to the deployment and clickOK.

      Thedeployments.json file is opened in the editor. The file has been updated to include thehelloworld API proxy in theproxies deployment array, as shown below:

      {  "proxies": ["helloworld"  ],  "sharedflows": []}

3. Deploy an archive of your API proxy configuration to theprod environment in your Apigee organization.
   1. In theTerminal tab in Apigee VS Code, navigate to themyapigeeworkspace directory.

      cd myapigeeworkspace

   2. Run the following command:

      gcloud beta apigee archives deploy --environment=prod --labels=release=052021.1

      The following provides an example of the response:

      Using Apigee organization devWaiting for operation [$OPERATION_ID] to complete...⠹

   3. Run the following command to check the status of the operation, replacing$OPERATION_ID with the operation ID returned in the previous call:

      gcloud beta apigee operations describe$OPERATION_ID

      The following provides an example of the response. Note thatstate is set toIN_PROGRESS.

      Using Apigee organization 'prod'done: truemetadata:  '@type': type.googleapis.com/google.cloud.apigee.v1.OperationMetadata  operationType: INSERTstate: IN_PROGRESS  targetResourceName:uriname: organizations/prod/operations/$OPERATION_IDorganization: prodresponse:  '@type': type.googleapis.com/google.cloud.apigee.v1.CanaryEvaluation  control: 1-5-0-20210319-071117-ghq74  endTime: '2021-03-20T06:15:44.329363950Z'  metricLabels:    env: test    location: us-central1  name:uri  startTime: '2021-03-20T06:14:44.306534584Z'  treatment: 1-5-0-20210319-190954-if0wk  verdict: NONEuuid:$OPERATION_ID

   4. Repeat the previous step untilstate is set toFINISHED indicating that the archive depoloyment is complete.
   5. Run the following command to view all archive deployments in theprod environment:

      gcloud beta apigee archives list --environment=prod

      The following provides an example of the response:

      Using Apigee organization 'prod'ARCHIVE ID                        ENVIRONMENT   DEPLOYED AT           LABELS            OPERATION STATUSvrytwbhso558oil53m                prod          2021-04-20 21:20:53   release=052021.1  Deployed

Congratulations! You've successfully promoted your API archive to an Apigee production environment!