viewing Apigee X documentation.
View Apigee Edge documentation.
Installation and configuration process
This section describes the overall process for setting up and configuring a paid org with Apigee so that you can then create and deploy your very own API proxies.
The general process for provisioning a paid org is as follows:
- Select your project. Launch the provisioning wizard and select the project you are configuring Apigee for.
- Enable APIs. Without these, Apigee services wouldn't be able to talk to one another or other services.
- Create encryption keys Apigee uses Cloud KMS keys to encrypt data communicated between applications and the database and to encrypt organization-level entities. See also Encrypting and decrypting data with a symmetric key.
- Create an organization which will encompass all of your environments and groups, users, API proxies, and related resources.
- Configure service networking to allocate IP addresses for your private connection between your project and the Google services. Apigee requires a CIDR range of /16 or /20 per region. The range is provided at the time the runtime instance is created.
- Create a runtime that hosts your project and its API proxies. It connects to Google via a private peered VPC network. Apigee requires a Cloud KMS key per runtime instance. See also Encrypting and decrypting data with a symmetric key.
- Create an environment and an environment group, and then attach the group to your runtime.
- Configure routing so that you can access your new cluster and the API proxy deployed on it.
- Deploy sample proxy and see how it all ties together.
Each step is described in detail in the sections that follow.
About the Apigee provisioning wizard
Apigee provides you with the Apigee
provisioning wizard, which performs many of the tedious and error prone
tasks of provisioning for you. However, even with the wizard, there are still
some steps where you need to use
gcloud and other command line tools.
About the examples
Some commands and examples in the documentation use
curl to connect to the
Apigee APIs. In most cases, we try to:
- Include the
-ioption to display the request and response headers.
- Avoid the
-soption, as this suppresses errors that might provide useful information.
- Where possible, use local environment variables to ensure consistency and accuracy. While optional, using environment variables will save the possibility of typographical errors in commands that may be difficult to investigate. When using environment variables, however, be sure to wrap them in the proper quotation marks. Therefore the first step in this section is Define environment variables.
- Set the
Content-Typeheader to "application/json", which indicates that the data payload is in JSON format.
To learn more about Apigee:
To provision a paid org: