Skip to main content

Prerequisites for the Docker Images Plugin

Before you install and configure the Docker Images plugin, ensure that the following prerequisites are met:

  • The Docker server must be installed and configured properly in your environment. The Docker Images plugin can only be executed on a server that already has an authenticated connection to the Docker server.

    note

    The Docker Images plugin issues Docker commands without prompting for credentials.

  • All Code Insight prerequisite tasks for plugins have been performed, as described in Preparing to Use the Plugins.

  • A minimum of 2GB of heap space is allocated on the Docker server, which must be configured with a 64-bit JRE to support that amount of heap space.

  • The plugin sets the maximum JVM heap size to 4GB by default, a size sufficient for most images. However, if you are receiving errors due to heap size, you can increase this maximum by setting a higher -Xmx value in the last line of code in the code-insight-docker-plugin.sh file, located in the plugin folder. (You can also add a minimum heap size, using the -Xms option, if needed.) The following provides an example of how you might update this line to increase the maximum heap size:

    • java -Xmx10240m -Xms1024m-jar $DEBUG code-insight-docker-plugin.jar $*
    note

    If you are using a 64-bit JVM, you can increase the heap size to the size you need. If you are using a 32-bit JVM, you are limited to 4GB.

  • The Docker image you are scanning must already be downloaded to your system.