How-to guides

You're viewing Apigee Edge documentation.
View Apigee X documentation.

The how-to guides provide detailed instructions to help Apigee Edge Public Cloud and Private Cloud users accomplish the following tasks:

Configure various Apigee Edge resources and properties.
Verify that the resources and properties have been configured properly.
Share best practices (where applicable) that can be followed while configuring the resources and properties.

The following table describes the current how-to guides:

Timeout configuration

Best practices for configuring I/O timeout	Describes best practices for configuring the I/O timeout property on various components through which the API requests flow in Apigee Edge.	Edge Public and Private Cloud users
Configuring I/O timeout on Message Processors	How to configure the I/O timeout property in API Proxy and Apigee Edge's Message Processor component.	Edge Public and Private Cloud users
Configuring I/O timeout on Routers	How to configure the I/O timeout property in Virtual Host and Apigee Edge's Router component.	Edge Public and Private Cloud users
Configuring connection timeout on Message Processors	How to configure the connection timeout in API Proxy and Apigee Edge's Message Processor component.	Edge Public and Private Cloud users
Configuring keep alive timeout on Message Processors	How to configure the keep alive timeout in API Proxy and Apigee Edge's Message Processor component.	Edge Public and Private Cloud users

JVM parameter configuration

Configuring heap memory size on the Message Processors	How to configure the heap memory size on Apigee Edge’s Message Processors.	Edge Private Cloud users only
Configuring heap memory size on the Qpid servers	How to configure the heap memory size on Apigee Edge’s Qpid servers.	Edge Private Cloud users only
Enabling G1GC on the Message Processors	How to enable Garbage First Garbage Collector (G1GC) on the Apigee Edge’s Message Processors.	Edge Private Cloud users only
Enabling String Deduplication on the Message Processors	How to enable String Deduplication on the Apigee Edge’s Message Processors.	Edge Private Cloud users only

Virtual host configuration

How to configure cipher suites on virtual hosts and Routers in Apigee Edge.

Edge Public and Private Cloud users

SNI configuration

How to enable and disable SNI on Message Processors.

Edge Private Cloud users only

TLS certificate configuration

Converting certificates to supported format	How to convert the TLS certificate and associated Private key to the PEM or the PFX (PKCS #12) formats.	Edge Public and Private Cloud users
Validating certificate chain	How to validate a certificate chain before you upload the certificate to a keystore or a truststore in Apigee Edge.	Edge Public and Private Cloud users
Validating certificate purpose	How to validate a certificate’s purpose before you upload the certificate to a keystore or a truststore in Apigee Edge.	Edge Public and Private Cloud users
Validating client certificate against trustore	How to verify that the correct client certificates have been uploaded to Apigee Edge Routers.	Edge Private Cloud users only

Log rotation

Enable log rotation for `edge-message-processor.log`	How to enable log rotation for `/opt/apigee/var/log/edge-message-processor/edge-message-processor.log` logs on the Edge Message Processors.	Edge Private Cloud users only
Enable log rotation for `edge-router.log`	How to enable log rotation for `/opt/apigee/var/log/edge-router/edge-router.log` logs on the Edge Routers.	Edge Private Cloud users only

Operations

Restarting Routers and Message Processors without traffic impact	How to restart Routers and Message Processors (MPs) without impacting incoming API traffic.	Edge Private Cloud users only
Downgrading Apigee Components and Nginx	How to check whether you need to downgrade, and how to downgrade Apigee components, if necessary.	Edge Private Cloud users only

Timeout configuration