This pageapplies toApigee andApigee hybrid.

View Apigee Edge documentation.

This page describes how to launch the Apigee Developer Portal Kickstart solution from Cloud Marketplace withdefault configuration options.

In many cases, there are multiple options for portal customization to suit your scaling, security, or monitoring needs. See Customize the Apigee Developer Portal Kickstart solution in Cloud Marketplace for specific customization optionsto consider before deploying your portal.

Before you begin

This tutorial is intended to familiarize you with the steps required for a default portal configuration.Before you deploy a portal for testing or production usage, see Customize the Apigee Developer Portal Kickstart solution in Cloud Marketplace for the prerequisite configuration steps needed for the following tasks:

• Configure a private IP address for using CloudSQL in a VPC network
• Use customer-managed encryption keys for your deployment
• Connect your portal to an Apigee or Apigee hybrid org
• Configure HTTPS for testing
• Launch a production-ready portal

Launching a new Apigee Developer Portal Kickstart

Follow the steps below to configure and deploy the Apigee Developer Portal Kickstart solution from Cloud Marketplace:

1. In the Google Cloud console, go to the Cloud Marketplace page and select theApigee Developer Portal Kickstart solution.
2. ClickLaunch.
3. Configure theNew Apigee Developer Portal deployment.
   1. Enter theDeployment name. For example,portal-dev. The name of your deployment:
      • Should not exceed 10 characters.
      • Match the regular expression[a-z]([-a-z0-9]*[a-z0-9])?. This means that the first character must be a lowercase letter, and all the following characters must be hyphens, lowercase letters, or digits, except the last character, which cannot be a hyphen.
      • See Compute Engine guidelines on Naming conventions for addition details.
   2. Select thePreferred Zone for your deployment from the dropdown list. For more details regarding Compute Engine resources available in various zones, seeRegions and Zones.
   3. Select theMachine type for the Compute Engine instance from the dropdown list. The default value is1vCPU.
      • Optional: ClickCustomize to change the selectedMachine type,Cores, andMemory for the Compute Engine instance.
      • See Creating a VM Instance with a custom machine typefor more information on machine type customization options.
   4. Create a new Service Account orSelect an existing Service Account for the Compute Engine instances in your deployment. The Service Account is used by Compute Engine to access other Google APIs.
      • To create a new Service account, provide the following information:
        • Service account name: This unique identifier will appear in the service account's email address that is provisioned during creation. For example,sa-name@project-id.iam.gserviceaccount.com.
        • Service account ID: The ID must be between 6 and 30 characters, and can contain lowercase alphanumeric characters and dashes.
        • Service account description: a brief description of the service account
        • SeeCreating a service account for additional details.
      • To select an existing Service Account,Select a Service Account from the dropdown list of available Service Accounts within your project with the correct roles.
      Note: The existing Service Account must have the following roles:
      • roles/storage.objectViewer
      • roles/logging.logWriter
      • roles/runtimeconfig.admin
      • roles/apigee.developerAdmin
      • roles/cloudsql.client
      • roles/monitoring.metricWriter
   5. Optional: Configure Boot Disk options:
      • Select theBoot disk type from the dropdown list. The default value is Standard Persistent Disk.
      • Select theBoot disk size from the dropdown list. The default value is 200GB.
      • SeeStorage options for a comparison of storage options and disk pricing.
   6. Optional: ConfigureNetworking options:
      • New portals are provisioned with a default IP address for connecting to the CloudSQL instance.
      • Optionally, select the checkbox to configure HTTPS on the new portal using annip.io domain.nip.io is a third-party service that can provide a wildcard DNS for an IP address. If you wish to usenip.io for development and testing, you can modify the domain in the load balancer configuration prior to production use. SeeUsing a testing domain for an example of the steps required.
   7. Optional: ConfigureCloud Logging and Monitoring:
      • Cloud Logging and Cloud Monitoring are enabled for new Apigee Developer Portal Kickstart deployments by default.
      • To disable either Cloud service, uncheck the corresponding box.
      • See theCloud Logging and Cloud Monitoring documentation for more details on configuration options.
   8. Optional: ConfigureEncryption options:
      • By default, the Apigee Developer Portal Kickstart usesGoogle Managed Encryption Keys to secure access to your Cloud SQL instance.
      • To use a configured customer-managed encryption key (CMEK) to secure access to Cloud SQL, enter theResource Name of the Encryption key in the text field.
   9. ClickDeploy.

   Congratulations, you have successfully deployed a Apigee Developer Portal Kickstart!

   Viewing your portal deployment

   To see the details of your portal deployment:

   1. From the Apigee Developer Portal Kickstart page, clickView Past deployments. This will take you to theDeployment Manager dashboard.
   2. To view the details of a given portal deployment, select the desired portal deployment from the list. The detail page will recommend next steps, link to additional documentation, and provide links and IDs for provisioned Cloud services, including the following:
      • Instance Group
      • Cloud SQL Instance
      • Filestore Instance
      • Firewall Rule
      • Load Balancer
   3. For more information on managing, updating, and deleting deployments, see the Deployment Manager documentation.

   Clean up

   To avoid incurring charges to your Google Cloud account for the resources used in this quickstart,you candelete your deployment. You can alsodelete the Google Cloud project used for this tutorial.

   What's next

   • Additional options for Customize the Apigee Developer Portal Kickstart solution in Cloud Marketplace.
   • Learn more aboutSupport resources for the Apigee Developer Portal Kickstart solution.