Adding script packages

Create a script package and add it to the catalog.

Before you begin

You must be assigned the Create new catalog content role or the Workload resources administration role with full permissions to complete this task. You must be assigned System level, user or user group role with permission to Manage workload resources (Full permission) to grant access to another user on script packages to complete this task.

Before you create a new script package, verify whether any previously created script packages in the catalog already meet your needs. You might also be able to clone an existing script package and modify it for your needs before you create a new one.

You must create an archive file in .zip or .tgz (.tar.gz) format that contains the main executable file and all associated artifacts that support the execution of the main executable file. This file is uploaded into Cloud Pak System Software for Power® and used as input to create the script package.
Important: When you create your scripts, use a text editor that does not introduce control characters as the scripts might become unusable. Before a script is run on a Linux/UNIX system in a virtual system pattern, all files in the script that end in .sh, .py, or .rb. are converted from DOS/MAC to UNIX format by running the dos2unix utility. If your script includes files with binary data, do not give them names that end with .sh, .py, or .rb. Classic virtual system patterns do not have this limitation.
Restriction: Be aware of the following limitations for the compressed file that you are uploading:
  • On some web browsers, there is a 2 GB limitation on the size of files that can be uploaded. If your compressed file is greater than 2 GB in size, you might need to use a different browser that supports uploading larger files, or use the command-line interface to upload this file.
  • If your compressed file is packaged in .zip format, the file size must be less than 4 GB.
  • For compressed files larger than 4 GB, you must package the file in .tgz (.tar.gz) format, and use the command-line interface to upload the file.

For information about uploading a compressed file to a script package by using the command-line interface, see the related links.

About this task

You can create a script package that contains your main executable file and associated artifacts, configure parameters as needed, and then add your new script package to the catalog, where it is available for later inclusion in virtual system patterns.
Multisystem environment considerations
  • If you are adding script packages in a multisystem environment, the operation takes place only on the local system.
  • For information about the fields on the Script Packages page, see Fields on the Script Packages page.

Procedure

  1. Click Catalog > Script Packages. The Script Packages page displays the list of script packages that are currently available. The list is displayed in a table format, providing some basic details about each script package.
  2. Click Create New.
  3. Browse to the archive file for the script package.
  4. Click Import.
    • If there are no existing script packages on the system with the same name and version as the script package that you are adding, the script package is added.
    • If a script package with the same name and version exists on the system, and one or both of the script packages are not locked (read-only), you are prompted with options:
      1. Specify a unique name for the imported script package.
        Note: This option is available only when the script package that you are adding is not read-only.
      2. Specify a unique version for the imported script package.
        Note: This option is available only when the script package that you are adding is not read-only.
        Restriction: Multiple versions of the same script package are not supported for use with classic virtual system patterns.
      3. Replace the existing script package.
        Note: This option is available only when the existing script package is not read-only.

      After you make a selection, click Import again to complete the import process.

    • If a script package with the same name and version exists on the system, and both of the script packages are read-only, the import fails.

    If the import is successful, the script package details are displayed.

  5. If necessary, configure the script package by providing information as needed in the fields on the Script Packages page.

    For details about how to configure the fields on the Script Packages page, see the related links.

    The compressed file that you upload might also include one or more license agreements that become part of the script package. You must accept all license agreements in the script package before you can include the script package in a virtual system pattern or deploy a virtual system pattern with the script package. For more information about license agreements in script packages, see the related links.

  6. When you complete the configuration for the script package, the script package is saved in the catalog.

What to do next

You can now associate this script package with a virtual system pattern. For more information about working with virtual system patterns, see the related links.