Import Large Archives

Archives exported from CSA can be imported to install artifacts or update existing artifacts in CSA. Archives can be imported using the CSA Content Archive Tool, the Cloud Service Management Console, or the REST API.

The default configuration for importing archives supports an archive up to 2 MB in size. When an archive larger than 2 MB is imported (typically, a catalog), the import operation may hang or take a very long time to complete. If an archive is larger than 2 MB, it is recommended that you use the Content Archive Tool and increasing the JVM heap size.

Import Large Archives Using the CSA Content Archive Tool

If you want to import an archive larger than 2 MB, it is recommended that you use the Content Archive Tool because the tool uses its own JVM heap (it does not share the JVM heap used by CSA). When you reconfigure the JVM heap size for the tool, you do not need to restart CSA and CSA performance is not affected by the import.

To increase the JVM heap size when running the Content Archive Tool, add the
‑Xms<heap_size>M ‑Xmx<heap_size>M options to the command line. For example, to increase the JVM heap size to 3 GB, type:

Windows:

"CSA_JRE_HOME\bin\java -Xms3072M -Xmx3072M -jar content-archive-tool.jar -i -z catalog_archive.zip

Linux:

CSA_JRE_HOME/bin/java -Xms3072M -Xmx3072M -jar content-archive-tool.jar -i -z catalog_archive.zip

where CSA_JRE_HOME is the directory in which the JRE that is used by CSA is installed.

Note By default, the JVM heap size used by the Content Archive Tool is 2 GB. If you want to use a larger JVM heap size, you must always specify the two options listed above when running the Content Archive Tool.

For more information about the Content Archive Tool, refer to the CSA Content Archive Tool guide.

Import Large Archives from the Cloud Service Management Console or through the REST API

If you want to import an archive larger than 2 MB, it is recommended that you use the Content Archive Tool. If you must use the Cloud Service Management Console or REST API to import a large archive, you must update the JVM heap size for CSA which requires CSA to be restarted. Also, importing a large archive from the Cloud Service Management Console or through the REST API may slow the performance of CSA.

To increase the JVM heap size before importing a large archive from the Cloud Service Management Console or through the REST API, do the following:

  1. Stop CSA.

    To stop CSA on Windows, complete the following steps:

    1. On the server that hosts CSA, navigate to Start > Administrative Tools > Services.
    2. Right-click on the CSA service and select Stop.

    3. Right-click on the HPE Marketplace Portal service and select Stop.

    4. If you installed an embedded Operations Orchestration instance, right-click on the HPE Operations Orchestration Central service and select Stop.

    5. If you enabled global search, do the following:

      1. Right-click on the Elasticsearch 1.6.1 service and select Stop. You do not need to stop this service if global search is disabled (by default, global search is disabled).

      2. Right-click on HPE Search Service and select Stop. You do not need to stop this service if global search is disabled (by default, global search is disabled).

    6. If Elasticsearch is enabled (by default, Elasticsearch is enabled; refer to the csa.provider.es.exists property in Appendix: Cloud Service Management Console Properties for more information), right-click on the Elasticsearch 1.6.1 service and select Stop.

    To stop CSA on Linux, complete the following steps:

    1. On the server that hosts CSA, type the following commands:

      service csa stop
      service mpp stop
    2. If you installed an embedded Operations Orchestration instance, type:

      <embeddedHPEOOinstallation>/central/bin/central stop

      For example, type: /usr/local/hpe/csa/OO/central/bin/central stop

  2. Increase the JVM heap size for CSA.

    1. Open the CSA_HOME/jboss-as/bin/standalone.conf.bat file in a text editor.

    2. Locate the following line:

      Windows:

      set "JAVA_OPTS=%JAVA_OPTS% -Xms2048M -Xmx2048M -XX:ReservedCodeCacheSize=256M"

      Linux:

      $JAVA_OPT -Xms2048M -Xmx2048M -XX:ReservedCodeCacheSize=256M"

    3. Increase the JVM heap size (by default, the JVM heap size is 1 GB). For example, to change the JVM heap size to 3 GB, change the line to:

      Windows:

      set "JAVA_OPTS=%JAVA_OPTS% -Xms3072M -Xmx3072M -XX:ReservedCodeCacheSize=256M"

      Linux:

      $JAVA_OPT -Xms3072M -Xmx3072M -XX:ReservedCodeCacheSize=256M"

    4. Save and close the file.
  3. Start CSA. See Start CSAfor instructions.

    To start CSA on Windows, complete the following steps:

    1. If you have configured CSA to be FIPS 140-2 compliant, create a CSA encryption keystore password file. The name and location of this file must match the value configured for the keystorePasswordFile property in the CSA_HOME\jboss-as\standalone\deployments\csa.war\WEB-INF\classes\csa.properties file.

      The password file must contain only the following content: keystorePassword=<CSA encryption keystore password>

      where <CSA encryption keystore password> is the CSA encryption keystore password in clear text.

      This file is automatically deleted when the HPE Cloud Service Automation service is started.

    2. On the server that hosts CSA, navigate to Start > Administrative Tools > Services.

    3. If global search is enabled, do the following:

      1. Right-click on the Elasticsearch 1.6.1 service and select Restart.

      2. Wait for a minute for the Elasticsearch 1.6.1 service to restart, then right-click on HPE Search Service and select Restart.

        Note: if global search is disabled, skip this step.
    4. Right-click on the CSA service and select Start.

    5. Right-click on the HPE Marketplace Portal service and select Start.

    6. If you installed an embedded Operations Orchestration instance, right-click on the HPE Operations Orchestration Central service and select Start.

       

    To start CSA on Linux, complete the following steps:

    1. On the server that hosts CSA, type the following:

      service csa start
      service mpp start

    2. If elasticsearch is enabled (by default, elasticsearch is enabled; refer to the csa.provider.es.exists property in Appendix: Cloud Service Management Console Properties for more information), type the following:

      service elasticsearch start

    3. If you installed an embedded Operations Orchestration instance, type:

      <embeddedHPEOOinstallation>/central/bin/central start

      For example, type /usr/local/hpe/csa/OO/central/bin/central start

For more information about importing archives from the Cloud Service Management Console, refer to the Cloud Service Management Console Help. For more information about importing archives through the REST API, refer to the CSA API Reference guide.