Plug-ins included with pattern types

Several preinstalled system plug-ins are available with the Cloud Pak System pattern types.

You can use these plug-ins to extend the function of patterns. The plug-ins contain the necessary code that you need for component parts when you build patterns, including caching, database, applications, transaction process, and messaging services.
Note: The following lists are not comprehensive.

IBM Foundation Pattern plug-ins

  • activator
  • agent
  • autoscaling
  • caching
  • deployinlet: This plug-in is used by the instance to monitor, manage, and show the log files of the instance.
  • elbInstance
  • elbManagement
  • firewall: For more information, see Other components.
  • foundation-license
  • iaas.WCA
  • logbackup: The logbackup plug-in contains optional configuration parameters, which, when set, enable backup of log files to a single location from the virtual machines that comprise a deployed pattern. You can configure log backup for virtual machines that run on Linux® or Windows. To configure log backup for Windows, you must use a custom script that is used to back up logs to the remote SCP server by using SSH key authentication. A valid Linux Secure Shell (SSH) storage location is needed for the backup. Backups are performed at regular intervals to the external server that runs the SSH and rsync daemons. The configuration parameters are as follows:
    Backup IP
    Specifies the IP address of the SSH and rsync server where virtual machine logs are the logs are synced.
    SSH host key file
    The public host key file, for example, /etc/ssh/ssh_host_rsa_key.pub of the backup system that is used for host verification when the backup system is connected.
    SSH key file
    The SSH key file that contains the private key for user authentication on the backup system. The corresponding public key is installed on the backup system.
    User name
    The backup system user with access to write to the backup root directory.
    Backup root directory
    The directory where the backups are stored on the backup system.
    Backup interval
    The interval, in seconds, at which the backups are performed through rsync. The default value is 1800 seconds.
    Backup Windows script
    This parameter is required to back up logs for virtual machines that run on Windows. Specifies the script file that is used to perform remote backup on Windows virtual machines. The following formats are supported: .bat, .vbs, and .py. The following parameters are provided by the system to your script when log backup occurs: -user <user> -host <backup-ip> -sshHostKey <path-to-sshHostKey> -sshKey <path-to-sshKey> -src <path-to-log> -dest <backup-path> -filePattern <log-file-pattern>
    Enable log backup on virtual systems
    Enabling this option installs the logbackup plug-in on classic virtual system patterns to perform log backup.
    Note: The plug-in is installed but not enabled, by default. You must provide the configuration parameters to enable it.

    By configuring the plug-in, you enable backup of log files that are generated by the instance. The log files that are generated vary depending on the pattern. The pattern developer specifies which log files are generated during development. These log files are the same log files that you see in the file viewer for the virtual machines that are associated with the instance. For more information, see the Related reference and Related tasks sections.

  • logging
  • monitoring: The monitoring plug-in has optional settings to integrate the provided IBM® Tivoli® Monitoring agent for Linux OS on each workload VM with their existing IBM Tivoli Monitoring server. The values available for configuration to use an IBM Tivoli Monitoring server are as follows:
    • Host name or IP address
    • Protocol, either IP.PIPE, IP.SPIPE or IP. The default is IP.PIPE.
    • Port, such as 1918 or 3660. The default is 1918.
    When the provided Tivoli Monitoring agents are configured to use a Tivoli Monitoring server, situations and actions can be configured on the server, along with viewing historical data in the Tivoli Enterprise Portal.
  • ssh: This plug-in is for managing Secure Shell (SSH) access to the workload virtual machines.
  • IBMEndpointManagerClient: This plug-in installs the Endpoint Manager client on virtual machines in your instances. If you deploy the IBM Endpoint Manager Service shared service on your system, the client connects to this IBM Endpoint Manager relay to install operating system updates and patches on the virtual machines.
  • troubleshooting
  • virtualsystem: This plug-in provides a limited capability for the installation of plug-in components on classic virtual system instances. It is used by the monitoring, logbackup, and IBMEndpointManagerClient system plug-ins. The configurable parameters are as follows:
    Plugins for virtual systems
    This parameter specifies whether plug-in components are installed on classic virtual system instances.
    • Enabled: Install the plug-in components on classic virtual system instances. This setting is the default for Cloud Pak System.
    • Documents only: Build the topology.json file and other documents in storehouse, but do not install the plug-in components. This option is used only for testing.
    • Disabled: Do not install plug-in components on classic virtual system instances.
    Note: For the monitoring and logbackup system plug-ins, you must also enable the plug-in to install on classic virtual system instances in the configuration settings for those plug-ins.
    Pattern types
    This parameter lists the pattern types that are scanned for plug-ins that can be installed on classic virtual system instances. This list includes itm, opm, and webapp by default.
    Packages
    This parameter lists the packages that are installed if the plug-in is enabled for virtual systems.

IBM Virtual System Pattern Type

plug-ins
  • activator
  • agent
  • autoscaling
  • chefclient
  • deployinlet: This plug-in is used by the instance to monitor, manage, and show the log files of the instance.
  • docker
  • firewall: For more information, see Other components.
  • foundation-license
  • gpfsclient
  • gpfssharedservice
  • iaas.WCA
  • IBMEndpointManagerClient
  • IBMEndpointManagerservice
  • imrepository
  • logbackup: The logbackup plug-in contains optional configuration parameters, which, when set, enable backup of log files to a single location from the virtual machines that comprise a deployed pattern. You can configure log backup for virtual machines that run on Linux or Windows. To configure log backup for Windows, you must use a custom script that is used to back up logs to the remote SCP server by using SSH key authentication. A valid Linux Secure Shell (SSH) storage location is needed for the backup. Backups are performed at regular intervals to the external server that runs the SSH and rsync daemons. The configuration parameters are as follows:
    Backup IP
    Specifies the IP address of the SSH and rsync server where virtual machine logs are the logs are synced.
    SSH host key file
    The public host key file, for example, /etc/ssh/ssh_host_rsa_key.pub of the backup system that is used for host verification when the backup system is connected.
    SSH key file
    The SSH key file that contains the private key for user authentication on the backup system. The corresponding public key is installed on the backup system.
    User name
    The backup system user with access to write to the backup root directory.
    Backup root directory
    The directory where the backups are stored on the backup system.
    Backup interval
    The interval, in seconds, at which the backups are performed through rsync. The default value is 1800 seconds.
    Backup Windows script
    This parameter is required to back up logs for virtual machines that run on Windows. Specifies the script file that is used to perform remote backup on Windows virtual machines. The following formats are supported: .bat, .vbs, and .py. The following parameters are provided by the system to your script when log backup occurs: -user <user> -host <backup-ip> -sshHostKey <path-to-sshHostKey> -sshKey <path-to-sshKey> -src <path-to-log> -dest <backup-path> -filePattern <log-file-pattern>
    Enable log backup on virtual systems
    Enabling this option installs the logbackup plug-in on classic virtual system patterns to perform log backup.
    Note: The plug-in is installed but not enabled, by default. You must provide the configuration parameters to enable it.

    By configuring the plug-in, you enable backup of log files that are generated by the instance. The log files that are generated vary depending on the pattern. The pattern developer specifies which log files are generated during development. These log files are the same log files that you see in the file viewer for the virtual machines that are associated with the instance. For more information, see the Related reference and Related tasks sections.

  • maintenance
  • monitoring: The monitoring plug-in has optional settings to integrate the provided IBM Tivoli Monitoring agent for Linux OS on each workload VM with their existing IBM Tivoli Monitoring server. The values available for configuration to use an IBM Tivoli Monitoring server are as follows:
    • Host name or IP address
    • Protocol, either IP.PIPE, IP.SPIPE or IP. The default is IP.PIPE.
    • Port, such as 1918 or 3660. The default is 1918.
    When the provided Tivoli Monitoring agents are configured to use a Tivoli Monitoring server, situations and actions can be configured on the server, along with viewing historical data in the Tivoli Enterprise Portal.
  • patterncomponent
  • ssh
  • troubleshooting

IBM Db2® with BLU Acceleration® Pattern virtual application pattern plug-ins

  • db2
  • dbaas-license
  • dswc
  • tsm

Application Pattern Type for Java™ virtual application pattern plug-ins

  • filemonitor
  • healthcenter
  • java
  • javafile
  • jdk7
  • netconnect