This documentation is for older WSO2 products. View documentation for the latest release.
Page Comparison - Clustering API Manager (v.122 vs v.123) - Clustering Guide 4.2.0 - WSO2 Documentation

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. Open the <APIM_HOME>/repository/conf/api-manager.xml files in the Gateway, Publisher, Key Manager and Store components.
  2. Modify each of the files as follows:
    • Key Manager

      Localtab Group
      Localtab
      activetrue
      titleAPI Manager 1.9.0
      Code Block
      <APIGateway>
      	<Environments>
      		<Environment type="hybrid">
      		...
      			<ServerURL>https://<IP of the Gateway>:9443/services/</ServerURL>
      			<Username>admin</Username>
      			<Password>admin</Password> 
      			<GatewayEndpoint>http://<IP of the Gateway>:8280,https://<IP of the Gateway>:8243</GatewayEndpoint>
      		</Environment>
      	</Environments> 
      ...
      </APIGateway>
      Localtab
      titleAPI Manager 1.8.0 and 1.7.0

      Configure the <RevokeAPIURL> element in in the api-manager.xml file by providing the URL of the Revoke API that is deployed in the API Gateway node.

      Code Block
      <RevokeAPIURL>https://${carbon.local.ip}:${https.nio.port}/revoke</RevokeAPIURL>
      ...
      <APIGateway>
      	<Environments>
      		<Environment type="hybrid">
      		...
      			<ServerURL>https://<IP of the Gateway>:9443/services/</ServerURL>
      			<Username>admin</Username>
      			<Password>admin</Password> 
      			<GatewayEndpoint>http://<IP of the Gateway>:8280,https://<IP of the Gateway>:8243</GatewayEndpoint>
      		</Environment>
      	</Environments> 
      ...
      </APIGateway>
      Localtab
      titleAPI Manager 1.6.0 and 1.5.0

      No changes required in the Key Manager node.

    • Gateway: configure the connection to the Key Manager component as follows:

      Localtab Group
      Localtab
      activetrue
      titleAPI Manager 1.9.0
      Code Block
      languagenone
      <APIKeyValidator> 
        <ServerURL>https://<IP of the Key Manager>:9443/services/</ServerURL>
        <Username>admin</Username>
        <Password>admin</Password>
        ...
      </APIKeyValidator>
      Localtab
      titleAPI Manager 1.8.0, 1.7.0, 1.6.0 and 1.5.0
      Code Block
      languagenone
      <APIKeyManager> 
        <ServerURL>https://<IP of the Key Manager>:9443/services/</ServerURL>
        <Username>admin</Username>
        <Password>admin</Password>
        ...
      </APIKeyManager>
      
    • Publisher: configure connections to the Key Manager and Gateway as follows:

      Localtab Group
      Localtab
      activetrue
      titleAPI Manager 1.9.0
      Code Block
      languagenone
      <APIKeyValidator>
      	<ServerURL>https://<IP of the Key Manager>:9443/services/</ServerURL>
      	<Username>admin</Username>
      	<Password>admin</Password>
      ...
      </APIKeyValidator>
      
      
      <AuthManager>
      	<ServerURL>https://<IP of the Key Manager>:9443/services/</ServerURL>
      	<Username>admin</Username>
      	<Password>admin</Password>
      </AuthManager>
      
      
      <APIGateway>
      	<Environments>
      		<Environment type="hybrid">
      		...
      			<ServerURL>https://<IP of the Gateway>:9443/services/</ServerURL>
      			<Username>admin</Username>
      			<Password>admin</Password> 
      			<GatewayEndpoint>https://<IP of the Gateway>:8280,https://<IP of the Gateway>:8243</GatewayEndpoint>
      		</Environment>
      	</Environments> 
      ...
      </APIGateway>
      Localtab
      titleAPI Manager 1.8.0, 1.7.0, 1.6.0 and 1.5.0

      Configure the <RevokeAPIURL> element in in the api-manager.xml file by providing the URL of the Revoke API that is deployed in the API Gateway node.

      Code Block
      languagenone
      <APIKeyManager>
      	<ServerURL>https://<IP of the Key Manager>:9443/services/</ServerURL>
      	<Username>admin</Username>
      	<Password>admin</Password>
      ...
      </APIKeyManager>
      
      
      <AuthManager>
      	<ServerURL>https://<IP of the Key Manager>:9443/services/</ServerURL>
      	<Username>admin</Username>
      	<Password>admin</Password>
      </AuthManager>
      
      
      <APIGateway>
      	<Environments>
      		<Environment type="hybrid">
      		...
      			<ServerURL>https://<IP of the Gateway>:9443/services/</ServerURL>
      			<Username>admin</Username>
      			<Password>admin</Password> 
      			<GatewayEndpoint>https://<IP of the Gateway>:8280,https://<IP of the Gateway>:8243</GatewayEndpoint>
      		</Environment>
      	</Environments> 
      ...
      </APIGateway>
      Info

      Creating a connection to the Key Manager from the Publisher is required in API Manager 1.3.0 but is no longer required from API Manager 1.4.0 onwards.

    • Store

      Localtab Group
      Localtab
      activetrue
      titleAPI Manager 1.9.0
      Code Block
      languagenone
      <RevokeAPIURL>https://${carbon.local.ip}:${https.nio.port}<IP of the Gateway>:8243/revoke</RevokeAPIURL>
       
       
      <APIKeyValidator>
      	<ServerURL>https://<IP of the Key Manager>:9443/services/</ServerURL>
      	<Username>admin</Username>
      	<Password>admin</Password>
      ...
      </APIKeyValidator>
      
      
      <AuthManager>
      	<ServerURL>https://<IP of the Key Manager>:9443/services/</ServerURL>
      	<Username>admin</Username>
      	<Password>admin</Password>
      </AuthManager>
      
      
      <APIGateway>
      	<Environments>
      		<Environment type="hybrid">
      		...
      			<ServerURL>https://<IP of the Gateway>:9443/services/</ServerURL>
      			<Username>admin</Username>
      			<Password>admin</Password> 
      			<GatewayEndpoint>https://<IP of the Gateway>:8280,https://<IP of the Gateway>:8243</GatewayEndpoint>
      		</Environment>
      	</Environments> 
      ...
      </APIGateway>
      Localtab
      titleAPI Manager 1.8.0, 1.7.0, 1.6.0 and 1.5.0
      Code Block
      languagenone
      <APIKeyManager>
      	<ServerURL>https://<IP of the Key Manager>:9443/services/</ServerURL>
      	<Username>admin</Username>
      	<Password>admin</Password>
      ...
      </APIKeyManager>
      
      
      <AuthManager>
      	<ServerURL>https://<IP of the Key Manager>:9443/services/</ServerURL>
      	<Username>admin</Username>
      	<Password>admin</Password>
      </AuthManager>
      
      
      <APIGateway>
      	<Environments>
      		<Environment type="hybrid">
      		...
      			<ServerURL>https://<IP of the Gateway>:9443/services/</ServerURL>
      			<Username>admin</Username>
      			<Password>admin</Password> 
      			<GatewayEndpoint>https://<IP of the Gateway>:8280,https://<IP of the Gateway>:8243</GatewayEndpoint>
      		</Environment>
      	</Environments> 
      ...
      </APIGateway>
      Tip

      Tip: For more information on how different environment types, see Maintaining Separate Production and Sandbox Gateways. This is useful when configuring environments in different geographical locations.

...

As explained in the sections above, the API Publisher and API Store use a shared registry for sharing API artifacts. Therefore, whenever an artifact is added/modified on the Publisher, the change needs to be reflected on the API Store appropriately. Due to the fact that the API Store fetches artifacts from the registry cache, modifications to artifacts done on the Publisher may not immediately be reflected on the Store unless the relevant cache entry is explicitly cleared off or the cache expires. For the cache to be explicitly cleared off, the Publisher and Store need to be in the same cluster domain and need to be aware of each other's existence. See Configuring Caching for more information.

...