Send Docs Feedback

Developer Services Portal Overview

Developer Services Portal v. 4.16.05

Apigee Developer Channel Services is a template portal for content and community management. It is based on the open source Drupal (www.drupal.org) project. The default setup allows creating and managing API documentation, forums, and blogs. A built-in test console allows testing of APIs in real time from within the portal. 

Apart from content management, Developer Channel Services has various features for community management such as manual/automatic user registration and moderating user comments. Role-Based Access Control (RBAC) model controls the access to features on the Developer Channel Services. For example, you can enable controls to allow registered user to create forum posts, use test consoles, and so on.  

This version of this document has details specific to version 4.16.05. Any references that are specific to previous versions are oversights and should be reported as bugs. 

Access the Apigee Community for your questions 

The Apigee Community is a free resource where you can contact Apigee as well as other Apigee customers with questions, tips, and other issues. Before posting to the community, be sure to first search existing posts to see if your question has already been answered. 

Supported Network Topologies

The components of the Apigee Developer Channel Services can be installed in several different network configurations, or topologies, including:

  • Single machine - All Apigee Developer Channel Services components installed on a single machine.
  • Small - The Drupal MySQL database is installed on a separate machine from the other components.
  • Medium - Multiple Apache Servers installed with a sync script to keep them updated.
  • Large - Multiple Apache Servers installed with NFS, GlusterFS, S3, or other type of syncing mechanism.

These four topologies are the only topologies supported by Apigee. If you use a different network topology, Apigee might not be able to support it. 

The following figure shows the single-machine topology where all components of the Apigee Developer Channel Services are installed on a single machine:

If you install the portal on RedHat 7 or CentOS 7, then the installation script installs MariaDB and not MySQL. MariaDB is functionally equivalent to MySQL.

In this figure, the Public core contains the components that are publicly accessible. The Private core contains components that are not publicly accessible. 

構成要素

説明

Installed by

ELB

An Enterprise Load Balancer (ELB).

Your network provider.

For example, both Amazon and Rackspace provide Enterprise load balancers for use with their instances.

Apache Server Version 2.2

Depending on your topology, you can have a single Apache server instance (single machine and small) or multiple (medium and large).

For medium and large, you must provide a way to synchronize the instances.

Apigee

Apache Solr

The Drupal search server. Apache Solr uses the Apache Lucene search library.

Apigee

MySQL 5.0.15 or later

The database used by Drupal. For the small, medium, and large topologies, the MySQL instance is on a different machine from the other components.

Apigee, or connect to an existing installation. If MySQL is installed by the Apigee installer, it installs the latest version available for your OS.

If you want to connect to a remote MySQL installation, it must be version 5.0.15 or later.

MariaDB 5.1.38 or later

If you install the portal on RedHat 7 or CentOS 7, then the installation script installs MariaDB and not MySQL. MariaDB is functionally equivalent to MySQL.

Apigee, or connect to an existing installation. If MariaDB is installed by the Apigee installer, it installs the latest version available for your OS.

If you want to connect to a remote MariaDB installation, it must be version 5.1.38 or later.

Drupal shared storage

The shared storage area used by Drupal for uploaded files, static scripts, and other information.

Apigee

Drush 6.2

The Drupal command line interface.

Apigee

PHP 5.3.6

Server-side scripting engine.

Apigee

Shown below is the small topology where the MySQL servers resides on a separate machine:

The medium topology useS multiple Apache Server instances and multiple MySQL host machines:

In the large topology, use NFS, GlusterFS, S3, or other type of syncing mechanism to sync the WEBROOT/sites/default/files/:

 

Help or comments?