Populate Cache policy deployment error troubleshooting

InvalidCacheResourceReference

Error Message

Deployment of the API proxy through either the Apigee UI or API fails with this error message:

Error Deploying Revision revision_number to environment
Invalid cache resource reference [cache_resource] in Step definition [populate_cache_policy_name]. Context Revision:[revision_number];APIProxy:[apiproxy_name];Organization:[organization];Environment:[environment]

Example Error Message

Error Deploying Revision 2 to test
Invalid cache resource reference tokencache in Step definition PopulateCache-Token. Context Revision:2;APIProxy:TestCache;Organization:kkalckstein-eval;Environment:test

Example Error Screenshot

Error deploying revision 2 to test.

Cause

This error occurs if the <CacheResource> element in the PopulateCache policy is set to a name that does not exist in the environment where the API proxy is being deployed.

Diagnosis

  1. Identify the PopulateCache policy name, the invalid cache used in the <CacheResource> element of the policy, and the environment where the error occurred. You can find all these items in the error message. For example, in the following error, the PopulateCache policy name is PopulateCache-Token, the name of the invalid cache is tokencache and the environment name is test.

    Invalid cache resource reference tokencache in Step definition PopulateCache-Token. Context Revision:2;APIProxy:TestCache;Organization:kkalckstein-eval;Environment:test
    
  2. Examine the failed PopulateCache policy XML and verify if the cache name specified for the <CacheResource> element matches the error message.

    In this example, the cache name specified in the <CacheResource> element is tokencache:

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <PopulateCache async="false" continueOnError="false" enabled="true" name="PopulateCache-Token">
        <DisplayName>PopulateCache-Token</DisplayName>
        <Properties/>
        <CacheKey>
            <Prefix/>
            <KeyFragment ref="request.queryparam.client_id"/>
        </CacheKey>
        <CacheResource>tokencache</CacheResource>
        <Scope>Exclusive</Scope>
        <ExpirySettings>
            <TimeoutInSec>3600</TimeoutInSec>
        </ExpirySettings>
        <Source>token</Source>
    </PopulateCache>
    
  3. Verify if the cache (determined in step #1) has been defined in the specific environment (identified in step #1).

    In the Apigee UI, navigate to ADMIN > Environment > test and check if the cache exists in the Caches tab of Environment Configuration. If the cache does not exist, then that's the cause of the error.

    For example, notice in the screenshot below that the cache named tokencache does not exist.

    Environment Configuration Caches tab.

    Because the cache named tokencache is not defined in the test environment, you get the error:

    Invalid cache resource reference tokencache in Step definition PopulateCache-Token. Context Revision:2;APIProxy:TestCache;Organization:kkalckstein-eval;Environment:test
    

Resolution

Ensure that the cache specified in the <CacheResource> element of PopulateCache policy has been created in the environment where you want to deploy the API proxy.

CacheNotFound

Error Message

Deployment of the API proxy through either the Apigee UI or API results in an error message like this, and the deployment status of the API Proxy is marked as partially deployed:

Error: Cache : cache_resource, not found in organization : organization__environment.

Example Error Message

Error Cache : configCache, not found in organization : kkalckstein-eval__test

Cause

This error occurs if the specific cache mentioned in the error message has not been created on a specific Message Processor component. A Message Processor is an internal Apigee component that processes the flow of API traffic through Apigee.

Resolution

Contact Apigee Support for assistance.