Common Runtime and Configuration Artifacts

The following are the artifacts used commonly in a WSO2 API Manager and API Manager Analytics deployment.

Persistent Runtime Artifacts - directories in API Manager which includes deployable files which are valid from a specified date and time at runtime.

Persistent Configuration Artifacts - directories in API Manager where the configuration files are included which are used for configurations.

Info

Persistent runtime artifacts could be updated at the runtime, and are expected to be available across instance restarts, VM re-creation or container re-spawning. Persistent file storage systems should be used to ensure this.

Example: In a Kubernetes based container environment, its possible to use Persistent Volumes to persist these artifacts.

  1. API Manager
    1. Persistent Runtime Artifacts
    2. Persistent Configuration Artifacts
  2. APIM Analytics
    1. Persistent Runtime Artifacts
    2. Persistent Configuration Artifacts

API Manager

Persistent Runtime Artifacts

  1. <API-M_HOME>/repository/deployment/server - Contains webapps that are related to customizing WSO2 API Manager during deployment. Required for deploying a super tenant. Also contains Synapse configurations and custom sequences, throttling execution plans.

  2. <API-M_HOME>/repository/tenants - This is only used when the deployment involves multi-tenancy. For more information, see Configuring Multiple Tenants

  3. <API-M_HOME>/solr - Contains files for Apache solr indexing. For additional information, see Add Apache Solr-Based Indexing

  4. <API-M_HOME>/repository/database - H2 database (For solr indexing)

Info

Shared Artifacts

The following artifacts can be shared among API Manager nodes

  1. <API-M_HOME>/repository/deployment/server/synapse-configs
  2. <API-M_HOME>/repository/deployment/server/executionplans
  3. <API-M_HOME>/repository/tenants

Persistent Configuration Artifacts

  1. <API-M_HOME>/repository/resources - This folder/artifact contains keystores, templates, scripts, etc.

  2. <API-M_HOME>/repository/conf - This folder contains the configuration files related to servers, datasources, registry, user management, etc.

  3. <API-M_HOME>/bin - Contains files for JVM changes, profile changes, etc.

APIM Analytics

Persistent Runtime Artifacts

  1. <API-M_ANALYTICS_HOME>/wso2/worker/deployment/siddhi-files - Contains the Siddhi application artifacts related to APIM analytics worker runtime.

Info

Shared Artifacts

The following artifacts can be shared among APIM Analytics nodes

  1. <API-M_ANALYTICS_HOME>/wso2/worker/deployment/siddhi-files

Persistent Configuration Artifacts

  1. <API-M_ANALYTICS_HOME>/conf/worker - This folder contains the configuration files related to servers, datasources, user management, etc.

  2. <API-M_ANALYTICS_HOME>/wso2/worker/bin - Contains files for JVM changes, profile changes, etc.

Top